arthurai.client.helper.get_auth_info#

arthurai.client.helper.get_auth_info(api_http_host, api_prefix, access_key, verify_ssl=True)#

Get the AuthInfo struct associated with the provided access key

Parameters

  • api_http_host (str) – base url of the host to connect to, including protocol (e.g. “https://app.arthur.ai”)

  • api_prefix (str) – prefix of the API to connect to (e.g. “/api/v3”)

  • access_key (str) – API token to pass to the API

  • verify_ssl (bool) – Boolean for whether requests should verify that the SSL certificate is valid and not self-signed

Return type

Optional[AuthInfo]

Returns

the AuthInfo associated with the provided access key

Permissions

N/A