Get Enterprise User | ArcGIS REST APIs

URL:: https://<root>/orgs/<orgID>/security/users/getEnterpriseUser
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.

Security and infrastructure

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 generateToken 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.

Learn how to generate a token

Description

The getEnterpriseUser operation returns the description, full name, and email address for a single user in the enterprise identity user store configured with the organization. If the user does not exist, an error is returned.

Request parameters

Parameter Details

Parameter	Details
`username`	The username of the enterprise account. For Windows Active Directory users, this can be either `domain/username` or `username`. For LDAP users, the format is always `username`. Example Use dark colors for code blocksCopy `1 2 3 4 5 //Windows Active Directory username=domain\aturing //LDAP username=jdoe`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

username

The username of the enterprise account. For Windows Active Directory users, this can be either domain/username or username. For LDAP users, the format is always username.

Example
Use dark colors for code blocksCopy
//Windows Active Directory
username=domain\aturing

//LDAP
username=jdoe

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

Use dark colors for code blocksCopy
POST /<context>/admin/orgs/0123456789ABCDEF/security/users/getEnterpriseUser
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

username=jdoe&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

JSON Response example

Use dark colors for code blocksCopy
{
  "username": "john",
  "fullname": "John Doe",
  "description": "cn=John Doe,ou=users,ou=ags,dc=domain",
  "email": "john_doe@email.com"
}