v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Roles

This endpoint returns a list of all role assignments in current user's account.

get/roleAssignments

Query parameters

userId__instring[]

List of user IDs to filter on that is comma separated.

[
  "abc456f"
]
roleId__instring[]

List of role IDs to filter on that is comma separated.

[
  "2428fda3-389f-48ce-b062-85875dd6b2e2"
]
roleId__containsstring

Filter to get the user role assignments whose the role ID contains the provided substring. The lookup is exact but case insensitive

roleName__containsstring

Filter to get the user role assignments whose the role name contains the provided substring. The lookup is exact but case insensitive

selfboolean

Filter to get the role assignments for the requesting user.

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Response

List of role assignments.

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger required

Size of the total result set.