Interface MembershipsApiMembershipsListRequest

Request parameters for membershipsList operation in MembershipsApi.

MembershipsApiMembershipsListRequest

interface MembershipsApiMembershipsListRequest {
    filter?: string;
    org?: string;
    orgId?: number;
    page?: number;
    pageSize?: number;
    role?: MembershipsListRoleEnum;
    search?: string;
    sort?: string;
    user?: 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;user&#39;, &#39;role&#39;, &#39;id&#39;].

MembershipsApiMembershipsList

org?: string

Organization unique slug

MembershipsApiMembershipsList

orgId?: number

Organization identifier

MembershipsApiMembershipsList

page?: number

A page number within the paginated result set.

MembershipsApiMembershipsList

pageSize?: number

Number of results to return per page.

MembershipsApiMembershipsList

A simple equality filter for the role field

MembershipsApiMembershipsList

search?: string

A search term. Available search_fields: (&#39;user&#39;, &#39;role&#39;)

MembershipsApiMembershipsList

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;user&#39;, &#39;role&#39;, &#39;id&#39;]

MembershipsApiMembershipsList

user?: string

A simple equality filter for the user field

MembershipsApiMembershipsList

xOrganization?: string

Organization unique slug

MembershipsApiMembershipsList