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 |
---|---|
account.info | View basic information about your account (e.g., account ID and account name) . |
account.user | Create, view, edit, and delete users on your account. |
account.user:readonly | View users on your account. |
account.user.transfercontent | Transfer ownership of a user's resources to another user on your account. |
folder | Create, view, edit, share, and delete your folders. Organize your folders and their contents. |
folder:readonly | View any of your folders and list their contents. |
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. |
lucidchart.document.app.folder | Create, view, edit, and manage any Lucidchart document within its app-specific folder. |
lucidchart.document.app.picker | View, edit, and manage any Lucidchart document selected for this third-party application. |
lucidchart.document.app.picker:readonly | View and download any Lucidchart document selected for this third-party application. |
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. |
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. |
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. |
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. |
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. |
lucidchart.document.content | Create, view, edit, and delete any Lucidchart document on your account. |
lucidchart.document.content:readonly | View and download any Lucidchart document on your account. |
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. |
lucidchart.document.content.share.collaborator:readonly | View collaborators and invitations for any of your Lucidchart documents on your team or enterprise account. |
lucidchart.document.content.share.embed | Create, view, edit, and delete embeds for any of your Lucidchart documents on your team or enterprise account. |
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. |
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. |
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. |
lucidscale.document.app.folder | Create, view, edit, and manage any Lucidscale model within its app-specific folder. |
lucidscale.document.app.picker | View, edit, and manage any Lucidscale model selected for this third-party application. |
lucidscale.document.app.picker:readonly | View and download any Lucidscale model selected for this third-party application. |
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. |
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. |
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. |
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. |
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. |
lucidscale.document.content | Create, view, edit, and delete any Lucidscale model on your account. |
lucidscale.document.content:readonly | View and download any Lucidscale model on your account. |
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. |
lucidscale.document.content.share.collaborator:readonly | View collaborators and invitations for any of your Lucidscale models on your team or enterprise account. |
lucidscale.document.content.share.embed | Create, view, edit, and delete embeds for any of your Lucidscale models on your team or enterprise account. |
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. |
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. |
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. |
lucidspark.document.app.folder | Create, view, edit, and manage any Lucidspark board within its app-specific folder. |
lucidspark.document.app.picker | View, edit, and manage any Lucidspark board selected for this third-party application. |
lucidspark.document.app.picker:readonly | View and download any Lucidspark board selected for this third-party application. |
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. |
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. |
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. |
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. |
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. |
lucidspark.document.content | Create, view, edit, and delete any Lucidspark board on your account. |
lucidspark.document.content:readonly | View and download any Lucidspark board on your account. |
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. |
lucidspark.document.content.share.collaborator:readonly | View collaborators and invitations for any of your Lucidspark boards on your team or enterprise account. |
lucidspark.document.content.share.embed | Create, view, edit, and delete embeds for any of your Lucidspark boards on your team or enterprise account. |
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. |
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. |
offline_access | Continue to perform authorized actions when you’re not logged in (required to refresh tokens). |
user.profile | Allow applications to view basic information about you (e.g., full name, username, and email). |
Important
The 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.content
becomeslucidchart.document.content
). Make sure your access tokens are using the new product specific scopes.
Deprecated Scope | Description shown to users on the consent screen |
---|---|
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. |
document.app.folder | Create, view, edit, and manage any Lucidchart document within its app-specific folder. |
document.app.picker | View, edit, and manage any Lucidchart document selected for this third-party application. |
document.app.picker:readonly | View and download any Lucidchart document selected for this third-party application. |
document.content | Create, view, edit, and delete any Lucidchart document on your account. |
document.content:readonly | View and download any Lucidchart document on your account. |