The following document will capture the available integration points with Lucidchart and how to configure them.
Vendor: Lucidchart
Integration Type:
Authentication
OAuth2.0
Please follow the following steps to get new access token which can be used in Oomnitza API pre-sets and SaaS User Role block.
- Please follow the documentation to create an OAuth2.0 app and keep your Client ID and Client Secret to be used later in configuring your credential setup within Oomnitza (Step 8)
- Go to Oomnitza "Settings" page and select "Credentials"
- Click the '+' icon in the top right corner to add a new credential. A pop-up will appear:
- Type the 'Name' which helps you identify the credential, example ‘Lucidchart OAuth2.0’
- Enter the 'Owner' of the credential (optional), possibly the creator of this credential.
- Click the "Authorization" tab and select "OAuth 2.0" from the ‘Authorization type’ dropdown.
- Select your ‘Saas’, "Lucidchart" from the SaaS dropdown
- Type the Client ID and Client Secret you created in your OAuth2.0 App (Step 1 above)
- Click "Authenticate" button which will prompt you to log into 'Lucidchart' and authorize the request
- Type a useful "Description" which will help you identify the credential (optional)
- Click the "Create" button
- Finally, you should see the credential you created in the credentials list
Documentation Links:
- Lucidchart OAuth2.0 Documentation
User Token (User Role and Delete User)
Use the same method above to add the User Token (API Key) Credential.
Notes:
- Authorization Type: API Key
- Token Name: Authorization
- API Key: Bearer {API key}
- Please generate a bearer token via Admin → App Integration → SCIM → Check the checkbox “Automatically upgrade account when no more licenses are available“ → Click the button “Generate token“ → Copy the Bearer Token
- Please note: SCIM APIs are only available for Enterprise plan. It means the prerequisite of using User Role and Delete User blocks is upgrading to the Enterprise plan. Please ask Lucidchart CSM / Support to enable SCIM function.
Documentation Links:
- Lucidchart API Key Documentation
SaaS User Role Block
Please work through the following steps to configure the SaaS User Role Block for Lucidchart. Configuration of this SaaS User Role block will allow you to capture the Lucidchart "User Role" and the "Last Login" date (coming from your Lucidchart account) within Oomnitza.
Pre-requirements:
1. A Lucidchart Credential is added using the API Token Authentication method as described above.
2. Your Lucidchart SaaS and Contract details with Users are already available within Oomnitza
Steps:
1. Navigate to "Software>Workflow>SaaS Users" as per screenshot below.
2. From the SaaS Users Workflow page, select the "Add" button in the top right of your screen, above the grid.
3. Give your new Workflow a "Workflow name" (mandatory) and a "Workflow description" (optional) before selecting "Add Item" to create it.
4. From the "Tools" section on the left, drag the "SaaS User Role retrieval block" onto the "Sandbox" section.
Note: All workflows must start with the "Begin" block. The configuration for SaaS User Role blocks can be found here: https://oomnitza.zendesk.com/hc/en-us/articles/360053185893
5. To configure the "SaaS User Role retrieval block", you simply select "Edit" on this block.
6. You will be presented with a two step wizard. Search for the SaaS of choice, in this case, 'Lucidchart'. Select your SaaS using the '>' arrow control as high-lighted below to proceed with the configuration.
7. The "Name", "Description" and "Doculink" are all provided for you. You need to select the 'Credential' you created previously for Lucidchart, using the API Key authentication method.
Note: With "Deactivated User" selected, we will automatically reconcile deactivated users from your SaaS system (Lucidchart) back into Oomnitza.
8. Finally, select "Save" and your "SaaS User Role retrieval block' configuration is complete.
9. Your new workflow is ready to run, based off the "Actions" selected if the "Begin" block or else you can run it manually from here.
Lucidchart "User Role" and "Last Login" date
Now that your SaaS User Role block has been setup and the workflow has run, you will be able to get the "User Role" and "Last Login" details from your Lucidchart integration.
Steps:
1. Navigate to "Software>SaaS" and select your software entry for Lucidchart. Note, that we are continuing to use Zoom for illustrative purposes.
2. From the dialog, navigate to "Users"
3. From within "Users", the "Role" and "Last visit" information will be populated directly from your SaaS account (via the SaaS User Role block workflow).
Documentation Links:
- Oomnitza: SaaS User Roles Overview
API block (Presets)
The following Lucidchart API block Presets are available:
- Lucidchart Delete User
Lucidchart Delete User
Using this setup outlined below, you can create a workflow that would automatically delete a Lucidchart user account within your Lucidchart SaaS which was deactivated from within Oomnitza.
Prerequisites:
1. A Lucidchart Credential is added using API Key Authentication method as described above.
2. Your Lucidchart SaaS and Contract details with Users are already setup within Oomnitza
3. You have run a workflow similar to above which would populate Oomnitza with the actual Lucidchart User Role and Last Login date from your Lucidchart SaaS.
Steps:
1. Navigate to "Software>Workflow>SaaS Users".
2. With "Workflow: SaaS Users" now selected, you can select the "Add" button in the top right of your screen.
3. Give your new Workflow a "Workflow name" (mandatory) and a "Workflow description" (optional) before selecting "Add Item" to create it.
4. From the "Tools" section, drag the "API block" onto the "Sandbox" section.
5. To configure the "API block", you simply select "Edit".
6. Select "Show Presets" from the API block dialog.
7. Search for you Vendor, in this case "Lucidchart"
8. "Apply" the Preset you wish to use, "Lucidchart Delete User" in this example.
9. A confirmation message will appear on screen your and the URL will be populated on the dialog.
10. You can update the current "Name" on the dialog before moving onto the "Authorization" tab
11. Set the "Type" to "API Key" and select the "Credentials" that you have previously created as part of the API Key authentication method.
12. Finally, select "Save" and your "API block' configuration is complete.
13. Your new workflow is ready to run, based off the configuration of the "Begin" block or else you can run it manually from here.
Notes:
- No additional amendments to Parameters, Headers, Body are required for this API Preset to work
0 Comments