View Tenants

Details

API Details
Name

View Tenants

Description

Displays configured information for all tenants or for the specified tenant. You can view a list by specifying any attribute used to create the tenant.

MethodGET
URI
  • v1/tenants
  • v1/tenants/tenantId
  • v1/tenants?detail=true
  • v1/tenants?includeDeleted=true
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • The minAppFeeRate, ccTransactionFeeRate, revShareRate, and enableConsolidatedBilling attributes are deprecated.
  • Enhanced in CloudCenter 4.6.0 to include the includeDeleted query parameter and the deleted response parameter
  • Enhanced in CloudCenter 4.8.1 to include the createUserSecurityGroup and allowVmConnection attributes (see Create Tenant > Example 2)
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format. 
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • If you include a tenantId to identify a tenant, the response includes information for that tenant only.
ESB Header
  • action: get.tenants
  • action: get.tenants.tenantId
  • action: get.tenants
    actionparam: detail=true

Example

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants"

Response

  • v1/tenants

     {
      "resource": "https://<HOST>:<PORT>/v1/tenants/",
      "size": 8,
      "pageNumber": 0,
      "totalElements": 8,
      "totalPages": 1,
      "tenants": [
        {
          "id": "2",
          "resource": https://<HOST>:<PORT>/v1/tenants/2,
          "perms": [],
          "name": "Marketing",
          "url": "",
          "about": "Cloudenter Marketing Team",
          "contactEmail": "",
          "phone": "",
          "userId": "4",
          "termsOfService": "",
          "privacyPolicy": "",
          "shortName": "marketing",
          "enablePurchaseOrder": true,
          "enableEmailNotificationsToUsers": true,
          "parentTenantId": 1,
          "externalId": "",
          "defaultActivationProfileId": null,
          "enableMonthlyBilling": true,
          "defaultChargeType": null,
          "loginLogo": "/assets/vendors/2/img/logo.png",
          "homePageLogo": "/assets/vendors/2/img/logo-loggedin.png",
          "domainName": null,
          "activationCodes": [],
          "firewallProfiles": [],
          "preferences": [],
          "user": {
            "id": "4",
            "resource": null,
            "perms": [],
            "username": "marketing_4",
            "password": "== redacted ==",
            "enabled": true,
            "type": "TENANT",
            "firstName": "Marketing",
            "lastName": "CloudCenter",
            "companyName": "Marketing",
            "tenantId": "2",
            "emailAddr": "marketing@cloudcenter.com",
            "emailVerified": true,
            "phoneNumber": "6504531235",
            "externalId": "",
            "accessKeys": "https://<HOST>:<PORT>/v1/users/4/keys",
            "disableReason": null,
            "accountSource": "AdminCreated",
            "status": "ENABLED",
            "detail": null,
            "activationData": null,
            "created": 1433265468000,
            "lastUpdated": 1433265468000,
            "coAdmin": false
          }
        },
        ...
        {
          "id": "15",
          "resource": https://<HOST>:<PORT>/v1/tenants/15,
          "perms": [],
          "name": "Doc1",
          "url": "www.cloudcenter.docs.com",
          "about": "",
          "contactEmail": "",
          "phone": "",
          "userId": "28",
          "termsOfService": "",
          "privacyPolicy": "",
          "shortName": "docs1",
          "enablePurchaseOrder": true,
          "enableEmailNotificationsToUsers": true,
          "parentTenantId": 1,
          "externalId": "",
          "defaultActivationProfileId": null,
          "enableMonthlyBilling": false,
          "defaultChargeType": null,
          "loginLogo": "/assets/vendors/15/img/logo.png",
          "homePageLogo": "/assets/vendors/15/img/logo-loggedin.png",
          "domainName": null,
          "activationCodes": [],
          "firewallProfiles": [],
          "preferences": [],
          "user": {
            "id": "28",
            "resource": https://<HOST>:<PORT>/v1/tenants/users/28,
            "perms": [],
            "username": "cc_s",
            "password": "== redacted ==",
            "enabled": false,
            "type": "TENANT",
            "firstName": "CloudCenter",
            "lastName": "Docs",
            "companyName": "Company",
            "tenantId": "15",
            "emailAddr": "cc@company.com",
            "emailVerified": true,
            "phoneNumber": "",
            "externalId": "",
            "accessKeys": "https://cloudCenter4beta.cliqrtech.com/v1/users/28/keys",
            "disableReason": "TrialCreditExhausted",
            "accountSource": "AdminCreated",
            "status": "DISABLED",
            "detail": null,
            "activationData": null,
            "created": 1434579262000,
            "lastUpdated": 1434579262000,
            "coAdmin": false
          }
        }
      ]
    }


  • v1/tenants/tenantId

     {
      "id": "13",
      "resource": "https://<HOST>:<PORT>/v1/tenants/13",
      "perms": [],
      "name": "s",
      "url": "sui.company.com",
      "about": "",
      "contactEmail": "",
      "phone": "",
      "userId": "42",
      "termsOfService": "",
      "privacyPolicy": "",
      "shortName": "sui",
      "enablePurchaseOrder": true,
      "enableEmailNotificationsToUsers": true,
      "parentTenantId": 1,
      "externalId": "",
      "defaultActivationProfileId": null,
      "enableMonthlyBilling": false,
      "defaultChargeType": null,
      "loginLogo": "/assets/vendors/13/img/logo.png",
      "homePageLogo": "/assets/vendors/13/img/logo-loggedin.png",
      "domainName": null,
      "activationCodes": [],
      "firewallProfiles": [],
      "preferences": [],
      "user": {
        "id": "42",
        "resource": https://<HOST>:<PORT>/v1/tenants//users/42,
        "perms": [],
        "username": "sui_G",
        "password": "== redacted ==",
        "enabled": true,
        "type": "TENANT",
        "firstName": "sui",
        "lastName": "ti",
        "companyName": "Company",
        "tenantId": "13",
        "emailAddr": "sui@company.com",
        "emailVerified": true,
        "phoneNumber": "9901244556",
        "externalId": "",
        "accessKeys": "https://<HOST>:<PORT>/v1/users/42/keys",
        "disableReason": null,
        "accountSource": "AdminCreated",
        "status": "ENABLED",
        "detail": null,
        "activationData": null,
        "created": 1435920797000,
        "lastUpdated": 1435920797000,
        "coAdmin": false
      }
    }
  • v1/tenants/?detail=true

    {
      "resource": "https://<HOST>:<PORT>/v1/tenants?detail=true",
      "size": 8,
      "pageNumber": 0,
      "totalElements": 8,
      "totalPages": 1,
      "tenants": [
        {
          "id": "2",
          "resource": https://<HOST>:<PORT>/v1/tenants/2,
          "perms": [],
          "name": "Marketing",
          "url": "",
          "about": "CloudCenter Marketing Team",
          "contactEmail": "",
          "phone": "",
          "userId": "4",
          "termsOfService": "",
          "privacyPolicy": "",
          "shortName": "marketing",
          "enablePurchaseOrder": true,
          "enableEmailNotificationsToUsers": true,
          "parentTenantId": 1,
          "externalId": "",
          "defaultActivationProfileId": null,
          "enableMonthlyBilling": true,
          "defaultChargeType": null,
          "loginLogo": "/assets/vendors/2/img/logo.png",
          "homePageLogo": "/assets/vendors/2/img/logo-loggedin.png",
          "domainName": null,
          "activationCodes": [],
          "firewallProfiles": [],
          "preferences": [],
          "user": {
            "id": "4",
            "resource": https://<HOST>:<PORT>/v1/tenants/4,
            "perms": [],
            "username": "marketing_4",
            "password": "== redacted ==",
            "enabled": true,
            "type": "TENANT",
            "firstName": "Marketing",
            "lastName": "CloudCenter",
            "companyName": "Marketing",
            "tenantId": "2",
            "emailAddr": "marketing@company.com",
            "emailVerified": true,
            "phoneNumber": "6504531235",
            "externalId": "",
            "accessKeys": "https://<HOST>:<PORT>/v1/users/4/keys",
            "disableReason": null,
            "accountSource": "AdminCreated",
            "status": "ENABLED",
            "detail": {
              "paymentProfileStatus": "Active",
              "plan": {
                "id": "3",
                "resource": https://<HOST>:<PORT>/v1/tenants/3,
                "perms": [],
                "name": "Unlimited Plan",
                "description": "Unlimited Subscription Plan",
                "tenantId": "1",
                "type": "UNLIMITED_PLAN",
                "monthlyLimit": 0,
                "nodeHourIncrement": 0,
                "includedBundleId": null,
                "price": 5000,
                "onetimeFee": 10000,
                "annualFee": 0,
                "storageRate": 0,
                "hourlyRate": 0,
                "overageRate": 0,
                "overageLimit": null,
                "paymentProfileRequired": false,
                "restrictedToAppStoreOnly": false,
                "billToVendor": true,
                "enableRollover": false,
                "disabled": false,
                "showOnlyToAdmin": false,
                "numberOfUsers": 6
              },
              "contract": {
                "id": "1",
                "resource": https://<HOST>:<PORT>/v1/tenants/2/contracts/1,
                "perms": [],
                "name": "QA Contract",
                "description": "QA Contract",
                "tenantId": "1",
                "length": 12,
                "terms": "Agree ToS",
                "discountRate": 0,
                "disabled": false,
                "showOnlyToAdmin": false,
                "numberOfUsers": 11
              },
              "userPricePlan": {
                "userId": "4",
                "planId": "3",
                "contractId": "1",
                "type": null,
                "renewContract": false
              },
              "contractStartDate": 0,
              "regions": [
                "2",
                "10",
                "1",
                "3"
              ]
            },
            "activationData": null,
            "created": 1433265468000,
            "lastUpdated": 1433265468000,
            "coAdmin": false
          }
        },
        ...,
        {
          "id": "15",
          "resource": https://<HOST>:<PORT>/v1/tenants/15,
          "perms": [],
          "name": "Doc1",
          "url": "www.cloudCenter.docs.com",
          "about": "",
          "contactEmail": "",
          "phone": "",
          "userId": "28",
          "termsOfService": "",
          "privacyPolicy": "",
          "shortName": "docs1",
          "enablePurchaseOrder": true,
          "enableEmailNotificationsToUsers": true,
          "parentTenantId": 1,
          "externalId": "",
          "defaultActivationProfileId": null,
          "enableMonthlyBilling": false,
          "defaultChargeType": null,
          "loginLogo": "/assets/vendors/15/img/logo.png",
          "homePageLogo": "/assets/vendors/15/img/logo-loggedin.png",
          "domainName": null,
          "activationCodes": [],
          "firewallProfiles": [],
          "preferences": [],
          "user": {
            "id": "28",
            "resource": https://<HOST>:<PORT>/v1/tenants//users/28,
            "perms": [],
            "username": "cc_s",
            "password": "== redacted ==",
            "enabled": false,
            "type": "TENANT",
            "firstName": "CloudCenter",
            "lastName": "Docs",
            "companyName": "Company",
            "tenantId": "15",
            "emailAddr": "cc@ccompany.com",
            "emailVerified": true,
            "phoneNumber": "",
            "externalId": "",
            "accessKeys": "https://<HOST>:<PORT>/v1/users/28/keys",
            "disableReason": "TrialCreditExhausted",
            "accountSource": "AdminCreated",
            "status": "DISABLED",
            "detail": {
              "paymentProfileStatus": null,
              "plan": null,
              "contract": null,
              "userPricePlan": null,
              "contractStartDate": 0,
              "regions": [
                "1"
              ]
            },
            "activationData": null,
            "created": 1434579262000,
            "lastUpdated": 1434579262000,
            "coAdmin": false
          }
        }
      ]
    }
  • v1/tenants/?detail=true

    {
        "resource": "https://<HOST>:<PORT>/v1/tenants?includeDeleted=true",
        "size": 20,
        "pageNumber": 0,
        "totalElements": 20,
        "totalPages": 1,
        "tenants": [{
            "id": "7",
            "resource": "https://<HOST>:<PORT>/v1/tenants/7?includeDeleted=true",
            "name": "Tej",
            "url": "",
            "about": "",
            "contactEmail": "",
            "phone": "",
            "userId": "13",
            "termsOfService": "",
            "privacyPolicy": "",
            "revShareRate": 0.0,
            "ccTransactionFeeRate": 0.0,
            "minAppFeeRate": 0.0,
            "enableConsolidatedBilling": true,
            "shortName": "Tej",
            "enablePurchaseOrder": true,
            "enableEmailNotificationsToUsers": true,
            "parentTenantId": 5,
            "externalId": "",
            "defaultActivationProfileId": null,
            "enableMonthlyBilling": false,
            "defaultChargeType": null,
            "loginLogo": "/assets/vendors/7/img/logo.png",
            "homePageLogo": "/assets/vendors/7/img/logo-loggedin.png",
            "domainName": null,
            "activationCodes": [],
            "firewallProfiles": [],
            "skipDefaultUserSecurityGroup": false,
            "disableAllEmailNotification": false,
            "preferences": [{
                "name": "PASSWORD_MIN_LENGTH",
                "value": "5"
            }],
            "user": {
                "id": "13",
                "resource": null,
                "username": "tej_d",
                "password": "== redacted ==",
                "enabled": true,
                "type": "TENANT",
                "firstName": "Tej",
                "lastName": "Bhan",
                "companyName": "CliQr",
                "tenantId": "7",
                "emailAddr": "tej@cliqr.com",
                "emailVerified": true,
                "phoneNumber": "",
                "externalId": "",
                "accessKeys": "https://<HOST>:<PORT>/v1/users/13/keys",
                "disableReason": null,
                "accountSource": "AdminCreated",
                "status": "ENABLED",
                "detail": null,
                "activationData": null,
                "created": 1458019334000,
                "lastUpdated": 1458019334000,
                "coAdmin": false,
                "tenantAdmin": true,
                "activationProfileId": null,
                "hasSubscriptionPlanType": false
            },
            "trademarkURL": null,
            "deleted": false
        }, {
            "id": "76",
            "resource": "https://<HOST>:<PORT>/v1/tenants/76?includeDeleted=true",
            "name": "INA1",
            "url": "",
            "about": "",
            "contactEmail": "",
            "phone": "",
            "userId": "214",
            "termsOfService": "",
            "privacyPolicy": "",
            "revShareRate": 0.0,
            "ccTransactionFeeRate": 0.0,
            "minAppFeeRate": 0.0,
            "enableConsolidatedBilling": true,
            "shortName": "INA1",
            "enablePurchaseOrder": true,
            "enableEmailNotificationsToUsers": true,
            "parentTenantId": 5,
            "externalId": "",
            "defaultActivationProfileId": null,
            "enableMonthlyBilling": false,
            "defaultChargeType": null,
            "loginLogo": "/assets/vendors/76/img/logo.png",
            "homePageLogo": "/assets/vendors/76/img/logo-loggedin.png",
            "domainName": null,
            "activationCodes": [],
            "firewallProfiles": [],
            "skipDefaultUserSecurityGroup": false,
            "disableAllEmailNotification": false,
            "preferences": [{
                "name": "PASSWORD_EXPIRATION_DAYS",
                "value": "1"
            }, {
                "name": "PASSWORD_MIN_LENGTH",
                "value": "5"
            }],
            "user": {
                "id": "214",
                "resource": null,
                "username": "ina321_m3",
                "password": "== redacted ==",
                "enabled": true,
                "type": "TENANT",
                "firstName": "ina321",
                "lastName": "ina",
                "companyName": "cliqr",
                "tenantId": "76",
                "emailAddr": "ina321@cliqr.com",
                "emailVerified": true,
                "phoneNumber": "",
                "externalId": "",
                "accessKeys": "https://<HOST>:<PORT>/v1/users/214/keys",
                "disableReason": null,
                "accountSource": "AdminCreated",
                "status": "ENABLED",
                "detail": null,
                "activationData": null,
                "created": 1476265356725,
                "lastUpdated": 1476265356656,
                "coAdmin": false,
                "tenantAdmin": true,
                "activationProfileId": null,
                "hasSubscriptionPlanType": true
            },
            "deleted": true
        }]
    }

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

