searchUsers

searchUsers

Function
searchUsers(searchIUserSearchOptions | SearchQueryBuilder): Promise<ISearchResult<IUser>>

Search a portal for users.

1
2
3
4
import { searchUsers } from "@esri/arcgis-rest-portal";
//
searchUsers({ q: 'tommy', authentication })
  .then(response) // response.total => 355
Parameters
ParameterTypeNotes
search
IUserSearchOptions | SearchQueryBuilder

A RequestOptions object to pass through to the endpoint.

Returns 
Promise<ISearchResult<IUser>>

A Promise that will resolve with the data from the response.

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