Access scopes are used to limit the permissions of an issued token. When requesting a token, the client includes a list of what actions it wants permission to perform by including the appropriate scopes. Each API includes a list of which scopes allow that action to be performed.
Some scopes contain children to provide additional access granularity. If the parent scope is given, all children permissions are included. For example, requesting lucidchart.document.app includes all permissions given in lucidchart.document.app.folder, etc.
Additional details about OAuth 2.0 scopes can be found at https://oauth.net/2/scope
| Scope | Description shown to users on the consent screen | Valid Token Types |
|---|---|---|
| account.audit.logs | View audit logs on your account. | Account User |
| account.info | View basic information about your account (e.g., account ID and account name) . | Account User |
| account.legalhold | Create and view legal holds on your account. | User |
| account.legalhold.users | Manage and view users on legal hold on your account. | User |
| account.legalhold.users:readonly | View users on legal hold on your account. | User |
| account.legalhold:readonly | View legal holds on your account. | User |
| account.settings:readonly | View settings for your account. | Account User |
| account.user | Create, view, edit, and delete users on your account. | Account |
| account.user.transfercontent | Transfer ownership of a user's resources to another user on your account. | Account |
| account.user:readonly | View users on your account. | Account User |
| account.users:admin.readonly | View all users and their roles on your account. | User |
| cloud.credential | Create and view cloud credentials for your user. | User |
| cloud.credential:readonly | View cloud credentials for your user. | User |
| cloud.datasource | Create and view cloud data sources for your user. | User |
| cloud.datasource:readonly | View cloud data sources for your user. | User |
| cloud.model | Create cloud documents for your user. | User |
| folder | Create, view, edit, share, and delete your folders. Organize your folders and their contents. | User |
| folder:admin | View and manage any of the folders on your account. | User |
| folder:admin.readonly | View any of the folders on your account. | User |
| folder:readonly | View any of your folders and list their contents. | Account User |
| invitation.accept | Accept document and folder share links. | User |
| licenses:admin | View and manage licenses on your account. | User |
| licenses:admin.readonly | View licenses on your account. | User |
| lucid.document.accessRequest | Request access to any Lucid document on your behalf. | User |
| lucid.document.app.folder | Create, view, edit, and manage Lucid documents created with this app. Create an account project to store the created documents. | Account User |
| lucid.document.app.picker | View, edit, and manage any Lucid document on your account selected for this application. | Account User |
| lucid.document.app.picker.share.collaborator | Create, view, edit, and delete collaborators and invitations of any Lucid document on your account selected for this application. | Account User |
| lucid.document.app.picker.share.collaborator:readonly | View collaborators and invitations of any Lucid document on your account selected for this application. | Account User |
| lucid.document.app.picker.share.embed | Create, view, edit, and delete embeds of any Lucid document on your account selected for this application. | Account User |
| lucid.document.app.picker.share.embed:readonly | View embeds of any Lucid document on your account selected for this application. | Account User |
| lucid.document.app.picker.share.link | Create, view, edit, and delete share links owned by this application of any Lucid document selected for this application. | Account User |
| lucid.document.app.picker.share.link:readonly | View share links owned by this application of any Lucid document selected for this application. | Account User |
| lucid.document.app.picker:readonly | View and download any Lucid document on your account selected for this application. | Account User |
| lucid.document.content | Create, view, edit, and delete any Lucid document on your account. | Account User |
| lucid.document.content.share.collaborator | Create, view, edit, and delete collaborators and invitations for any Lucid documents on your account. | Account User |
| lucid.document.content.share.collaborator:readonly | View collaborators and invitations for any Lucid documents on your account. | Account User |
| lucid.document.content.share.embed | Create, view, edit, and delete embeds for any Lucid documents on your account. | Account User |
| lucid.document.content.share.embed:readonly | View embeds for any Lucid documents on your account. | Account User |
| lucid.document.content.share.link | Create, view, edit, and delete share links owned by this application for any of your Lucid documents. | Account User |
| lucid.document.content.share.link:readonly | View share links owned by this application for any of your Lucid documents. | Account User |
| lucid.document.content:admin | View and manage any of the Lucid documents on your account. | User |
| lucid.document.content:admin.readonly | View any of the Lucid documents on your account. | User |
| lucid.document.content:readonly | View and download any Lucid document on your account. | Account User |
| lucidchart.document.accessRequest | Request access to any Lucidchart document on your behalf. | User |
| lucidchart.document.app | View, edit, and manage any Lucidchart document selected for this third-party application. Create, view, edit, and manage any Lucidchart document within its app-specific folder. | User |
| lucidchart.document.app.folder | Create, view, edit, and manage any Lucidchart document within its app-specific folder. | User |
| lucidchart.document.app.picker | View, edit, and manage any Lucidchart document selected for this third-party application. | Account User |
| lucidchart.document.app.picker.share.collaborator | Create, view, edit, and delete collaborators and invitations of any Lucidchart document on your team or enterprise account selected for the third-party application. | Account User |
| lucidchart.document.app.picker.share.collaborator:readonly | View collaborators and invitations of any Lucidchart document on your team or enterprise account selected for the third-party application. | Account User |
| lucidchart.document.app.picker.share.embed | Create, view, edit, and delete embeds of any Lucidchart document on your team or enterprise account selected for the third-party application. | Account User |
| lucidchart.document.app.picker.share.embed:readonly | View embeds of any Lucidchart document on your account selected for this application. | Account User |
| lucidchart.document.app.picker.share.link | Create, view, edit, and delete the third party application's share links of any Lucidchart document on your team or enterprise account selected for the third-party application. | Account User |
| lucidchart.document.app.picker.share.link:readonly | View the third party application's share links of any Lucidchart document on your team or enterprise account selected for the third-party application. | Account User |
| lucidchart.document.app.picker:readonly | View and download any Lucidchart document selected for this third-party application. | Account User |
| lucidchart.document.content | Create, view, edit, and delete any Lucidchart document on your account. | Account User |
| lucidchart.document.content.share.collaborator | Create, view, edit, and delete collaborators and invitations for any of your Lucidchart documents on your team or enterprise account. | Account User |
| lucidchart.document.content.share.collaborator:readonly | View collaborators and invitations for any of your Lucidchart documents on your team or enterprise account. | Account User |
| lucidchart.document.content.share.embed | Create, view, edit, and delete embeds for any of your Lucidchart documents on your team or enterprise account. | Account User |
| lucidchart.document.content.share.embed:readonly | View embeds for any Lucidchart documents on your account. | Account User |
| lucidchart.document.content.share.link | Create, view, edit, and delete the third party application's share links for any of your Lucidchart documents on your team or enterprise account. | Account User |
| lucidchart.document.content.share.link:readonly | View the third party application's share links for any of your Lucidchart documents on your team or enterprise account. | Account User |
| lucidchart.document.content:admin | View and manage any of the Lucidchart documents on your account. | User |
| lucidchart.document.content:admin.readonly | View any of the Lucidchart documents on your account. | User |
| lucidchart.document.content:readonly | View and download any Lucidchart document on your account. | Account User |
| lucidscale.document.accessRequest | Request access to any Lucidscale model on your behalf. | User |
| lucidscale.document.app | View, edit, and manage any Lucidscale model selected for this third-party application. Create, view, edit, and manage any Lucidscale model within its app-specific folder. | User |
| lucidscale.document.app.folder | Create, view, edit, and manage any Lucidscale model within its app-specific folder. | User |
| lucidscale.document.app.picker | View, edit, and manage any Lucidscale model selected for this third-party application. | Account User |
| lucidscale.document.app.picker.share.collaborator | Create, view, edit, and delete collaborators and invitations of any Lucidscale model on your team or enterprise account selected for the third-party application. | Account User |
| lucidscale.document.app.picker.share.collaborator:readonly | View collaborators and invitations of any Lucidscale model on your team or enterprise account selected for the third-party application. | Account User |
| lucidscale.document.app.picker.share.embed | Create, view, edit, and delete embeds of any Lucidscale model on your team or enterprise account selected for the third-party application. | Account User |
| lucidscale.document.app.picker.share.embed:readonly | View embeds of any Lucidscale model on your account selected for this application. | Account User |
| lucidscale.document.app.picker.share.link | Create, view, edit, and delete the third party application's share links of any Lucidscale model on your team or enterprise account selected for the third-party application. | Account User |
| lucidscale.document.app.picker.share.link | View the third party application's share links of any Lucidscale model on your team or enterprise account selected for the third-party application. | Account User |
| lucidscale.document.app.picker.share.link:readonly | View share links owned by this application of any Lucidscale model selected for this application. | Account User |
| lucidscale.document.app.picker:readonly | View and download any Lucidscale model selected for this third-party application. | Account User |
| lucidscale.document.content | Create, view, edit, and delete any Lucidscale model on your account. | Account User |
| lucidscale.document.content.share.collaborator | Create, view, edit, and delete collaborators and invitations for any of your Lucidscale models on your team or enterprise account. | Account User |
| lucidscale.document.content.share.collaborator:readonly | View collaborators and invitations for any of your Lucidscale models on your team or enterprise account. | Account User |
| lucidscale.document.content.share.embed | Create, view, edit, and delete embeds for any of your Lucidscale models on your team or enterprise account. | Account User |
| lucidscale.document.content.share.embed:readonly | View embeds for any Lucidscale models on your account. | Account User |
| lucidscale.document.content.share.link | Create, view, edit, and delete the third party application's share links for any of your Lucidscale models on your team or enterprise account. | Account User |
| lucidscale.document.content.share.link:readonly | View the third party application's share links for any of your Lucidscale models on your team or enterprise account. | Account User |
| lucidscale.document.content:admin | View and manage any of the Lucidscale models on your account. | User |
| lucidscale.document.content:admin.readonly | View any of the Lucidscale models on your account. | User |
| lucidscale.document.content:readonly | View and download any Lucidscale model on your account. | Account User |
| lucidspark.document.accessRequest | Request access to any Lucidspark board on your behalf. | User |
| lucidspark.document.app | View, edit, and manage any Lucidspark board selected for this third-party application. Create, view, edit, and manage any Lucidspark board within its app-specific folder. | User |
| lucidspark.document.app.folder | Create, view, edit, and manage any Lucidspark board within its app-specific folder. | User |
| lucidspark.document.app.picker | View, edit, and manage any Lucidspark board selected for this third-party application. | Account User |
| lucidspark.document.app.picker.share.collaborator | Create, view, edit, and delete collaborators and invitations of any Lucidspark board on your team or enterprise account selected for the third-party application. | Account User |
| lucidspark.document.app.picker.share.collaborator:readonly | View collaborators and invitations of any Lucidspark board on your team or enterprise account selected for the third-party application. | Account User |
| lucidspark.document.app.picker.share.embed | Create, view, edit, and delete embeds of any Lucidspark board on your team or enterprise account selected for the third-party application. | Account User |
| lucidspark.document.app.picker.share.embed:readonly | View embeds of any Lucidspark board on your account selected for this application. | Account User |
| lucidspark.document.app.picker.share.link | Create, view, edit, and delete the third party application's share links of any Lucidspark board on your team or enterprise account selected for the third-party application. | Account User |
| lucidspark.document.app.picker.share.link:readonly | View the third party application's share links of any Lucidspark board on your team or enterprise account selected for the third-party application. | Account User |
| lucidspark.document.app.picker:readonly | View and download any Lucidspark board selected for this third-party application. | Account User |
| lucidspark.document.content | Create, view, edit, and delete any Lucidspark board on your account. | Account User |
| lucidspark.document.content.share.collaborator | Create, view, edit, and delete collaborators and invitations for any of your Lucidspark boards on your team or enterprise account. | Account User |
| lucidspark.document.content.share.collaborator:readonly | View collaborators and invitations for any of your Lucidspark boards on your team or enterprise account. | Account User |
| lucidspark.document.content.share.embed | Create, view, edit, and delete embeds for any of your Lucidspark boards on your team or enterprise account. | Account User |
| lucidspark.document.content.share.embed:readonly | View embeds for any Lucidspark boards on your account. | Account User |
| lucidspark.document.content.share.link | Create, view, edit, and delete the third party application's share links for any of your Lucidspark boards on your team or enterprise account. | Account User |
| lucidspark.document.content.share.link:readonly | View the third party application's share links for any of your Lucidspark boards on your team or enterprise account. | Account User |
| lucidspark.document.content:admin | View and manage any of the Lucidspark boards on your account. | User |
| lucidspark.document.content:admin.readonly | View any of the Lucidspark boards on your account. | User |
| lucidspark.document.content:readonly | View and download any Lucidspark board on your account. | Account User |
| offline_access | Continue to perform authorized actions when you’re not logged in (required to refresh tokens). | Account User |
| repository | Create, view, and manage any of your repositories. | User |
| repository:readonly | View any of your repositories. | User |
| teams | Create, view, and manage any of your Teams. | User |
| teams:admin | Create, view, and manage any Teams on your account. | User |
| teams:readonly | View any of your Teams. | User |
| user.profile | Allow applications to view basic information about you (e.g., full name, username, and email). | User |
ImportantThe following list of scopes will be deprecated in favor of product specific scopes. In the meantime, they will be mapped to their Lucidchart scope equivalent (ex.
document.contentbecomeslucidchart.document.content). Make sure your access tokens are using the new product specific scopes.
| Deprecated Scope | Description shown to users on the consent screen | Valid Token Types |
|---|---|---|
| document.app | View, edit, and manage any Lucidchart document selected for this third-party application. Create, view, edit, and manage any Lucidchart document within its app-specific folder. | Account User |
| document.app.folder | Create, view, edit, and manage any Lucidchart document within its app-specific folder. | Account User |
| document.app.picker | View, edit, and manage any Lucidchart document selected for this third-party application. | Account User |
| document.app.picker:readonly | View and download any Lucidchart document selected for this third-party application. | Account User |
| document.content | Create, view, edit, and delete any Lucidchart document on your account. | Account User |
| document.content:readonly | View and download any Lucidchart document on your account. | Account User |