Class SecurityCategoriesAPI

Deprecated

Asset-centric API, deprecated 2026-10-15 and retired 2027-12-31. Will be removed or moved in a future major release. See https://docs.cognite.com/cdf/deprecated and https://github.com/cognitedata/cognite-sdk-js/blob/master/guides/DEPRECATIONS.md.

Hierarchy

BaseResourceAPI<SecurityCategory>
- SecurityCategoriesAPI

Index

Methods

create delete list

Methods

create

create(items): Promise<SecurityCategory[]>
Create security categories
```
const securityCategories = [
  { name: 'Admins' },
  { name: 'Developers' },
];
const createdSecurityCategories = await client.securityCategories.create(securityCategories);
```
Parameters
- items: SecurityCategorySpec[]
Returns Promise<SecurityCategory[]>
Deprecated
Asset-centric API, deprecated 2026-10-15 and retired 2027-12-31. Will be removed or moved in a future major release.
- Defined in packages/stable/src/api/securityCategories/securityCategoriesApi.ts:31

delete

delete(ids): Promise<object>
Delete security categories
```
await client.securityCategories.delete([123, 456]);
```
Parameters
- ids: number[]
Returns Promise<object>
Deprecated
Asset-centric API, deprecated 2026-10-15 and retired 2027-12-31. Will be removed or moved in a future major release.
- Defined in packages/stable/src/api/securityCategories/securityCategoriesApi.ts:61

list

list(query?): CursorAndAsyncIterator<SecurityCategory>
List security categories
```
const securityCategories = await client.securityCategories.list({ sort: 'ASC' });
```
Parameters
- Optionalquery: ListSecurityCategories
Returns CursorAndAsyncIterator<SecurityCategory>
Deprecated
Asset-centric API, deprecated 2026-10-15 and retired 2027-12-31. Will be removed or moved in a future major release.
- Defined in packages/stable/src/api/securityCategories/securityCategoriesApi.ts:46