@esri/arcgis-rest-portal/dist/esm/users/search-users.d.ts

ArcGIS Online and Enterprise content and user helpers for @esri/arcgis-rest-request

import { IAuthenticationManager, IUser } from "@esri/arcgis-rest-request";
import { SearchQueryBuilder } from "../util/SearchQueryBuilder.js";
import { ISearchOptions, ISearchResult } from "../util/search.js";
export interface IUserSearchOptions extends ISearchOptions {
    authentication: IAuthenticationManager;
}
/**
 * Search a portal for users.
 *
 * ```js
 * import { searchUsers } from "@esri/arcgis-rest-portal";
 * //
 * searchUsers({ q: 'tommy', authentication })
 *   .then(response) // response.total => 355
 * ```
 *
 * @param search - A RequestOptions object to pass through to the endpoint.
 * @returns A Promise that will resolve with the data from the response.
 */
export declare function searchUsers(search: IUserSearchOptions | SearchQueryBuilder): Promise<ISearchResult<IUser>>;
/**
 * ```js
 * import { searchCommunityUsers } from "@esri/arcgis-rest-portal";
 * //
 * searchCommunityUsers({ q: 'tommy', authentication })
 *   .then(response) // response.total => 355
 * ```
 * Search all portals for users.
 *
 * @param search - A RequestOptions object to pass through to the endpoint.
 * @returns A Promise that will resolve with the data from the response.
 */
export declare function searchCommunityUsers(search: IUserSearchOptions | SearchQueryBuilder): Promise<ISearchResult<IUser>>;