Creating workflows for TeamViewer users

Let Oomnitza be your single source of truth!

You'll get visibility of your users as data from TeamViewer is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and TeamViewer in minutes

You'll get visibility of your TeamViewer users by creating configurable workflows to automate tasks such as:

• • Onboarding and offboarding users 
  • Retrieving SaaS user roles
  • Getting a user's last login activity, enabling you to identify accounts that are underutilized or that can be canceled
  • Deactivating users, such as inactive or underutilized users

Contents

1. Before you start
2. Creating workflows
3. Create user workflows
4. TeamViewer
   1. TeamViewer Get User Details
   2. TeamViewer Create User
   3. TeamViewer Update User
5. SCIM
   1. TeamViewer Get SCIM User Details
   2. TeamViewer Create SCIM SSO User
   3. TeamViewer Create SCIM Standard User
   4. TeamViewer Update SCIM User
   5. TeamViewer Deactivate SCIM User
   6. TeamViewer Activate SCIM User
6. Creating SaaS user workflows

Before you start

Before you can create the integration with Oomnitza, you need to have added your TeamViewer credentials to Oomnitza. For further information, see Adding your TeamViewer credentials to Oomnitza.

We recommend that you also create the extended integration for TeamViewer users.  You can use the information retrieved in these integrations to trigger workflows that can get user information.

Creating workflows

Create user workflows

To create a user workflow, you must complete these steps:  

1. Click Configuration > Workflows 
2. Click Add (+) and select People from the list.
3. Drag and drop the API block onto the Sandbox.
4. Click Edit on the API block and enter TeamViewer in the search field. 
5. Select a preset:
   • TeamViewer Get User Details
   • TeamViewer Create User
   • TeamViewer Update User
   • TeamViewer Get SCIM User Details
   • TeamViewer Create SCIM SSO User
   • TeamViewer Create SCIM Standard User
   • TeamViewer Update SCIM User
   • TeamViewer Deactivate SCIM User
   • TeamViewer Activate SCIM User
6. To choose a preset, click the forward arrow (>).
7. Select the credentials that you created in Adding your TeamViewer credentials to Oomnitza.
8. Configure the API Block following the preset instructions below, and save your changes.
9. Edit the Begin Block and add rules to trigger the workflow. For example, if you set the Actions to Schedule and add a rule so that the Email Equals <EmployeeEmail> you can trigger a workflow to fetch a user matching a certain name on a specific date. Refer to Using the Begin block. 
10. Connect the Blocks. 
11. Save, validate, and activate your workflow.

TeamViewer

Using the Get User Details preset

The Get User Details preset gets an existing user, by User ID. You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the TeamViewer User ID is referenced in the property {{teamviewer_user_id}}.Follow the mapping steps in Creating custom mappings so that this property exists in Oomnitza and is populated with information before you run this workflow.
3. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. Once you have the entire response, you can then parse the JSON response values to custom Oomnitza fields as per the example below.

For further information, refer to the TeamViewer API Documentation: GET Users.

Using the Create User preset

The Create User preset creates a new TeamViewer user. When you select this preset you need to supply the new user email, password, full name, and language.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. Ensure that the message body contains information similar to the request example below. To add more fields to the message body, refer to the TeamViewer API Documentation: POST Users.
3. Select the Response tab. You can map the entire response as per the example in the Get User Details preset.

{
"email": "[e-mail]",
"password": "string",
"name": "Jane Doe",
"permissions": "EditFullProfile",
"language": "de_DE",
}

Using the Update User Details preset

The Update User Details preset updates a user's details, by User ID. When you select this preset you need to supply the new user's Full Name. You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the TeamViewer User ID is referenced in the property {{teamviewer_user_id}}.Follow the mapping steps in Creating custom mappings so that this property exists in Oomnitza and is populated with information before you run this workflow.
3. Select the Body tab. To add more fields to the message body, refer to the TeamViewer API Documentation: PUT Users.

Warning
If successful, this workflow returns a204 No Contentresponse code.

SCIM

Using the Get SCIM User Details preset

The Get User Details preset gets the details of a specific SCIM user. You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the TeamViewer SCIM User ID is referenced in the property {{teamviewer_scim_user_id}}.Follow the mapping steps in Creating custom mappings so that this property exists in Oomnitza and is populated with information before you run this workflow.
3. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. Once you have the entire response, you can then parse the JSON response values to custom Oomnitza fields as per the example below.

For further information, refer to the TeamViewer API Documentation: Get a list of users.

Using the Create SCIM SSO User preset

