Skip to content
/
Add Authentication

Tenant Management API (v0.3.0)

Ruckus Network Technical Documents

Overview

This document provides information about Tenant management.

Rate Limit

For the Ptenant 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
Languages
Servers
North American region

https://api.ruckus.cloud/

Asian region

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

European region

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

Notification Recipient

Manage notification recipients.

Operations

Tenant

Manage tenants.

Operations

Delegation

Manage delegations.

Operations

User Profile

Manage user profiles.

Operations

Privacy Features

Manage privacy features.

Operations

Administrator

Manage administrators.

Operations

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations

Get Authentications

Request

Get all authentications.

Query
withExtendedRoleboolean
Default false
No request payload

Responses

OK

Body
Array [
idstring
clientIDstring
clientSecretstring
scopesstring
tokenURLstring
authorizationURLstring
authenticationTypestringrequired
Enum"IDM""SAML""OATH2_OIDC""OAUTH2_CLIENT_CREDENTIALS""LDAP""GOOGLE_WORKSPACE"
samlFileURLstring
namestringrequired
clientIDStatusstring
Enum"ACTIVE""REVOKED"
samlFileTypestring
Enum"DIRECT_URL""FILE"
domainsArray of strings
samlSignatureEnabledboolean
samlEncryptionCertificateIdstring
parentTenantIdstring
samlEncryptionPublicCertificatestring
samlEncryptionPrivateKeystring
]
Response
[
  {
    "id": "string",
    "clientID": "string",
    "clientSecret": "string",
    "scopes": "string",
    "tokenURL": "string",
    "authorizationURL": "string",
    "authenticationType": "IDM",
    "samlFileURL": "string",
    "name": "string",
    "clientIDStatus": "ACTIVE",
    "samlFileType": "DIRECT_URL",
    "domains": [ … ],
    "samlSignatureEnabled": true,
    "samlEncryptionCertificateId": "string",
    "parentTenantId": "string",
    "samlEncryptionPublicCertificate": "string",
    "samlEncryptionPrivateKey": "string"
  }
]

Add Authentication

Request

Add authentication.

Body
required
idstring
clientIDstring
clientSecretstring
scopesstring
tokenURLstring
authorizationURLstring
authenticationTypestringrequired
Enum"IDM""SAML""OATH2_OIDC""OAUTH2_CLIENT_CREDENTIALS""LDAP""GOOGLE_WORKSPACE"
samlFileURLstring
namestringrequired
clientIDStatusstring
Enum"ACTIVE""REVOKED"
samlFileTypestring
Enum"DIRECT_URL""FILE"
domainsArray of strings
samlSignatureEnabledboolean
samlEncryptionCertificateIdstring
parentTenantIdstring
samlEncryptionPublicCertificatestring
samlEncryptionPrivateKeystring
{
  "id": "string",
  "clientID": "string",
  "clientSecret": "string",
  "scopes": "string",
  "tokenURL": "string",
  "authorizationURL": "string",
  "authenticationType": "IDM",
  "samlFileURL": "string",
  "name": "string",
  "clientIDStatus": "ACTIVE",
  "samlFileType": "DIRECT_URL",
  "domains": [
    "string"
  ],
  "samlSignatureEnabled": true,
  "samlEncryptionCertificateId": "string",
  "parentTenantId": "string",
  "samlEncryptionPublicCertificate": "string",
  "samlEncryptionPrivateKey": "string"
}

Responses

OK

Body
idstring
clientIDstring
clientSecretstring
scopesstring
tokenURLstring
authorizationURLstring
authenticationTypestringrequired
Enum"IDM""SAML""OATH2_OIDC""OAUTH2_CLIENT_CREDENTIALS""LDAP""GOOGLE_WORKSPACE"
samlFileURLstring
namestringrequired
clientIDStatusstring
Enum"ACTIVE""REVOKED"
samlFileTypestring
Enum"DIRECT_URL""FILE"
domainsArray of strings
samlSignatureEnabledboolean
samlEncryptionCertificateIdstring
parentTenantIdstring
samlEncryptionPublicCertificatestring
samlEncryptionPrivateKeystring
Response
{
  "id": "string",
  "clientID": "string",
  "clientSecret": "string",
  "scopes": "string",
  "tokenURL": "string",
  "authorizationURL": "string",
  "authenticationType": "IDM",
  "samlFileURL": "string",
  "name": "string",
  "clientIDStatus": "ACTIVE",
  "samlFileType": "DIRECT_URL",
  "domains": [
    "string"
  ],
  "samlSignatureEnabled": true,
  "samlEncryptionCertificateId": "string",
  "parentTenantId": "string",
  "samlEncryptionPublicCertificate": "string",
  "samlEncryptionPrivateKey": "string"
}