Version 2.0

Get Cbac Banner

GET/api/v2/admin/cbacBanner

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 a classification banner string and colors 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

displayType

string (enum)optional

The display type of the banner. Defaults to PORTION_MARKING. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs

Enum values: BANNER_LINE, PORTION_MARKING

markingIds

list<MarkingId>optional

The marking IDs for which to generate a banner. Duplicate entries are ignored.

Show child attributes

preview

booleanoptional

Enables the use of preview functionality.

Response body

CbacBanner

object

Hide child attributes

classificationString

string

The formatted classification string for the requested markings and display type.

markings

list<MarkingId>optional

The marking IDs represented by the classification string.

Show child attributes

textColor

string

The hexadecimal text color to use when displaying the banner.

backgroundColors

list<Color>optional

The hexadecimal background colors to use when displaying the banner.

Show child attributes

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/cbacBanner?displayType=PORTION_MARKING&markingIds=MTS%2CMNF&preview=true"

Response

Copied!

{
  "markings": [
    "MTS",
    "MNF"
  ],
  "backgroundColors": [
    "#FFFFFF"
  ],
  "classificationString": "MTS//MNF",
  "textColor": "#FFFFFF"
}

Error responses

Error Name
`GetCbacBannerPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The provided token does not have permission to get the CBAC banner for the markings.
	Parameters	`markingIds`
`CbacUnavailable`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	CBAC is not available.
	Parameters
`UnknownClassificationBannerDisplayType`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The provided classification banner display type is not recognized.
	Parameters	`displayType`
`CbacBannerNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given CbacBanner could not be found.
	Parameters

See Errors for a general overview of errors in the platform.