searchUsers
FunctionsearchUsers(search: IUserSearchOptions | SearchQueryBuilder): Promise<ISearchResult<IUser>>
Search a portal for users.
import { searchUsers } from "@esri/arcgis-rest-portal";
//
searchUsers({ q: 'tommy', authentication })
.then(response) // response.total => 355
Parameters
Parameter | Type | Notes |
---|---|---|
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.