Get Tenant

Tenant Management API (v0.3.0)

Ruckus Network Technical Documents

Overview

This document provides information about Tenant management.

Rate Limit

For the Ptenant REST API the following will be true:

Limits are applied to each tenant.
A maximum of 200 calls can be made per second.
Each second 100 calls will be returned to be used.

Download OpenAPI description

Download PDF

Servers

North American region

https://api.ruckus.cloud/

Asian region

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

European region

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

Notification Recipient

Manage notification recipients.

Operations

Tenant

Manage tenants.

Operations

Get Tenant

Request

Get tenant by identifier.

Query

deepboolean

No request payload

Responses

Body

idstring

createdDatestring(date-time)read-only

updatedDatestring(date-time)read-only

entitlementIdstringread-only

externalModifiedDatestring(date-time)

namestring

externalIdstringrequired

adminsArray of objects(Admin)

notificationRecipientsArray of objects(NotificationRecipient)

authenticationsArray of objects(Authentication)

almActivatedboolean

almActivationDatestring(date-time)

almSysAccountIdstring

almMigrationFlagboolean

almMigrationDatestring(date-time)

accountTierstring

accountVerticalstring

obsoleteboolean

Tenant is no longer used or active.

oemNamestring

mspobject(Msp)

MspEcServiceDatesobject(MspEc)

MspEcServiceDates

tenantMFAobject(TenantMFA)

serviceAccountboolean

mspPingOrgIdstring

aggregateNotificationsboolean

excludeecforAggregationboolean

pingMigratedboolean

inMaintenanceboolean

accountobject(Account)

extendedTrialboolean

propertyCodestring

expirationEnforcementboolean

expirationEnforcementDatestring(date-time)

preferencesstring

isActivatedboolean

ruckusUserboolean

delegationsToArray of objects(Delegation)

parentIdstringread-only

statusstring

Enum	Meaning
active	The account is active.
suspended	The account has been administratively suspended for an indefinite period of time; while in this state, logins are disabled.
maintenance	The account is temporarily undergoing maintenance; while in this state, logins 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"active""suspended""deleted""maintenance"

tenantTypestring

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.

Enum"REC""MSP""MSP_EC""VAR""MSP_NON_VAR""UNKNOWN""MSP_INSTALLER""MSP_INTEGRATOR""MSP_REC"

subscribesstring

maintenanceStatebooleanDeprecatedread-only

maintenanceDatestring(date-time)Deprecatedread-only

upgradeGroupstringDeprecatedread-only

Response

{
  "id": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "updatedDate": "2019-08-24T14:15:22Z",
  "entitlementId": "string",
  "externalModifiedDate": "2019-08-24T14:15:22Z",
  "maintenanceState": true,
  "maintenanceDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "externalId": "string",
  "admins": [
    { … }
  ],
  "notificationRecipients": [
    { … }
  ],
  "authentications": [
    { … }
  ],
  "almActivated": true,
  "almActivationDate": "2019-08-24T14:15:22Z",
  "almSysAccountId": "string",
  "almMigrationFlag": true,
  "almMigrationDate": "2019-08-24T14:15:22Z",
  "accountTier": "string",
  "accountVertical": "string",
  "obsolete": true,
  "oemName": "string",
  "upgradeGroup": "string",
  "msp": {
    "mspLabel": "string",
    "mspFQDN": "string",
    "logoUUID": "string",
    "alarmNotificationLogoUUID": "string",
    "pingNotificationLogoUUID": "string",
    "mlisaLogoUUID": "string",
    "pingLoginLogoUUID": "string",
    "defaultLogoUUID": "string",
    "contactSupportUrl": "string",
    "contractSupportBehavior": "string",
    "openCaseUrl": "string",
    "openCaseBehavior": "string",
    "myOpenCaseUrl": "string",
    "myOpenCaseBehavior": "string",
    "changePasswordUrl": "string",
    "phone": "string",
    "email": "string",
    "website": "string",
    "isDisableNotification": true
  },
  "MspEcServiceDates": {
    "parentMspId": "string",
    "serviceExpirationDate": "2019-08-24T14:15:22Z",
    "serviceEffectiveDate": "2019-08-24T14:15:22Z"
  },
  "tenantMFA": {
    "mfaStatus": "string",
    "recoveryCodes": "string"
  },
  "serviceAccount": true,
  "mspPingOrgId": "string",
  "aggregateNotifications": true,
  "excludeecforAggregation": true,
  "pingMigrated": true,
  "inMaintenance": true,
  "account": {
    "id": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "streetAddress": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "city": "string",
    "type": "string",
    "mappingURL": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "parentId": "string"
  },
  "extendedTrial": true,
  "propertyCode": "string",
  "expirationEnforcement": true,
  "expirationEnforcementDate": "2019-08-24T14:15:22Z",
  "preferences": "string",
  "isActivated": true,
  "ruckusUser": true,
  "delegationsTo": [
    { … }
  ],
  "parentId": "string",
  "status": "active",
  "tenantType": "REC",
  "subscribes": "string"
}

Update a Tenant

Request

Update tenant information are tenant name, tenant type,external id by passing the alto tenant id.

Body

required

newIdmIdstring

varboolean

tenantNamestring

enableMfastring

enableSaboolean

enableBetaboolean

enableAlphaboolean

entitlementIdstring

subscribesstring

requestIdstring

responsestring

userNamestring

missingAdminIdsArray of strings

{
  "newIdmId": "string",
  "var": true,
  "tenantName": "string",
  "enableMfa": "string",
  "enableSa": true,
  "enableBeta": true,
  "enableAlpha": true,
  "entitlementId": "string",
  "subscribes": "string",
  "requestId": "string",
  "response": "string",
  "userName": "string",
  "missingAdminIds": [
    "string"
  ]
}

Responses

Body

requestIdstring

Response

{
  "requestId": "string"
}

Get Beta Feature Identifiers

Request

Get list of beta features.

No request payload

Responses

Bodyapplication/json

betaFeaturesArray of objects(BetaFeature)

errorMessagestring

invalidFeatureIdsArray of strings

Response

application/json

{
  "betaFeatures": [
    { … }
  ],
  "errorMessage": "string",
  "invalidFeatureIds": [
    "string"
  ]
}

Update Beta Feature Identifiers

Request

Update beta feature identifiers.

Bodyapplication/jsonrequired

betaFeatureIdsArray of stringsunique

application/json

{
  "betaFeatureIds": [
    "string"
  ]
}

Responses

Bodyapplication/json

betaFeaturesArray of objects(BetaFeature)

errorMessagestring

invalidFeatureIdsArray of strings

Response

application/json

{
  "betaFeatures": [
    { … }
  ],
  "errorMessage": "string",
  "invalidFeatureIds": [
    "string"
  ]
}

Delegation

Manage delegations.

Operations

User Profile

Manage user profiles.

Operations

Privacy Features

Manage privacy features.

Operations

Administrator

Manage administrators.

Operations

acx-mobile-push-notification-endpoint-controller

Operations

authentication-controller

Operations