Generated by API Evangelist
Written by API Evangelist tooling for Jira's API. It is a proposal applied on top of the contract, not a document Jira publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Jira Cloud platform REST Permissions API
version: 1.0.0
extends: openapi/jira-permissions-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
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 permissions
effect: read
questions:
- Do I have permission to edit issues in a certain project?
- Can I check my permissions on one specific issue or comment?
instructions:
- text: Check whether I have permissions {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-09-26'
- target: $.paths['/rest/api/3/permissions'].get
update:
x-apievangelist-phrasing:
intent: List all permissions defined in Jira
effect: read
questions:
- What global and project permissions exist on the instance?
- Are permissions added by apps included in the full permission list?
instructions:
- text: List every permission defined on the instance.
- text: Show all global and project permission keys, including app-added ones.
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/permissions/check'].post
update:
x-apievangelist-phrasing:
intent: Check a user's permissions in bulk
effect: read
questions:
- Which of a set of projects and issues can a given user browse or edit?
- Can I check several global permissions for another user at once?
instructions:
- text: Check global permissions {globalPermissions} for user {accountId}.
slots:
globalPermissions: requestBody.globalPermissions
accountId: requestBody.accountId
- text: For user {accountId}, check project permissions {projectPermissions} across the listed projects and issues.
slots:
accountId: requestBody.accountId
projectPermissions: requestBody.projectPermissions
method: generated
generated: '2026-09-26'
- 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 get every project where I have a particular set of project permissions?
instructions:
- text: List the projects where I have permissions {permissions}.
slots:
permissions: requestBody.permissions
- text: Find all projects granting me {permissions}.
slots:
permissions: requestBody.permissions
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
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.