Permission schemes

Update permission scheme

Changed on

Updates a permission scheme. Below are some important things to note when using this resource:

  • If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
  • If you want to update only the name and description, then do not send a permissions list in the request.
  • Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

put/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: manage:jira-configuration)

Path parameters

schemeIdinteger required

The ID of the permission scheme to update.

Query parameters

expandstring

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always 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.

Request body

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.

Response

Returned if the scheme is updated.

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

    • info

      added the new product_discovery enum value to the request property //////////

  • fc2da4091826Revision changes
    • info

      added the non-success response with the status