includeDeleted
  • Description: A query parameter that determines if the CloudCenter platform should retrieve and display details of deleted tenants in response to the View Tenants API request.
  • Type: Boolean
    • true = The CloudCenter platform sends the details of deleted tenants in the response.
    • false = Default. The CloudCenter platform does not send the details of deleted tenants in the response.


Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
tenants
  • Description: Identifies information about each tenant
  • Type: Array of tenants

    See pageResource or Pagination for additional context

    tenant
    • Description: Identifies information for a tenant
    • Type: Array of mapped attributes

      id
      • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

      • Type: String

      resource
      • Description: Unique URL to access this resource
      • Type: String
      perms (click for additional details)

      name
      • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

      • Type: String

      Required

      url
      • Description: The URL that is associated with the tenant's marketing website. See  Add Sub-TenantsTenant ID and Tenant Name Dependency for additional details.

        This is not the URL to access the CloudCenter platform

      • Type: String

      Required

      about
      • Description: Additional information about the tenant organization
      • Type: String

      Required

      contactEmail
      • Description: The contact email address for this tenant organization
      • Type: String

      Required

      phone
      • DescriptionThe phone number for this tenant organization 
      • Type: String
      userId
      • Description: Unique, system-generated identifier for a user
      • Type: String

      termsOfService
      • Description: The text of this contract
      • Type: String

      Required

      privacyPolicy
      • Description: Privacy policy of the tenant organization
      • Type: String

      Required

      shortName
      • Description: Unique short version of this tenant's name to be used in the Login page. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.
      • Type: String
      • Type: Boolean
      enableEmailNotificationsToUsers
      • Description: Indicates if the invoice email at the end of each month must be sent to tenant users.
        • true = Email messages should be sent to users
        • false = email messages should not be sent to users
      • Type: Boolean
      parentTenantId
      • Description: Unique, system-generated identifier for the parent tenant organization
      • Type: Integer
      externalId
      • DescriptionIdentity provider ID for external access (for example, SSO). This value must match the corresponding user's SAML subject Name ID value. Defaults to empty string if not set.
      • Type: String
      defaultActivationProfileId
      • Description: Activation profile ID to use when activating a user if another activation profile ID is not specified. See Map an Activation Profile for additional context.
      • Type: String
      enableMonthlyBilling
      • Description: Indicates whether monthly billing should be enabled for this tenant. See Tenant Billing for additional context.
        • true = Enable monthly billing for this tenant
        • false = Do not enable monthly billing for this tenant
      • Type: Boolean
      defaultChargeType
      • DescriptionThe default charge type for this account.  
      • Type: Enumeration

        EnumerationDescription
        HOURLYDefault, if not included in the request. See Tenant Billing for additional context.
        MONTHLYSee Tenant Billing for additional context.
      • Description: URL of a saved image to be displayed as the logo on the Login page of the CCM uploading logos. See Upload Logo for additional context.
      • Type: String
      • Description: URL of a saved image to be displayed as the logo on the CCM home page after the user has logged into the CloudCenter platform. See Upload Logo for additional context.
      • Type: String
      domainName
      • Description: DNS domain name for this tenant organization. Valid characters are letters, numbers, hyphens, and underscores. See Add Sub-TenantsTenant ID and Tenant Name Dependency for additional details. The behavior for this attribute differs based on it being a request or a response:
        • API Request: If the suffix company07.com is present in the CCM property file, and requiredname.company07.com is required dnsName, the domainName attribute should only contain the value requiredname.
        • API Response: The domainName attribute  displays requiredname.company07.com.
      • Type: String

      activationCodes (click for additional details)

      firewallProfiles (click for additional details)

      createUserSecurityGroup
      • Description: Indicates if a security group should be created for each user. See Security and Firewall Rules for additional context.
      • Type: Boolean
        • false = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are ignored.
        • true = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are honored.

      allowVmConnection
      • Description: Indicates if this user is allowed unrestricted access across VMs and/or if the tenant specific firewall rules per cloud is set. See Security and Firewall Rules for additional context.
      • Type: Boolean
        • false = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are ignored.
        • true = The existing property to allow unrestricted access across VMs created by this user and the tenant specific firewall rules per cloud are honored.

      preferences (click for additional details)
      user (click for additional details)
      deleted
      • Description: Identifies if this resource is deleted in the CloudCenter platform.
      • Type: Boolean
        • true = The resource is deleted.
        • false = The resource is not deleted.