The Create SCIM SSO User preset creates an SSO User. When you select this preset you need to supply the new user details.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. The message body should contain information similar to the request example below. 
3. Select the Response tab. You can map the entire response as per the example in the Get SCIM User Details preset.

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:teamviewer:1.0:SsoUser"
    ],
    "userName": "[e-mail]",
    "displayName": "Jane Doe",
    "emails": [
        {
            "value": "[e-mail]",
            "primary": true
        }
    ],
    "name": {
        "givenName": "Jane",
        "familyName": "Doe",
        "formatted": "Jane Doe"
    },
    "preferredLanguage": "de_DE",
    "urn:ietf:params:scim:schemas:extension:teamviewer:1.0:SsoUser": {
        "ssoCustomerId": "a1b2bc4d5e6f7"
    }
}

For further information, refer to the TeamViewer API Documentation: Single Sign-On User.

Using the Create SCIM Standard User preset

The Create SCIM Standard User preset creates a standard SCIM User. When you select this preset you need to supply the new user details.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. The message body should contain information similar to the request example below. 
3. Select the Response tab. You can map the entire response as per the example in the Get SCIM User Details preset.

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "userName": "[e-mail]",
    "displayName": "Jane Doe",
    "emails": [
        {
            "value": "[e-mail]",
            "primary": true
        }
    ],
    "name": {
        "givenName": "Jane",
        "familyName": "Doe",
        "formatted": "Jane Doe"
    },
    "password": "secret1!",
    "preferredLanguage": "de_DE"
}

For further information, refer to the TeamViewer API Documentation: Standard (Normal) User.

Using the Update SCIM User preset

The Update SCIM User preset updates a user's details, by User ID. When you select this preset you need to supply the First Name and Last Name of the user you wish to update.

You can configure the message payload by selecting Advanced Mode.

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. You will notice that the TeamViewer SCIM User ID is referenced in the property {{teamviewer_scim_user_id}}.Follow the mapping steps in Creating custom mappings so that this property exists in Oomnitza and is populated with information before you run this workflow.
3. Select the Body tab. The message body should contain information similar to the request example below. 
4. Select the Response tab. You can map the entire response as per the example in the Get SCIM User Details preset.

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "userName": "[e-mail]",
    "displayName": "Jane Doe (Updated Name)",
    "emails": [
        {
            "value": "[e-mail]",
            "primary": true
        }
    ],
    "name": {
        "givenName": "Jane",
        "familyName": "Doe (Updated Name)",
        "formatted": "Jane Doe (Updated Name)"
    },
    "active": true
}

For further information, refer to the TeamViewer API Documentation: Update an existing user.

Using the Deactivate SCIM User preset

The Deactivate SCIM User preset sets a user's account to inactive. This preset operates in the same manner as the Update SCIM User preset, except that the property active in the Advanced Mode> Body is set to false. 

Using the Activate SCIM User preset

The Activate SCIM User preset updates a user's account to active. This preset operates in the same manner as the Update SCIM User preset, and sets the property active in the Advanced Mode> Body to true. 

Reference articles for workflows

• Mapping positive and negative responses
• Troubleshooting workflows 
• Using the API block

Creating SaaS user workflows

You can create a Saas User workflow in Oomnitza using the TeamViewer User Role preset.  This preset supplies you with a comma-separated list of Permissions (such as Manage Users, View All Assets, etc.) and the Last Login Date ('last_access_date') of your SaaS users.

Prerequisites

Before you create a SaaS user workflow, you should have already run your extended user integration and selected User plus SaaS User to populate the software entry in the Software > SaaS menu.

To create a Saas User workflow using the TeamViewer User Role preset, complete the following steps:

1. Click Configuration > Workflows > Saas Users from the menu.
2. Click Add (+). The Begin and End blocks are automatically added to the sandbox.
3. Enter the name and a description of the workflow. 
4. Edit the Begin block by adding the rules that will trigger the workflow. For further information see SaaS User Roles.
5. Click the Blocks tab, and drag and drop the SaaS User Role retrieval block onto the canvas.
6. Click the Edit icon.
7. Enter TeamViewer in the search field and choose the TeamViewer User Role preset.
8. Click the right arrow >.
9. Enter your Credentials.
10. Select the Deactivate User checkbox to deactivate the users listed in SaaS > TeamViewer > Users if they do not exist in your SaaS application.
11. Click SAVE.
12. Connect the blocks.
13. Save, validate, and activate your workflow.

To view active TeamViewer users in the SaaS Users UI, complete the following steps:

1. Click Software from the menu.
2. Select the SaaS tab, and select your software entry for TeamViewer.
3. Click Users in the side pane.
4. The Role and Last activity column will be populated with the user details to confirm that this user has been found in your TeamViewer SaaS.           

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.