Auth
RapidAuth
__init__(client_id=None, client_secret=None, url=None)
The rAPId auth class is a helper authentication class used to connect to your rAPId API instance. The authentication values can be passed into the constructor but they default to reading them from your environment variables.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
client_id |
str
|
Your rAPId API client id token. Defaults to None. |
None
|
client_secret |
str
|
Your rAPId API client secret token. Defaults to None. |
None
|
url |
str
|
The url where your rAPId API is hosted. Defaults to None. |
None
|
validate_credentials()
Tests authentication to the rAPId API.
Raises:
| Type | Description |
|---|---|
AuthenticationErrorException
|
If no authorisation can be created. |
Returns:
| Name | Type | Description |
|---|---|---|
None |
If authentication was successful. |