Skip to main content

Genetec ClearID

Learn how to automatically load visitors into your ClearID

Updated this week

Overview

Genetec ClearID is a cloud-based physical identity and access management platform that standardizes and automates access requests, approvals, and permissions through configurable workflows. The Genetec ClearID + Envoy Visitors integration enables organizations to automate and manage visitor access using policy-driven workflows. When a visitor is invited or signs in through Envoy, their access can be provisioned and governed in ClearID to ensure the right permissions are granted in line with your organization’s security policies.

PREREQUISITES

  • You must have Account Owner admin level permissions or equivalent within your Genetec instance

  • You'll also need:

    • ClearID API credentials (Client ID and Secret)

    • Your ClearID Account ID

    • Base URL and Auth Base URL for your ClearID instance

Configuration

Step 1: Info

  1. Navigate to your Envoy dashboard, click Integrations > All integrations and search "Genetec ClearID." Click Install to begin configuration.

  2. Read over the information and be sure to have all required keys on hand to complete the configuration steps.

  3. Click Next.

Step 2: API Access

  1. Enter your Auth Base URL for your ClearID instance. This is typically provided by Genetec during setup.

  2. Next, enter your API Base URL.

  3. Client ID: Enter your ClearID OAuth Client ID.

  4. Client Secret: Your ClearID OAuth Client Secret.

  5. Account ID: Your ClearID Account ID.

  6. Once all fields are complete, click Next Step to connect your account and

    configure your visitors settings.

Step 3: Visitors

  1. Check the Invite Only box to skip provisioning access for walk-up visitors.

  2. Visitor Access Duration: How long visitors will have access after arrival. Select a value from the dropdown.

  3. (Optional) Visitor Early Access Duration: Allow invited visitors to access before their scheduled arrival time

  4. Card number assignment: Select how card numbers should be assigned to visitors. Each assignment type has slightly different configuration steps.

    1. Auto-Generate Card Numbers: Provide the Minimum Card Number, Maximum Card Number, Credential Format, and Facility Code.

    2. Manual Card Assignment: Select the Credential Format and provide the Facility Code.

    3. No Card Assignment: Skip card assignment and continue on to the next step.

  5. Now, set the Access Level Configuration to decide how to assign ClearID Roles to visitors. You can select from:

    1. Default Roles: All visitor types receive the same ClearID roles.

      1. Select the Default role(s) that all visitors will receive.

      2. Visitor Blocklist: Prevent sign-in flows from receiving credentials by selecting them here.

    2. Granular Roles: Map different visitor types to different ClearID roles. Click Add Another for each visitor type you want to grant ClearID roles to.

  6. (Optional) Save Sign-in Fields responses to ClearID: If you want to store Visitor data within ClearID, you can populate it based on sign-in flow fields. Select the field, then map it to the ClearID field. Click Add Another for each piece of data you want to save.

  7. Permanently delete visitor records from ClearID when visitors sign out by checking the box next to Delete Visitor on Sign-Out. The visitor record will not be deleted from Envoy with either option.

    1. Deleting is best for privacy-focused environments or one-time visitors.

    2. Deactivating is best for compliance, auditability, and repeat visitors.

  8. Click Complete Set-up to save and complete the configuration.

Did this answer your question?