How to authenticate with the The Jira Cloud platform REST API API.
OAuth2 scopes for Jira
https://auth.atlassian.com/authorizehttps://auth.atlassian.com/oauth/token| Scope | Description |
|---|---|
read:jql:jira | View JQL. |
read:jira-user | View user information in Jira that you have access to, including usernames, email addresses, and avatars. |
read:jira-work | Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs). |
read:role:jira | View roles. |
read:user:jira | View users. |
read:field:jira | View fields. |
read:group:jira | View user groups. |
read:issue:jira | View issues. |
read:label:jira | View labels. |
write:jira-work | Create and edit issues in Jira, post comments, create worklogs, and delete issues. |
read:avatar:jira | View system and custom avatars. |
read:filter:jira | View filters. |
read:screen:jira | View screens. |
read:status:jira | View statuses. |
write:field:jira | Create and update fields. |
write:group:jira | Create and update user groups. |
write:issue:jira | Create and update issues. |
delete:field:jira | Delete fields. |
delete:group:jira | Delete user groups. |
delete:issue:jira | Delete issues. |
read:comment:jira | View issue comments. |
read:license:jira | View licenses. |
read:project:jira | View projects. |
read:webhook:jira | View webhooks. |
validate:jql:jira | Validate JQL. |
write:avatar:jira | Create and update system and custom avatars. |
write:filter:jira | Create and update filters. |
write:screen:jira | Create and update screens. |
delete:avatar:jira | Delete system and custom avatars. |
delete:filter:jira | Delete filters. |
delete:screen:jira | Delete screens. |
read:priority:jira | View priorities. |
read:workflow:jira | View workflows. |
write:comment:jira | Create and update issue comments. |
write:project:jira | Create and update projects. |
write:webhook:jira | Create and update webhooks. |
delete:comment:jira | Delete issue comments. |
delete:project:jira | Delete projects and their details, such as issue types, project lead, and avatars. |
delete:webhook:jira | Delete webhooks. |
manage:jira-project | Create and edit project settings and create new project-level objects, for example, versions, components. |
manage:jira-webhook | Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks. |
read:audit-log:jira | View audit logs. |
read:dashboard:jira | View dashboards. |
write:workflow:jira | Create and update workflows. |
delete:workflow:jira | Delete workflows. |
read:attachment:jira | View issue attachments. |
read:issue-link:jira | View issue links. |
read:issue-meta:jira | View issue meta. |
read:issue-type:jira | View issue types. |
read:issue.vote:jira | View issue votes. |
read:permission:jira | View permissions. |
read:resolution:jira | View resolutions. |
read:screen-tab:jira | View screen tabs. |
write:dashboard:jira | Create and update dashboards. |
delete:dashboard:jira | Delete dashboards. |
read:issue-event:jira | Read issue events. |
read:issue.votes:jira | View issue voteses. |
write:attachment:jira | Create and update issue attachments. |
write:issue-link:jira | Create and update issue links. |
write:issue-type:jira | Create and update issue types. |
write:issue.vote:jira | Create and update issue votes. |
write:permission:jira | Create and update permissions. |
write:screen-tab:jira | Create and update screen tabs. |
delete:async-task:jira | Delete asynchronous task. |
delete:attachment:jira | Delete issue attachments. |
delete:issue-link:jira | Delete issue links. |
delete:issue-type:jira | Delete issue types. |
delete:permission:jira | Delete permissions. |
delete:screen-tab:jira | Delete screen tabs. |
read:field.option:jira | View field options. |
read:issue-status:jira | View issue statuses. |
read:project-role:jira | View project roles. |
read:project-type:jira | View project types. |
read:screen-field:jira | View screen fields. |
read:user.columns:jira | View user columnses. |
send:notification:jira | Send notifications. |
read:field.options:jira | Read field options. |
read:filter.column:jira | View filter columns. |
read:issue-details:jira | View issue details. |
read:issue-worklog:jira | View issue worklogs. |
read:issue.watcher:jira | View issue watchers. |
read:project.email:jira | View project emails. |
read:screen-scheme:jira | View screen schemes. |
read:user.property:jira | View user properties. |
write:field.option:jira | Create and update field options. |
write:project-role:jira | Create and update project roles. |
delete:field.option:jira | Delete field options. |
delete:project-role:jira | Delete project roles. |
read:issue.property:jira | View issue properties. |
read:project.avatar:jira | Read project avatars. |
write:filter.column:jira | Create and update filter columns. |
write:issue-worklog:jira | Create and update issue worklogs. |
write:issue.watcher:jira | Create and update issue watchers. |
write:project.email:jira | Create and update project emails. |
write:screen-scheme:jira | Create and update screen schemes. |
write:user.property:jira | Create and update user properties. |
delete:filter.column:jira | Delete filter columns. |
delete:issue-worklog:jira | Delete issue worklogs. |
delete:screen-scheme:jira | Delete screen schemes. |
delete:user.property:jira | Delete user properties. |
manage:jira-configuration | Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types. |
read:issue-link-type:jira | View issue link types. |
read:issue.changelog:jira | View issue changelogs. |
read:project-version:jira | View project versions. |
read:project.feature:jira | Read project features. |
read:workflow-scheme:jira | View workflow schemes. |
write:issue.property:jira | Create and update issue properties. |
write:project.avatar:jira | Create and update project avatars. |
delete:issue.property:jira | Delete issue properties. |
delete:project.avatar:jira | Delete project avatars. |
read:application-role:jira | View application roles. |
read:comment.property:jira | View issue comment properties. |
read:issue.transition:jira | View issue transitions. |
read:jira-expressions:jira | View jira expressions. |
read:project-category:jira | View project categories. |
read:project.property:jira | View project properties. |
read:screenable-field:jira | View screenable fields. |
write:issue-link-type:jira | Create and update issue link types. |
write:project-version:jira | Create and update project versions. |
write:project.feature:jira | Save project features. |
write:workflow-scheme:jira | Create and update workflow schemes. |
delete:issue-link-type:jira | Delete issue link types. |
delete:project-version:jira | Delete project versions. |
delete:workflow-scheme:jira | Delete workflow schemes. |
read:issue-type-scheme:jira | View issue type schemes. |
read:issue.remote-link:jira | View issue remote links. |
read:permission-scheme:jira | View permission schemes. |
read:project.component:jira | View project components. |
read:workflow.property:jira | View workflow properties. |
write:comment.property:jira | Create and update issue comment properties. |
write:project-category:jira | Create and update project categories. |
write:project.property:jira | Create and update project properties. |
write:screenable-field:jira | Create and update screenable fields. |
delete:comment.property:jira | Delete issue comment properties. |
delete:project-category:jira | Delete project categories. |
delete:project.property:jira | Delete project properties. |
delete:screenable-field:jira | Delete screenable fields. |
read:dashboard.property:jira | View dashboard properties. |
read:issue-field-values:jira | View issue field valueses. |
read:user-configuration:jira | View user configurations. |
write:issue-type-scheme:jira | Create and update issue type schemes. |
write:issue.remote-link:jira | Create and update issue remote links. |
write:permission-scheme:jira | Create and update permission schemes. |
write:project.component:jira | Create and update project components. |
write:workflow.property:jira | Create and update workflow properties. |
delete:issue-type-scheme:jira | Delete issue type schemes. |
delete:issue.remote-link:jira | Delete issue remote links. |
delete:permission-scheme:jira | Delete permission schemes. |
delete:project.component:jira | Delete project components. |
delete:workflow.property:jira | Delete workflow properties. |
read:field-configuration:jira | Read field configurations. |
read:field.default-value:jira | View field default values. |
read:issue-type.property:jira | View issue type properties. |
read:issue.time-tracking:jira | View issue time trackings. |
read:notification-scheme:jira | View notification schemes. |
write:dashboard.property:jira | Create and update dashboard properties. |
write:user-configuration:jira | Create and update user configurations. |
delete:dashboard.property:jira | Delete dashboard properties. |
delete:user-configuration:jira | Delete user configurations. |
read:issue-security-level:jira | View issue security levels. |
read:issue-type-hierarchy:jira | Read issue type hierarchies. |
write:field-configuration:jira | Save field configurations. |
write:field.default-value:jira | Create and update field default values. |
write:issue-type.property:jira | Create and update issue type properties. |
write:issue.time-tracking:jira | Create and update issue time trackings. |
delete:field-configuration:jira | Delete field configurations. |
delete:issue-type.property:jira | Delete issue type properties. |
read:issue-security-scheme:jira | View issue security schemes. |
read:instance-configuration:jira | View instance configurations. |
read:issue-worklog.property:jira | View issue worklog properties. |
write:instance-configuration:jira | Create and update instance configurations. |
write:issue-worklog.property:jira | Create and update issue worklog properties. |
delete:issue-worklog.property:jira | Delete issue worklog properties. |
read:issue-type-screen-scheme:jira | View issue type screen schemes. |
write:issue-type-screen-scheme:jira | Create and update issue type screen schemes. |
delete:issue-type-screen-scheme:jira | Delete issue type screen schemes. |
read:field-configuration-scheme:jira | View field configuration schemes. |
read:filter.default-share-scope:jira | View filter default share scopes. |
write:field-configuration-scheme:jira | Create and update field configuration schemes. |
write:filter.default-share-scope:jira | Create and update filter default share scopes. |
delete:field-configuration-scheme:jira | Delete field configuration schemes. |
read:custom-field-contextual-configuration:jira | Read custom field contextual configurations. |
write:custom-field-contextual-configuration:jira | Save custom field contextual configurations. |
You can access this resource via basic auth.
How to authenticate with the The Jira Cloud platform REST API API.
OAuth2 scopes for Jira
https://auth.atlassian.com/authorizehttps://auth.atlassian.com/oauth/token| Scope | Description |
|---|---|
read:jql:jira | View JQL. |
read:jira-user | View user information in Jira that you have access to, including usernames, email addresses, and avatars. |
read:jira-work | Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs). |
read:role:jira | View roles. |
read:user:jira | View users. |
read:field:jira | View fields. |
read:group:jira | View user groups. |
read:issue:jira | View issues. |
read:label:jira | View labels. |
write:jira-work | Create and edit issues in Jira, post comments, create worklogs, and delete issues. |
read:avatar:jira | View system and custom avatars. |
read:filter:jira | View filters. |
read:screen:jira | View screens. |
read:status:jira | View statuses. |
write:field:jira | Create and update fields. |
write:group:jira | Create and update user groups. |
write:issue:jira | Create and update issues. |
delete:field:jira | Delete fields. |
delete:group:jira | Delete user groups. |
delete:issue:jira | Delete issues. |
read:comment:jira | View issue comments. |
read:license:jira | View licenses. |
read:project:jira | View projects. |
read:webhook:jira | View webhooks. |
validate:jql:jira | Validate JQL. |
write:avatar:jira | Create and update system and custom avatars. |
write:filter:jira | Create and update filters. |
write:screen:jira | Create and update screens. |
delete:avatar:jira | Delete system and custom avatars. |
delete:filter:jira | Delete filters. |
delete:screen:jira | Delete screens. |
read:priority:jira | View priorities. |
read:workflow:jira | View workflows. |
write:comment:jira | Create and update issue comments. |
write:project:jira | Create and update projects. |
write:webhook:jira | Create and update webhooks. |
delete:comment:jira | Delete issue comments. |
delete:project:jira | Delete projects and their details, such as issue types, project lead, and avatars. |
delete:webhook:jira | Delete webhooks. |
manage:jira-project | Create and edit project settings and create new project-level objects, for example, versions, components. |
manage:jira-webhook | Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks. |
read:audit-log:jira | View audit logs. |
read:dashboard:jira | View dashboards. |
write:workflow:jira | Create and update workflows. |
delete:workflow:jira | Delete workflows. |
read:attachment:jira | View issue attachments. |
read:issue-link:jira | View issue links. |
read:issue-meta:jira | View issue meta. |
read:issue-type:jira | View issue types. |
read:issue.vote:jira | View issue votes. |
read:permission:jira | View permissions. |
read:resolution:jira | View resolutions. |
read:screen-tab:jira | View screen tabs. |
write:dashboard:jira | Create and update dashboards. |
delete:dashboard:jira | Delete dashboards. |
read:issue-event:jira | Read issue events. |
read:issue.votes:jira | View issue voteses. |
write:attachment:jira | Create and update issue attachments. |
write:issue-link:jira | Create and update issue links. |
write:issue-type:jira | Create and update issue types. |
write:issue.vote:jira | Create and update issue votes. |
write:permission:jira | Create and update permissions. |
write:screen-tab:jira | Create and update screen tabs. |
delete:async-task:jira | Delete asynchronous task. |
delete:attachment:jira | Delete issue attachments. |
delete:issue-link:jira | Delete issue links. |
delete:issue-type:jira | Delete issue types. |
delete:permission:jira | Delete permissions. |
delete:screen-tab:jira | Delete screen tabs. |
read:field.option:jira | View field options. |
read:issue-status:jira | View issue statuses. |
read:project-role:jira | View project roles. |
read:project-type:jira | View project types. |
read:screen-field:jira | View screen fields. |
read:user.columns:jira | View user columnses. |
send:notification:jira | Send notifications. |
read:field.options:jira | Read field options. |
read:filter.column:jira | View filter columns. |
read:issue-details:jira | View issue details. |
read:issue-worklog:jira | View issue worklogs. |
read:issue.watcher:jira | View issue watchers. |
read:project.email:jira | View project emails. |
read:screen-scheme:jira | View screen schemes. |
read:user.property:jira | View user properties. |
write:field.option:jira | Create and update field options. |
write:project-role:jira | Create and update project roles. |
delete:field.option:jira | Delete field options. |
delete:project-role:jira | Delete project roles. |
read:issue.property:jira | View issue properties. |
read:project.avatar:jira | Read project avatars. |
write:filter.column:jira | Create and update filter columns. |
write:issue-worklog:jira | Create and update issue worklogs. |
write:issue.watcher:jira | Create and update issue watchers. |
write:project.email:jira | Create and update project emails. |
write:screen-scheme:jira | Create and update screen schemes. |
write:user.property:jira | Create and update user properties. |
delete:filter.column:jira | Delete filter columns. |
delete:issue-worklog:jira | Delete issue worklogs. |
delete:screen-scheme:jira | Delete screen schemes. |
delete:user.property:jira | Delete user properties. |
manage:jira-configuration | Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types. |
read:issue-link-type:jira | View issue link types. |
read:issue.changelog:jira | View issue changelogs. |
read:project-version:jira | View project versions. |
read:project.feature:jira | Read project features. |
read:workflow-scheme:jira | View workflow schemes. |
write:issue.property:jira | Create and update issue properties. |
write:project.avatar:jira | Create and update project avatars. |
delete:issue.property:jira | Delete issue properties. |
delete:project.avatar:jira | Delete project avatars. |
read:application-role:jira | View application roles. |
read:comment.property:jira | View issue comment properties. |
read:issue.transition:jira | View issue transitions. |
read:jira-expressions:jira | View jira expressions. |
read:project-category:jira | View project categories. |
read:project.property:jira | View project properties. |
read:screenable-field:jira | View screenable fields. |
write:issue-link-type:jira | Create and update issue link types. |
write:project-version:jira | Create and update project versions. |
write:project.feature:jira | Save project features. |
write:workflow-scheme:jira | Create and update workflow schemes. |
delete:issue-link-type:jira | Delete issue link types. |
delete:project-version:jira | Delete project versions. |
delete:workflow-scheme:jira | Delete workflow schemes. |
read:issue-type-scheme:jira | View issue type schemes. |
read:issue.remote-link:jira | View issue remote links. |
read:permission-scheme:jira | View permission schemes. |
read:project.component:jira | View project components. |
read:workflow.property:jira | View workflow properties. |
write:comment.property:jira | Create and update issue comment properties. |
write:project-category:jira | Create and update project categories. |
write:project.property:jira | Create and update project properties. |
write:screenable-field:jira | Create and update screenable fields. |
delete:comment.property:jira | Delete issue comment properties. |
delete:project-category:jira | Delete project categories. |
delete:project.property:jira | Delete project properties. |
delete:screenable-field:jira | Delete screenable fields. |
read:dashboard.property:jira | View dashboard properties. |
read:issue-field-values:jira | View issue field valueses. |
read:user-configuration:jira | View user configurations. |
write:issue-type-scheme:jira | Create and update issue type schemes. |
write:issue.remote-link:jira | Create and update issue remote links. |
write:permission-scheme:jira | Create and update permission schemes. |
write:project.component:jira | Create and update project components. |
write:workflow.property:jira | Create and update workflow properties. |
delete:issue-type-scheme:jira | Delete issue type schemes. |
delete:issue.remote-link:jira | Delete issue remote links. |
delete:permission-scheme:jira | Delete permission schemes. |
delete:project.component:jira | Delete project components. |
delete:workflow.property:jira | Delete workflow properties. |
read:field-configuration:jira | Read field configurations. |
read:field.default-value:jira | View field default values. |
read:issue-type.property:jira | View issue type properties. |
read:issue.time-tracking:jira | View issue time trackings. |
read:notification-scheme:jira | View notification schemes. |
write:dashboard.property:jira | Create and update dashboard properties. |
write:user-configuration:jira | Create and update user configurations. |
delete:dashboard.property:jira | Delete dashboard properties. |
delete:user-configuration:jira | Delete user configurations. |
read:issue-security-level:jira | View issue security levels. |
read:issue-type-hierarchy:jira | Read issue type hierarchies. |
write:field-configuration:jira | Save field configurations. |
write:field.default-value:jira | Create and update field default values. |
write:issue-type.property:jira | Create and update issue type properties. |
write:issue.time-tracking:jira | Create and update issue time trackings. |
delete:field-configuration:jira | Delete field configurations. |
delete:issue-type.property:jira | Delete issue type properties. |
read:issue-security-scheme:jira | View issue security schemes. |
read:instance-configuration:jira | View instance configurations. |
read:issue-worklog.property:jira | View issue worklog properties. |
write:instance-configuration:jira | Create and update instance configurations. |
write:issue-worklog.property:jira | Create and update issue worklog properties. |
delete:issue-worklog.property:jira | Delete issue worklog properties. |
read:issue-type-screen-scheme:jira | View issue type screen schemes. |
write:issue-type-screen-scheme:jira | Create and update issue type screen schemes. |
delete:issue-type-screen-scheme:jira | Delete issue type screen schemes. |
read:field-configuration-scheme:jira | View field configuration schemes. |
read:filter.default-share-scope:jira | View filter default share scopes. |
write:field-configuration-scheme:jira | Create and update field configuration schemes. |
write:filter.default-share-scope:jira | Create and update filter default share scopes. |
delete:field-configuration-scheme:jira | Delete field configuration schemes. |
read:custom-field-contextual-configuration:jira | Read custom field contextual configurations. |
write:custom-field-contextual-configuration:jira | Save custom field contextual configurations. |
You can access this resource via basic auth.