Search documentation
karat

+

K

User Documentation ↗

List Marking Members

GET/api/v2/admin/markings/{markingId}/markingMembers
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.

Lists all principals who can view resources protected by the given Marking. Ignores the pageSize parameter. Requires api:admin-write because only marking administrators can view marking members.

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

Path parameters

markingId
string

The ID of a security marking.

Query parameters

transitive
boolean
optional

When true, includes the transitive members of groups contained within groups that are members of this Marking. For example, say the Marking has member Group A, and Group A has member User B. If transitive=false only Group A will be returned, but if transitive=true, then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting.

Defaults to false.

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

ListMarkingMembersResponse
object
Hide child attributes

Hide child attributes

data
list<MarkingMember>
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/markingMembers?pageSize=100&pageToken=v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z&preview=true"

Response

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