Site Admin Guides
      Back to home
      1. HealthSafe Help Center
      2. SecurePass™
      3. Site Admin Guides

      SecurePass and Microsoft Entra ID Integration

      Overview

      The SecurePass application allows you to integrate with Azure Entra ID to import and manage user data. This guide will help you gather and set up the necessary information to configure the integration.

      Gathering Entra ID Key Configuration Data

      To configure the Entra ID integration, you will need to gather the following data from your Azure AD:

      1. Client ID
      2. Tenant ID
      3. Client Secret
      4. Key Settings

      Steps to Obtain Client ID, Tenant ID, and Client Secret

      1. Register an Application in Microsoft Entra ID

      • Click on the 'New registration’ button.

      • Enter a name for your application and configure the required settings:
        • Name
          • SecurePass App
        • Supported account types
          • Accounts in this organizational directory only (Default Directory only - Single tenant)
        • Redirect URI (optional)
      • Click on the ‘Register’ button.

      2. Get Client ID

      • After registering your application, you will be redirected to the application's Overview page.
      • Copy the Application (client) ID. This is your Client ID.

      3. Get Tenant ID

      • Copy the Directory (tenant) ID. This is your Tenant ID.

      4. Create a Client Secret

      • Navigate to your registered application.
      • Go to Certificates & secrets > Client secrets.
      • Click on New client secret.
      • Add a description and set an expiration period.
      • Click Add.
      • Copy your Client Secret’s generated Value.
        • This is your Client Secret. Note: You will not be able to copy this value again after leaving this page, so store it securely.

      Setting Up Key Settings

      Key settings are the fields used to map user data from Entra ID to SecurePass application. Here are the default keys you may need:

      • Name* : Key for user's given name (e.g., givenName )
      • Position* : Key for user's position (e.g., employeeType )
      • Phone : Key for user's phone (e.g., mobilePhone )
      • Email* : Key for user's email (e.g., mail )

      These keys should correspond to the fields in your Entra ID user profile that you want to map to your SecurePass application.

      Configuring Entra ID Settings in SecurePass


      Once you have gathered the necessary data, you can configure the Entra ID settings in your SecurePass application.

      1. Navigate to Entra ID Settings

      • Log into SecurePass Admin.
      • Go to the Entra ID integration settings page by going to the:
        • People menu > Staff
        • Click on the ‘Microsoft Entra ID’ button

      2. Enter Configuration Data

      • Enter the Client ID, Tenant ID, and Client Secret you obtained from Azure AD.
      • Configure the key settings to map the Azure AD fields to your application fields.

      3. Save Settings

      • Click Save to store your settings.
      • The application will now use these settings to connect to Azure Entra ID and manage user data.

      Cronjob Configuration

      The SecurePass application includes a scheduled task (cronjob) to automatically synchronize user data from Entra ID once per night.

      Activating the Cronjob

      To activate the cronjob, ensure that the Run Auto-Update option is enabled in the Entra ID configuration.


      Run Auto-Update: Switch to enable/disable automatic updates via the Cronjob.

      Executing the Cronjob

      The cronjob will run once per night to synchronize user data from Entra ID with the SecurePass application. During execution, user data will be imported or updated as necessary. The cronjob will take the previously set key parameters into account during this process.


      Support

      • By following this guide, you will be able to successfully configure the Entra ID integration in your SecurePass application and manage your user data effectively.
      • For further assistance or questions regarding the SecurePass and Microsoft Entra ID Integration, please contact our support team at support@healthsafe.co or visit our support page at Submit a support ticket (healthsafe.co.nz).