Interface UsersApiUsersListRequest

Request parameters for usersList operation in UsersApi.

UsersApiUsersListRequest

interface UsersApiUsersListRequest {
    filter?: string;
    firstName?: string;
    isActive?: boolean;
    lastName?: string;
    org?: string;
    orgId?: number;
    page?: number;
    pageSize?: number;
    search?: string;
    sort?: string;
    username?: string;
    xOrganization?: string;
}

Properties

filter?: string

JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;username&#39;, &#39;first_name&#39;, &#39;last_name&#39;, &#39;id&#39;, &#39;is_active&#39;].

UsersApiUsersList

firstName?: string

A simple equality filter for the first_name field

UsersApiUsersList

isActive?: boolean

A simple equality filter for the is_active field

UsersApiUsersList

lastName?: string

A simple equality filter for the last_name field

UsersApiUsersList

org?: string

Organization unique slug

UsersApiUsersList

orgId?: number

Organization identifier

UsersApiUsersList

page?: number

A page number within the paginated result set.

UsersApiUsersList

pageSize?: number

Number of results to return per page.

UsersApiUsersList

search?: string

A search term. Available search_fields: (&#39;username&#39;, &#39;first_name&#39;, &#39;last_name&#39;)

UsersApiUsersList

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;username&#39;, &#39;first_name&#39;, &#39;last_name&#39;, &#39;id&#39;, &#39;is_active&#39;]

UsersApiUsersList

username?: string

A simple equality filter for the username field

UsersApiUsersList

xOrganization?: string

Organization unique slug

UsersApiUsersList