Create a user
POST https://{{host}}/identity-management/v3/user-admin/ui-identities
This operation creates a user, or clones an existing user's role assignments, in the account specified in your API client credentials. Optionally, sends a randomly generated one-time use password to the new user. If you send the email with the password directly to the user, the response for this operation doesn't include that password. If you don't send the password to the user through email, the password is included in the response.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sendEmail | string | (Optional) Sends a one-time password to the new user, true by default. | |
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
Request Body
{"additionalAuthentication"=>"TFA", "address"=>"first Street", "authGrants"=>[{"groupId"=>12345, "groupName"=>"High Street Company", "roleDescription"=>"Provides users with the maximum access to users.", "roleId"=>3, "roleName"=>"Admin", "subGroups"=>[{"groupId"=>54321, "groupName"=>"Internet Company", "subGroups"=>[{"groupId"=>12345, "groupName"=>"Digital Company"}]}]}], "city"=>"Santa Clara", "contactType"=>"Billing", "country"=>"USA", "email"=>"jsmith@example.com", "firstName"=>"John", "jobTitle"=>"Engineer", "lastName"=>"Smith", "mobilePhone"=>"3456787657", "notifications"=>{"options"=>{"apiClientCredentialExpiryNotification"=>true, "newUserNotification"=>true, "passwordExpiry"=>true, "proactive"=>["EdgeScape", "EdgeSuite (HTTP Content Delivery)"], "upgrade"=>["NetStorage", "Other Upgrade Notifications (Planned)"]}, "enableEmailNotifications"=>true}, "phone"=>"(123) 321-1234", "preferredLanguage"=>"English", "secondaryEmail"=>"john-smith@example.com", "sessionTimeOut"=>64800, "state"=>"CA", "timeZone"=>"GMT", "zipCode"=>"34567"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"actions":{"delete":true,"apiClient":true,"edit":true,"isCloneable":true,"resetPassword":true,"thirdPartyAccess":false},"additionalAuthentication":"TFA","additionalAuthenticationConfigured":false,"address":"first Street","authGrants":[{"groupId":12345,"groupName":"Main Street Corporatio","roleDescription":"Provides the maximum access to users.","roleId":3,"roleName":"Admin","subGroups":[{"groupId":54321,"groupName":"Internet Company","subGroups":[{"groupId":54321,"groupName":"Digital Company"}]}]}],"city":"Santa Clara","contactType":"Billing","country":"USA","email":"jsmith@example.com","firstName":"John","lastName":"Smith","notifications":{"options":{"apiClientCredentialExpiryNotification":true,"newUserNotification":true,"passwordExpiry":true,"proactive":["Security"],"upgrade":["24x7"]},"enableEmailNotifications":true},"passwordExpiryDate":"2018-05-05T22:38:39.000Z","phone":"(123) 321-1234","preferredLanguage":"English","sessionTimeOut":64800,"state":"CA","timeZone":"GMT","uiIdentityId":"A-BC-1234567","uiUserName":"john.sith@example.com"}