Users

Description

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

Request Parameters

Parameter

Details

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

NoteNote:

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

level

Filter users by their levels.

Values: 1 | 2 | none

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)

Response Properties

Property

Details

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

http://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>",
  "fullName": "<first name> <last name>",
  "preferredView":"Web | GIS | null,
  "description": "<description>",
  "email": "<email address>",
  "access": "public | org | private",
  "storageUsage": <storage used - bytes>,      
  "storageQuota": <storage quota - bytes>,  
  "orgId": "<organization id>",
  "role": "<org_admin | org_publisher | org_user>",
  "tags":[        
		"<tag1>",              
		"<tag2>"      
], 
  "culture": "<culture code>",
  "region": "<region>",
  "thumbnail": "<file name>",
  "created": date created shown in UNIX time,
  "modified": date modified shown in UNIX time,
  "groups": []
    },
  {
 "username": "<username>",
  "fullName": "<first name> <last name>",
  "preferredView":"Web | GIS | null,
  "description": "<description>",
  "email": "<email address>",
  "access": "public | org | private",
  "storageUsage": <storage used - bytes>,      
  "storageQuota": <storage quota - bytes>,  
  "orgId": "<organization id>",
  "role": "<org_admin | org_publisher | org_user>",
  "tags":[        
		"<tag1>",              
		"<tag2>"      
], 
  "culture": "<culture code>",
  "region": "<region>",
  "thumbnail": "<file name>",
  "created": date created shown in UNIX time,
  "modified": date modified shown in UNIX time,
  "groups": []
    }
  ]
    }

JSON Response Example

{
  "total": 2,
  "start": 1,
  "num": 10,
  "nextStart": -1,
  "users": [
    {
  "username": "jsmith",
  "fullName": "John Smith",
  "preferredView": GIS,
  "description": null,
  "email": "jsmith@esri.com",
  "access": "public",
  "storageUsage": 6037704,
  "storageQuota": 2147483648,
  "orgId": "fa019fbbfbb845d08cc9f0acde6dd8af",
  "role": "org_admin",
  "tags": [],
  "culture": "en",
  "region": "US",
  "thumbnail": null,
  "created": 1308268264000,
  "modified": 1309282262000,
  "groups": []
    },
    {
  "username": "swilson",
  "fullName": "Sam Wilson",
  "preferredView": "Web",
  "description": null,
  "email": "swilson@esri.com",
  "access": "public",
  "storageUsage": 321389,
  "storageQuota": 2147483648,
  "orgId": "fa019fbbfbb845d08cc9f0acde6dd8af",
  "role": "org_publisher",
  "tags": [],
  "culture": "en",
  "region": "US",
  "thumbnail": null,
  "created": 1251912434000,
  "modified": 1309885754000,
  "groups": []
    }
    ]
    }

10/6/2017