Authenticating your connection

2024-02-19Last updated

Before you can connect with Genetec ClearID™ to synchronize data or issue API commands, you must first authenticate your applications (or API environment) so that your applications or API can communicate with ClearID.

What you should know

Use the service user 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 do not share it.
Important: When you regenerate your key, you must update any applications that access this account to use the new key.
You can create a service user to authenticate communications for the following:
  • Genetec ClearID™ LDAP Synchronization Agent
  • Genetec ClearID™ API
  • Genetec ClearID™ One Identity Synchronization Tool (Azure AD, Database, File)

Procedure

  1. Add a service user.
    1. In ClearID, click Administration > Automation .
    2. Click Add service user.
      Name
      Enter a name for the service user. For example, Active Directory LDAP Synchronization, API user connection, or One Identity Synchronization.
      Description
      Enter a meaningful description for the service user.
    3. Click Save.
  2. Select a user from the service user list.
    1. Click Generate key and then click Confirm, to generate the authentication key for your service user.
      CAUTION: The current service user key immediately becomes invalid and is not recoverable.
    2. Click Download authentication key.
      Tip: Make a note of the downloaded file location for later use.

      By default, the authentication key for your service user is named key-systemID-serviceusername.json.

You are now ready to configure your applications to synchronize data or issue API commands.

After you finish

Depending on how attributes are set up in your organization, do one of the following: