Class ProjectPermissionSchemesService

This resource represents permission schemes for a project. Use this resource to:

get details of a project's issue security levels available to the calling user.
get the permission scheme associated with the project or assign different permission scheme to the project.
get details of a project's issue security scheme.

See Managing project permissions for more information about permission schemes.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes

Hierarchy

CommonHttpService
- ProjectPermissionSchemesService

Index

Constructors

constructor

Methods

assignPermissionScheme getAssignedPermissionScheme getProjectIssueSecurityScheme getSecurityLevelsForProject initialize

Constructors

constructor

new ProjectPermissionSchemesService(getClientInstance): ProjectPermissionSchemesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ProjectPermissionSchemesService
Inherited from CommonHttpService.constructor

Methods

assignPermissionScheme

assignPermissionScheme(params): Promise<PermissionScheme>
Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.

Permissions required: Administer Jira global permission
Parameters
- params: {
      expand?: string;
      idBean: IdBean;
      projectKeyOrId: string;
  }
  - Optionalexpand?: string
    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.
  - idBean: IdBean
    Example
  - projectKeyOrId: string
    The project ID or project key (case sensitive).
Returns Promise<PermissionScheme>
Returned if the request is successful.

example:
```
{
  "description": "description",
  "id": 10000,
  "name": "Example permission scheme",
  "self": "https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000"
}
```
Path
PUT /rest/api/3/project/{projectKeyOrId}/permissionscheme @scopes-current manage:jira-project @scopes-beta read:application-role:jira, read:field:jira, read:group:jira, read:permission-scheme:jira, read:permission:jira, read:project-role:jira, read:user:jira, write:project:jira, read:avatar:jira, read:project-category:jira, read:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-permissionscheme-put

getAssignedPermissionScheme

getAssignedPermissionScheme(params): Promise<PermissionScheme>
Gets the permission scheme associated with the project.

Permissions required: Administer Jira global permission or Administer projects project permission.
Parameters
- params: {
  expand?: string;
  projectKeyOrId: string;
  }
  - Optionalexpand?: string
    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.
  - projectKeyOrId: string
    The project ID or project key (case sensitive).
Returns Promise<PermissionScheme>
Returned if the request is successful.

example:
```
{
  "description": "description",
  "id": 10000,
  "name": "Example permission scheme",
  "self": "https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000"
}
```
Path
GET /rest/api/3/project/{projectKeyOrId}/permissionscheme @scopes-current read:jira-work @scopes-beta read:application-role:jira, read:field:jira, read:group:jira, read:permission-scheme:jira, read:permission:jira, read:project-role:jira, read:user:jira, read:avatar:jira, read:project-category:jira, read:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-permissionscheme-get

getProjectIssueSecurityScheme

getProjectIssueSecurityScheme(params): Promise<SecurityScheme>
Returns the issue security scheme associated with the project.

Permissions required: Administer Jira global permission or the Administer Projects project permission.
Parameters
- params: {
  projectKeyOrId: string;
  }
  - projectKeyOrId: string
    The project ID or project key (case sensitive).
Returns Promise<SecurityScheme>
Returned if the request is successful.

example:
```
{
  "defaultSecurityLevelId": 10021,
  "description": "Description for the default issue security scheme",
  "id": 10000,
  "levels": [
    {
      "description": "Only the reporter and internal staff can see this issue.",
      "id": "10021",
      "name": "Reporter Only",
      "self": "https://your-domain.atlassian.net/rest/api/3/securitylevel/10021"
    }
  ],
  "name": "Default Issue Security Scheme",
  "self": "https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000"
}
```
Path
GET /rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme @scopes-current read:jira-work @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-issuesecuritylevelscheme-get

getSecurityLevelsForProject

getSecurityLevelsForProject(params): Promise<ProjectIssueSecurityLevels>
Returns all issue security levels for the project that the user has access to.

This operation can be accessed anonymously.

Permissions required: Browse projects global permission for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permission for the project.
Parameters
- params: {
  projectKeyOrId: string;
  }
  - projectKeyOrId: string
    The project ID or project key (case sensitive).
Returns Promise<ProjectIssueSecurityLevels>
Returned if the request is successful.

example:
```
{
  "levels": [
    {
      "description": "Only the reporter and internal staff can see this issue.",
      "id": "100000",
      "name": "Reporter Only",
      "self": "https://your-domain.atlassian.net/rest/api/3/securitylevel/100000"
    },
    {
      "description": "Only internal staff can see this issue.",
      "id": "100001",
      "name": "Staff Only",
      "self": "https://your-domain.atlassian.net/rest/api/3/securitylevel/100001"
    }
  ]
}
```
Path
GET /rest/api/3/project/{projectKeyOrId}/securitylevel @scopes-current read:jira-work @scopes-beta read:issue-security-level:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes#api-rest-api-3-project-projectkeyorid-securitylevel-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class ProjectPermissionSchemesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ProjectPermissionSchemesService

Methods

assignPermissionScheme

Parameters

Optionalexpand?: string

idBean: IdBean

Example

projectKeyOrId: string

Returns Promise<PermissionScheme>

Path

See

getAssignedPermissionScheme

Parameters

Optionalexpand?: string

projectKeyOrId: string

Returns Promise<PermissionScheme>

Path

See

getProjectIssueSecurityScheme

Parameters

projectKeyOrId: string

Returns Promise<SecurityScheme>

Path

See

getSecurityLevelsForProject

Parameters

projectKeyOrId: string

Returns Promise<ProjectIssueSecurityLevels>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`expand?: string

`Optional`expand?: string

`Protected` `Static`initialize