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.
Get the Marking with the specified id.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.
objectstringThe ID of a security marking.
stringThe ID of a marking category. For user-created categories, this will be a UUID. Markings associated with Organizations are placed in a category with ID "Organization".
stringstringstringIf this marking is associated with an Organization, its RID will be populated here.
stringThe time at which the resource was created.
stringThe Foundry user who created this resource
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/markings/18212f9a-0e63-4b79-96a0-aae04df23336?preview=true"1
2
3
4
5
6
7
8
9
{
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
"name": "PII",
"description": "Contains personally identifiable information about our customers",
"createdTime": "2003-05-06T12:34:56.789Z",
"id": "18212f9a-0e63-4b79-96a0-aae04df23336",
"categoryId": "0950264e-01c8-4e83-81a9-1a6b7f77621a"
}| Error Name | ||
|---|---|---|
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | You do not have permission to view the marking. | |
| Parameters | markingId | |
Marking | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Marking could not be found. | |
| Parameters | markingId | |
See Errors for a general overview of errors in the platform.