Search Users

URL:
https://<root>/security/users/search
Methods:
POST
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

The search operation searches for a specific user, or a group of users, from the user store. The size of the search result can be controlled with the maxCount parameter.

Request parameters

ParameterDescription

filter

A filter string to search the users.

Example
1
filter=john

maxCount

The maximum number of users that will be returned.

Example
1
maxCount=20

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the search operation that seeks to return the first 20 users whose usernames start with 'john':

1
2
3
4
5
6
POST /webadaptor/admin/security/users/search HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

filter=john&maxCount=20&f=json

JSON Response syntax

1
2
3
4
{
  "users": [<user1>, <user2>],
  "hasMore": <true|false>
}

JSON Response example

1
2
3
4
{
  "users": [johnDoe, johnDern],
  "hasMore": false
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close