RoleCache

class pyatlan.cache.role_cache.RoleCache(client: AtlanClient)

Lazily-loaded cache for translating Atlan-internal roles into their various IDs.

get_id_for_name(name: str) → str | None

Translate the provided human-readable role name to its GUID.

Parameters:

name – human-readable name of the role

Returns:

unique identifier (GUID) of the role

get_name_for_id(idstr: str) → str | None

Translate the provided role GUID to the human-readable role name.

Parameters:

idstr – unique identifier (GUID) of the role

Returns:

human-readable name of the role

is_api_token_user() → bool

Check if the current user is authenticated via an API token or OAuth client. This method checks for the presence of $api-token-default-access or $admin roles.

Returns:

True if the user is an API token user, False otherwise

validate_idstrs(idstrs: Iterable[str])

Validate that the given role GUIDs are valid. A ValueError will be raised in any are not.

Parameters:

idstrs – a collection of unique identifiers (GUID) of the roles to be checked