Authenticating your connection

2026-05-06Last updated

To allow external applications to synchronize data or issue API commands, you must first authenticate the connection in Genetec ClearID™.

What you should know

Use the API integration key to authenticate your applications when making requests to your ClearID account.
  • The OAUTH 2.0 protocol is used to authenticate non-user system communications or connections with ClearID.
  • Store your key securely and don’t share it.
  • When you regenerate your key, all applications using the previous key must be updated to use the new key.
You can create an API integration to authenticate communications for the following:
  • Genetec ClearID™ API
  • System for Cross-domain Identity Management (SCIM) integration
  • Genetec ClearID™ One Identity Synchronization Tool (Azure AD, Database, File)
  • Genetec ClearID™ LDAP Synchronization Agent

Procedure

  1. Add an API integration.
    1. In ClearID, click Administration > API integrations .
    2. Click Add API integration, and then enter a name and description.
    3. Click Save.
  2. Generate an authentication key.
    1. In the list of integrations, select your integration and click Generate key, then click Confirm.
      CAUTION:
      The current API integration key immediately becomes invalid and isn’t recoverable.
    2. Click Download authentication key.
      By default, the file is named: key-systemID-APIintegrationname.json.

Example

After you finish

Depending on your organization's setup, you can now synchronize identity attributes using REST API commands, SCIM integration, the One Identity Synchronization Tool, or an LDAP Synchronization Agent.