Create User

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 createUser 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

ParameterDetails

username

(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
Use dark colors for code blocksCopy
1
username=jdoe@domain.com

password

The password for the account. This is a required parameter only if provider is arcgis; otherwise, the password parameter is ignored.

Example
Use dark colors for code blocksCopy
1
password=secretpassword

firstname

(Required)

The first name for the user account.

Example
Use dark colors for code blocksCopy
1
firstname=John

lastname

(Required)

The last name for the user account.

Example
Use dark colors for code blocksCopy
1
lastname=Doe

role

The role for the user account. The default value is org_user. For more information on roles, see User types, roles, and privileges.

Values: org_admin | org_publisher | org_user | iBBBBBBBBBBBBBBB (Data Editor) | iAAAAAAAAAAAAAAA (Viewer)

userLicenseTypeId

(Required)

The user type for the account.

Values: creatorUT | editorUT | GISProfessionalStdUT | GISProfessionalAdvUT | viewerUT | fieldWorkerUT

email

(Required)

The email address for the user account.

Example
Use dark colors for code blocksCopy
1
email=jdoe@email.com

provider

The provider for the account. The default value is arcgis.

Values: arcgis | enterprise

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
Use dark colors for code blocksCopy
1
idpUsername=domain\jdoe

description

A string that gives a description string for the user account.

Example
Use dark colors for code blocksCopy
1
description=A publisher account for John Doe.

applyDefaults

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 true, new member defaults are applied to the user. This parameter can still be set to true even if there are no new member defaults configured for the organization. If set to false, the new member defaults are not applied. The default value is true.

Values: true | false

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:

Use dark colors for code blocksCopy
1
2
3
4
5
6
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

Use dark colors for code blocksCopy
1
2
3
{
  "status": "success"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.