Skip To Content
ArcGIS Developers
Dashboard

Create User

Description

The operation pre-creates either a built-in (arcgis) or enterprise user account, the designation of which is specified with the provider parameter.

Note:

When ArcGIS Enterprise on Kubernetes is connected to an enterprise identity store, users sign in using heir enterprise credentials. By default, new installations do not allow accounts from an enterprise identity store to be registered automatically.

Request parameters

ParameterDetails
username

(Required)

The name of the user account. Eligible user names must be at least 6 characters in length, using alphanumeric values with only the following symbols allowed:

  • @
  • _
  • ,
  • -

username=KubeAdmin
password

(Optional)

The password for the account. This is a required parameter only if provider is arcgis; otherwise, the password parameter is ignored. Eligible passwords must be at least 8 characters in length, contain at least one letter (A-Z, a-z) and one number (0-9). All special characters are supported.

password=test.pass1
firstname

(Required)

The first name for the user account.

firstname=John
lastname

(Required)

The last name for the user account.

lastname=Smith
role

(Required)

The role for the user account. The default value is org_user.

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

userLicenseTypeId

(Required)

The user type for the account.

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

email

(Required)

The email address for the user account.

Example

email=jsmith@org.com
provider

(Required)

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

Values: arcgis | enterprise

idpUsername

(Optional)

The name of the user as stored by the enterprise user store. This parameter is only required if the provider parameter is enterprise.

Example

idpUsername=domain\jsmith
description

(Optional)

An optional description for the user account

Example

description=An administrator account for John Doe.
f

The response format. The default response is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the createUser operation:

POST /context/admin/orgs/0123456789ABCDEF/security/users/createUser HTTP/1.1
Host: organization.domain.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=&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

JSON Response example

{"status": "success"}

Below 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
  }
}

Below 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
  }
}