Permission schemes

Get permission scheme

Changed on

Returns a permission scheme.

Permissions required: Permission to access Jira.

get/rest/api/2/permissionscheme/{schemeId}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/permissionscheme/{schemeId}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)

Path parameters

schemeIdinteger required

The ID of the permission scheme to return.

Query parameters

expandstring

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.

Response

Returned if the request is successful.

descriptionstring

A description for the permission scheme.

expandstring

The expand options available for the permission scheme.

idinteger

The ID of the permission scheme.

namestring required

The name of the permission scheme. Must be unique.

selfstring uri

The URL of the permission scheme.

Changes

  • 38a98954789eRevision changes
    • warning

      added the new product_discovery enum value to the ////////// response property for the response status