Skip to content
External Authentication S...
/
/
Activate Encryption Certi...

External Authentication Service (0.0.1)

https://support.ruckuswireless.com/ruckus-cloud-wifi-legal-terms-and-conditions

Overview

The External Authentication Service REST API provides enterprise identity management for authentication in RUCKUS Cloud WiFi environments.

Key Features

  • SAML Identity Provider Management: Create, retrieve, update, and delete SAML IdP profiles
  • Certificate Management: Manage encryption and signing certificates with activation and deactivation controls

This API enables network administrators to integrate enterprise identity providers with RUCKUS Cloud WiFi for secure user authentication across wireless networks.

Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for North American region.
https://api.ruckus.cloud

SAML Identity Provider

Manage SAML identity providers.

Operations

Create SAML Identity Provider Profile

Request

Create a SAML identity provider profile.

Body
required
attributeMappingsArray of objects(AttributeMapping)[ 0 .. 64 ] items

List of mappings from SAML provider attributes to R1 user attributes.

metadatastring

Base64-encoded content, max 512KB when decoded.

metadataUrlstring[ 0 .. 2048 ] characters^https?:\/\/([A-Za-z0-9]+([\-\.]{1}[A-Za-z0-9...

URL to fetch SAML identity provider metadata from.

namestring[ 2 .. 32 ] charactersrequired
{
  "attributeMappings": [
    { … }
  ],
  "metadata": "string",
  "metadataUrl": "string",
  "name": "string"
}

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

responseobject(EntityId)

The unique identifier for the entity that will be created.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Delete SAML Identity Provider Profile

Request

Delete the specified SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Get SAML Identity Provider Profile

Request

Retrieve the specified SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
No request payload

Responses

OK

Body
attributeMappingsArray of objects(AttributeMapping)[ 0 .. 64 ] items

List of mappings from SAML provider attributes to R1 user attributes.

metadatastring

Base64-encoded content, max 512KB when decoded.

metadataUrlstring[ 0 .. 2048 ] characters^https?:\/\/([A-Za-z0-9]+([\-\.]{1}[A-Za-z0-9...

URL to fetch SAML identity provider metadata from.

namestring[ 2 .. 32 ] charactersrequired
updatedDatestring(date-time)read-only

Timestamp when the profile was last updated.

Response
{
  "attributeMappings": [
    { … }
  ],
  "metadata": "string",
  "metadataUrl": "string",
  "name": "string",
  "updatedDate": "2019-08-24T14:15:22Z"
}

Update Partial SAML Profile

Request

Update the specified partial SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
Body
required
actionstring

The action type to execute on the profile.

Value"REFRESH_METADATA"
{
  "action": "REFRESH_METADATA"
}

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Update Entire SAML Profile

Request

Update the specified entire SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
Body
required
attributeMappingsArray of objects(AttributeMapping)[ 0 .. 64 ] items

List of mappings from SAML provider attributes to R1 user attributes.

metadatastring

Base64-encoded content, max 512KB when decoded.

metadataUrlstring[ 0 .. 2048 ] characters^https?:\/\/([A-Za-z0-9]+([\-\.]{1}[A-Za-z0-9...

URL to fetch SAML identity provider metadata from.

namestring[ 2 .. 32 ] charactersrequired
{
  "attributeMappings": [
    { … }
  ],
  "metadata": "string",
  "metadataUrl": "string",
  "name": "string"
}

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Deactivate Encryption Certificate

Request

Deactivates the specified encryption certificate for the SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
certificateIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Activate Encryption Certificate

Request

Activates the specified encryption certificate for the SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
certificateIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Deactivate Signing Certificate

Request

Deactivates the specified signing certificate for the SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
certificateIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}

Activate Signing Certificate

Request

Activates the specified signing certificate for the SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
certificateIdstringrequired
No request payload

Responses

OK

Body
requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

Response
{
  "requestId": "string"
}