- URL:
- https://<root>/orgs/<orgID>/security/users/createUser
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The create operation creates either a built-in (arcgis) user account or an enterprise user account, the designation of which is specified using the provider parameter.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The name of the user account. Eligible user names must be at least six characters in length, using alphanumeric values with only the following symbols allowed:
Example |
(Optional; Required if | The password for the account. This parameter is required if the Example |
(Required) | The first name for the user account. Example |
(Required) | The last name for the user account. Example |
(Required) | The role for the user account. The default value is Values: |
(Required) | The user type for the account. Values: |
(Required) | The email address for the user account. Example |
(Required) | The provider for the account. The default value is Values: |
(Optional; Required if | The name of the user as stored by the enterprise user store. This parameter is required if the Example |
(Optional) | The user account description. Example |
| Introduced at 11.5. Determines if new member defaults (the user type, member role, add-on licenses, and group memberships that are assigned to new users by default) should be applied to the new user. If specified as Values: |
| The response format. The default response is Values: |
Example usage
The following is a sample POST request for the create operation:
POST /<context>/admin/orgs/0123456789ABCDEF/security/users/createUser HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=KubeAdmin&password=test.pass1&firstname=John&lastname=Smith&role=org_admin&userLicenseTypeId=creatorUT&email=jsmith@org.com&provider=arcgis&idpUsername=&description=&applyDefaults=true&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8CisJSON Response example
{"status": "success"}The following is a sample error message returned when the requirements for the username parameter are not met:
{
"error" : {
"code" : 500,
"message" : "\"Failed to create user 'tuser'. Invalid username specified. The username must be at least six characters and may only contain Latin-based alphanumeric characters or \"@\", \".\", and \"_\".",
"details" : null
}
}The following is a sample error message returned when the requirements for the password parameter are not met:
{
"error" : {
"code" : 500,
"message" : "The password does not meet the minimum strength requirement.",
"details" : null
}
}