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

Interface: SearchUsersOptions

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

Portable user search criteria supported by both backends.

Extends

• ListUsersOptions

Properties

count?

optional count: number

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

Inherited from

ListUsersOptions.count

---

disabled?

optional disabled: boolean

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

---

email?

optional email: string

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

---

locked?

optional locked: boolean

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

---

login?

optional login: string

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

---

query?

optional query: unknown

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

Raw OCAPI query. In auto mode this deliberately selects the OCAPI fallback.

---

searchPhrase?

optional searchPhrase: string

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

---

sortBy?

optional sortBy: string

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

---

sortOrder?

optional sortOrder: "asc" | "desc"

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

---

start?

optional start: number

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

Inherited from

ListUsersOptions.start