- 28 Sep 2023
- 3 Minutes to read
- Print
- DarkLight
- PDF
Lucidchart
- Updated on 28 Sep 2023
- 3 Minutes to read
- Print
- DarkLight
- PDF
Lucidchart allows users to collaborate on drawing, revising, and sharing charts and diagrams.
Types of Assets Fetched
This adapter fetches the following types of assets:
- Users
- SaaS Data
Parameters
Host Name or IP Address (required) - The hostname or IP address of the Lucidchart server that Axonius can communicate with via the Required Ports.
Client ID and Client Secret (required) - The Client ID and Client Secret for an account that has read access to the API.
Refresh Token - The Refresh Token, refer to Obtaining an access token.
Login URL (Only for accounts with SaaS Management capability) - Needed to fetch SaaS data.
Redirect URL (Only for accounts with SaaS Management capability) - The Axonius OAuth app URI.
Account ID - Your Lucidchart account ID. This is the number in your admin console URL.
For example, if your URL is "https://admin.lucid.app/teams/123456789#/", then enter 123456789 in the Account name field.Username and Password (Only for accounts with SaaS Management capability) - The username and the password of an Axonius user account.
2FA Secret (Only for accounts with SaaS Management capability)- If the user created to collect SaaS Management data accesses Lucidchart through an SSO solution that requires 2-factor authentication, you will need to generate a secret key in that solution and paste it here. See instructions for performing this action in Okta.
Verify SSL (required, default: false) - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.
HTTPS Proxy (optional, default: empty) - Connect the adapter to a proxy instead of directly connecting it to the domain.
HTTPS Proxy User Name (optional, default: empty) - The user name to use when connecting to the value supplied in Host Name or IP Address via the value supplied in HTTPS Proxy.
HTTPS Proxy Password (optional, default: empty) - The password to use when connecting to the server using the HTTPS Proxy.
To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.
APIs
Axonius uses the Lucid API Version 1.
Required Ports
Axonius must be able to communicate with the value supplied in Host Name or IP Address via the following ports:
- 80
- 443
Required Permissions
- The custom OAuth app you create, must be granted 'View users on your account' permission.
- The value supplied in Client ID must have account.user:readonly access token permissions to fetch assets and
scope= account.user:readonly+offline_access
. - The access token must be an "Account token" and must be created by a user with Account Administrator permissions. For more information, see Access Token Types.
- The user you create must be granted Team Admin Privileges (needed to fetch SaaS data).
Generating a Client ID and Client Secret
The Lucidchart adapter uses Oauth2 verification, which requires a Client ID and Client Secret.
To generate a Client ID and Client Secret:
Login as an admin user to your Lucid admin console.
From the left navigation menu, go to App Integration > General > Custom OAuth app.
Under the Create Custom OAuth 2.0 Client section, provide a name for your app and click on Create OAuth 2.0 Client.
A new app record is added.Grant it the View users on your account permission.
From the app record, click on Details.
Copy the generated Client ID and Client Secret. Paste them in their corresponding parameters in Axonius.
In the Redirect URI field, add the following value: https://localhost/adapters/lucidchart_adapter.
(For users with the SaaS Management module) Copy the redirect URI and paste it in the Redirect URL parameter in Axonius.
Navigate to: https://lucid.app/oauth2/authorizeUser?client_id={client_id}&redirect_uri=https://localhost/adapters/lucidchart_adapter&scope=account.user:readonly+offline_access.
After authorizing, you will be redirected to https://localhost/adapters/lucidchart_adapter?code={code}.Copy the authorization code into the Token Request as described in Obtaining an Access Token.
You will receive a Refresh Token, paste that in the Refresh Token parameter in Axonius.
To Access SaaS Data
Create a New User Account
- Login as an admin user to your Lucid admin console.
- From the left navigation menu, go to Users.
- Click Add Users > Add a single user.
- Provide an email address you can access.
- Edit the users' roles and set it as Team Admin Privileges.
- You will receive an activation mail. Open the mail and use it to set the password.
- Copy the generated Username and Password.
- Paste the copied values into their parameters in Axonius.
Version Matrix
This adapter was only tested with the versions marked as supported, but may work with other versions. Contact Axonius Support if you have a version that is not listed, which is not functioning as expected.
Version | Supported | Notes |
---|---|---|
API v1 | Yes |
Supported From Version
Supported from Axonius version 5.0