Home
Connecting to other systems
Learn how to connect ClearID to other systems.
Authenticating your connection
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.

About ClearID
Learn about the ClearID self-service physical access management solution.
What's new
Check out what's new in the latest update to ClearID.
Deployment preparation
Check your compatibility and deployment requirements.
ClearID plugin
Learn how to download and install the plugin.
Managing identities and users
Learn how to manage identities and users.
Managing sites
Learn how to manage sites.
Managing areas
Learn how to manage areas.
Managing visitors
Learn how to manage visit requests and access requests.
Managing visitor watchlists
Learn how to manage visitor access using watchlists.
Role-based access control
Learn about role-based access control.
Connecting to other systems
Learn how to connect ClearID to other systems.
- Authenticating your connection
  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.
- Setting up data synchronization
  Setting up data synchronization in Genetec ClearID™ involves learning some concepts, configuring the synchronization solution for your identity data, and the webhook integration options that are relevant for your organization.
- Synchronizing identities using an API
  Use the Genetec ClearID™ API to code your own solutions to automate various functions in ClearID. The primary use for the REST API is synchronizing identities, however many other scenarios are also possible.
- Synchronizing identities using the SCIM integration
  To synchronize external system attributes from a supported identity provider into Genetec ClearID™ identity attributes, you can use the System for Cross-domain Identity Management (SCIM) integration. These identity attributes can then be used in ClearID to assign people to roles and automate role-based access control.
- Synchronizing identities using One Identity
  Use the Genetec ClearID™ One Identity Synchronization Tool to synchronize external system attributes into Genetec ClearID™ identity attributes. These identity attributes in ClearID can then be used to assign people to roles and automate role-based access control.
- Synchronizing identities using LDAP
  Use the Genetec ClearID™ LDAP Synchronization Agent to synchronize Active Directory (AD) Lightweight Directory Access Protocol (LDAP) attributes into Genetec ClearID™ identity attributes. These identity attributes in ClearID can then be used to assign people to roles and automate role-based access control.
ClearID Self-Service Kiosk
Learn about the ClearID Self-Service Kiosk mobile app that simplifies visitor management and check-in.
Troubleshooting
Troubleshoot common issues that can occur.
Additional resources
Need tech support or product information? Check out these resources.
Glossary

Authenticating your connection

2024-12-10

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 don’t 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™ 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

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.
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 isn’t 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.

You’re 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: