Search documentation
karat

+

K

User Documentation ↗

List Marking Role Assignments

GET/api/v2/admin/markings/{markingId}/roleAssignments
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

List all principals who are assigned a role for the given Marking. Ignores the pageSize parameter.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

markingId
string

The ID of a security marking.

Query parameters

pageSize
integer
optional

The page size to use for the endpoint.

pageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

preview
boolean
optional

Enables the use of preview functionality.

Response body

ListMarkingRoleAssignmentsResponse
object
Hide child attributes

Hide child attributes

data
list<MarkingRoleAssignment>
optional
Show child attributes

Show child attributes

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/markings/18212f9a-0e63-4b79-96a0-aae04df23336/roleAssignments?pageSize=100&pageToken=v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z&preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 { "data": [ { "role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "principalType": "USER" } ], "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }