API keys

You can use API keys to access the Oblique API.

API keys have two kinds of permissions:

• Read-only: Can access all information via the Oblique API, but not perform any actions.
• Read-write: Can access all information and perform all actions via the Oblique API.

Create an API key

Caution

API keys are only shown when they are first generated. If you don’t copy the key, revoke it and generate a new one.

You must be a admin to create an API key.

Navigate to the API keys page.

1. Select Add API key.
2. Enter a name for the API key. This name helps you understand why you generated an API key and identify the key.
3. Select the permissions for the API key: read-only or read-write.
4. Select Create key.
5. An API key will be generated and displayed. Copy the API key and save it in a secure place, then select Done.

The API key can be used as bearer token to authenticate as the associated service account:

OBLIQUE_API_KEY="my-api-key"
OBLIQUE_BASE_URL="https://us.oblique.security" # Or "https://eu.oblique.security"
curl -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  "$OBLIQUE_BASE_URL/api/v1/users"

Revoke an API key

Caution

Removing an admin doesn’t invalidate the API keys they generated. To invalidate these keys, navigate to the API keys page and filter for keys created by that admin.

You must be a admin to revoke an API key.

Navigate to the API keys page.

1. Locate the key to be removed. If you have a lot of keys, use the search bar to more easily find the desired key.
2. For the selected key, in the More menu, select Delete….
3. Confirm you want to revoke the key, and select Delete.

View API key logs

You must be a admin to view API logs.

Audit logs are available for all write operations performed by an API key. To view logs for a given key, navigate to the API keys page.

1. Locate the key to audit. If you have a lot of keys, use the search bar to more easily find the desired key.
2. For the selected key, in the More menu, select View API key activity.