Retrieve Postgres Gateway Users

async AsyncCogniteClient.postgres_gateway.users.retrieve(
username: str | SequenceNotStr[str],
ignore_unknown_ids: bool = False,
) → User | UserList

Retrieve a list of users by their usernames.

Retrieve a list of postgres users by their usernames, optionally ignoring unknown usernames

Parameters:

  • username (str | SequenceNotStr[str]) – Usernames of the users to retrieve.

  • ignore_unknown_ids (bool) – Ignore usernames that are not found

Returns:

The retrieved user(s).

Return type:

User | UserList

Examples

Retrieve user:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.postgres_gateway.users.retrieve("myUser", ignore_unknown_ids=True)