Creating extended integrations for Lucidchart Enterprise (SCIM) users

Sync Lucidchart with Oomnitza to retrieve and track enterprise SCIM users.

The Lucidchart integration syncs with the Get All Users SCIM API. 

Contents

1. Before you start
2. Creating the integration
3. Mapping fields

---

Before you start

To create the integration and workflows that use API presets, you must:

• Have a Lucid enterprise plan account.
• Have enabled SCIM. See Enabling SCIM.

Generate an API token in your Lucid enterprise account by navigating to Admin > App Integration > General and clicking Settings in the SCIM section.  See API Keys.

Add credentials to the vault in Oomnitza

To authorize connections between Oomnitza and Lucidchart, complete these steps:

Make life easier and add your credentials to Oomnitza before you create the integration.  

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. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. On the INFORMATION tab:
   1. Add the name of the credential such as Lucidchart Users.
   2. Add the name of the owner. 
2. On the AUTHORIZATION tab, complete these actions:
   • Ensure that API Key is selected as the Authorization type.
   • Ensure that the Token Name is Authorization 
   • Enter Bearer, press the space bar, and enter the value for your API token.
   • Ensure that Add to header is selected.
3. Click CREATE.

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

You can choose one of the following Lucid SCIM integrations:

• Lucid SCIM User Load - Groups as roles. Retrieves user information, the groups they belong to, and their roles. 
• Lucid SCIM User Load - Products as roles. Retrieves product license information.

You can also create an integration for Lucid account users.

---

Creating the integration

Creating the 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. User records and SaaS user records are retrieved. User records are displayed on the People page and SaaS user records can be accessed when you open the SaaS application record on the SaaS page and click the Users tab. In addition to retrieving information about the SaaS application such as usernames, you also retrieve key information such as the user's SaaS role and last activity which will enable you to reduce costs by monitoring SaaS usage and removing users who aren't using the SaaS application. To maintain data hygiene, you can enable the deactivate feature.
• Software SaaS Selection. Link the vendor application to the Oomnitza Software Catalog which is a repository of supported vendor applications and services. If an entry for the vendor application is not shown in the list, it means that the vendor application has not been added to the SaaS page in Oomnitza and linked to the catalog. See SaaS details overview. You can ignore this field because the vendor application is automatically linked to the catalog when the integration is saved.

Important
Now that user information can be retrieved and users deactivated when the integration is run, you can deactivate or remove the workflows that were added to retrieve SaaS user information and deactivate SaaS users. (The block that is used to complete these actions in workflows is the SaaS User Role Retrieval block.)

When you enable the Deactivate feature, the following actions are completed when the integration runs:

• If a user record is missing from the data source - the vendor application - or if the record is marked as inactive in the data source, the user record is deactivated in Oomnitza.
• If a user record was deactivated and is now available in the data source, for example, the user logs into the SaaS application, the user record becomes active in Oomnitza. 

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

When you edit the Integration details section, you can select the name or names of integration contacts.  Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.

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 .

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

Mapping fields

Creating custom mappings

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

Complete these actions:

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

Create custom mappings to map the Lucidchart fields that you want to add to Oomnitza:

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. For example, you can change the name of the Id field to Lucidchart ID.
4. Click CREATE. 
5. Ensure that the Email is mapped to the Email field on the Oomnitza side (required for integration).
6. Ensure that the Username is mapped to the Username field on the Oomnitza side (required for integration).
7. Select the Role field on the Oomnitza mapping side.
8. Choose a suitable role from the list (a defined role is necessary for the integration)
9. Assign a sync key to a unique field, such as the Email.
10. Click UPDATE.

Custom Lucidchart to Oomnitza mappable fields

The following Lucidchart fields can be mapped to Oomnitza:

Can Edit
Connector Sync Time
Created
Display Name
Email
Family Name
Formatted Name
Given Name
Id
Is Active
Last Modified
Location
Resource Type
Roles List
Username
Version

---

Running the integration

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

Optional: Using workflows to retrieve SaaS user information ▼

SaaS user role information is automatically retrieved when you run the integration. And, if you have enabled the Deactivate feature, users are automatically deactivated.

Before you create a SaaS user workflow, you must have run the Lucid integration and selected User plus SaaS User to populate the Lucidchart software entry in the Software SaaS menu.

To create a SaaS User workflow using the Lucidchart user role preset, complete the following steps:

1. Click Configuration  Workflows
2. Click Add and select Software SaaS Users from the list.
3. Enter the name and a description of the workflow.
4. Edit the Begin block and add rules to target the records.
5. Click the Blocks tab, and drag and drop the SaaS User Role retrieval block onto the canvas.
6. Click Edit.
7. Enter Lucidchart in the search field and choose the Lucidchart User Role preset.
8. Click the right arrow.
9. Enter your credentials.
10. Select the Deactivate User checkbox to deactivate the SaaS user in SaaS Lucidchart Users if they are flagged as inactive in Lucidchart. In other words, if active equals false in Lucidchart.
11. Click SAVE.
12. Connect the blocks.
13. Validate, launch, and save your workflow.

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.