- URL:
- https://<root>/security/users/createUser
- Methods:
POST
- Required Capability:
- Access allowed with either the "Security and Infrastructure" or "Add" privileges
- Version Introduced:
- 10.2.1
Description
The create
operation allows organization administrators to pre-create either a built-in or enterprise accounts for an organization member. The type of account is determined by the value set for the provider
parameter.
Request parameters
Parameter | Details |
---|---|
(Required) | The name of the user account. Usernames must be within a 6-24 character range. Only alphanumeric ASCII characters or underscores are supported. Example
|
| The password for the account. This is a required parameter only if Example
|
(Required) | The first name for the user account. Example
|
(Required) | The last name for the user account. Example
|
| 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
|
| The provider for the account. The default value is Values: |
| The name of the user as stored by the enterprise user store. This parameter is only required if the provider parameter is Example
|
| A string that gives a description string for the user account. 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 format is Values: |
Example usage
The following is a sample POST request for the create
operation:
POST /<context>/portaladmin/security/users/createUser HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=jdoe&password=test1234&firstname=Joe&lastname=Doe&role=org_user&userLicenseTypeId=creatorUT&email=joedoe@domain.com&provider=arcgis&idpUsername=&description=Creator+account+for+Joe+Doe&f=json
JSON Response example
{
"status": "success"
}