Authentication information and impersonation#
For usage information and examples, see Authentication information and impersonation
- DSSClient.get_auth_info(with_secrets=False)
Returns various information about the user currently authenticated using this instance of the API client.
This method returns a dict that may contain the following keys (may also contain others):
authIdentifier: login for a user, id for an API key
groups: list of group names (if context is an user)
secrets: list of dicts containing user secrets (if context is an user)
- Param:
with_secrets boolean: Return user secrets
- Returns:
a dict
- Return type:
dict
- DSSClient.get_auth_info_from_browser_headers(headers_dict, with_secrets=False)
Returns various information about the DSS user authenticated by the dictionary of HTTP headers provided in headers_dict.
This is generally only used in webapp backends
This method returns a dict that may contain the following keys (may also contain others):
authIdentifier: login for a user, id for an API key
groups: list of group names (if context is an user)
secrets: list of dicts containing user secrets (if context is an user)
- Param:
headers_dict dict: Dictionary of HTTP headers
- Param:
with_secrets boolean: Return user secrets
- Returns:
a dict
- Return type:
dict