Tutorial: Configure TeamViewer for automatic user provisioning

This tutorial describes the steps you need to perform in both TeamViewer and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users to TeamViewer using the Microsoft Entra 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 Microsoft Entra ID.

Capabilities supported

  • Create users in TeamViewer
  • Remove users in TeamViewer when they do not require access anymore
  • Keep user attributes synchronized between Microsoft Entra ID and TeamViewer
  • Single sign-on to TeamViewer (recommended)


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


This requires a Microsoft Entra Premium license subscription.

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 Microsoft Entra ID and TeamViewer.

Step 2: Configure TeamViewer to support provisioning with Microsoft Entra ID

  1. Log in to TeamViewer Management Console. Navigate to Admin settings.

  2. In the Authentication section, click Apps and token.

  3. Click Profile settings.

  4. Click Add app or token.

  5. Click Create script token.

  6. Enter a name for your API token and select the following options for the token.

    Account management

    • View online state.
    • View account data.
    • View email address.
    • View license.

    User management

    • Create users.
    • Edit users.
    • View users.

    User groups

    • Create user groups.
    • Delete user groups.
    • Edit user groups.
    • Read user groups.
  7. Click Save, to create your script token.

Add TeamViewer from the Microsoft Entra application gallery to start managing provisioning to TeamViewer. If you have previously setup TeamViewer 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 Microsoft Entra provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users to the application. If you choose to scope who will be provisioned based solely on attributes of the user, you can use a scoping filter as described here.

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

  • If you need additional roles, you can update the application manifest to add new roles.

Step 5: Configure automatic user provisioning to TeamViewer

This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users in TestApp based on user assignments in Microsoft Entra ID.

To configure automatic user provisioning for TeamViewer in Microsoft Entra ID:

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications

    Enterprise applications blade

  3. In the applications list, select TeamViewer.

    The TeamViewer link in the Applications list

  4. Select the Provisioning tab.

    Screenshot of the Manage options with the Provisioning option called out.

  5. Set the Provisioning Mode to Automatic.

    Screenshot of the Provisioning Mode dropdown list with the Automatic option called out.

  6. Under the Admin Credentials section, enter https://webapi.teamviewer.com/scim/v2 in the Tenant URL field and enter the script token created earlier in the Secret Token. Click Test Connection to ensure Microsoft Entra ID can connect to TeamViewer. If the connection fails, ensure your TeamViewer account has Admin permissions and try again.

    Screenshot shows the Admin Credentials dialog box, where you can enter your Tenant U R L and Secret Token.

  7. 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

  8. Select Save.

  9. Under the Mappings section, select Synchronize Microsoft Entra users to TeamViewer.

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

    Attribute Type
    userName String
    displayName String
    active Boolean
  11. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

  12. To enable the Microsoft Entra provisioning service for TeamViewer, change the Provisioning Status to On in the Settings section.

    Provisioning Status Toggled On

  13. Define the users that you would like to provision to TeamViewer by choosing the desired values in Scope in the Settings section.

    Provisioning Scope

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

    Saving Provisioning Configuration

This operation starts the initial synchronization cycle of all users 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 Microsoft Entra provisioning service is running.

Step 6: Monitor your deployment

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

  • Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully
  • Check the progress bar to see the status of the provisioning cycle and how close it is to completion
  • 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