Tutorial: Configure Twingate for automatic user provisioning

This tutorial describes the steps you need to perform in both Twingate and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to Twingate using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory.

Capabilities Supported

  • Create users in Twingate
  • Remove users in Twingate when they do not require access anymore
  • Keep user attributes synchronized between Azure AD and Twingate
  • Provision groups and group memberships in Twingate
  • Single sign-on to Twingate (recommended)

Prerequisites

The scenario outlined in this tutorial assumes that you already have the following prerequisites:

  • An Azure AD tenant
  • A user account in Azure AD with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
  • A Twingate tenant in a product tier that supports identity provider integration. See Twingate pricing for details on different product tiers.
  • A user account in Twingate with Admin permissions.

Step 1. Plan your provisioning deployment

  1. Learn about how the provisioning service works.
  2. Determine who will be in scope for provisioning.
  3. Determine what data to map between Azure AD and Twingate.

Step 2. Configure Twingate to support provisioning with Azure AD

  1. Sign in to your Twingate Admin Console.

  2. Navigate to Settings > Identity Provider

  3. Click on the ... button to open the action menu. Select Regenerate SCIM Token. Note that this would invalidate your existing token if any.

    Azure AD action menu

  4. Copy the SCIM Endpoint and SCIM token from the modal. These values will be entered in the Tenant URL and Secret Token fields respectively in the Provisioning tab of your Twingate application in the Azure portal.

    SCIM info modal

Add Twingate from the Azure AD application gallery to start managing provisioning to Twingate. If you have previously setup Twingate for SSO, you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.

Step 4. Define who will be in scope for provisioning

The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.

  • When assigning users and groups to Twingate, you must select a role other than Default Access. Users with the Default Access role are excluded from provisioning and will be marked as not effectively entitled in the provisioning logs. If the only role available on the application is the default access role, you can update the application manifest to add additional roles.

  • Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.

Step 5. Configure automatic user provisioning to Twingate

This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Twingate based on user and/or group assignments in Azure AD.

To configure automatic user provisioning for Twingate in Azure AD:

  1. Sign in to the Azure portal. Select Enterprise Applications, then select All applications.

    Enterprise applications blade

  2. In the applications list, select Twingate.

    The Twingate link in the Applications list

  3. Select the Provisioning tab.

    Provisioning tab

  4. Set the Provisioning Mode to Automatic.

    Provisioning tab automatic

  5. Under the Admin Credentials section, input your Twingate Tenant URL and Secret Token. Click Test Connection to ensure Azure AD can connect to Twingate. If the connection fails, ensure your Twingate account has Admin permissions and try again.

    Token

  6. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and select the Send an email notification when a failure occurs check box.

    Notification Email

  7. Select Save.

  8. Under the Mappings section, select Synchronize Azure Active Directory Users to Twingate.

  9. Review the user attributes that are synchronized from Azure AD to Twingate in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Twingate for update operations. If you choose to change the matching target attribute, you will need to ensure that the Twingate API supports filtering users based on that attribute. Select the Save button to commit any changes.

    Attribute Type Supported For Filtering
    externalId String
    userName String
    active Boolean
    emails[type eq "work"].value String
    name.givenName String
    name.familyName String
  10. Under the Mappings section, select Synchronize Azure Active Directory Groups to Twingate.

  11. Review the group attributes that are synchronized from Azure AD to Twingate in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in Twingate for update operations. Select the Save button to commit any changes.

    Attribute Type Supported For Filtering
    externalId String
    displayName String
    members Reference
  12. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

  13. To enable the Azure AD provisioning service for Twingate, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  14. Define the users and/or groups that you would like to provision to Twingate by choosing the desired values in Scope in the Settings section.

    Provisioning Scope

  15. When you are ready to provision, click Save.

    Saving Provisioning Configuration

This operation starts the initial synchronization cycle of all users and groups defined in Scope in the Settings section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.

Step 6. Monitor your deployment

Once you've configured provisioning, use the following resources to monitor your deployment:

  1. Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
  2. Check the progress bar to see the status of the provisioning cycle and how close it is to completion
  3. If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states here.

Additional resources

Next steps