Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Cbac Marking Restrictions

GET/api/v2/admin/cbacMarkingRestrictions
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.

Returns disallowed, implied, and required markings for the given set of marking IDs.

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

Query parameters

markingIds
list<MarkingId>
optional

The marking IDs for which to get restrictions.

Show child attributes

Show child attributes

preview
boolean
optional

Enables the use of preview functionality.

Response body

CbacMarkingRestrictions
object
Hide child attributes

Hide child attributes

disallowedMarkings
list<MarkingId>
optional

Markings that cannot appear in conjunction with the provided markings. This includes all such markings, not just those present in the provided set.

Show child attributes

Show child attributes

impliedMarkings
list<MarkingId>
optional

Markings that are automatically granted when a user has membership in any of the provided markings.

Show child attributes

Show child attributes

requiredMarkings
list<array>
optional

Markings that must appear in conjunction with the provided markings. Each list contains the requirements for one of the provided markings, and at least one marking from each must be included in the provided markingIds to constitute a valid classification.

Show child attributes

Show child attributes

userSatisfiesMarkings
boolean

True if the current user satisfies the provided markings. The user must be a member of all conjunctive markings. The provided disjunctive markings are grouped by category, and the user must be a member of at least one marking in each group.

isValid
boolean

True if the provided markings constitute a valid classification, containing no disallowed markings and satisfying all required marking constraints.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/cbacMarkingRestrictions?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "disallowedMarkings": [ "18212f9a-0e63-4b79-96a0-aae04df23336" ], "requiredMarkings": [ [ "18212f9a-0e63-4b79-96a0-aae04df23336" ] ], "userSatisfiesMarkings": true, "isValid": true, "impliedMarkings": [ "18212f9a-0e63-4b79-96a0-aae04df23336" ] }

Error responses

Error Name
GetCbacMarkingRestrictionInfoPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionThe provided token does not have permission to get the CBAC marking restrictions for the markings.
ParametersmarkingIds
CbacUnavailableError CodeINVALID_ARGUMENT
Status Code400
DescriptionCBAC is not available.
Parameters
CbacMarkingRestrictionsNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given CbacMarkingRestrictions could not be found.
Parameters