Cognite JavaScript SDK > Groups

Class: Groups

Hierarchy

Groups

Index

Methods


Methods

<Static> addUsers

addUsers(groupId: number, userIds: number[]): Promise<void>

Defined in Groups.ts:220

Parameters:

Name Type
groupId number
userIds number[]

Returns: Promise<void>


<Static> create

create(groups: Partial<Group>[]): Promise<Group[]>

Defined in Groups.ts:187

Parameters:

Name Type
groups Partial<Group>[]

Returns: Promise<Group[]>


<Static> delete

delete(groupIds: number[]): Promise<void>

Defined in Groups.ts:198

Parameters:

Name Type
groupIds number[]

Returns: Promise<void>


<Static> list

list(params?: GroupListParams): Promise<Group[]>

Defined in Groups.ts:206

Parameters:

Name Type
Optional params GroupListParams

Returns: Promise<Group[]>


<Static> listUsers

listUsers(groupId: number): Promise<User[]>

Defined in Groups.ts:214

Parameters:

Name Type
groupId number

Returns: Promise<User[]>


<Static> removeUsers

removeUsers(groupId: number, userIds: number[]): Promise<void>

Defined in Groups.ts:231

Parameters:

Name Type
groupId number
userIds number[]

Returns: Promise<void>