The below information is a high-level overview of how to use the Auth API.
Prerequisite:
A valid user must be set up in Enable’s IAM (Okta) and assigned to the relevant groups by the RSP IAM administrator.
Steps:
- Base64 Encode your Okta username and password as "username:password".
- Send a Post request to the /token endpoint
- If successful, the response will contain the access token. This is the authorisation token that will be required to access the other Enable APIs.
Notes:
The Base64 Encode of your Okta username and password requires the colon ":"
The access token will reset every 12 hours. To allow continuous access to the Enable API’s, ensure a new token is retrieved before the previous token expires.
The table below outlines how different aspects of the Auth API operate, and how each can be used.
| Endpoint | How it works | What it can be used for |
|---|---|---|
| /token | Retrieves an authentication token | The authentication token must be used to authenticate with Enable’s other APIs |
| /version | Returns the application version information | Used to retrieve version information or to ensure the application is running |