/users: Organization Users

URL:: https://[root]/portals/[portalID]/users
Methods:: GET

Example usage

The following is a sample ArcGIS Online request URL for the users resource, which is used to retrieve a list of users registered with the organization. The results will start with the eleventh entry, sorted by the full names of users in ascending order.

Use dark colors for code blocksCopy
https://org.machine.com/sharing/rest/portals/0123456789ABCDEF/users?start=11&num=50&sortField=fullName&sortOrder=asc&f=pjson

The following is a sample ArcGIS Enterprise request URL for the users resource, which is used to retrieve a list of users registered with the organization. The results will start with the eleventh entry, sorted by the full names of users in ascending order.

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/users?start=11&num=50&sortField=fullName&sortOrder=asc&f=pjson

Description

The users resource lists all the members of the organization. The start and num paging parameters are supported.

Request parameters

Parameter	Details
`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 Use dark colors for code blocksCopy `1 2 //return result 11 as the first entry in the response start=11`
`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 the `num` value. This happens when the number of results remaining after the `start` value is less than the `num` value.
`sortField`	The field used to sort users. If this is not included in the request, the default is for the list to be sorted by username. Values: `username` \| `fullname` \| `created` \| `lastlogin` \| `mfaenabled` \| `level` \| `role`
`sortOrder`	Specify whether the user list is returned in ascending or descending order. Values: `asc` \| `desc`
`userLicenseType`	Filter users by their user license type ID.
`provider`	Filter users by their identity providers. Values: `arcgis` \| `enterprise` \| `facebook` \| `google` \| `apple` \| `github`
`role`	Filter users by their roles. Values: `org_admin` (default organization admins) \| `org_publisher` (default organization publishers) \| `org_user` (default organization users) \| custom role ID (users in a specific custom role)
`fullname`	Filter users by their full name.
`username`	Filter users by their username.
`firstname`	Filter users by their first name.
`lastname`	Filter users by their last name.
`categories`	Filter users by categories. Example Use dark colors for code blocksCopy `1 2 categories=categories/USA/redlands` Note The `null` value can be used to filter users with no categories assigned to them. Example Use dark colors for code blocksCopy `1 2 categories=null`
`applyFiltersIntersection`	If `true`, two or more filters will be applied with the `AND` operator; otherwise, if `false`, two or more filters will be applied with the `OR` operator. For example, the `userLicenseType` and `role` filters are more appropriate to be applied with an AND operator, whereas OR may suit the `fullname`, `username`, and `firstname` filters better. Values: `true` \| `false`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

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 the sections below to see which user properties are returned by this resource. For a full list of user information, see the User resource.

JSON Response syntax

Use dark colors for code blocksCopy
{
  "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>",

    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "total": 22,
  "start": 11,
  "num": 50,
  "nextStart": -1,
  "users": [
    {
      "username": "asmith",
      "id": "61e2ab78ff17b5fda94a8a212ba5df10",
      "fullName": "Aaron Smith",
      "availableCredits": 156,
      "assignedCredits": 200,
      "firstName": "Aaron",
      "lastName": "Smith",
      "preferredView": GIS,
      "description": null,
      "email": "asmith@esri.com",
      "idpUsername": null,
      "favGroupId": "ac0358ef58744067b94edcc001803adb",
      "lastLogin": 1542753677000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 6037704,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "org_admin",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1308268264000,
      "modified": 1309282262000,
      "provider": "arcgis",

    },
    {
      "username": "bSmith",
      "id": "264c8943e7b40cd8fba69cf4f6ac7e7",
      "fullName": "Benson Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Benson",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "bsmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "dCuFMuHWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "cSmith",
      "id": "316d5248a7b21da8fba69cf4f6ac7e7",
      "fullName": "Caitlin Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Caitlin",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "csmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "cBaMDhaWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "dSmith",
      "id": "813d67140a7b64cd8fba69cf4f6ac7e7",
      "fullName": "Denise Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Denise",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "dsmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "dUmBAmbWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "eSmith",
      "id": "912c7165a7b27cd8fba69cf4f6ac7e7",
      "fullName": "Eddie Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Eddie",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "eSmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "zAyDHyuWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "fSmith",
      "id": "489d37260a7d26cd8fba69cf4f6ac7e7",
      "fullName": "Franny Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Franny",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "fsmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "GmUDMvuWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "gSmith",
      "id": "257d6491e7b61cd8fba69cf4f6ac7e7",
      "fullName": "Gregory Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Gregory",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "gSmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "KdmBFuyWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "hSmith",
      "id": "369e18549f7b40cd8fba69cf4f6ac7e7",
      "fullName": "Horton Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Horton",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "hsmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "ZDaMFyuWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "iSmith",
      "id": "914a1849b7b40cd8fba69cf4f6ac7e7",
      "fullName": "Ingrid Wilson",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Ingrid",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "ismith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "BmyDHmaWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "jSmith",
      "id": "326c42150f7b40cd8fba69cf4f6ac7e7",
      "fullName": "Jason Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Jason",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "jsmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "dzNDHyuWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "kSmith",
      "id": "256d97610f7b40cd8fcd69cf4f6ac7e7",
      "fullName": "Kenny Smith",
      "availableCredits": 89,
      "assignedCredits": 200,
      "firstName": "Kenny",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "ksmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "MybDHyuWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
    {
      "username": "lSmith",
      "id": "721b14690e7b40ab8fba69cf4f6ac7e7",
      "fullName:" "Lean Smith",
      "availableCredits": 50,
      "assignedCredits": 200,
      "firstName": "Lean",
      "lastName": "Smith",
      "preferredView": "Web",
      "description": null,
      "email": "lSmith@esri.com",
      "idpUsername": null,
      "favGroupId": "caf9947676ae4aba8ee188ac260cd908",
      "lastLogin": 1542678075000,
      "mfaEnabled": false,
      "access": "public",
      "storageUsage": 321389,
      "storageQuota": 2147483648,
      "orgId": "0123456789ABCDEF",
      "role": "zAyDMsaWBbTvRkT2",
      "userLicenseTypeId": "creatorUT",
      "disabled": false,
      "tags": [],
      "culture": "en",
      "cultureFormat": "us",
      "region": "US",
      "units": "english",
      "thumbnail": null,
      "created": 1251912434000,
      "modified": 1309885754000,
      "provider": "arcgis",

    }
  ]
}