Skip to content

Settings↑

Admins can generate client credentials or an API token for working with the AQtive Guard API. These methods authenticate automation and data exchanges, with each type corresponding to a specific user role and associated privileges:

  • Client credentials - consist of a client ID and client secret.
  • API tokens - a single-string bearer token often used for command-line tools, or temporary access.

Regardless of the method used, you must assign a role to define the level of access:

  • Uploader - Authenticates uploads of data generated using an AQtive Guard sensor or supported external file format.
  • Admin - Grants full administrator privileges for configuring data sources and automation using the AQG API.

Refer to Assigning user roles for more information about user roles and privileges.

Important security considerations↑

Sharing admin-level credentials poses a significant security risk to your AQtive Guard configuration and data. Admin credentials provide unrestricted access to your account, allowing the holder to:

  • Create and modify configurations.
  • Set up automation.
  • Access sensitive data.

To maintain the security and integrity of your AQtive Guard account:

  • Protect all credentials as confidential.
  • Only share Admin credentials with trusted administrators who have a legitimate need for full access.
  • Ensure that all credentials are properly managed and revoked when no longer needed.

Create authentication credentials↑

The following sections explain how to generate each type of authentication credentials.

Create client credentials↑

To generate AQG client credentials:

  1. Log in to AQtive Guard as an administrator.
  2. Select Settings, then Client credentials.
  3. Select Create credential and enter a name for the credential.
  4. Choose either an Admin or Uploader credential, then select Create.
  5. Copy and securely save the generated credentials you require before closing the page.

View client credentials↑

To view AQG client credential details:

  1. Log in to AQtive Guard as an administrator.
  2. Select Settings, then Client credentials.
  3. Locate the credential you’re interested in and select Details at the end of the row.

Revoke client credentials↑

To revoke AQG client credentials:

  1. Log in to AQtive Guard as an administrator.
  2. Select Settings, then Client credentials.
  3. Locate the credential you want to revoke in the table and select Details at the end of the row.
  4. Select Revoke.
  5. Confirm the action to instantly invalidate the credentials and block all future requests.

Create an API token↑

To generate an AQG API token:

  1. Log in to AQtive Guard as an administrator.
  2. Select Settings, then API tokens.
  3. Select Create API token and enter a name for the token.
  4. Choose either an Admin or Uploader token, then select Create.
  5. Copy and securely save the generated token you require before closing the page.

View API tokens↑

To view AQG API token details:

  1. Log in to AQtive Guard as an administrator.
  2. Select Settings, then API tokens.
  3. Locate the token you’re interested in and select Details at the end of the row.

Revoke an API token↑

To revoke an AQG API token:

  1. Log in to AQtive Guard as an administrator.
  2. Select Settings, then API tokens.
  3. Locate the token you want to revoke in the table and select Details at the end of the row.
  4. Select Revoke.
  5. Confirm the action to instantly invalidate the token and block all future requests.