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

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.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`schemeId`	Integer	Yes	The ID of the permission scheme to update.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`expand`	String	No	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.

expand

String

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 fields

Name	Type	Required	Description
`id`	Integer	No	The ID of the permission scheme.
`name`	String	Yes	The name of the permission scheme. Must be unique.
`description`	String	No	A description for the permission scheme.
`self`	String	No	The URL of the permission scheme.
`expand`	String	No	The expand options available for the permission scheme.
`permissions[]`	Array	No	The permission scheme to create or update. See About permission schemes and grants for more information.
`permissions[].id`	Integer	No	The ID of the permission granted details.
`permissions[].permission`	String	No	The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See Built-in permissions in Get all permission schemes for more information about the built-in permissions. See the project permission and global permission module documentation for more information about custom permissions.
`permissions[].self`	String	No	The URL of the permission granted details.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.