ArcGIS REST API

Users

Description

Lists all the members of the organization. The start and num paging parameters are supported.

Request Parameters

ParameterDetails
[Common Parameters]

For a complete listing, see Common parameters.

start

The number of the first entry in the result set response. The index number is 1-based.

The default value of start is 1 (that is, the first search result).

The start parameter, along with the num parameter, can be used to paginate the search results.

Example: start=11 (return result #11 as the first entry in the response)

num

The maximum number of results to be included in the result set response.

The default value is 10, and the maximum allowed value is 100.

The start parameter, along with the num parameter, can be used to paginate the search results.

Note:

The actual number of returned results may be less than num. This happens when the number of results remaining after start is less than num.

sortField

The field to sort users by.

Values: username | fullname | created | lastlogin | mfaenabled | level | role

sortOrder

Describe whether the user order returns in ascending or descending order.

Values: asc | desc

userLicenseType

Filter users by their user license type ID.

Example: creatorUT

provider

Filter users by their identity providers.

Values: arcgis | enterprise | facebook | google

role

Filter users by their roles.

Values: org_admin (default org admins) | org_publisher (default org publishers) | org_user (default org users) | custom role ID (users in a specific custom role)

fullname

Filter users by their full name.

username

Filter users by their user name.

firstname

Filter users by their first name.

lastname

Filter users by their last name.

applyFiltersIntersection

If true, two or more filters will be applied with "AND" operator, otherwise "OR" is used. For example, userLicenseType, role filters are more appropriate to be applied with an "AND" whereas "OR" may suit fullname, username, firstname filters better.

Response Properties

PropertyDetails
total

The total number of results found.

start

The number of the first entry in the result set response. The index number is 1-based.

num

The number of results included in this result set response.

nextStart

The next entry index if the current result set doesn't contain all results.

users

A JSON array of user objects. See User for possible response properties.

Example Usage

https://www.arcgis.com/sharing/rest/portals/fa019fbbfbb845d08cc9f0acde6dd8af/users

JSON Response Syntax

{
  "total": <total number of results>,  
  "start": <results in first set>,  
  "num": <number of results per page>,  
  "nextStart": <result number of next page>,  
  "users": [
    {
  "username": "<username>",
  "id": "<user id>",
  "fullName": "<first name> <last name>",
  "availableCredits": <available credits>,
  "assignedCredits": <assigned credits>,
  "firstName": "<first name>",
  "lastName": "<last name>",
  "preferredView":"Web | GIS | null,
  "description": "<description>",
  "email": "<email address>",
  "idpUsername": "<idp username>",
  "favGroupId": "<favorite group id>",
  "lastLogin": <last login date in UNIX time>,
  "mfaEnabled": true | false,
  "access": "public | org | private",
  "storageUsage": <storage used - bytes>,      
  "storageQuota": <storage quota - bytes>,  
  "orgId": "<organization id>",
  "role": "<role id>",
  "userLicenseTypeId": "<user license type ID>",
  "tags":[        
		  "<tag1>",              
		  "<tag2>"      
    ], 
  "disabled": true | false,
  "culture": "<culture code>",
  "cultureFormat": "<culture format>",
  "region": "<region>",
  "units": "<unit>",
  "thumbnail": "<file name>",
  "created": <date created shown in UNIX time>,
  "modified": <date modified shown in UNIX time>,
  "provider": "<user provider>",
  "groups": []
    },
  ......
  ]}

JSON Response Example

{
  "total": 2,
  "start": 1,
  "num": 10,
  "nextStart": -1,
  "users": [
    {
  "username": "jsmith",
  "id": "61e2ab78ff17b5fda94a8a212ba5df10",
  "fullName": "John Smith",
  "availableCredits": 156,
  "assignedCredits": 200,
  "firstName": "John",
  "lastName": "Smith",
  "preferredView": GIS,
  "description": null,
  "email": "jsmith@esri.com",
  "idpUsername": null,
  "favGroupId": "ac0358ef58744067b94edcc001803adb",
  "lastLogin": 1542753677000,
  "mfaEnabled": false,
  "access": "public",
  "storageUsage": 6037704,
  "storageQuota": 2147483648,
  "orgId": "fa019fbbfbb845d08cc9f0acde6dd8af",
  "role": "org_admin",
  "userLicenseTypeId": "creatorUT",
  "disabled": false,
  "tags": [],
  "culture": "en",
  "cultureFormat": "us",
  "region": "US",
  "units": "english",
  "thumbnail": null,
  "created": 1308268264000,
  "modified": 1309282262000,
  "provider": "arcgis",
  "groups": []
    },
    {
  "username": "swilson",
  "id": "849a84360c7b40cd8fba69cf4f6ac7e7",
  "fullName": "Sam Wilson",
  "availableCredits": 89,
  "assignedCredits": 200,
  "firstName": "Sam",
  "lastName": "Wilson",
  "preferredView": "Web",
  "description": null,
  "email": "swilson@esri.com",
  "idpUsername": null,
  "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
  "lastLogin": 1542678075000,
  "mfaEnabled": false,
  "access": "public",
  "storageUsage": 321389,
  "storageQuota": 2147483648,
  "orgId": "fa019fbbfbb845d08cc9f0acde6dd8af",
  "role": "zAyDHyuWBbTvRkT2",
  "userLicenseTypeId": "creatorUT",
  "disabled": false,
  "tags": [],
  "culture": "en",
  "cultureFormat": "us",
  "region": "US",
  "units": "english",
  "thumbnail": null,
  "created": 1251912434000,
  "modified": 1309885754000,
  "provider": "arcgis",
  "groups": []
    }
    ]
    }