OAuth Scopes
Scopes | Description | Associated Apis | Supports Tokens |
organizations:read | View details of all organizations associated with the user | Get all organizations | user token |
organization:read | View details of an organization | Get a single organization | user token |
| Get all stacks in an Organization | user token | ||
organization.logs:read | View organization logs | Get organization log details | user token |
| Get organization log item | user token | ||
organization.ownership:write | Create, update of organization ownership | Transfer Organization ownership | user token |
organization.roles:read | View organization level roles | Get all roles in an Organization | user token |
organization.share:write | Update, remove organization invitation shares | Add users to Organization | user token |
| Remove users from organization | user token | ||
| Resend pending Organization invitation | user token | ||
organization.share:read | View details of organization invitations shared with users | Get all Organization invitations | user token |
user:read | View user details | Get user | user token |
user:write | Update user details | Update user | user token |
user.assignments:read | View user assignments | Get all Tasks | user token |
cm.stacks.management:read | View all stacks | Get a single stack | user token |
cm.stacks.management:write | Create, update, remove stacks | Create stack | user token |
| Update stack | user token | ||
| Delete stack | user token | ||
cm.stack.users:read | View users associated with a stack | Get all users of a stack | user token, app token |
cm.stack.users:write | Update user roles and user associations with a stack | Update User Role | user token |
cm.stack.management:write | Update stack management properties | Transfer stack ownership to other users | user token |
cm.stack.settings:read | Update stack settings | Add stack settings | user token |
| Reset stack settings | user token | ||
cm.stack:share | Share stack invitation with users | Share a stack | user token |
cm.stack:unshare | Unshare stack invitations | Unshare a stack | user token |
cm.stack.delivery-tokens:read | View delivery tokens associated with a stack | Get all delivery tokens | user token |
| Get a single delivery token | user token | ||
cm.stack.delivery-tokens:write | Create, update, remove delivery tokens in a stack | Create delivery token | user token |
| Update delivery token | user token | ||
| Delete delivery token | user token | ||
cm.stack.management-tokens:read | View management tokens associated with a stack | Get all management tokens | user token |
| Get a single management token | user token | ||
cm.stack.management-tokens:write | Create, update, remove management tokens in a stack | Create management token | user token |
| Update management token | user token | ||
| Delete management token | user token | ||
cm.content-types.management:read | View all content types | Get all content types | user token, app token |
| Get a single content type | user token, app token | ||
cm.content-types.management:write | Create, update, remove content types | Create a content type | user token, app token |
| Create content type with select field | user token, app token | ||
| Create content type with JSON RTE | user token, app token/p> | ||
| Create a content type with embedded RTE objects | user token, app token | ||
| Create Content Type with Extension Field | user token, app token | ||
| Create content type with JSON RTE plugin | user token, app token | ||
| Update Content Type | user token, app token | ||
| Update content type with embedded RTE objects | user token, app token | ||
| Set Field Visibility Rule for Content Type | user token, appp token | ||
| Delete Content Type | user token, app token | ||
cm.content-type:read | View content type details | Get all references of content type | user token, app token |
cm.content-types:export | Export content types | Export a content type | user token, app token |
cm.content-types:import | Import content types | Import a content type | user token, app token |
cm.global-fields.management:read | View all global fields | Get all global fields | user token, app token |
| Get a single global field | user token, app token | ||
cm.global-fields.management:write | Create, update, remove global fields | Create a global field | user token, app token |
| Update a global field | user token, app token | ||
| Delete global field | user token, app token | ||
cm.global-fields:import | Export global fields | Export a global field | user token, app token |
cm.entries.management:read | View all entries | Get all entries | user token, app token |
| Get a single entry | user token, app token | ||
| Get information on embedded RTE objects | user token, app token | ||
cm.entries.management:write | Create, update, remove entries | Create an entry | user token, app token |
| Create an entry with JSON RTE | user token, app token | ||
| Create an entry with embedded entries in RTE | user token, app token | ||
| Create an entry with embedded assets in RTE | user token, app token | ||
| Create an entry with master locale | user token, app token | ||
| Update an entry | user token, app token | ||
| Update an entry with JSON RTE | user token, app token | ||
| Update embedded RTE objects | user token, app token | ||
| Delete an entry | user token, app token | ||
| Localize an entry | user token, app token | ||
cm.entry:write | Update details associated with an entry | Set Version Name for Entry | user token, app token |
| Delete Version Name of Entry | user token, app token | ||
| Unlocalize an entry | user token, app token | ||
cm.entry:read | View details associated with an entry | Get Details of All Versions of an Entry | user token, app token |
| Get references of an entry | user token, app token | ||
| Get languages of an entry | user token, app token | ||
cm.entries:export | Export entries | Export an entry | user token, app token |
cm.entries:import | Import entries | Import an entry | user token, app token |
| Import an existing entry | user token, app token | ||
cm.entry:publish | Publish an entry | Publish an entry | user token, app token |
cm.entry:unpublish | Unpublish an entry | Unpublish an entry | user token, app token |
cm.entry.workflow:write | Create a workflow for an entry | Set entry workflow stage | user token, app token |
| Request/Accept/Reject Entry Publish Request | user token, app token | ||
cm.bulk-operations:publish | Publish bulk operations | Publish an entry with references | user token, app token |
| Publish entries and assets in bulk | user token, app token | ||
cm.bulk-operations:unpublish | Unpublish bulk operations | Unpublish entries and assets in bulk | user token, app token |
cm.bulk-operations:delete | Delete bulk operations | Delete entries and assets in bulk | user token, app token |
cm.bulk-operations:workflow | Workflow bulk operations | Update workflow details in bulk | user token, app token |
cm.assets.management:read | View all assets | Get all assets | user token, app token |
| Get an asset | user token, app token | ||
| Get assets of a specific folder | user token, app token | ||
| Get assets and subfolders of a parent folder | user token, app token | ||
| Get either only images or videos | user token, app token | ||
| Get a single folder | user token, app token | ||
| Get a single folder by name | user token, app token | ||
| Get subfolders of a parent folder | user token, app token | ||
cm.assets.management:write | Create, update, remove assets | Upload asset | user token, app token |
| Replace asset | user token, app token | ||
| Generate permanent asset URL | user token, app token | ||
| Delete asset | user token, app token | ||
| Update asset revision | user token, app token | ||
| Update asset | user token, app token | ||
| Create a folder | user token, app token | ||
| Update or move folder | user token, app token | ||
| Delete a folder | user token, app token | ||
cm.assets:download | Download assets | Download an asset with permanent URL | user token, app token |
cm.assets.rt:read | View all RTE assets | Get information on RTE assets | user token, app token |
cm.asset:write | Create, update, remove RTE assets | Set Version Name for Asset | user token, app token |
| Delete Version Name of Asset | user token, app token | ||
cm.asset:read | View asset details | Get Details of All Versions of an Asset | user token, app token |
| Get asset references | user token, app token | ||
cm.asset:publish | Publish an asset | Publish an asset | user token, app token |
cm.asset:unpublish | Unpublish an asset | Unpublish an asset | user token, app token |
cm.extensions.management:read | View all extensions | Get all custom fields | user token, app token |
| Get a single custom field | user token, app token | ||
| Get all widgets | user token, app token | ||
| Get widgets of a content type | user token, app token | ||
| Get All Dashboard Widgets | user token, app token | ||
| Get all JSON RTE plugins | user token, app token | ||
| Get a single JSON RTE plugin | user token, app token | ||
cm.extensions.management:write | Create, update, remove extensions | Upload a custom field | user token, app token |
| Create a custom field with source URL | user token, app token | ||
| Create a custom field with source code | user token, app token | ||
| Update a custom field | user token, app token | ||
| Delete custom field | user token, app token | ||
| Upload a widget | user token, app token | ||
| Create widget with source URL | user token, app token | ||
| Create widget with source code | user token, app token | ||
| Update a widget | user token, app token | ||
| Delete a widget | user token, app token | ||
| Upload Dashboard Widget | user token, app token | ||
| Create a Dashboard Widget with Source URL | user token, app token | ||
| Create a Dashboard Widget with Source code | user token, app token | ||
| Update the Dashboard Widget | user token, app token | ||
| Delete the Dashboard Widget | user token, app token | ||
| Create a JSON RTE plugin with source URL | user token, app token | ||
| Update a JSON RTE plugin | user token, app token | ||
| Delete JSON RTE plugin | user token, app token | ||
cm.releases.management:read | View all releases | Get all Releases | user token, app token |
| Get a single Release | user token, app token | ||
cm.releases.management:write | Create, update, remove releases | Create a Release | user token, app token |
| Update a Release | user token, app token | ||
| Delete a Release | user token, app token | ||
cm.release:read | View details associated with a release | Get all items in a Release | user token, app token |
cm.release:write | Update details associated with a release | Add a single item to a Release | user token, app token |
| Add multiple items to a Release | user token, app token | ||
| Remove an item from a Release | user token, app token | ||
| Delete multiple items from a Release | user token, app token | ||
| Update Release items to their latest versions | user token, app token | ||
cm.release:deploy | Deploy a release | Deploy a Release | user token, app token |
cm.release:clone | Clone a release | Clone a Release | user token, app token |
cm.workflows.management:read | View all workflows | Get all workflows | user token, app token |
| Get a single workflow | user token, app token | ||
| Get publish rules by content types | user token, app token | ||
cm.workflows.management:write | Create, update, remove workflows | Create a workflow | user token, app token |
| Add or update workflow details | user token, app token | ||
| Disable workflow | user token, app token | ||
| Enable workflow | user token, app token | ||
| Delete workflow | user token, app token | ||
cm.workflows.publishing-rules:write | Create, update, remove workflow publishing rules | Create publish rules | user token, app token |
| Update publish rules | user token, app token | ||
| Delete publish rules | user token, app token | ||
cm.workflows.publishing-rules:read | View all workflow publishing rules | Get all publish rules | user token, app token |
| Get a single publish rule | user token, app token | ||
cm.labels.management:read | View all labels | Get all labels | user token, app token |
| Get a single label | user token, app token | ||
cm.labels.management:write | Create, update, remove labels | Add label | user token, app token |
| Update label | user token, app token | ||
| Delete label | user token, app token | ||
cm.languages.management:read | View all languages | Get all languages | user token, app token |
| Get a language | user token, app token | ||
cm.languages.management:write | Create, update, remove languages | Add a language | user token, app token |
| Update language | user token, app token | ||
| Delete language | user token, app token | ||
| Set a fallback language | user token, app token | ||
| Update fallback language | user token, app token | ||
cm.environments.management:read | View all environments | Get all environments | user token, app token |
| Get a single environment | user token, app token | ||
cm.environments.management:write | Create, update, remove environments | Add an environment | user token, app token |
| Update environment | user token, app token | ||
| Delete environment | user token, app token | ||
cm.roles.management:read | View all roles | Get all roles | user token, app token |
| Get a single role | user token, app token | ||
cm.roles.management:write | Create, update, remove roles | Create a role | user token, app token |
| Update role | user token, app token | ||
| Delete role | user token, app token | ||
cm.webhooks.management:read | View all webhooks | Get all webhooks | user token, app token |
| Get webhook | user token, app token | ||
cm.webhooks.management:write | Create, update, remove webhooks | user token, app token | |
| Update webhook | user token, app token | ||
| Delete webhook | user token, app token | ||
| Retry a webhook | user token, app token | ||
cm.webhooks:export | Export webhooks | Export a Webhook | user token, app token |
cm.webhooks:import | Import webhooks | Import a Webhook | user token, app token |
| Import an Existing Webhook | user token, app token | ||
cm.webhook:read | View webhook details | Get executions of a webhook | user token, app token |
| Get latest execution log of a webhook | user token, app token | ||
cm.audit-logs:read | View all audit logs | Get audit log | user token, app token |
| Get audit log item | user token, app token | ||
cm.publish-queue.management:read | View all publish queues | Get publish queue | user token, app token |
| Get publish queue activity | user token, app token | ||
cm.publish-queue.management:write | Create, update, remove publish queues | Cancel scheduled action | user token, app token |
cm.branches.management:read | View all branches | Get all Branches | user token, app token |
Get a single branch | user token, app token | ||
| cm.branches.management:write | Create, delete a branch | Create a branch | user token, app token |
| Delete a branch | user token, app token | ||
cm.branch-aliases.management:read | View all aliases | Get all branch-aliases | user token, app token |
| Get a single branch-alias | user token, app token | ||
| cm.branch-aliases.management:write | Create, assign, delete a branch alias | Assign a branch-alias | user token, app token |
| Delete a branch-alias | user token, app token | ||
| cm.taxonomies.management:read | View all taxonomies | Get all taxonomies | user token, app token |
| cm.taxonomies.management:write | Create, update, delete taxonomies | Create a taxonomy | user token, app token |
| Update a taxonomy | user token, app token | ||
| Delete a taxonomy | user token, app token | ||
| cm.taxonomy.terms:read | View all terms of a taxonomy | Get all terms of a taxonomy | user token, app token |
| cm.taxonomy.terms:write | Create, update, move, delete term(s) of a taxonomy | Create a term | user token, app token |
| Update a term | user token, app token | ||
| Move/Reorder a term | user token, app token | ||
| Delete a term | user token, app token | ||
| brand-kits:read | View Brand Kit(s) and Voice Profile(s). Generative AI to generate content. | Get All Brand Kits | user token, app token |
| Get a Single Brand Kit | user token, app token | ||
| Get All Voice Profiles | user token, app token | ||
| Get a Single Voice Profile | user token, app token | ||
| GenAI | user token, app token | ||
| brand-kits:manage | Create, update, or delete Brand Kit and Voice Profile. Ingest, get usage, update, and delete Knowledge Vault. | Create Brand Kit | user token, app token |
| Update Brand Kit | user token, app token | ||
| Delete Brand Kit | user token, app token | ||
| Create Voice Profile | user token, app token | ||
| Update Voice Profile | user token, app token | ||
| Delete Voice Profile | user token, app token | ||
| Ingest Content | user token, app token | ||
| Get Content Usage | user token, app token | ||
| Update Content | user token, app token | ||
| Delete Content | user token, app token | ||
| personalize:read | View Attributes, Audiences, Events, Experiences, Experiences Priority, Analytics Summary, Time-series Analytics, Regions, Countries, and Cities. | Get all Attributes | >user token, app token |
| Get all Audiences | user token, app token | ||
| Get all Experiences | user token, app token | ||
| Get a Single Experience | user token, app token | ||
| Get all Experience Versions | user token, app token | ||
| Get all Events | user token, app token | ||
| Get Experiences Priority | user token, app token | ||
| Get Analytics Summary | user token, app token | ||
| Get Time-series Analytics | user token, app token | ||
| Get all Regions | user token, app token | ||
| Get all Countries | user token, app token | ||
| Get all Cities | user token, app token | ||
| personalize:manage | Create, update, or delete Attribute, Audience, Experience, Event, and Experience Version, and update Experiences Priority. | Create an Attribute | user token, app token |
| Update an Attribute | user token, app token | ||
| Delete an Attribute | user token, app token | ||
| Create an Audience | user token, app token | ||
| Update an audience | user token, app token | ||
| Delete an audience | user token, app token | ||
| Create an Experience | user token, app token | ||
| Update an Experience | user token, app token | ||
| Delete an Experience | user token, app token | ||
| Create an Experience Version | user token, app token | ||
| Update an Experience Version | user token, app token | ||
| Delete an Experience Version | user token, app token | ||
| Create an Event | user token, app token | ||
| Update an Event | user token, app token | ||
| Delete an Event | user token, app token | ||
| Update Experiences Priority | user token, app token | ||
| launch:manage | This scope lets you read, update, and manage resources | Get all Projects | user token, app token |
| Get a Project | user token, app token | ||
| Create a Project (Using Git Provider) | user token | ||
| Create a Project (Using File Upload) | user token, app token | ||
| Update a Project | user token, app token | ||
| Delete a Project | user token, app token | ||
| Get all Environments | user token, app token | ||
| Get an Environment | user token, app token | ||
| Create an Environment (Using Git Provider) | user token | ||
| Create an Environment (Using File Upload) | user token, app token | ||
| Update an Environment | user token, app token | ||
| Delete an Environment | user token, app token | ||
| Revalidate CDN Cache | user token, app token | ||
| Get a Signed Upload URL for a Project | user token, app token | ||
| Get a Signed Upload URL for an Environment | user token, app token | ||
| Get a Signed Upload URL for a Deployment | user token, app token | ||
| Get a Download URL for the Uploaded File | user token, app token | ||
| Get all Deployments | user token, app token | ||
| Get a Deployment | user token, app token | ||
| Create a Deployment (Using Git Provider) | user token | ||
| Create a Deployment (Using Previously Uploaded File) | user token, app token | ||
| Create a Deployment (Using Newly Uploaded File) | user token, app token | ||
| Get Deployment Logs | user token, app token | ||
| Get Server Logs | user token, app token | ||
| launch.projects:read | This scope lets you read resources | Get all Projects | user token, app token |
| Get a Project | user token, app token | ||
| Get all Environments | user token, app token | ||
| Get an Environment | user token, app token | ||
| Get all Deployments | user token, app token | ||
| Get a Deployment | user token, app token | ||
| Get a Download URL for the Uploaded File | user token, app token | ||
| Get Deployment Logs | user token, app token | ||
| Get Server Logs | user token, app token | ||
| launch.projects:write | This scope lets you create and update resources | Create a Project (Using Git Provider) | user token |
| Create a Project (Using File Upload) | user token, app token | ||
| Get a Signed Upload URL for a Project | user token, app token | ||
| Update a Project | user token, app token | ||
| Create an Environment (Using Git Provider) | user token | ||
| Create an Environment (Using File Upload) | user token, app token | ||
| Get a Signed Upload URL for an Environment | user token, app token | ||
| Update an Environment | user token, app token | ||
| Create a Deployment (Using Git Provider) | user token | ||
| Create a Deployment (Using Previously Uploaded File) | user token, app token | ||
| Create a Deployment (Using Newly Uploaded File) | user token, app token | ||
| Get a Signed Upload URL for a Deployment | user token, app token | ||
| Revalidate CDN Cache | user token, app token | ||
| launch.projects:delete | This scope lets you delete resources | Delete a Project | user token, app token |
| Delete an Environment | user token, app token |
More articles in "Contentstack OAuth"