- URL:https://<users-url>/createUser(POST only)
- Required Capability:Default administrator role | Security and infrastructure privilege | Add privilege
- Version Introduced:10.2.1
Description
The createUser operation allows organization administrators to pre-create either a built-in or enterprise accounts for a portal member. The type of account is determined by the value set for the provider parameter.
Note:
When an Enterprise portal is connected to an enterprise identity store, enterprise users sign in to the portal using their enterprise credentials. By default, new installations of portal do not allow accounts from an enterprise identity store to be registered to the portal automatically. Only users with accounts that have been pre-created can sign in to the portal. Alternatively, you can configure the portal to register enterprise accounts the first time the user connects to the website. See Update Security Configuration for details.
Request parameters
| Parameter | Details |
|---|---|
| username | The name of the user account. User names cannot have more than 24 characters or fewer than 6 characters. They can only contain alphanumeric ASCII characters or underscores. Example |
| password | The password for the account. This is a required parameter only if provider is arcgis; otherwise, the password parameter is ignored. Note:For the purposes of this document, the password example below and in the Example usage section is written as a clear password. When actually performing this operation in the Portal Admin API directory, the information entered for the password parameter is masked. When the request is submitted, the password information is encrypted, as access to the Portal Admin API requires HTTPS to be in place. Example |
| firstname | The first name for the user account. Example |
| lastname | The last name for the user account. Example |
| role | The role for the user account. The default value is org_user. Note:Support for defining a custom role began at 10.6.1. For more information, see User types, roles, and privileges. Values: org_admin | org_publisher | org_user | iBBBBBBBBBBBBBBB (Data Editor)| iAAAAAAAAAAAAAAA (Viewer) |
| userLicenseTypeId | The user type for the account. Values: creatorUT | editorUT | GISProfessionalAdvUT | GISProfessionalBasicUT | GISProfessionalStdUT | viewerUT | fieldWorkerUT | liteUT (Partner user type) | basicUT (Partner user type) | standardUT (Partner user type) |
The email address for the user account. Example | |
| provider | The provider for the account. The default value is arcgis. Values: arcgis | enterprise Example |
| idpUsername | The name of the user as stored by the enterprise user store. This parameter is only required if the provider parameter is enterprise. Example |
| description | An optional description string for the user account. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for the createUser operation:
POST /webadaptor/portaladmin/security/users/createUser HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=jdoe&password=test1234&firstname=Joe&lastname=Doe&role=org_user&userLicenseTypeId=creatorUT&[email protected]&provider=arcgis&idpUsername=&description=Creator+account+for+Joe+Doe&f=jsonJSON Response example
{"status": "success"}