@salesforce/b2c-tooling-sdk / operations/bm-users / searchBmUsers

Function: searchBmUsers()

searchBmUsers(instance, options): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/bm-users/users.ts:223

Searches users on an instance.

Supports either a fully-formed OCAPI query (options.query) or convenience flags (searchPhrase, login, email, locked, disabled) which are combined into a bool_query. If no criteria are provided a match_all_query is used.

Parameters

instance

B2CInstance

B2C instance

options

SearchBmUsersOptions = {}

Search options

Returns

Promise<{ }>

User search result