Skip to main content

Authentication

Authentication to the API is performed by passing your API token in the Authorization header using the Bearer Scheme: Authorization: Bearer <api_key>

All API requests must be made over HTTPS.

API Access

To access this API your Cyera environment must have API access enabled. To request access, please contact your Customer Success Engineer.

API Key Management​

Creating an API Key​

To create API keys for accessing data and resources from the Cyera products in your environment (e.g. Cyera Privacy, Opt-Out):

  1. Log in to Cyera.
  2. Navigate to Settings and select API Keys.
  3. Select Create API Key.
  4. Enter a key Name and select the necessary Permissions. Permissions cannot be edited after creation, so select the scopes that provide least privileged access for your apps.
  5. When the key is created, copy the key for use in your app code.
warning

The key will not be visible after closing the modal. You will need to create another key if you lose the previous one, as a security precaution.

Deleting an API Key​

  1. Log in to Cyera.
  2. Navigate to Settings and select API Keys.
  3. Select the API Key you want to delete.
  4. In the bottom right of the modal, select Delete API Key.
warning

Once deleted, this action cannot be undone.

 

Need help?
If you have any questions, please reach out to your dedicated Customer Success Engineer or contact us at support@cyera.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.