Assign permission scheme

PUT

/rest/api/3/project/{projectKeyOrId}/permissionscheme

Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.

Permissions required: Administer Jira global permission

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/project//permissionscheme' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 10000
}'

Response Example

200 - Success

{"id":10000,"self":"https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000","name":"Example permission scheme","description":"description"}

Request

Path Params

projectKeyOrId

string

required

The project ID or project key (case sensitive).

Query Params

expand

string

optional

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.

Body Params application/json

integer <int64>

required

The ID of the permission scheme to associate with the project. Use the Get all permission schemes resource to get a list of permission scheme IDs.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details of a permission scheme.

description

string

optional

A description for the permission scheme.

expand

string

read-onlyoptional

The expand options available for the permission scheme.

integer <int64>

read-onlyoptional

The ID of the permission scheme.

name

string

required

The name of the permission scheme. Must be unique.

permissions

array[object (PermissionGrant) {4}]

optional

The permission scheme to create or update. See About permission schemes and grants for more information.

holder

object

optional

The user or group being granted the permission. It consists of a type, a type-dependent parameter and a type-dependent value. See Holder object in Get all permission schemes for more information.

integer <int64>

read-onlyoptional

The ID of the permission granted details.

permission

string

optional

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.

self

string <uri>

read-onlyoptional

The URL of the permission granted details.

scope

object

optional

The scope of the permission scheme.

project

object

read-onlyoptional

The project the item has scope in.

type

enum<string>

read-onlyoptional

The type of scope.

Allowed values:

PROJECTTEMPLATE

Additional properties

integer | number | string | boolean

optional

self

string <uri>

read-onlyoptional

The URL of the permission scheme.

Additional properties

integer | number | string | boolean

optional

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if: * the user does not have the necessary permission to edit the project's configuration. * the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be assigned to projects on free plans.

🟠404Returned if the project or permission scheme is not found.

Modified at 2023-07-13 03:27:27

Get assigned permission scheme

Get project issue security levels