Search for user profiles

async AsyncCogniteClient.iam.user_profiles.search(
name: str,
limit: int = 25,
) → UserProfileList

Search for user profiles.

Primarily meant for human-centric use-cases and data exploration, not for programs, as the result set ordering and match criteria threshold may change over time.

Parameters:

  • name (str) – Prefix search on name.

  • limit (int) – Maximum number of results to return.

Returns:

User profiles search result

Return type:

UserProfileList

Examples

Search for users with first (or second…) name starting with “Alex”:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.iam.user_profiles.search(name="Alex")