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

Interface: SearchBmUsersOptions

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

Options for searching BM users.

Searchable fields per the Data API spec: login, email, first_name, last_name, external_id, last_login_date, is_locked, is_disabled.

Properties

count?

optional count: number

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

Number of items to return (default 25)

---

disabled?

optional disabled: boolean

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

Match disabled users

---

email?

optional email: string

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

Match users with a specific email

---

locked?

optional locked: boolean

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

Match locked users

---

login?

optional login: string

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

Match users with a specific login

---

query?

optional query: unknown

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

Pre-built OCAPI query object (e.g. {text_query: {fields: ['login'], search_phrase: 'foo'}}). If omitted, one is built from the convenience flags below.

---

searchPhrase?

optional searchPhrase: string

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

Free-text phrase searched across login/email/first_name/last_name

---

select?

optional select: string

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

Property selector (default returns shallow user fields)

---

sortBy?

optional sortBy: string

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

Field to sort by (e.g. 'login', 'email', 'last_login_date')

---

sortOrder?

optional sortOrder: "asc" | "desc"

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

Sort direction

---

start?

optional start: number

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

Start index (default 0)