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

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 Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

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

• User only. Add user records.
• User plus SaaS user. Add user and SaaS user records. 

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Editing the integration details

1. Click Edit .
2. Make your changes.

Editing the credential details

If you selected Cloud as the installation type, 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

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Selecting Edit integration to add rules for syncing data. Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

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 to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
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. Ensure that the Email is mapped to the
   1. Username field on the Oomnitza side (required for integration).
   2. Email field on the Oomnitza side (required for integration).
4. Select the Role field on the Oomnitza mapping side.
5. Choose a suitable role from the list (a defined role is necessary for the integration)
6. Assign a sync key to a unique field, such as the Email.
7. Click UPDATE.

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

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

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.

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.

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

Reference articles for workflows

• Mapping positive and negative responses
• Troubleshooting workflows 
• Using the 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.