List groups

async AsyncCogniteClient.iam.groups.list(

all: bool = False,

) → GroupList

List groups.

Parameters:

all (bool) – Whether to get all groups, only available with the groups:list acl.

Returns:

List of groups.

Return type:

GroupList

Example

List your own groups:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> my_groups = client.iam.groups.list()

List all groups:

>>> all_groups = client.iam.groups.list(all=True)