Update Permission Scheme
PUT {{baseUrl}}/rest/api/3/permissionscheme/:schemeId?expand=<string>
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 Params
Key | Datatype | Required | Description |
---|---|---|---|
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
{"name"=>"<string>", "description"=>"<string>", "scope"=>{"type"=>"PROJECT", "project"=>{"self"=>"et occaecat ad mollit", "id"=>"aliquip laborum dolor", "key"=>"deserunt", "name"=>"do aliqua", "projectTypeKey"=>"business", "simplified"=>true, "avatarUrls"=>{"16x16"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "24x24"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "32x32"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "48x48"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}, "projectCategory"=>{"self"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "id"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "description"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "name"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}}}}, "permissions"=>[{"holder"=>{"type"=>"<string>", "parameter"=>"<string>"}, "permission"=>"<string>"}, {"holder"=>{"type"=>"<string>", "parameter"=>"<string>"}, "permission"=>"<string>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"id":10000,"self":"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000","name":"Example permission scheme","description":"description","permissions":[{"id":10000,"self":"https://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000","holder":{"type":"group","parameter":"jira-core-users","expand":"group"},"permission":"ADMINISTER_PROJECTS"}]}