Interface MembershipsApiMembershipsListRequest

Request parameters for membershipsList operation in MembershipsApi.

Export

MembershipsApiMembershipsListRequest

Hierarchy

  • MembershipsApiMembershipsListRequest

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;].

Memberof

MembershipsApiMembershipsList

org?: string

Organization unique slug

Memberof

MembershipsApiMembershipsList

orgId?: number

Organization identifier

Memberof

MembershipsApiMembershipsList

page?: number

A page number within the paginated result set.

Memberof

MembershipsApiMembershipsList

pageSize?: number

Number of results to return per page.

Memberof

MembershipsApiMembershipsList

A simple equality filter for the role field

Memberof

MembershipsApiMembershipsList

search?: string

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

Memberof

MembershipsApiMembershipsList

sort?: string

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

Memberof

MembershipsApiMembershipsList

user?: string

A simple equality filter for the user field

Memberof

MembershipsApiMembershipsList

xOrganization?: string

Organization unique slug

Memberof

MembershipsApiMembershipsList

Generated using TypeDoc