View Users

Details

API Details
Name

View Users

Description

Displays configured information for all users or for a specified user.

MethodGET
URI
  • v1/users
  • v1/users/userId
  • v1/users/userId?detail=true
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Replaces the 3.x version of this API.
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 userId to identify a user, the response includes information for that user only.
  • You can sort the response based on the firstName and emailAddr attributes. See CloudCenter API Overview (Pagination and Sorting) for additional context.

ESB Header
  • action: get.users
  • action: get.users.userId 
  • action: get.users.userId
    actionparam: detail=true

Example 1 – /v1/users

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

Response

{
    "resource": "https://<HOST>:<PORT>/v1/users",
    "size": 3,
    "pageNumber": 0,
    "totalElements": 3,
    "totalPages": 1,
    "users": [
        {
            "id": "2",
            "resource": https://<HOST>:<PORT>/v1/users/2,
            "perms": [],
            "username": "cloudcenteradmin",
            "password": "===redacted===",
            "enabled": true,
            "type": "TENANT",
            "firstName": "CloudCenter",
            "lastName": "Admin",
            "companyName": "CloudCenter",
            "tenantId": "1",
            "emailAddr": "admin@cliqrtech.com",
            "emailVerified": true,
            "phoneNumber": "",
            "externalId": null,
            "accessKeys": "https://<HOST>:<PORT>/v1/users/2/keys",
            "disableReason": null,
            "accountSource": null,
            "status": "ENABLED",
            "detail": null,
            "activationData": null,
            "created": 1435336896000,
            "lastUpdated": 1435336913000,
            "coAdmin": false
        },
        {
            "id": "11",
            "resource": https://<HOST>:<PORT>/v1/users/11,
            "perms": [],
            "username": "user.01_b",
            "password": "== red-acted ==",
            "enabled": false,
            "type": "STANDARD",
            "firstName": "User 01",
            "lastName": "CloudCenter",
            "companyName": "CloudCenter, Inc",
            "tenantId": "1",
            "emailAddr": "user.01@cloudCenter.com",
            "emailVerified": false,
            "phoneNumber": "14085467899",
            "externalId": "",
            "accessKeys": "https://<HOST>:<PORT>/v1/users/11/keys",
            "disableReason": null,
            "accountSource": "AdminCreated",
            "status": "NEW",
            "detail": null,
            "activationData": null,
            "created": 1438980545000,
            "lastUpdated": 1438980545000,
            "coAdmin": false
        },
        {
            "id": "12",
            "resource": https://<HOST>:<PORT>/v1/users/12,
            "perms": [],
            "username": "user.02_c",
            "password": "== red-acted ==",
            "enabled": false,
            "type": "STANDARD",
            "firstName": "User 02",
            "lastName": "CloudCenter",
            "companyName": "CloudCenter Company",
            "tenantId": "1",
            "emailAddr": "user.02@cloudcenter.com",
            "emailVerified": false,
            "phoneNumber": "14085467899",
            "externalId": "",
            "accessKeys": "https://<HOST>:<PORT>/v1/users/12/keys",
            "disableReason": null,
            "accountSource": "AdminCreated",
            "status": "NEW",
            "detail": null,
            "activationData": null,
            "created": 1438981158000,
            "lastUpdated": 1438981158000,
            "coAdmin": false
        }
    ]
}

Example 2 – /v1/users/userId

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

Response

{
    "id": "6",
    "resource": "https://<HOST>:<PORT>/v1/users/6",
    "perms": [],
    "username": "user.01_6",
    "password": "===redacted===",
    "enabled": true,
    "type": "STANDARD",
    "firstName": "User 01",
    "lastName": "CloudCenter 02",
    "companyName": "CloudCenter 02, Inc",
    "tenantId": "3",
    "emailAddr": "user.01@cloudcenter.02.com",
    "emailVerified": true,
    "phoneNumber": "",
    "externalId": "",
    "accessKeys": "https://<HOST>:<PORT>/v1/users/6/keys",
    "disableReason": null,
    "accountSource": "AdminCreated",
    "status": "ENABLED",
    "detail": null,
    "activationData": null,
    "created": 1436221479000,
    "lastUpdated": 1436221479000,
    "coAdmin": false
}

