Create User without Activation

Details

API Details
Name

Create User without Activation

Description

Creates a new user and places the user in the NEW state.

MethodPOST
URI/v1/users
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Replaces the 3.x version of this API.
Notes

API Notes:

User Creation Notes:

  • When you create a user, this user's status defaults to NEW and the user is not functional.
  • For this user to be functional (for example, to make API calls), the admin must first  activate this user.
  • To obtain the tenantId, issue the View Users API request. Your tenantId is listed in the response. Use this tenantId to create a new user within a particular tenant.
ESB Headeraction: create.users

Example

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cloudCenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/users"

Request Body

{
    "firstName": "User 02",
    "lastName": "CloudCenter",
    "password": "===redacted===",
    "emailAddr": "user.02@company.com",
    "companyName": "Company, Inc",
    "phoneNumber": "18005536387",
    "externalId": "",
    "tenantId": 1
}'

Response

None.

Request Attributes

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
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

Required
emailAddr
  • Description: Unique (in the system) email address for this resource and must match the regular expression
  • Type: String

Required

companyName
  • Description: The company name for this user. The default is an empty string.
  • Type: String
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

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

Required

Response Attributes

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

  • Type: String

The User ID for the user is generated by the system and can be viewed in response to the View Users API call.