provider Permission schemes GET /rest/api/3/permissionscheme/{schemeId}
@utdk/jira /rest/api/3/permissionscheme/{schemeId}
Get permission scheme
Returns a permission scheme. **[Permissions](#permissions) required:** Permission to access Jira.
schemeId path required
The ID of the permission scheme to return.
integer
expand query
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission.
string

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getpermissionscheme
GET/rest/api/3/permissionscheme/{schemeId}
Returns a permission scheme. **[Permissions](#permissions) required:** Permission to access Jira.

Parameters

required

The ID of the permission scheme to return.

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: * `all` Returns all expandable information. * `field` Returns information about the custom field granted the permission. * `group` Returns information about the group that is granted the permission. * `permissions` Returns all permission grants for each permission scheme. * `projectRole` Returns information about the project role granted the permission. * `user` Returns information about the user who is granted the permission.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getpermissionscheme()