Update permission scheme

PUT

/rest/api/3/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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/rest/api/3/permissionscheme/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "description",
    "name": "Example permission scheme",
    "permissions": [
        {
            "holder": {
                "parameter": "jira-core-users",
                "type": "group",
                "value": "ca85fac0-d974-40ca-a615-7af99c48d24f"
            },
            "permission": "ADMINISTER_PROJECTS"
        }
    ]
}'

Response Example

{"description":"description","id":10000,"name":"Example permission scheme","permissions":[{"holder":{"expand":"group","parameter":"jira-core-users","type":"group","value":"ca85fac0-d974-40ca-a615-7af99c48d24f"},"id":10000,"permission":"ADMINISTER_PROJECTS","self":"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000"}],"self":"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000"}

Request

Path Params

Query Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned if the scheme is updated.

Body

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-16 07:18:01

Get permission scheme

Get permission scheme grants