CliQr is now part of Cisco Learn More About Cisco

Create User with Activation

Details

API Details
Name
Description

Creates a new user and starts activation of this user based on the default activation profile defined by the tenant administrator.

MethodPOST
URI/v1/users
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Replaces the 3.x version of this API.
  • Enhanced in CloudCenter 4.2 to include the activationProfileId attribute.
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.
  • One valid entry in the activateRegions array is required for this API call to succeed.
ESB Headeraction: create.users

Example 1 – Using Activation Data

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

Request Body

Response

A success or failure HTTP Status Code.

See HTTP Location URL for the link to the newly created user resource.

Example 2 – Using Activation Profile (Effective CloudCenter 4.2)

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

Request Body

Response

A success or failure HTTP Status Code.

See HTTP Location URL for the link to the newly created user resource.

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

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

contractId
  • DescriptionUnique, system-generated identifier for a contract belonging to this tenant.
  • Type: String
bundleId
  • Description: Unique, system-generated identifier for the bundle belonging to this tenant.
  • Type: String
planId 
  • DescriptionUnique, system-generated identifier for the plan belonging to this tenant. The default is Null.
  • Type: String
activateRegions
  • Description: Cannot be an empty array, needs to have at least one entry in the array with a valid cloud region's regionId value.
  • Type: Array of key-value pairs (of type map)

    regionId
    • DescriptionUnique, system-generated identifier for the cloud region 
    • Type: String

Required.

agreeToContract
  • Description: Indicates whether the user has agreed to the tenant organization contract.

    • true = The user has agreed to the tenant organization contract 
    • false = Default. The user has not agreed to the tenant organization contract
  • Type: Boolean

importApps
  • Description: Array of unique identifiers for applications from the tenant Marketplace that will be made available to this user on activation. The default is an empty array.
  • Type: String (array)
sendActivationEmail
  • Description: Indicates whether the system sends an email message to the activated user.

    • true = The system sends an email message on user activation
    • false = Default. The system does not send an email message on user activation
  • Type: Boolean

Required if using activation data method

activationProfileId
  • Description: Unique, system-generated identifier for the activationProfile
  • Type: String

Required if using activation profile method

Response Attributes

None