List principals

async AsyncCogniteClient.iam.principals.list( types: str | Sequence[str] | None = None, limit: int = 25, ) → PrincipalList

List principals in the organization.

Parameters:

types (str | Sequence[str] | None) – Filter by principal type(s). Defaults to None, which means no filtering.
limit (int) – The maximum number of principals to return. Defaults to 25.

Returns:

The principal of the user running the code, i.e. the principal this CogniteClient was instantiated with.

Return type:

PrincipalList

Examples

List principals in the organization:

>>> from cognite.client import CogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.iam.principals.list(types="USER", limit=10)