Manage security categories for a specific project. Security categories can be used to restrict access to a resource. Applying a security category to a resource means that only principals (users or service accounts) that also have this security category can access the resource. To learn more about security categories please read this page.
Required capabilities:
securityCategoriesAcl:LIST
Retrieves a list of all security categories for a project.
A list of security categories.
const securityCategories = await client.securityCategories.list({ sort: 'ASC' });
{- "items": [
- {
- "name": "Guarded by vendor x",
- "id": 0
}
], - "nextCursor": "string"
}Required capabilities:
securityCategoriesAcl:CREATE
Creates security categories with the given names. Duplicate names in the request are ignored. If a security category with one of the provided names exists already, then the request will fail and no security categories are created.
List of categories to create
required | Array of objects (SecurityCategorySpecDTO) non-empty |
A list of security categories.
{- "items": [
- {
- "name": "Guarded by vendor x"
}
]
}{- "items": [
- {
- "name": "Guarded by vendor x",
- "id": 0
}
]
}Required capabilities:
securityCategoriesAcl:DELETE
Deletes the security categories that match the provided IDs. If any of the provided IDs does not belong to an existing security category, then the request will fail and no security categories are deleted.
Empty response.
The response for a failed request.
{- "items": [
- 23872937137,
- 1238712837,
- 128371973
]
}{ }