Interface ListUsersOptions

What UserOperations.list narrows the listing by.

interface ListUsersOptions {
    search?: string;
    page?: number;
    pageSize?: number;
    timeout?: number;
}

Properties

search?: string

Keeps users whose external id, name or email matches this text, case-insensitively.

page?: number

The page to return, counting from 1. Omitted, the first.

pageSize?: number

How many users a page holds. Omitted, the service's default.

timeout?: number

Seconds to wait for this call. Defaults to the client's own timeout.