ListUsersOptions

Filters for listUsers. All filters are AND-combined.

Index

Properties

• email
• externalUsername
• includeDeleted
• limit
• page
• q

Properties

optionalemail

email?: string

Case-insensitive exact match on email. Unlike the fuzzy q search this never matches substrings. May yield 0..n users — the field is not unique. Empty strings are treated as "no filter".

optionalexternalUsername

externalUsername?: string

Case-insensitive exact match on external username. Unlike the fuzzy q search this never matches substrings. May yield 0..n users — the field is not unique. Empty strings are treated as "no filter".

optionalincludeDeleted

includeDeleted?: boolean

When true, includes soft-deleted users. Requires Edit on the global principal-management scope; the request fails with 403 otherwise.

optionallimit

limit?: number

Maximum number of items to return (max 1000). Defaults to 500.

optionalpage

page?: string

Pagination token from a previous response's pagination.nextPage.

optionalq

q?: string

Case-insensitive free-text search matched against external username, email, first name, and last name (never the opaque username). Empty strings are treated as "no filter".