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.
string (enum)The display type of the banner. Defaults to PORTION_MARKING.
Enum values: BANNER_LINE, PORTION_MARKING
list<MarkingId>The marking IDs for which to generate a banner.
booleanEnables the use of preview functionality.
objectstringlist<MarkingId>stringThe hex value of a color.
list<Color>1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/cbacBanner?displayType=BANNER_LINE&preview=true"1
2
3
4
5
6
7
8
9
10
{
"markings": [
"18212f9a-0e63-4b79-96a0-aae04df23336"
],
"backgroundColors": [
"#FFFFFF"
],
"classificationString": "MTS//MNF",
"textColor": "#FFFFFF"
}| Error Name | ||
|---|---|---|
Get | 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 | |
Cbac | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | CBAC is not available. | |
| Parameters | | |
Unknown | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The provided classification banner display type is not recognized. | |
| Parameters | displayType | |
Cbac | 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.