Reference for hub_sdk/base/auth.py
Note
This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/auth.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
hub_sdk.base.auth.Auth
Represents an authentication manager.
Attributes:
Name | Type | Description |
---|---|---|
api_key |
(str, None)
|
The API key used for authentication. |
id_token |
(str, None)
|
The authentication token. |
Source code in hub_sdk/base/auth.py
authenticate
Attempt to authenticate with the server using either id_token or API key.
Returns:
Type | Description |
---|---|
bool
|
True if authentication is successful, False otherwise. |
Raises:
Type | Description |
---|---|
ConnectionError
|
If request response fails, raise connection error exception. |
Source code in hub_sdk/base/auth.py
authorize
Authorize the user by obtaining an idToken through a POST request with email and password.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
email |
str
|
User's email. |
required |
password |
str
|
User's password. |
required |
Returns:
Type | Description |
---|---|
bool
|
True if authorization is successful, False otherwise. |
Source code in hub_sdk/base/auth.py
get_auth_header
Get the authentication header for making API requests.
Returns:
Type | Description |
---|---|
Optional[dict]
|
The authentication header if id_token or API key is set, None otherwise. |
Source code in hub_sdk/base/auth.py
get_state
Get the authentication state.
Returns:
Type | Description |
---|---|
bool
|
True if either id_token or API key is set, False otherwise. |
set_api_key
Set the API key for authentication.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The API key string. |
required |