Security & Auth APIs
The Security & Auth APIs help you manage API and Session keys for secure application access. These APIs include endpoints to create, verify, and delete keys, ensuring robust security and authentication. By using these endpoints, you can control access to your services and maintain a secure environment.
Endpoints Section
Create A New Key
This API creates a new key. A key with the owner, admin, and developer roles can create a key for the same account. An API key can create an API key and a session key. If expires_in is not specified, it is set to the default duration of the key types. The default duration of a session key is within 2 hours, and for an API key, it is 7 days. If scopes are not specified, it is set to the user.
| Endpoint | /utils/auth/keys/v1 |
|---|---|
| Method | POST |
| Tags | platform, auth |
| API Playground | Click Here |
# This tab is intentionally left blank.
Who am I?
Get the information about the authenticated key. It is used to check whether the key is valid and to get the details of the key.
| Endpoint | /utils/auth/me/v1 |
|---|---|
| Method | GET |
| Tags | platform, auth |
| API Playground | Click Here |
# This tab is intentionally left blank.
Forget Me
Turn off the authenticated key. It turns off the authenticated key and deletes the cookie if it exists.
| Endpoint | /utils/auth/forget-me/v1 |
|---|---|
| Method | POST |
| Tags | platform, auth |
| API Playground | Click Here |
# This tab is intentionally left blank.
Delete Key
Delete the key by id or key. Authenticated keys with owner, admin, and developer scopes can delete keys belonging to the same account. The deletion of the authenticated key is not allowed.
| Endpoint | /utils/auth/keys/v1/{id_or_key} |
|---|---|
| Method | DELETE |
| Tags | platform, auth |
| API Playground | Click Here |
# This tab is intentionally left blank.