Tenant Management

GET /admins/{adminId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed property authenticationId (object)
Identifier for the authentication method associated with this administrator.

Changed property detailLevel (object)

Detail level for events.
Enum Meaning
ba Show events appropriate for a basic user.
it Show events appropriate for someone having training as an IT administrator.
su Show events appropriate for a super user.
debug Show events useful for debugging purposes.
.

Changed property email (object)
Email address used as the administrator's login username.
Changed property externalId (object)
External identifier from RUCKUS cloud authentication system.
Changed property id (object)
Unique identifier for the administrator account.
Changed property lastName (object)
Last name of the administrator.
Changed property name (object)
First name of the administrator.
Changed property phoneNumber (object)
Contact phone number for the administrator.
Changed property role (object)
Role assigned to the administrator, such as prime admin, admin, or readonly.

Changed content type : application/vnd.ruckus.v1+json

Changed property authenticationId (object)
Identifier for the authentication method associated with this administrator.

Changed property detailLevel (object)

Detail level for events.
Enum Meaning
ba Show events appropriate for a basic user.
it Show events appropriate for someone having training as an IT administrator.
su Show events appropriate for a super user.
debug Show events useful for debugging purposes.
.

Changed property email (object)
Email address used as the administrator's login username.
Changed property externalId (object)
External identifier from RUCKUS cloud authentication system.
Changed property id (object)
Unique identifier for the administrator account.
Changed property lastName (object)
Last name of the administrator.
Changed property name (object)
First name of the administrator.
Changed property phoneNumber (object)
Contact phone number for the administrator.
Changed property role (object)
Role assigned to the administrator, such as prime admin, admin, or readonly.

DELETE /admins/{adminId}

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

GET /tenants/accounts

Return Type:

Deleted response : 415 Unsupported Media Type

Unsupported Media Type

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property accountName (object)
  Name of the account in the system.
- Changed property accountSapId (object)
  SAP identifier for the account.
- Changed property address (object)
  Street address for the account location.
- Changed property assetSerialNumber (object)
  Serial number of the asset associated with this account.
- Changed property city (object)
  City for the account location.
- Changed property country (object)
  Country for the account location.
- Changed property organization (object)
  Organization or company name for this account.
- Changed property stateOrProvince (object)
  State or province for the account location.
- Changed property userEmail (object)
  Email address of the primary user associated with this account.
- Changed property userFullName (object)
  Full name of the primary user associated with this account.
- Changed property zip (object)
  Postal code or zip code for the account location.

GET /tenants/authentications

POST /tenants/authentications

Request:

Changed content type : application/json

Changed property authenticationType (object)
Type of authentication method (e.g., OAuth, SAML, local).
Changed property authorizationURL (object)
URL for OAuth authorization endpoint.
Changed property clientID (object)
OAuth client identifier used for authentication.
Changed property clientIDStatus (object)
Status of the client ID configuration.
Changed property clientSecret (object)
OAuth client secret for secure authentication.
Changed property domains (object)
List of email domains associated with this authentication configuration.
Changed property name (object)
Name of the authentication configuration.
Changed property parentTenantId (object)
Parent tenant identifier for hierarchical authentication configuration.
Changed property samlEncryptionCertificateId (object)
Identifier for the certificate used for SAML encryption.
Changed property samlEncryptionPrivateKey (object)
Private key content for SAML encryption.
Changed property samlEncryptionPublicCertificate (object)
Public certificate content for SAML encryption.
Changed property samlFileType (object)
Type of SAML file (metadata or certificate).
Changed property samlFileURL (object)
URL to the SAML metadata or configuration file.
Changed property samlSignatureEnabled (object)
Indicates whether SAML signature validation is enabled.
Changed property scopes (object)
OAuth scopes defining the level of access requested.
Changed property tokenURL (object)
URL for obtaining OAuth tokens.

Changed content type : application/vnd.ruckus.v1+json

Changed property authenticationType (object)
Type of authentication method (e.g., OAuth, SAML, local).
Changed property authorizationURL (object)
URL for OAuth authorization endpoint.
Changed property clientID (object)
OAuth client identifier used for authentication.
Changed property clientIDStatus (object)
Status of the client ID configuration.
Changed property clientSecret (object)
OAuth client secret for secure authentication.
Changed property domains (object)
List of email domains associated with this authentication configuration.
Changed property name (object)
Name of the authentication configuration.
Changed property parentTenantId (object)
Parent tenant identifier for hierarchical authentication configuration.
Changed property samlEncryptionCertificateId (object)
Identifier for the certificate used for SAML encryption.
Changed property samlEncryptionPrivateKey (object)
Private key content for SAML encryption.
Changed property samlEncryptionPublicCertificate (object)
Public certificate content for SAML encryption.
Changed property samlFileType (object)
Type of SAML file (metadata or certificate).
Changed property samlFileURL (object)
URL to the SAML metadata or configuration file.
Changed property samlSignatureEnabled (object)
Indicates whether SAML signature validation is enabled.
Changed property scopes (object)
OAuth scopes defining the level of access requested.
Changed property tokenURL (object)
URL for obtaining OAuth tokens.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property authenticationType (object)
  Type of authentication method (e.g., OAuth, SAML, local).
- Changed property authorizationURL (object)
  URL for OAuth authorization endpoint.
- Changed property clientID (object)
  OAuth client identifier used for authentication.
- Changed property clientIDStatus (object)
  Status of the client ID configuration.
- Changed property clientSecret (object)
  OAuth client secret for secure authentication.
- Changed property domains (object)
  List of email domains associated with this authentication configuration.
- Changed property name (object)
  Name of the authentication configuration.
- Changed property parentTenantId (object)
  Parent tenant identifier for hierarchical authentication configuration.
- Changed property samlEncryptionCertificateId (object)
  Identifier for the certificate used for SAML encryption.
- Changed property samlEncryptionPrivateKey (object)
  Private key content for SAML encryption.
- Changed property samlEncryptionPublicCertificate (object)
  Public certificate content for SAML encryption.
- Changed property samlFileType (object)
  Type of SAML file (metadata or certificate).
- Changed property samlFileURL (object)
  URL to the SAML metadata or configuration file.
- Changed property samlSignatureEnabled (object)
  Indicates whether SAML signature validation is enabled.
- Changed property scopes (object)
  OAuth scopes defining the level of access requested.
- Changed property tokenURL (object)
  URL for obtaining OAuth tokens.
Changed content type : application/vnd.ruckus.v1+json
- Changed property authenticationType (object)
  Type of authentication method (e.g., OAuth, SAML, local).
- Changed property authorizationURL (object)
  URL for OAuth authorization endpoint.
- Changed property clientID (object)
  OAuth client identifier used for authentication.
- Changed property clientIDStatus (object)
  Status of the client ID configuration.
- Changed property clientSecret (object)
  OAuth client secret for secure authentication.
- Changed property domains (object)
  List of email domains associated with this authentication configuration.
- Changed property name (object)
  Name of the authentication configuration.
- Changed property parentTenantId (object)
  Parent tenant identifier for hierarchical authentication configuration.
- Changed property samlEncryptionCertificateId (object)
  Identifier for the certificate used for SAML encryption.
- Changed property samlEncryptionPrivateKey (object)
  Private key content for SAML encryption.
- Changed property samlEncryptionPublicCertificate (object)
  Public certificate content for SAML encryption.
- Changed property samlFileType (object)
  Type of SAML file (metadata or certificate).
- Changed property samlFileURL (object)
  URL to the SAML metadata or configuration file.
- Changed property samlSignatureEnabled (object)
  Indicates whether SAML signature validation is enabled.
- Changed property scopes (object)
  OAuth scopes defining the level of access requested.
- Changed property tokenURL (object)
  URL for obtaining OAuth tokens.

GET /tenants/betaFeatures

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property betaFeatures (object)
  List of beta features with their enabled status.
- Changed property errorMessage (object)
  Error message if the beta feature operation failed.
- Changed property invalidFeatureIds (object)
  List of feature identifiers that were invalid or not found.

PUT /tenants/betaFeatures

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Changed property betaFeatureIds (object)
Set of beta feature identifiers to configure.

Return Type:

Changed response : 200 OK

OK

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property betaFeatures (object)
  List of beta features with their enabled status.
- Changed property errorMessage (object)
  Error message if the beta feature operation failed.
- Changed property invalidFeatureIds (object)
  List of feature identifiers that were invalid or not found.

GET /tenants/privacySettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
Changed content type : application/vnd.ruckus.v1+json

POST /tenants/privacySettings

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Return Type:

Deleted response : 415 Unsupported Media Type

Unsupported Media Type

Changed response : 200 OK

OK

Changed content type : application/json
Changed content type : application/vnd.ruckus.v1+json

PATCH /tenants/privacySettings

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Return Type:

Deleted response : 415 Unsupported Media Type

Unsupported Media Type

Changed response : 200 OK

OK

Changed content type : application/json
Changed content type : application/vnd.ruckus.v1+json

POST /admins/query

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Changed property filters (object)
Additional filter criteria as key value pairs for refined searching.
Changed property page (object)
Page number for pagination starting from 0.
Changed property pageSize (object)
Number of records per page for pagination.
Changed property searchString (object)
Search text string to match against target fields.
Changed property searchTargetFields (object)
List of fields to search within when filtering administrators.
Changed property sortField (object)
Field by which to sort the administrator results.
Changed property sortOrder (object)
Sort order direction (ascending or descending).

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.
Changed content type : application/vnd.ruckus.v1+json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.

GET /tenants/delegations

POST /tenants/delegations

Request:

Changed content type : application/json

Changed property username (object)
Username or email address of the VAR to invite.

Changed content type : application/vnd.ruckus.v1+json

Changed property username (object)
Username or email address of the VAR to invite.

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

Changed response : 400 Bad Request

Bad/Malformed Request

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

GET /tenants/delegations/{delegationId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property createdDate (object)
  Timestamp when this entity was created.
- Changed property delegatedBy (object)
  Username of the administrator who initiated the delegation.
- Changed property delegatedTo (object)
  Identifier of the tenant receiving the delegation.
- Changed property delegatedToAdmin (object)
  Email address of the administrator at the delegated organization.
- Changed property delegatedToName (object)
  Name of the tenant or organization receiving the delegation.
- Changed property expiryDate (object)
  Expiration date for time limited delegations such as support access.
- Changed property isValid (object)
  Indicates whether the delegation is currently valid and not expired.
- Changed property parentId (object)
  Identifier of the parent entity in the hierarchy.
- Changed property updatedDate (object)
  Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property createdDate (object)
  Timestamp when this entity was created.
- Changed property delegatedBy (object)
  Username of the administrator who initiated the delegation.
- Changed property delegatedTo (object)
  Identifier of the tenant receiving the delegation.
- Changed property delegatedToAdmin (object)
  Email address of the administrator at the delegated organization.
- Changed property delegatedToName (object)
  Name of the tenant or organization receiving the delegation.
- Changed property expiryDate (object)
  Expiration date for time limited delegations such as support access.
- Changed property isValid (object)
  Indicates whether the delegation is currently valid and not expired.
- Changed property parentId (object)
  Identifier of the parent entity in the hierarchy.
- Changed property updatedDate (object)
  Timestamp when this entity was last updated.

DELETE /tenants/delegations/{delegationId}

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

PUT /tenants/delegations/{delegationId}

Request:

Changed content type : application/json

Changed property accept (object)
Indicates whether to accept or reject the delegation request.
Changed property fromTenantId (object)
Identifier of the tenant requesting the delegation.

Changed content type : application/vnd.ruckus.v1+json

Changed property accept (object)
Indicates whether to accept or reject the delegation request.
Changed property fromTenantId (object)
Identifier of the tenant requesting the delegation.

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

POST /tenants/mobilePushNotifications

Request:

Changed content type : application/json
Changed content type : application/vnd.ruckus.v1+json

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Mobile push notification endpoint for delivering alerts to mobile devices.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Mobile push notification endpoint for delivering alerts to mobile devices.

DELETE /tenants/notificationRecipients

Return Type:

New response : 400 Bad Request

Indicates that a bad request was made.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

POST /tenants/notificationRecipients

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Changed property emailPreferences (object)
Indicates whether email notifications are enabled for this recipient.
Changed property endpoints (object)
List of notification endpoints configured for this recipient.
Changed property privilegeGroupId (object)
Identifier of the privilege group associated with this notification recipient.
Changed property recipientType (object)
Type of notification recipient such as privilege group or global.
Changed property smsPreferences (object)
Indicates whether SMS notifications are enabled for this recipient.

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Notification recipient configuration with role based access control privilege group association.
  - Changed property emailPreferences (object)
    Indicates whether email notifications are enabled for this recipient.
  - Changed property endpoints (object)
    List of notification endpoints configured for this recipient.
  - Changed property privilegeGroupId (object)
    Identifier of the privilege group associated with this notification recipient.
  - Changed property recipientType (object)
    Type of notification recipient such as privilege group or global.
  - Changed property smsPreferences (object)
    Indicates whether SMS notifications are enabled for this recipient.

Changed response : 400 Bad Request

Bad/Malformed Request

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Notification recipient configuration with role based access control privilege group association.
  - Changed property emailPreferences (object)
    Indicates whether email notifications are enabled for this recipient.
  - Changed property endpoints (object)
    List of notification endpoints configured for this recipient.
  - Changed property privilegeGroupId (object)
    Identifier of the privilege group associated with this notification recipient.
  - Changed property recipientType (object)
    Type of notification recipient such as privilege group or global.
  - Changed property smsPreferences (object)
    Indicates whether SMS notifications are enabled for this recipient.

Changed response : 500 Internal Server Error

Internal Server Error

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Notification recipient configuration with role based access control privilege group association.
  - Changed property emailPreferences (object)
    Indicates whether email notifications are enabled for this recipient.
  - Changed property endpoints (object)
    List of notification endpoints configured for this recipient.
  - Changed property privilegeGroupId (object)
    Identifier of the privilege group associated with this notification recipient.
  - Changed property recipientType (object)
    Type of notification recipient such as privilege group or global.
  - Changed property smsPreferences (object)
    Indicates whether SMS notifications are enabled for this recipient.

POST /tenants/notifications/recipients/query

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

Changed property filters (object)
Additional filter criteria as key value pairs for refined searching.
Changed property pageSize (object)
Number of records per page for pagination.
Changed property searchString (object)
Search text string to match against target fields.
Changed property searchTargetFields (object)
List of fields to search within when filtering notification recipients.
Changed property sortField (object)
Field by which to sort the notification recipient results.
Changed property sortOrder (object)
Sort order direction (ascending or descending).

Return Type:

Deleted response : 415 Unsupported Media Type

Unsupported Media Type

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.
Changed content type : application/vnd.ruckus.v1+json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.

Changed response : 400 Bad Request

Bad/Malformed Request

Changed content type : application/json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.
Changed content type : application/vnd.ruckus.v1+json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.
Changed content type : application/vnd.ruckus.v1+json
- Changed property content (object)
  List of items in the current page.
- Changed property empty (object)
  Indicates whether the page has no content.
- Changed property first (object)
  Indicates whether this is the first page.
- Changed property last (object)
  Indicates whether this is the last page.
- Changed property number (object)
  Current page number starting from 0.
- Changed property numberOfElements (object)
  Number of elements in the current page.
- Changed property totalElements (object)
  Total number of elements across all pages.
- Changed property totalPages (object)
  Total number of pages available.
- Changed property pageable (object)
  Pagination request parameters including page number, size, and sorting.
  - Changed property pageNumber (object)
    Requested page number starting from 0.
  - Changed property pageSize (object)
    Number of items per page.
  - Changed property paged (object)
    Indicates whether pagination is enabled.
  - Changed property unpaged (object)
    Indicates whether pagination is disabled.
- Changed property sort (object)
  Sort order configuration for paginated results.
  - Changed property empty (object)
    Indicates whether no sort parameters are defined.
  - Changed property sorted (object)
    Indicates whether sorting is applied.
  - Changed property unsorted (object)
    Indicates whether no sorting is applied.

PUT /tenants/self

Request:

Changed content type : application/json

Changed property enableAlpha (object)
Indicates whether alpha features are enabled for this tenant.
Changed property enableBeta (object)
Indicates whether beta features are enabled for this tenant.
Changed property enableMfa (object)
Indicates whether multifactor authentication is enabled for the tenant.
Changed property enableSa (object)
Indicates whether service account functionality is enabled.
Changed property entitlementId (object)
Entitlement identifier for license and subscription management.
Changed property missingAdminIds (object)
List of administrator IDs that were not found during the operation.
Changed property newIdmId (object)
New identity management identifier for the tenant.
Changed property requestId (object)
Unique identifier for tracking this API request.
Changed property response (object)
Response message or status from the operation.
Changed property subscribes (object)
Notification subscription preferences for the tenant.
Changed property tenantName (object)
Name of the tenant or organization.
Changed property userName (object)
Username of the person performing the operation.
Changed property var (object)
Indicates whether this tenant is a value added reseller.

Changed content type : application/vnd.ruckus.v1+json

Changed property enableAlpha (object)
Indicates whether alpha features are enabled for this tenant.
Changed property enableBeta (object)
Indicates whether beta features are enabled for this tenant.
Changed property enableMfa (object)
Indicates whether multifactor authentication is enabled for the tenant.
Changed property enableSa (object)
Indicates whether service account functionality is enabled.
Changed property entitlementId (object)
Entitlement identifier for license and subscription management.
Changed property missingAdminIds (object)
List of administrator IDs that were not found during the operation.
Changed property newIdmId (object)
New identity management identifier for the tenant.
Changed property requestId (object)
Unique identifier for tracking this API request.
Changed property response (object)
Response message or status from the operation.
Changed property subscribes (object)
Notification subscription preferences for the tenant.
Changed property tenantName (object)
Name of the tenant or organization.
Changed property userName (object)
Username of the person performing the operation.
Changed property var (object)
Indicates whether this tenant is a value added reseller.

Return Type:

Deleted response : 415 Unsupported Media Type

Unsupported Media Type

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.

GET /tenants/self

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json

Changed property accountTier (object)
Service tier level for this tenant account (e.g., bronze, silver, gold, premium).
Changed property accountVertical (object)
Industry vertical or business category for this tenant account.
Changed property admins (object)
List of administrators who have access to manage this tenant.
Changed property aggregateNotifications (object)
Indicates whether notification aggregation is enabled for this tenant.
Changed property almActivated (object)
Indicates whether this tenant is activated in the analytic and logging module.
Changed property almActivationDate (object)
Date when analytic and logging module was activated for this tenant.
Changed property almMigrationDate (object)
Date when analytic and logging module migration was performed.
Changed property almMigrationFlag (object)
Indicates whether this tenant has been migrated from analytic and logging module.
Changed property almSysAccountId (object)
System account identifier for analytic and logging module.
Changed property authentications (object)
List of authentication configurations available for this tenant.
Changed property createdDate (object)
Timestamp when this entity was created.
Changed property delegationsTo (object)
List of delegation relationships where this tenant is the recipient.
Changed property entitlementId (object)
Entitlement identifier for license and subscription management.
Changed property excludeecforAggregation (object)
Indicates whether end customers are excluded from notification aggregation.
Changed property expirationEnforcement (object)
Indicates whether license expiration enforcement is enabled for this tenant.
Changed property expirationEnforcementDate (object)
Date when license expiration enforcement becomes effective.
Changed property extendedTrial (object)
Indicates whether this tenant has an extended trial period.
Changed property externalId (object)
External identifier for this tenant from the source system.
Changed property externalModifiedDate (object)
Date when the tenant record was last modified in the external system.
Changed property inMaintenance (object)
Indicates whether this tenant is currently in maintenance mode.
Changed property isActivated (object)
Indicates whether this tenant is activated and operational.
Changed property maintenanceDate (object)
Date when maintenance mode was last activated.
Changed property maintenanceState (object)
Indicates whether the tenant is in maintenance mode.
Changed property mspPingOrgId (object)
Ping identity organization identifier for this managed service provider.
Changed property name (object)
Display name of the tenant or organization.
Changed property notificationRecipients (object)
List of notification recipients configured for this tenant.
Changed property oemName (object)
Original equipment manufacturer name if this tenant is OEM branded.
Changed property parentId (object)
Identifier of the parent entity in the hierarchy.
Changed property pingMigrated (object)
Indicates whether this tenant has been migrated to ping identity.
Changed property preferences (object)
User preferences and settings stored in JSON format.
Changed property propertyCode (object)
Property code for hospitality or venue based tenants.
Changed property ruckusUser (object)
Indicates whether this is a RUCKUS internal user tenant.
Changed property serviceAccount (object)
Indicates whether this is a service account tenant.

Changed property status (object)

Tenant status.
Enum Meaning
active The account is active.
suspended The account has been administratively suspended for an indefinite period of time; while in this state, login are disabled.
maintenance The account is temporarily undergoing maintenance; while in this state, login are disabled.
deleted The account has been deleted; although a record of the account exists, all other Network management configuration and data has been deleted.

Changed property subscribes (object)
Notification subscription preferences configured for this tenant.

Changed property tenantType (object)

Tenant type.
Enum Meaning
REC RUCKUS end customer.
VAR Value added reseller.
MSP Managed service provider.
MSP_EC MSP's end customer.
MSP_NON_VAR This value is reserved for RUCKUS purposes.
MSP_INSTALLER Installer organization which administratively reports to an MSP.
MSP_INTEGRATOR Installer organization which administratively reports to an MSP.
UNKNOWN Unknown.
.

Changed property updatedDate (object)
Timestamp when this entity was last updated.
Changed property upgradeGroup (object)
Deprecated upgrade group identifier for tenant grouping.
Changed property MspEcServiceDates (object)
Managed service provider end customer service dates and relationships.
- Changed property parentMspId (object)
  Identifier of the parent managed service provider tenant.
- Changed property serviceEffectiveDate (object)
  Date when the service contract becomes effective for this end customer.
- Changed property serviceExpirationDate (object)
  Date when the service contract expires for this end customer.
Changed property account (object)
Account information including address and contact details for a tenant.
- Changed property city (object)
  City for the account location.
- Changed property country (object)
  Country for the account location.
- Changed property createdDate (object)
  Timestamp when this entity was created.
- Changed property faxNumber (object)
  Fax number for the account.
- Changed property latitude (object)
  Latitude coordinate for the account's geographic location.
- Changed property longitude (object)
  Longitude coordinate for the account's geographic location.
- Changed property mappingURL (object)
  URL for mapping/location services associated with this account.
- Changed property parentId (object)
  Identifier of the parent entity in the hierarchy.
- Changed property phoneNumber (object)
  Primary contact phone number for the account.
- Changed property postalCode (object)
  Postal code or zip code for the account location.
- Changed property state (object)
  State or province for the account location.
- Changed property streetAddress (object)
  Street address for the account location.
- Changed property updatedDate (object)
  Timestamp when this entity was last updated.
Changed property msp (object)
Managed service provider configuration including branding and support settings.
- Changed property alarmNotificationLogoUUID (object)
  Unique identifier for the alarm notification logo.
- Changed property changePasswordUrl (object)
  URL for changing the user password.
- Changed property contactSupportUrl (object)
  URL for contacting customer support.
- Changed property contractSupportBehavior (object)
  Behavior setting for the contact support link.
- Changed property defaultLogoUUID (object)
  Unique identifier for the default logo used when specific logos are not set.
- Changed property email (object)
  Contact email address for the managed service provider.
- Changed property isDisableNotification (object)
  Indicates whether notifications are disabled for this managed service provider.
- Changed property logoUUID (object)
  Unique identifier for the logo image stored in file services.
- Changed property mlisaLogoUUID (object)
  Unique identifier for the machine learning inspection and service assurance logo.
- Changed property mspFQDN (object)
  Fully qualified domain name for the managed service provider portal.
- Changed property mspLabel (object)
  Display label for the managed service provider.
- Changed property myOpenCaseBehavior (object)
  Behavior setting for the my open cases link.
- Changed property myOpenCaseUrl (object)
  URL for viewing existing open support cases.
- Changed property openCaseBehavior (object)
  Behavior setting for the open case link.
- Changed property openCaseUrl (object)
  URL for opening a new support case.
- Changed property phone (object)
  Contact phone number for the managed service provider.
- Changed property pingLoginLogoUUID (object)
  Unique identifier for the ping login page logo.
- Changed property pingNotificationLogoUUID (object)
  Unique identifier for the ping notification logo.
- Changed property website (object)
  Website URL for the managed service provider.
Changed property tenantMFA (object)
Multifactor authentication configuration and recovery codes for a tenant.
- Changed property mfaStatus (object)
  Flag indicating whether multifactor authentication is active.
- Changed property recoveryCodes (object)
  Encrypted recovery codes for multifactor authentication backup access.

Changed content type : application/vnd.ruckus.v1+json

Changed property accountTier (object)
Service tier level for this tenant account (e.g., bronze, silver, gold, premium).
Changed property accountVertical (object)
Industry vertical or business category for this tenant account.
Changed property admins (object)
List of administrators who have access to manage this tenant.
Changed property aggregateNotifications (object)
Indicates whether notification aggregation is enabled for this tenant.
Changed property almActivated (object)
Indicates whether this tenant is activated in the analytic and logging module.
Changed property almActivationDate (object)
Date when analytic and logging module was activated for this tenant.
Changed property almMigrationDate (object)
Date when analytic and logging module migration was performed.
Changed property almMigrationFlag (object)
Indicates whether this tenant has been migrated from analytic and logging module.
Changed property almSysAccountId (object)
System account identifier for analytic and logging module.
Changed property authentications (object)
List of authentication configurations available for this tenant.
Changed property createdDate (object)
Timestamp when this entity was created.
Changed property delegationsTo (object)
List of delegation relationships where this tenant is the recipient.
Changed property entitlementId (object)
Entitlement identifier for license and subscription management.
Changed property excludeecforAggregation (object)
Indicates whether end customers are excluded from notification aggregation.
Changed property expirationEnforcement (object)
Indicates whether license expiration enforcement is enabled for this tenant.
Changed property expirationEnforcementDate (object)
Date when license expiration enforcement becomes effective.
Changed property extendedTrial (object)
Indicates whether this tenant has an extended trial period.
Changed property externalId (object)
External identifier for this tenant from the source system.
Changed property externalModifiedDate (object)
Date when the tenant record was last modified in the external system.
Changed property inMaintenance (object)
Indicates whether this tenant is currently in maintenance mode.
Changed property isActivated (object)
Indicates whether this tenant is activated and operational.
Changed property maintenanceDate (object)
Date when maintenance mode was last activated.
Changed property maintenanceState (object)
Indicates whether the tenant is in maintenance mode.
Changed property mspPingOrgId (object)
Ping identity organization identifier for this managed service provider.
Changed property name (object)
Display name of the tenant or organization.
Changed property notificationRecipients (object)
List of notification recipients configured for this tenant.
Changed property oemName (object)
Original equipment manufacturer name if this tenant is OEM branded.
Changed property parentId (object)
Identifier of the parent entity in the hierarchy.
Changed property pingMigrated (object)
Indicates whether this tenant has been migrated to ping identity.
Changed property preferences (object)
User preferences and settings stored in JSON format.
Changed property propertyCode (object)
Property code for hospitality or venue based tenants.
Changed property ruckusUser (object)
Indicates whether this is a RUCKUS internal user tenant.
Changed property serviceAccount (object)
Indicates whether this is a service account tenant.

Changed property status (object)

Tenant status.
Enum Meaning
active The account is active.
suspended The account has been administratively suspended for an indefinite period of time; while in this state, login are disabled.
maintenance The account is temporarily undergoing maintenance; while in this state, login are disabled.
deleted The account has been deleted; although a record of the account exists, all other Network management configuration and data has been deleted.

Changed property subscribes (object)
Notification subscription preferences configured for this tenant.

Changed property tenantType (object)

Tenant type.
Enum Meaning
REC RUCKUS end customer.
VAR Value added reseller.
MSP Managed service provider.
MSP_EC MSP's end customer.
MSP_NON_VAR This value is reserved for RUCKUS purposes.
MSP_INSTALLER Installer organization which administratively reports to an MSP.
MSP_INTEGRATOR Installer organization which administratively reports to an MSP.
UNKNOWN Unknown.
.

Changed property updatedDate (object)
Timestamp when this entity was last updated.
Changed property upgradeGroup (object)
Deprecated upgrade group identifier for tenant grouping.
Changed property MspEcServiceDates (object)
Managed service provider end customer service dates and relationships.
- Changed property parentMspId (object)
  Identifier of the parent managed service provider tenant.
- Changed property serviceEffectiveDate (object)
  Date when the service contract becomes effective for this end customer.
- Changed property serviceExpirationDate (object)
  Date when the service contract expires for this end customer.
Changed property account (object)
Account information including address and contact details for a tenant.
- Changed property city (object)
  City for the account location.
- Changed property country (object)
  Country for the account location.
- Changed property createdDate (object)
  Timestamp when this entity was created.
- Changed property faxNumber (object)
  Fax number for the account.
- Changed property latitude (object)
  Latitude coordinate for the account's geographic location.
- Changed property longitude (object)
  Longitude coordinate for the account's geographic location.
- Changed property mappingURL (object)
  URL for mapping/location services associated with this account.
- Changed property parentId (object)
  Identifier of the parent entity in the hierarchy.
- Changed property phoneNumber (object)
  Primary contact phone number for the account.
- Changed property postalCode (object)
  Postal code or zip code for the account location.
- Changed property state (object)
  State or province for the account location.
- Changed property streetAddress (object)
  Street address for the account location.
- Changed property updatedDate (object)
  Timestamp when this entity was last updated.
Changed property msp (object)
Managed service provider configuration including branding and support settings.
- Changed property alarmNotificationLogoUUID (object)
  Unique identifier for the alarm notification logo.
- Changed property changePasswordUrl (object)
  URL for changing the user password.
- Changed property contactSupportUrl (object)
  URL for contacting customer support.
- Changed property contractSupportBehavior (object)
  Behavior setting for the contact support link.
- Changed property defaultLogoUUID (object)
  Unique identifier for the default logo used when specific logos are not set.
- Changed property email (object)
  Contact email address for the managed service provider.
- Changed property isDisableNotification (object)
  Indicates whether notifications are disabled for this managed service provider.
- Changed property logoUUID (object)
  Unique identifier for the logo image stored in file services.
- Changed property mlisaLogoUUID (object)
  Unique identifier for the machine learning inspection and service assurance logo.
- Changed property mspFQDN (object)
  Fully qualified domain name for the managed service provider portal.
- Changed property mspLabel (object)
  Display label for the managed service provider.
- Changed property myOpenCaseBehavior (object)
  Behavior setting for the my open cases link.
- Changed property myOpenCaseUrl (object)
  URL for viewing existing open support cases.
- Changed property openCaseBehavior (object)
  Behavior setting for the open case link.
- Changed property openCaseUrl (object)
  URL for opening a new support case.
- Changed property phone (object)
  Contact phone number for the managed service provider.
- Changed property pingLoginLogoUUID (object)
  Unique identifier for the ping login page logo.
- Changed property pingNotificationLogoUUID (object)
  Unique identifier for the ping notification logo.
- Changed property website (object)
  Website URL for the managed service provider.
Changed property tenantMFA (object)
Multifactor authentication configuration and recovery codes for a tenant.
- Changed property mfaStatus (object)
  Flag indicating whether multifactor authentication is active.
- Changed property recoveryCodes (object)
  Encrypted recovery codes for multifactor authentication backup access.

DELETE /tenants/supportDelegations

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

Changed response : 500 Internal Server Error

Internal Server Error

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

POST /tenants/supportDelegations

Return Type:

Changed response : 202 Accepted

Accepted

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

Changed response : 500 Internal Server Error

Internal Server Error

New content type : application/vnd.ruckus.v1+json
Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Delegation relationship defining permissions granted from one tenant to another.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property delegatedBy (object)
    Username of the administrator who initiated the delegation.
  - Changed property delegatedTo (object)
    Identifier of the tenant receiving the delegation.
  - Changed property delegatedToAdmin (object)
    Email address of the administrator at the delegated organization.
  - Changed property delegatedToName (object)
    Name of the tenant or organization receiving the delegation.
  - Changed property expiryDate (object)
    Expiration date for time limited delegations such as support access.
  - Changed property isValid (object)
    Indicates whether the delegation is currently valid and not expired.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.

DELETE /admins

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Response payload containing the requested data or operation result.

PUT /admins

Request:

Changed content type : application/json

Changed property authenticationId (object)
Identifier for the authentication method associated with this administrator.

Changed property detailLevel (object)

Detail level for events.
Enum Meaning
ba Show events appropriate for a basic user.
it Show events appropriate for someone having training as an IT administrator.
su Show events appropriate for a super user.
debug Show events useful for debugging purposes.
.

Changed property email (object)
Email address used as the administrator's login username.
Changed property externalId (object)
External identifier from RUCKUS cloud authentication system.
Changed property id (object)
Unique identifier for the administrator account.
Changed property lastName (object)
Last name of the administrator.
Changed property name (object)
First name of the administrator.
Changed property phoneNumber (object)
Contact phone number for the administrator.
Changed property role (object)
Role assigned to the administrator, such as prime admin, admin, or readonly.

Changed content type : application/vnd.ruckus.v1+json

Changed property authenticationId (object)
Identifier for the authentication method associated with this administrator.

Changed property detailLevel (object)

Detail level for events.
Enum Meaning
ba Show events appropriate for a basic user.
it Show events appropriate for someone having training as an IT administrator.
su Show events appropriate for a super user.
debug Show events useful for debugging purposes.
.

Changed property email (object)
Email address used as the administrator's login username.
Changed property externalId (object)
External identifier from RUCKUS cloud authentication system.
Changed property id (object)
Unique identifier for the administrator account.
Changed property lastName (object)
Last name of the administrator.
Changed property name (object)
First name of the administrator.
Changed property phoneNumber (object)
Contact phone number for the administrator.
Changed property role (object)
Role assigned to the administrator, such as prime admin, admin, or readonly.

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.

POST /admins

Request:

Changed content type : application/json

Changed property authenticationId (object)
Identifier for the authentication method associated with this administrator.

Changed property detailLevel (object)

Detail level for events.
Enum Meaning
ba Show events appropriate for a basic user.
it Show events appropriate for someone having training as an IT administrator.
su Show events appropriate for a super user.
debug Show events useful for debugging purposes.
.

Changed property email (object)
Email address used as the administrator's login username.
Changed property externalId (object)
External identifier from RUCKUS cloud authentication system.
Changed property id (object)
Unique identifier for the administrator account.
Changed property lastName (object)
Last name of the administrator.
Changed property name (object)
First name of the administrator.
Changed property phoneNumber (object)
Contact phone number for the administrator.
Changed property role (object)
Role assigned to the administrator, such as prime admin, admin, or readonly.

Changed content type : application/vnd.ruckus.v1+json

Changed property authenticationId (object)
Identifier for the authentication method associated with this administrator.

Changed property detailLevel (object)

Detail level for events.
Enum Meaning
ba Show events appropriate for a basic user.
it Show events appropriate for someone having training as an IT administrator.
su Show events appropriate for a super user.
debug Show events useful for debugging purposes.
.

Changed property email (object)
Email address used as the administrator's login username.
Changed property externalId (object)
External identifier from RUCKUS cloud authentication system.
Changed property id (object)
Unique identifier for the administrator account.
Changed property lastName (object)
Last name of the administrator.
Changed property name (object)
First name of the administrator.
Changed property phoneNumber (object)
Contact phone number for the administrator.
Changed property role (object)
Role assigned to the administrator, such as prime admin, admin, or readonly.

Return Type:

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.

Changed response : 400 Bad Request

Bad/Malformed Request

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  Administrator entity with authentication, roles, and tenant association information.
  - Changed property adminAppSettings (object)
    Application specific settings for this administrator.
  - Changed property adminRoles (object)
    List of roles assigned to this administrator.
  - Changed property createdDate (object)
    Timestamp when this entity was created.
  - Changed property dateFormat (object)
    Date format preference for display in the user interface and notifications.
  - Changed property defaultTenant (object)
    Default tenant identifier for this administrator when multiple tenants are accessible.
  - Changed property detailLevel (object)
    Detail level for events displayed to the administrator.
  - Changed property externalId (object)
    External identifier from RUCKUS cloud authentication system.
  - Changed property firstName (object)
    First name of the administrator.
  - Changed property lastName (object)
    Last name of the administrator.
  - Changed property parentId (object)
    Identifier of the parent entity in the hierarchy.
  - Changed property phoneNumber (object)
    Contact phone number for the administrator.
  - Changed property updatedDate (object)
    Timestamp when this entity was last updated.
  - Changed property username (object)
    Username used for administrator login, typically an email address.
  - Changed property authentication (object)
    Authentication configuration including OAuth, SAML, and other authentication method details.
    - Changed property accountBased (object)
      Indicates whether authentication is account based or user based.
    - Changed property authDomains (object)
      List of authentication domains associated with this configuration.
    - Changed property authScopes (object)
      List of authentication scopes with privilege group mappings.
    - Changed property authenticationType (object)
      Type of authentication method (e.g., OAuth, SAML, local).
    - Changed property authorizationURL (object)
      URL for OAuth authorization endpoint.
    - Changed property clientID (object)
      OAuth client identifier used for authentication.
    - Changed property clientIDStatus (object)
      Status of the client ID configuration.
    - Changed property clientSecret (object)
      OAuth client secret for secure authentication.
    - Changed property createdDate (object)
      Timestamp when this entity was created.
    - Changed property name (object)
      Name of the authentication configuration.
    - Changed property parentId (object)
      Identifier of the parent entity in the hierarchy.
    - Changed property samlEncryptionCertificateId (object)
      Identifier for the certificate used for SAML encryption.
    - Changed property samlFileType (object)
      Type of SAML file (metadata or certificate).
    - Changed property samlFileURL (object)
      URL to the SAML metadata or configuration file.
    - Changed property samlSignatureEnabled (object)
      Indicates whether SAML signature validation is enabled.
    - Changed property scopes (object)
      Space separated list of privilege group names for access control mapping.
    - Changed property tokenURL (object)
      URL for obtaining OAuth tokens.
    - Changed property updatedDate (object)
      Timestamp when this entity was last updated.

GET /tenants/userProfiles

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property adminId (object)
  Administrator identifier unique to this administrator account.
- Changed property alphaStatus (object)
  Alpha feature access status for the administrator.
- Changed property companyName (object)
  Company name associated with the administrator's account.
- Changed property customRoleName (object)
  Custom role name assigned to the administrator.
- Changed property customRoleType (object)
  Custom role type defining the administrator's permissions.
- Changed property dateFormat (object)
  Date format preference for displaying dates in the user interface.
- Changed property detailLevel (object)
  Detail level for event log information displayed to the administrator.
- Changed property dogfood (object)
  Flag indicating whether this is a RUCKUS internal dog food account.
- Changed property edgeBeta (object)
  Edge beta feature access level for the administrator.
- Changed property email (object)
  Email address of the administrator user.
- Changed property externalId (object)
  External identifier for the user from the identity management system.
- Changed property firstName (object)
  First name of the administrator user.
- Changed property lastName (object)
  Last name of the administrator user.
- Changed property newDateFormat (object)
  New date format string for customizing date display.
- Changed property phoneNumber (object)
  Phone number associated with the administrator account.
- Changed property preferredLanguage (object)
  Preferred language code for the user interface display.
- Changed property privilegeGroupName (object)
  Privilege group name defining the administrator's access level.
- Changed property privilegeGroupType (object)
  Privilege group type categorizing the administrator's permissions.
- Changed property pver (object)
  Protocol version for API compatibility.
- Changed property region (object)
  Current geographic region for the user's API access.
- Changed property role (object)
  Deprecated administrator role name for backward compatibility.
- Changed property roles (object)
  Set of role names assigned to the administrator.
- Changed property scopes (object)
  Set of permission scopes granted to the administrator.
- Changed property support (object)
  Flag indicating whether this is a RUCKUS support account.
- Changed property tenantId (object)
  Tenant identifier for the administrator's primary tenant.
- Changed property username (object)
  Username for the administrator account login.
- Changed property var (object)
  Flag indicating whether the tenant is a value added reseller.
- Changed property varTenantId (object)
  Value added reseller tenant identifier if applicable.
- Changed property preferredNotifications (object)
  User preferences for notification delivery methods.
  - Changed property emailPreferences (object)
    User preference for receiving email notifications.
  - Changed property smsPreferences (object)
    User preference for receiving SMS text message notifications.
Changed content type : application/vnd.ruckus.v1+json
- Changed property adminId (object)
  Administrator identifier unique to this administrator account.
- Changed property alphaStatus (object)
  Alpha feature access status for the administrator.
- Changed property companyName (object)
  Company name associated with the administrator's account.
- Changed property customRoleName (object)
  Custom role name assigned to the administrator.
- Changed property customRoleType (object)
  Custom role type defining the administrator's permissions.
- Changed property dateFormat (object)
  Date format preference for displaying dates in the user interface.
- Changed property detailLevel (object)
  Detail level for event log information displayed to the administrator.
- Changed property dogfood (object)
  Flag indicating whether this is a RUCKUS internal dog food account.
- Changed property edgeBeta (object)
  Edge beta feature access level for the administrator.
- Changed property email (object)
  Email address of the administrator user.
- Changed property externalId (object)
  External identifier for the user from the identity management system.
- Changed property firstName (object)
  First name of the administrator user.
- Changed property lastName (object)
  Last name of the administrator user.
- Changed property newDateFormat (object)
  New date format string for customizing date display.
- Changed property phoneNumber (object)
  Phone number associated with the administrator account.
- Changed property preferredLanguage (object)
  Preferred language code for the user interface display.
- Changed property privilegeGroupName (object)
  Privilege group name defining the administrator's access level.
- Changed property privilegeGroupType (object)
  Privilege group type categorizing the administrator's permissions.
- Changed property pver (object)
  Protocol version for API compatibility.
- Changed property region (object)
  Current geographic region for the user's API access.
- Changed property role (object)
  Deprecated administrator role name for backward compatibility.
- Changed property roles (object)
  Set of role names assigned to the administrator.
- Changed property scopes (object)
  Set of permission scopes granted to the administrator.
- Changed property support (object)
  Flag indicating whether this is a RUCKUS support account.
- Changed property tenantId (object)
  Tenant identifier for the administrator's primary tenant.
- Changed property username (object)
  Username for the administrator account login.
- Changed property var (object)
  Flag indicating whether the tenant is a value added reseller.
- Changed property varTenantId (object)
  Value added reseller tenant identifier if applicable.
- Changed property preferredNotifications (object)
  User preferences for notification delivery methods.
  - Changed property emailPreferences (object)
    User preference for receiving email notifications.
  - Changed property smsPreferences (object)
    User preference for receiving SMS text message notifications.

PUT /tenants/userProfiles

Request:

Changed content type : application/json

Changed property adminId (object)
Administrator identifier unique to this administrator account.
Changed property alphaStatus (object)
Alpha feature access status for the administrator.
Changed property companyName (object)
Company name associated with the administrator's account.
Changed property customRoleName (object)
Custom role name assigned to the administrator.
Changed property customRoleType (object)
Custom role type defining the administrator's permissions.
Changed property dateFormat (object)
Date format preference for displaying dates in the user interface.
Changed property detailLevel (object)
Detail level for event log information displayed to the administrator.
Changed property edgeBeta (object)
Edge beta feature access level for the administrator.
Changed property email (object)
Email address of the administrator user.
Changed property externalId (object)
External identifier for the user from the identity management system.
Changed property firstName (object)
First name of the administrator user.
Changed property lastName (object)
Last name of the administrator user.
Changed property newDateFormat (object)
New date format string for customizing date display.
Changed property phoneNumber (object)
Phone number associated with the administrator account.
Changed property preferredLanguage (object)
Preferred language code for the user interface display.
Changed property privilegeGroupName (object)
Privilege group name defining the administrator's access level.
Changed property privilegeGroupType (object)
Privilege group type categorizing the administrator's permissions.
Changed property region (object)
Current geographic region for the user's API access.
Changed property role (object)
Deprecated administrator role name for backward compatibility.
Changed property roles (object)
Set of role names assigned to the administrator.
Changed property scopes (object)
Set of permission scopes granted to the administrator.
Changed property tenantId (object)
Tenant identifier for the administrator's primary tenant.
Changed property username (object)
Username for the administrator account login.
Changed property var (object)
Flag indicating whether the tenant is a value added reseller.
Changed property varTenantId (object)
Value added reseller tenant identifier if applicable.
Changed property preferredNotifications (object)
User preferences for notification delivery methods.
- Changed property emailPreferences (object)
  User preference for receiving email notifications.
- Changed property smsPreferences (object)
  User preference for receiving SMS text message notifications.

Changed content type : application/vnd.ruckus.v1+json

Changed property adminId (object)
Administrator identifier unique to this administrator account.
Changed property alphaStatus (object)
Alpha feature access status for the administrator.
Changed property companyName (object)
Company name associated with the administrator's account.
Changed property customRoleName (object)
Custom role name assigned to the administrator.
Changed property customRoleType (object)
Custom role type defining the administrator's permissions.
Changed property dateFormat (object)
Date format preference for displaying dates in the user interface.
Changed property detailLevel (object)
Detail level for event log information displayed to the administrator.
Changed property edgeBeta (object)
Edge beta feature access level for the administrator.
Changed property email (object)
Email address of the administrator user.
Changed property externalId (object)
External identifier for the user from the identity management system.
Changed property firstName (object)
First name of the administrator user.
Changed property lastName (object)
Last name of the administrator user.
Changed property newDateFormat (object)
New date format string for customizing date display.
Changed property phoneNumber (object)
Phone number associated with the administrator account.
Changed property preferredLanguage (object)
Preferred language code for the user interface display.
Changed property privilegeGroupName (object)
Privilege group name defining the administrator's access level.
Changed property privilegeGroupType (object)
Privilege group type categorizing the administrator's permissions.
Changed property region (object)
Current geographic region for the user's API access.
Changed property role (object)
Deprecated administrator role name for backward compatibility.
Changed property roles (object)
Set of role names assigned to the administrator.
Changed property scopes (object)
Set of permission scopes granted to the administrator.
Changed property tenantId (object)
Tenant identifier for the administrator's primary tenant.
Changed property username (object)
Username for the administrator account login.
Changed property var (object)
Flag indicating whether the tenant is a value added reseller.
Changed property varTenantId (object)
Value added reseller tenant identifier if applicable.
Changed property preferredNotifications (object)
User preferences for notification delivery methods.
- Changed property emailPreferences (object)
  User preference for receiving email notifications.
- Changed property smsPreferences (object)
  User preference for receiving SMS text message notifications.

Return Type:

Changed response : 200 OK

Accepted

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  User profile information for an authenticated administrator.
  - Changed property adminId (object)
    Administrator identifier unique to this administrator account.
  - Changed property alphaStatus (object)
    Alpha feature access status for the administrator.
  - Changed property companyName (object)
    Company name associated with the administrator's account.
  - Changed property customRoleName (object)
    Custom role name assigned to the administrator.
  - Changed property customRoleType (object)
    Custom role type defining the administrator's permissions.
  - Changed property dateFormat (object)
    Date format preference for displaying dates in the user interface.
  - Changed property detailLevel (object)
    Detail level for event log information displayed to the administrator.
  - Changed property dogfood (object)
    Flag indicating whether this is a RUCKUS internal dog food account.
  - Changed property edgeBeta (object)
    Edge beta feature access level for the administrator.
  - Changed property email (object)
    Email address of the administrator user.
  - Changed property externalId (object)
    External identifier for the user from the identity management system.
  - Changed property firstName (object)
    First name of the administrator user.
  - Changed property lastName (object)
    Last name of the administrator user.
  - Changed property newDateFormat (object)
    New date format string for customizing date display.
  - Changed property phoneNumber (object)
    Phone number associated with the administrator account.
  - Changed property preferredLanguage (object)
    Preferred language code for the user interface display.
  - Changed property privilegeGroupName (object)
    Privilege group name defining the administrator's access level.
  - Changed property privilegeGroupType (object)
    Privilege group type categorizing the administrator's permissions.
  - Changed property pver (object)
    Protocol version for API compatibility.
  - Changed property region (object)
    Current geographic region for the user's API access.
  - Changed property role (object)
    Deprecated administrator role name for backward compatibility.
  - Changed property roles (object)
    Set of role names assigned to the administrator.
  - Changed property scopes (object)
    Set of permission scopes granted to the administrator.
  - Changed property support (object)
    Flag indicating whether this is a RUCKUS support account.
  - Changed property tenantId (object)
    Tenant identifier for the administrator's primary tenant.
  - Changed property username (object)
    Username for the administrator account login.
  - Changed property var (object)
    Flag indicating whether the tenant is a value added reseller.
  - Changed property varTenantId (object)
    Value added reseller tenant identifier if applicable.
  - Changed property preferredNotifications (object)
    User preferences for notification delivery methods.
    - Changed property emailPreferences (object)
      User preference for receiving email notifications.
    - Changed property smsPreferences (object)
      User preference for receiving SMS text message notifications.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  User profile information for an authenticated administrator.
  - Changed property adminId (object)
    Administrator identifier unique to this administrator account.
  - Changed property alphaStatus (object)
    Alpha feature access status for the administrator.
  - Changed property companyName (object)
    Company name associated with the administrator's account.
  - Changed property customRoleName (object)
    Custom role name assigned to the administrator.
  - Changed property customRoleType (object)
    Custom role type defining the administrator's permissions.
  - Changed property dateFormat (object)
    Date format preference for displaying dates in the user interface.
  - Changed property detailLevel (object)
    Detail level for event log information displayed to the administrator.
  - Changed property dogfood (object)
    Flag indicating whether this is a RUCKUS internal dog food account.
  - Changed property edgeBeta (object)
    Edge beta feature access level for the administrator.
  - Changed property email (object)
    Email address of the administrator user.
  - Changed property externalId (object)
    External identifier for the user from the identity management system.
  - Changed property firstName (object)
    First name of the administrator user.
  - Changed property lastName (object)
    Last name of the administrator user.
  - Changed property newDateFormat (object)
    New date format string for customizing date display.
  - Changed property phoneNumber (object)
    Phone number associated with the administrator account.
  - Changed property preferredLanguage (object)
    Preferred language code for the user interface display.
  - Changed property privilegeGroupName (object)
    Privilege group name defining the administrator's access level.
  - Changed property privilegeGroupType (object)
    Privilege group type categorizing the administrator's permissions.
  - Changed property pver (object)
    Protocol version for API compatibility.
  - Changed property region (object)
    Current geographic region for the user's API access.
  - Changed property role (object)
    Deprecated administrator role name for backward compatibility.
  - Changed property roles (object)
    Set of role names assigned to the administrator.
  - Changed property scopes (object)
    Set of permission scopes granted to the administrator.
  - Changed property support (object)
    Flag indicating whether this is a RUCKUS support account.
  - Changed property tenantId (object)
    Tenant identifier for the administrator's primary tenant.
  - Changed property username (object)
    Username for the administrator account login.
  - Changed property var (object)
    Flag indicating whether the tenant is a value added reseller.
  - Changed property varTenantId (object)
    Value added reseller tenant identifier if applicable.
  - Changed property preferredNotifications (object)
    User preferences for notification delivery methods.
    - Changed property emailPreferences (object)
      User preference for receiving email notifications.
    - Changed property smsPreferences (object)
      User preference for receiving SMS text message notifications.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  User profile information for an authenticated administrator.
  - Changed property adminId (object)
    Administrator identifier unique to this administrator account.
  - Changed property alphaStatus (object)
    Alpha feature access status for the administrator.
  - Changed property companyName (object)
    Company name associated with the administrator's account.
  - Changed property customRoleName (object)
    Custom role name assigned to the administrator.
  - Changed property customRoleType (object)
    Custom role type defining the administrator's permissions.
  - Changed property dateFormat (object)
    Date format preference for displaying dates in the user interface.
  - Changed property detailLevel (object)
    Detail level for event log information displayed to the administrator.
  - Changed property dogfood (object)
    Flag indicating whether this is a RUCKUS internal dog food account.
  - Changed property edgeBeta (object)
    Edge beta feature access level for the administrator.
  - Changed property email (object)
    Email address of the administrator user.
  - Changed property externalId (object)
    External identifier for the user from the identity management system.
  - Changed property firstName (object)
    First name of the administrator user.
  - Changed property lastName (object)
    Last name of the administrator user.
  - Changed property newDateFormat (object)
    New date format string for customizing date display.
  - Changed property phoneNumber (object)
    Phone number associated with the administrator account.
  - Changed property preferredLanguage (object)
    Preferred language code for the user interface display.
  - Changed property privilegeGroupName (object)
    Privilege group name defining the administrator's access level.
  - Changed property privilegeGroupType (object)
    Privilege group type categorizing the administrator's permissions.
  - Changed property pver (object)
    Protocol version for API compatibility.
  - Changed property region (object)
    Current geographic region for the user's API access.
  - Changed property role (object)
    Deprecated administrator role name for backward compatibility.
  - Changed property roles (object)
    Set of role names assigned to the administrator.
  - Changed property scopes (object)
    Set of permission scopes granted to the administrator.
  - Changed property support (object)
    Flag indicating whether this is a RUCKUS support account.
  - Changed property tenantId (object)
    Tenant identifier for the administrator's primary tenant.
  - Changed property username (object)
    Username for the administrator account login.
  - Changed property var (object)
    Flag indicating whether the tenant is a value added reseller.
  - Changed property varTenantId (object)
    Value added reseller tenant identifier if applicable.
  - Changed property preferredNotifications (object)
    User preferences for notification delivery methods.
    - Changed property emailPreferences (object)
      User preference for receiving email notifications.
    - Changed property smsPreferences (object)
      User preference for receiving SMS text message notifications.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  Unique identifier for tracking this API request.
- Changed property response (object)
  User profile information for an authenticated administrator.
  - Changed property adminId (object)
    Administrator identifier unique to this administrator account.
  - Changed property alphaStatus (object)
    Alpha feature access status for the administrator.
  - Changed property companyName (object)
    Company name associated with the administrator's account.
  - Changed property customRoleName (object)
    Custom role name assigned to the administrator.
  - Changed property customRoleType (object)
    Custom role type defining the administrator's permissions.
  - Changed property dateFormat (object)
    Date format preference for displaying dates in the user interface.
  - Changed property detailLevel (object)
    Detail level for event log information displayed to the administrator.
  - Changed property dogfood (object)
    Flag indicating whether this is a RUCKUS internal dog food account.
  - Changed property edgeBeta (object)
    Edge beta feature access level for the administrator.
  - Changed property email (object)
    Email address of the administrator user.
  - Changed property externalId (object)
    External identifier for the user from the identity management system.
  - Changed property firstName (object)
    First name of the administrator user.
  - Changed property lastName (object)
    Last name of the administrator user.
  - Changed property newDateFormat (object)
    New date format string for customizing date display.
  - Changed property phoneNumber (object)
    Phone number associated with the administrator account.
  - Changed property preferredLanguage (object)
    Preferred language code for the user interface display.
  - Changed property privilegeGroupName (object)
    Privilege group name defining the administrator's access level.
  - Changed property privilegeGroupType (object)
    Privilege group type categorizing the administrator's permissions.
  - Changed property pver (object)
    Protocol version for API compatibility.
  - Changed property region (object)
    Current geographic region for the user's API access.
  - Changed property role (object)
    Deprecated administrator role name for backward compatibility.
  - Changed property roles (object)
    Set of role names assigned to the administrator.
  - Changed property scopes (object)
    Set of permission scopes granted to the administrator.
  - Changed property support (object)
    Flag indicating whether this is a RUCKUS support account.
  - Changed property tenantId (object)
    Tenant identifier for the administrator's primary tenant.
  - Changed property username (object)
    Username for the administrator account login.
  - Changed property var (object)
    Flag indicating whether the tenant is a value added reseller.
  - Changed property varTenantId (object)
    Value added reseller tenant identifier if applicable.
  - Changed property preferredNotifications (object)
    User preferences for notification delivery methods.
    - Changed property emailPreferences (object)
      User preference for receiving email notifications.
    - Changed property smsPreferences (object)
      User preference for receiving SMS text message notifications.

Enum	Meaning
ba	Show events appropriate for a basic user.
it	Show events appropriate for someone having training as an IT administrator.
su	Show events appropriate for a super user.
debug	Show events useful for debugging purposes.

Enum	Meaning
active	The account is active.
suspended	The account has been administratively suspended for an indefinite period of time; while in this state, login are disabled.
maintenance	The account is temporarily undergoing maintenance; while in this state, login are disabled.
deleted	The account has been deleted; although a record of the account exists, all other Network management configuration and data has been deleted.

Enum	Meaning
REC	RUCKUS end customer.
VAR	Value added reseller.
MSP	Managed service provider.
MSP_EC	MSP's end customer.
MSP_NON_VAR	This value is reserved for RUCKUS purposes.
MSP_INSTALLER	Installer organization which administratively reports to an MSP.
MSP_INTEGRATOR	Installer organization which administratively reports to an MSP.
UNKNOWN	Unknown.