Example 3 –  /v1/users/userId?detail=true

curl -k -X GET -H "Accept: application/json" -u cloudCenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/users/userId?detail=true

Response

{
  "id": "2",
  "resource": "https://<HOST>:<PORT>/v1/users/2?detail=true",
  "perms": [],
  "username": "cloudcenteradmin",
  "password": "==redacted==",
  "enabled": true,
  "type": "TENANT",
  "firstName": "CloudCenter",
  "lastName": "Admin",
  "companyName": "CloudCenter",
  "tenantId": "1",
  "emailAddr": "admin@cliqrtech.com",
  "emailVerified": true,
  "phoneNumber": "",
  "externalId": null,
  "accessKeys": "https://<HOST>:<PORT>/v1/users/2/keys",
  "disableReason": null,
  "accountSource": null,
  "status": "ENABLED",
  "detail": {
    "paymentProfileStatus": "Active",
    "plan": {
      "id": "3",
      "resource": null,
      "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": null,
      "perms": [],
      "name": "QA Contract",
      "description": "QA Contract",
      "tenantId": "1",
      "length": 12,
      "terms": "Agree ToS",
      "discountRate": 0,
      "disabled": false,
      "showOnlyToAdmin": false,
      "numberOfUsers": 11
    },
    "userPricePlan": {
      "userId": "2",
      "planId": "3",
      "contractId": "1",
      "type": null,
      "renewContract": false
    },
    "contractStartDate": 0,
    "regions": [
      "2",
      "10",
      "11",
      "12",
      "1",
      "19",
      "3"
    ]
  },
  "activationData": null,
  "created": 1433242061000,
  "lastUpdated": 1433882862000,
  "coAdmin": false
}

Request Attributes

userId
  • Description: Unique, system-generated identifier for a user
  • Type: String

Required

Response Attributes

users
  • Description: Identifies details about these users
  • Type: Array of users

    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)
    username
    • Description: Unique, CloudCenter-generated name reference for this user.
    • Type: String
    password
    • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
    • Type: String
    enabled
    • Description: Indicates that this resource has been enabled.

      • true = resource has been enabled
      • false = resource has not been enabled (default)
    • Type: Boolean
    type
    firstName
    • DescriptionCloudCenter user's first name. Defaults to empty string if not set.
    • Type: String
    lastName
    • DescriptionCloudCenter user's last name. Defaults to empty string if not set.
    • Type: String
    companyName
    • Description: The company name for this user. The default is an empty string.
    • Type: String
    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
    emailAddr
    • Description: Unique (in the system) email address for this resource and must match the regular expression
    • Type: String
    emailVerified
    • Description: Indicates whether this email address has been verified.
      • true = email address has been verified
      • false = email address has not been verified
    • Type: Boolean
    phoneNumber
    • Description: The phone number for this user. Defaults to empty string if not set.
    • Type: String

    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

    accessKeys
    • Description: URL from which you can fetch API, SSH, or SFTP access keys for each cloud. The system automatically generates SSH and SFTP keys on your behalf as needed. See API Authentication for additional details.
    • Type: URL

    disableReason
    • Description: Explanation of why this resource has been disabled
    • Type: String
    accountSource
    • Description: Indicates how this user account was created (system generated)
    • Type: Enumeration

      EnnumerationDescription
      adminCreated The account was created by an administrator
      selfActivated 

      The account was created by a user by using a self sign-up form

    status
    • Description: Identifies the status of the user. See User States and Actions for additional context.
    • Type: Enumeration

      EnumerationDescription
      NEWDefault. Identifies a newly-added user. 
      DISABLEDIdentifies a disabled user.
      ENABLEDIdentifies an activated user.
    detail (click for additional details)

    activationData (click for additional details)

    created
    • Description: The date that this resource or favorite was created (system generated). This is a read-only attribute and cannot be configured.
    • Type: Long
    lastUpdated
    • Description: Date that this resource was last updated. This attribute is the same as the lastUpdatedTime attribute.

    • Type: Long

    coAdmin
    • Description: The primary administrator can promote a Standard User to be a co-administrator.

      • true = This user is a co-admin
      • false = Default. This user is not a co-admin
    • Type: Boolean