Skip to content

External-Auth API and Model Documentation (0.0.1)

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

Overview

Rate Limit

For the ApOps REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.ruckus.cloud/

SAML Identity Provider

Manage SAML Identity Providers

Operations

Get SAML Identity Provider Profile

Request

Retrieve the specified SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
No request payload

Responses

OK

Body
namestring[ 2 .. 32 ] charactersrequired
metadatastring

Base64-encoded content, max 512KB when decoded.

metadataUrlstring[ 0 .. 2048 ] characters^https?:\/\/([A-Za-z0-9]+([\-\.]{1}[A-Za-z0-9...
updatedDatestring(date-time)read-only
attributeMappingsArray of objects(AttributeMapping)[ 0 .. 64 ] items
Response
{
  "name": "string",
  "metadata": "string",
  "metadataUrl": "string",
  "updatedDate": "2019-08-24T14:15:22Z",
  "attributeMappings": [
    { … }
  ]
}

Update Entire SAML Identity Provider Profile

Request

Update the specified entire SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
Body
required
namestring[ 2 .. 32 ] charactersrequired
metadatastring

Base64-encoded content, max 512KB when decoded.

metadataUrlstring[ 0 .. 2048 ] characters^https?:\/\/([A-Za-z0-9]+([\-\.]{1}[A-Za-z0-9...
attributeMappingsArray of objects(AttributeMapping)[ 0 .. 64 ] items
{
  "name": "string",
  "metadata": "string",
  "metadataUrl": "string",
  "attributeMappings": [
    { … }
  ]
}

Responses

OK

Body
requestIdstring
Response
{
  "requestId": "string"
}

Delete SAML Identity Provider Profile

Request

Delete the specified SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
Response
{
  "requestId": "string"
}

Update Partial SAML Identity Provider Profile

Request

Update the specified partial SAML identity provider profile.

Path
samlIdpProfileIdstringrequired
Body
required
actionstring
Value"REFRESH_METADATA"
{
  "action": "REFRESH_METADATA"
}

Responses

OK

Body
requestIdstring
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
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
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
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
Response
{
  "requestId": "string"
}

Create SAML Identity Provider Profile

Request

Create a SAML identity provider profile.

Body
required
namestring[ 2 .. 32 ] charactersrequired
metadatastring

Base64-encoded content, max 512KB when decoded.

metadataUrlstring[ 0 .. 2048 ] characters^https?:\/\/([A-Za-z0-9]+([\-\.]{1}[A-Za-z0-9...
attributeMappingsArray of objects(AttributeMapping)[ 0 .. 64 ] items
{
  "name": "string",
  "metadata": "string",
  "metadataUrl": "string",
  "attributeMappings": [
    { … }
  ]
}

Responses

OK

Body
requestIdstring
responseobject(EntityId)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}