Interface UsersApiListUsersRequest

Hierarchy

  • UsersApiListUsersRequest

Properties

filter? filterStatus? pageNumber? pageSize? sort? sortDir?

Properties

Optional filter

filter?: string

Filter all users by the given string. Defaults to no filtering.

Optional filterStatus

filterStatus?: string

Filter on status attribute. Comma separated list, with possible values Active, Pending, and Disabled. Defaults to no filtering.

Optional pageNumber

pageNumber?: number

Specific page number to return.

Optional pageSize

pageSize?: number

Size for a given page. The maximum allowed value is 100.

Optional sort

sort?: string

User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example sort=-name. Options: name, modified_at, user_count.

Optional sortDir

sortDir?: v2.QuerySortOrder

Direction of sort. Options: asc, desc.

Settings

Member Visibility

Theme

Generated using TypeDoc