Creating an extended integration for Cisco Webex users

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and Webex in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management
• Configurable workflows for: 
  • Ingesting all users from Webex into Oomnitza's SaaS module
  • Getting and deleting a user from Webex
  • Creating and updating Webex users

Navigation

Adding the credentials

Creating the user integration

Creating custom mappings

Creating workflows

Creating Saas user workflows

User Role preset

Creating user workflows with the API block

Create User 

Get User Details

Update User

Delete user 

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

Webex uses OAuth authentication and requires a Client ID, Client Secret and Scope. To obtain your Client ID and Secret simply:

1. Navigate and log in to My Webex Apps.
2. Click Create a New App, then select Create an Integration.
3. On the form, fill in the required information including your:
   1. Scopes. See the Webex Authentication guide for a full list of scopes.
   2. Redirect URL. Your redirect URL should be set to https://generic-oauth2-proxy.oomnitza.com/oauth2/redirect_url 

Each Webex user account is limited to 20 integrations.

Consult the Webex Authentication guide for additional steps - such as how to request permission to use an OAuth grant flow on behalf of another user. 

Adding the credentials

To stream Webex user data into Oomnitza, complete the following steps:

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Enter your client credentials and any other additional information.
5. Click Authenticate. You are prompted to log in to authorize your request.
6. Click CREATE.

Information
If the integration is not listed, click Advanced Mode, and add your credentials.

1. On the INFORMATION tab, complete these actions:
   1. Add the name of the credential.
   2. Add the name of the owner. 
2. Ensure that OAuth 2.0 is selected as the Authorization type.
3. Ensure that Webex is selected from the SaaS list.
4. Enter your Client ID and Client Secret that you obtained in Before you start.
5. Enter a space separated list of Scopes. For example, you would need to use
   spark-admin:people_writeto write to your user's company directory.
6.  Click Authenticate. You are prompted to log into Webex to authorize your request.
7. Click CREATE.

Next

You use the credentials that you added to create and customize your Webex integrations with Oomnitza.

Creating the user integration

1. In Oomnitza, click Configuration>Integrations>Overview.
2. Click Integrations List View
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. Search for the integration in the sidebar or use the Search.
6. Click ADD.

Integration Overview

Before you start

More information is provided about the following fields to help you complete the integration:

Integration preferences:  By default,  Create and Update are selected. To ensure that only live user records are synced with Oomnitza, select Update Only. When you run the integration, you can check the error logs to see the records that weren't uploaded and why they weren't uploaded. Then, you can decide whether to upload the user records that were skipped by changing your integration preference back to Create and Update.
 

User selection: When you select User plus SaaS User and you have multiple instances of the same SaaS, you can choose your SaaS instance from the dropdown. If you have a single instance of the SaaS, your instance is already detected by the system.

Integration details

Procedure
To review or update the integrations details, click the pencil:

1. Update the integration name if necessary. 
2. From the User Selection list, select an option. 
3. For installation type, ensure that Cloud is selected.
4. For integration preferences, select an option.
5. Enter the name of the integration user.

Credential details

Choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Click the pencil.
2. Configure your schedule.
3. Click Update.

Mappings

To map the fields to Oomnitza, click the pencil.

Creating custom mappings

Map the Webex fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Click Smart Mapping.
2. You have the option to create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field.
   4. Click CREATE. 
3. Map and assign a sync key to the Email field.
4. Click NEXT.

Note: For all user loads, it is recommended that you map role information to an employee role in Oomnitza. Users need to have an employee role defined in order to access Oomnitza. If the role information is not available from the user load, it is recommended that you select Employee from the Oomnitza Role dropdown list. You have the option to overwrite this at a later point should the role information become available. 

Standard Webex to Oomnitza mappings

The following Webex fields can be mapped to Oomnitza:

Created
DisplayName
Email
First Name
ID
Invite Pending
Last Modified
Last Name
Org Id
Status
Type
User Load Connector Sync Time

Did you know? 
You can define rules for your integration by selecting Edit integration at the top of the screen. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.  

