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.
Creates a new MarkingCategory.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.
objectobjectThe initial permissions for the Marking Category. This can be changed later through MarkingCategoryPermission operations. The provided permissions must include at least one ADMINISTER role assignment.
WARNING: If you do not list your own principal ID or the ID of a Group that you are a member of as an ADMINISTER, you will create a Marking Category that you cannot administer.
stringstringobjectThe created MarkingCategory
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".
stringstringstring (enum)Enum values: CONJUNCTIVE, DISJUNCTIVE
string (enum)Enum values: MANDATORY, CBAC
list<MarkingId>stringThe time at which the resource was created.
stringThe Foundry user who created this resource
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/markingCategories?preview=true" \
-d '{"name":"Customer Data","description":"Markings related to data about our customers","initialPermissions":{"organizationRids":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],"roles":[{"role":"ADMINISTER","principalId":"f05f8da4-b84c-4fca-9c77-8af0b13d11de"}],"isPublic":false}}'1
2
3
4
5
6
7
8
9
10
11
12
{
"categoryType": "CONJUNCTIVE",
"markings": [
"18212f9a-0e63-4b79-96a0-aae04df23336"
],
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"name": "Customer Data",
"description": "Markings related to data about our customers",
"createdTime": "2003-05-06T12:34:56.789Z",
"id": "0950264e-01c8-4e83-81a9-1a6b7f77621a",
"markingType": "MANDATORY"
}| Error Name | ||
|---|---|---|
Create | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | At least one ADMINISTER role assignment must be provided when creating a marking category. | |
| Parameters | | |
Create | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | At least one organization must be provided when creating a marking category. | |
| Parameters | | |
Principal | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | A principal (User or Group) with the given PrincipalId could not be found | |
| Parameters | principalId | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the MarkingCategory. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.