Generated by API Evangelist
Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Permissions API
version: 1.0.0
extends: openapi/atlassian-permissions-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/rest/api/3/mypermissions'].get
update:
x-apievangelist-phrasing:
intent: Check my own permissions
effect: read
questions:
- Do I have permission to edit issues in a particular project?
- Which permissions do I hold on a specific issue or comment?
instructions:
- text: Check whether I have {permissions} in project {projectKey}.
slots:
permissions: query.permissions
projectKey: query.projectKey
- text: Show my {permissions} permissions on issue {issueKey}.
slots:
permissions: query.permissions
issueKey: query.issueKey
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/permissions'].get
update:
x-apievangelist-phrasing:
intent: List every permission Jira defines
effect: read
questions:
- What global and project permissions exist in Jira, including app-added ones?
- Where can I find the keys for all permissions I could check?
instructions:
- text: List all global and project permissions defined in Jira.
- text: Show every permission key, including plugin permissions.
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/permissions/check'].post
update:
x-apievangelist-phrasing:
intent: Bulk check a user's permissions
effect: read
questions:
- Can I check several global and project permissions for a user in one call?
- Which projects and issues can a given user browse or edit?
instructions:
- text: Check global permissions {globalPermissions} for user {accountId}.
slots:
globalPermissions: requestBody.globalPermissions
accountId: requestBody.accountId
- text: Bulk check project permissions {projectPermissions} for {accountId}.
slots:
projectPermissions: requestBody.projectPermissions
accountId: requestBody.accountId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/permissions/project'].post
update:
x-apievangelist-phrasing:
intent: List projects where I hold given permissions
effect: read
questions:
- In which projects am I allowed to create issues?
- Can I find every project where I have a set of project permissions?
instructions:
- text: List the projects where I have {permissions}.
slots:
permissions: requestBody.permissions
- text: Find every project granting me permissions {permissions}.
slots:
permissions: requestBody.permissions
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.