You can add new fields to your integration by selecting the + (Add) option. All you need to do is specify the field name and then enter the JSON path, for example {{response.email}}. See Creating custom API fields. 

Launching the integration

Your integration is in Draft mode until all the required mandatory fields are added. Once you have added all of the required fields, we recommend that you complete the following steps

1. Select Launch to activate your integration.
2. Change your Integration preferences to Update only so that no records are imported and do a Test Run.
3. Click Sync Sessions and review the status of the integration. If you encounter any errors, see troubleshooting integrations.
4. When the test run has been completed, change your Integration preferences and click Run Now.

Getting your results
To view the information that is collected about your assets, click Assets. To view the information about software, click an asset and then click the Software tab. To view the information that is collected about your users, click People. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Creating workflows

Creating Saas user workflows

You can create the SaaS User workflow by following the steps in Creating Saas user workflows. When creating the user workflows with the API block for Webex, the following specific configuration is required:

To locate the available presets, enter Webex in the Select Preset search field. Select your preset of choice and for every preset your correct Webex Credentials that you created in Adding the credentials in the Configure section.

The Webex SaaS User workflow block comes with one available preset, the User Role preset.

Using the Webex User Role preset

The Webex User Role preset enables you to read a user’s role(s) and last activity. For further information see Webex API documentation: List people.

Creating user workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create user workflows with the API block by following the steps in Creating user workflows with the API block.

To locate the available presets, enter Webex in the Select Preset search field. Select your preset of choice and for every preset your correct Webex Credentials that you created in Adding the credentials in the Configure section.

The API block comes with the following Webex presets:

Create User 

Get User Details

Update User

Delete user 

Using the Webex Create User preset

The Webex Create User preset creates a new user account. To use this preset, you need to supply the firstname and lastname of the new user. When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. Modify, update or add fields that will be used in the request payload. For information on the fields that are permitted in the request payload refer to Webex API documentation: Create a person.
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. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

Using the Webex Get User Details preset

The Webex Get User preset shows the details of a person, by ID. When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The Webex user id is assumed to be stored in the variable{{webex_user_id}}. If this is not correct, you can replace the variable {{webex_user_id}} in the URL field with the correct variable or user id. 
   
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. For information on creating custom fields, see Creating Custom Fields in Oomnitza. Once you have the entire response, you should then map individual JSON values to custom fields, as per the example below. For further information, refer to the Enhanced API Block.
   
   Figure 1: Mapping the entire API response to individual Oomnitza fields in the Get User Details preset.

For further information, refer to the Webex API documentation: Get person details.

Using the Webex Update User preset

The Webex Update User preset updates the details of a person, by ID.

Note
When you select this preset, you will be assed to supply the first name and last name of the new user. You will also need to supply the remaining user details in the Body tab in Advanced Mode. This action expects all user details to be present in the request. A common approach is to first use the Get User Details preset to get the person's details, make changes, and then send the changed and unchanged values in the Update User preset.

When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The Webex user id is assumed to be stored in the variable {{webex_user_id}}. If this is not correct, you can replace the variable {{webex_user_id}} in the URL field with the correct variable or user id. 
3. Select the Body tab. Ensure that all of the user data appears in the request payload. If you do not supply all of the user details, you will receive a 400 bad requestresponse.
   Figure 2: Entering all of the user data in the Update User preset. 
4. 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. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

For further information on the request payload refer to Webex API documentation: Update a person.

Using the Webex Delete User preset

The Webex Delete User preset removes a person from the system.

Tip
You can use this preset in conjunction with the Webex User Role preset. Use the Webex delete user preset to delete the accounts that were found inactive after running the Webex User Role preset

Note
Only an admin can remove a person.

When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The Webex user id is assumed to be stored in the variable {{webex_user_id}}. If this is not correct, you can replace the variable {{webex_user_id}} in the URL field with the correct variable or user id. 
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. For information on creating custom fields, see Creating Custom Fields in Oomnitza.

For further information, refer to the Webex API documentation: Delete a person.

For further information on workflows see:
 Understanding workflows
 Workflow block overview
Enhanced API Block

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your users, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.