Interface SearchUsersRequest

interface SearchUsersRequest {
    filter: { email?: string; name?: string; username?: string };
    page: SearchPageRequest;
    sort: { field: "name" | "username" | "email"; order?: "ASC" | "DESC" }[];
}

Index

Properties

filter page sort

Properties

filter

filter: { email?: string; name?: string; username?: string }

User search filter.

Type declaration

Optionalemail?: string
The email of the user.
Optionalname?: string
The name of the user.
Optionalusername?: string
The username of the user.

page

page: SearchPageRequest

Pagination criteria.

sort

sort: { field: "name" | "username" | "email"; order?: "ASC" | "DESC" }[]

Sort field criteria.

Type declaration

field: "name" | "username" | "email"
The field to sort by.
Optionalorder?: "ASC" | "DESC"
The order in which to sort the related field.

Interface SearchUsersRequest

Index

Properties

Properties

filter

Type declaration

`Optional`email?: string

`Optional`name?: string

`Optional`username?: string

page

sort

Type declaration

field: "name" | "username" | "email"

`Optional`order?: "ASC" | "DESC"

Settings

On This Page

Interface SearchUsersRequest

Index

Properties

Properties

filter

Type declaration

Optionalemail?: string

Optionalname?: string

Optionalusername?: string

page

sort

Type declaration

field: "name" | "username" | "email"

Optionalorder?: "ASC" | "DESC"

Settings

On This Page

`Optional`email?: string

`Optional`name?: string

`Optional`username?: string

`Optional`order?: "ASC" | "DESC"