Authenticating your connection with ClearID - ClearID

Genetec ClearID™ User Guide
Applies to
ClearID
Last updated
2024-04-09
Content type
Guides > User guides
Language
English
Product
ClearID

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 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 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 an API integration 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 an API integration.
    1. In ClearID, click Administration > API integrations.
    2. Click Add API integration.
      Name
      Enter a name for the API integration. For example, Active Directory LDAP Synchronization, API user connection, or One Identity Synchronization.
      Description
      Enter a meaningful description for the API integration.
    3. Click Save.
  2. Select a user from the API integration list.
    1. Click Generate key and then click Confirm, to generate the authentication key for your API integration.
      CAUTION:
      The current API integration 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 API integration is named key-systemID-APIintegrationname.json.

Results

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

Example

After you finish

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