Class IssueSecuritySchemesService

This resource represents issue security schemes. Use it to get an issue security scheme or a list of issue security schemes.

Issue security schemes control which users or groups of users can view an issue. When an issue security scheme is associated with a project, its security levels can be applied to issues in that project. Sub-tasks also inherit the security level of their parent issue.

See

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

Hierarchy

CommonHttpService
- IssueSecuritySchemesService

Index

Constructors

constructor

Methods

addSecurityLevel addSecurityLevelMembers associateSchemesToProjects createIssueSecurityScheme deleteSecurityScheme getIssueSecurityScheme getIssueSecuritySchemes getSecurityLevelMembers getSecurityLevels removeLevel removeMemberFromSecurityLevel searchProjectsUsingSecuritySchemes searchSecuritySchemes setDefaultLevels updateIssueSecurityScheme updateSecurityLevel initialize

Constructors

constructor

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

Methods

addSecurityLevel

addSecurityLevel(params): Promise<void>
Adds levels and levels' members to the issue security scheme. You can add up to 100 levels per request.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  addSecuritySchemeLevelsRequestBean: AddSecuritySchemeLevelsRequestBean;
  schemeId: string;
  }
  - addSecuritySchemeLevelsRequestBean: AddSecuritySchemeLevelsRequestBean
    Example
  - schemeId: string
    The ID of the issue security scheme.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-schemeid-level-put

addSecurityLevelMembers

addSecurityLevelMembers(params): Promise<void>
Adds members to the issue security level. You can add up to 100 members per request.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      levelId: string;
      schemeId: string;
      securitySchemeMembersRequest: SecuritySchemeMembersRequest;
  }
  - levelId: string
    The ID of the issue security level.
  - schemeId: string
    The ID of the issue security scheme.
  - securitySchemeMembersRequest: SecuritySchemeMembersRequest
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-schemeid-level-levelid-member-put

associateSchemesToProjects

associateSchemesToProjects(params): Promise<void>
Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if provided.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  associateSecuritySchemeWithProjectDetails: AssociateSecuritySchemeWithProjectDetails;
  }
  - associateSecuritySchemeWithProjectDetails: AssociateSecuritySchemeWithProjectDetails
    Example
Returns Promise<void>
Path
PUT /rest/api/3/issuesecurityschemes/project

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-project-put

createIssueSecurityScheme

createIssueSecurityScheme(params): Promise<SecuritySchemeId>
Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme levels and security scheme levels' members per request.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  createIssueSecuritySchemeDetails: CreateIssueSecuritySchemeDetails;
  }
  - createIssueSecuritySchemeDetails: CreateIssueSecuritySchemeDetails
    Example
Returns Promise<SecuritySchemeId>
Returned if the request is successful.

example:
```
{
  "id": "10001"
}
```
Path
POST /rest/api/3/issuesecurityschemes

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-post

deleteSecurityScheme

deleteSecurityScheme(params): Promise<void>
Deletes an issue security scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  schemeId: string;
  }
  - schemeId: string
    The ID of the issue security scheme.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/issuesecurityschemes/{schemeId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-schemeid-delete

getIssueSecurityScheme

getIssueSecurityScheme(params): Promise<SecurityScheme>
Returns an issue security scheme along with its security levels.

Permissions required:
- Administer Jira global permission.
- Administer Projects project permission for a project that uses the requested issue security scheme.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.
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/issuesecurityschemes/{id} @scopes-current manage:jira-project @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-id-get

getIssueSecuritySchemes

getIssueSecuritySchemes(): Promise<SecuritySchemes>
Returns all issue security schemes.

Permissions required: Administer Jira global permission.

Returns Promise<SecuritySchemes>
Returned if the request is successful.

example:
```
{
  "issueSecuritySchemes": [
    {
      "defaultSecurityLevelId": 10021,
      "description": "Description for the default issue security scheme",
      "id": 10000,
      "name": "Default Issue Security Scheme",
      "self": "https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000"
    }
  ]
}
```
Path
GET /rest/api/3/issuesecurityschemes @scopes-current manage:jira-project @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-get

getSecurityLevelMembers

getSecurityLevelMembers(params?): Promise<PageBeanSecurityLevelMember>
Returns a paginated list of issue security level members.

Only issue security level members in the context of classic projects are returned.

Filtering using parameters is inclusive: if you specify both security scheme IDs and level IDs, the result will include all issue security level members from the specified schemes and levels.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      expand?: string;
      id?: string[];
      levelId?: string[];
      maxResults?: string;
      schemeId?: string[];
      startAt?: string;
  } = {}
  - Optionalexpand?: string
    Use expand to include additional information in the response. This parameter accepts a comma-separated list. 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
    
    projectRole Returns information about the project role granted the permission
    
    user Returns information about the user who is granted the permission
  - Optionalid?: string[]
    The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand: id=10000&id=10001.
  - OptionallevelId?: string[]
    The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand: levelId=10000&levelId=10001.
  - OptionalmaxResults?: string
    The maximum number of items to return per page.
  - OptionalschemeId?: string[]
    The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand: schemeId=10000&schemeId=10001.
  - OptionalstartAt?: string
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanSecurityLevelMember>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 100,
  "startAt": 0,
  "total": 3,
  "values": [
    {
      "id": "10000",
      "issueSecurityLevelId": "20010",
      "issueSecuritySchemeId": "10010",
      "holder": {
        "expand": "group",
        "type": "group"
      }
    }
  ]
}
```
Path
GET /rest/api/3/issuesecurityschemes/level/member @scopes-current manage:jira-configuration @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-level-member-get

getSecurityLevels

getSecurityLevels(params?): Promise<PageBeanSecurityLevel>
Returns a paginated list of issue security levels.

Only issue security levels in the context of classic projects are returned.

Filtering using IDs is inclusive: if you specify both security scheme IDs and level IDs, the result will include both specified issue security levels and all issue security levels from the specified schemes.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id?: string[];
      maxResults?: string;
      onlyDefault?: boolean;
      schemeId?: string[];
      startAt?: string;
  } = {}
  - Optionalid?: string[]
    The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an ampersand: id=10000&id=10001.
  - OptionalmaxResults?: string
    The maximum number of items to return per page.
  - OptionalonlyDefault?: boolean
    When set to true, returns multiple default levels for each security scheme containing a default. If you provide scheme and level IDs not associated with the default, returns an empty page. The default value is false.
  - OptionalschemeId?: string[]
    The list of issue security scheme IDs. To include multiple issue security schemes, separate IDs with an ampersand: schemeId=10000&schemeId=10001.
  - OptionalstartAt?: string
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanSecurityLevel>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 50,
  "startAt": 0,
  "total": 1,
  "values": [
    {
      "description": "Only the reporter and internal staff can see this issue.",
      "id": "10021",
      "isDefault": true,
      "issueSecuritySchemeId": "10001",
      "name": "Reporter Only",
      "self": "https://your-domain.atlassian.net/rest/api/3/issuesecurityscheme/level?id=10021"
    }
  ]
}
```
Path
GET /rest/api/3/issuesecurityschemes/level @scopes-current manage:jira-configuration @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-level-get

removeLevel

removeLevel(params): Promise<void>
Deletes an issue security level.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      levelId: string;
      replaceWith?: string;
      schemeId: string;
  }
  - levelId: string
    The ID of the issue security level to remove.
  - OptionalreplaceWith?: string
    The ID of the issue security level that will replace the currently selected level.
  - schemeId: string
    The ID of the issue security scheme.
Returns Promise<void>
Path
DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-schemeid-level-levelid-delete

removeMemberFromSecurityLevel

removeMemberFromSecurityLevel(params): Promise<void>
Removes an issue security level member from an issue security scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      levelId: string;
      memberId: string;
      schemeId: string;
  }
  - levelId: string
    The ID of the issue security level.
  - memberId: string
    The ID of the issue security level member to be removed.
  - schemeId: string
    The ID of the issue security scheme.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-schemeid-level-levelid-member-memberid-delete

searchProjectsUsingSecuritySchemes

searchProjectsUsingSecuritySchemes(params?): Promise<PageBeanIssueSecuritySchemeToProjectMapping>
Returns a paginated mapping of projects that are using security schemes. You can provide either one or multiple security scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Only issue security schemes in the context of classic projects are supported. Permissions required: Administer Jira global permission.
Parameters
- params: {
      issueSecuritySchemeId?: string[];
      maxResults?: string;
      projectId?: string[];
      startAt?: string;
  } = {}
  - OptionalissueSecuritySchemeId?: string[]
    The list of security scheme IDs to be filtered out.
  - OptionalmaxResults?: string
    The maximum number of items to return per page.
  - OptionalprojectId?: string[]
    The list of project IDs to be filtered out.
  - OptionalstartAt?: string
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanIssueSecuritySchemeToProjectMapping>
Returned if the request is successful.

example:
```
{
  "issueSecuritySchemeId": "10000",
  "projectId": "10000"
}
```
Path
GET /rest/api/3/issuesecurityschemes/project

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-project-get

searchSecuritySchemes

searchSecuritySchemes(params?): Promise<PageBeanSecuritySchemeWithProjects>
Returns a paginated list of issue security schemes. If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you filter by. Use {@link IssueSecuritySchemeResource#searchProjectsUsingSecuritySchemes(String, String, Set, Set)} to obtain all projects related to scheme.

Only issue security schemes in the context of classic projects are returned.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id?: string[];
      maxResults?: string;
      projectId?: string[];
      startAt?: string;
  } = {}
  - Optionalid?: string[]
    The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an ampersand: id=10000&id=10001.
  - OptionalmaxResults?: string
    The maximum number of items to return per page.
  - OptionalprojectId?: string[]
    The list of project IDs. To include multiple project IDs, separate IDs with an ampersand: projectId=10000&projectId=10001.
  - OptionalstartAt?: string
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanSecuritySchemeWithProjects>
Returned if the request is successful.

example:
```
{
  "id": 10000,
  "self": "https://your-domain.atlassian.net/rest/api/3/issuesecurityscheme/10000",
  "name": "Default scheme",
  "description": "Default scheme description",
  "defaultLevel": 10001,
  "projectIds": [
    10002
  ]
}
```
Path
GET /rest/api/3/issuesecurityschemes/search @scopes-current manage:jira-configuration @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-search-get

setDefaultLevels

setDefaultLevels(params): Promise<void>
Sets default issue security levels for schemes.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  setDefaultLevelsRequest: SetDefaultLevelsRequest;
  }
  - setDefaultLevelsRequest: SetDefaultLevelsRequest
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuesecurityschemes/level/default

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-level-default-put

updateIssueSecurityScheme

updateIssueSecurityScheme(params): Promise<void>
Updates the issue security scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: string;
  updateIssueSecuritySchemeRequestBean: UpdateIssueSecuritySchemeRequestBean;
  }
  - id: string
    The ID of the issue security scheme.
  - updateIssueSecuritySchemeRequestBean: UpdateIssueSecuritySchemeRequestBean
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuesecurityschemes/{id}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-id-put

updateSecurityLevel

updateSecurityLevel(params): Promise<void>
Updates the issue security level.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      levelId: string;
      schemeId: string;
      updateIssueSecurityLevelDetails: UpdateIssueSecurityLevelDetails;
  }
  - levelId: string
    The ID of the issue security level to update.
  - schemeId: string
    The ID of the issue security scheme level belongs to.
  - updateIssueSecurityLevelDetails: UpdateIssueSecurityLevelDetails
    Example
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes#api-rest-api-3-issuesecurityschemes-schemeid-level-levelid-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class IssueSecuritySchemesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueSecuritySchemesService

Methods

addSecurityLevel

Parameters

addSecuritySchemeLevelsRequestBean: AddSecuritySchemeLevelsRequestBean

Example

schemeId: string

Returns Promise<void>

Path

See

addSecurityLevelMembers

Parameters

levelId: string

schemeId: string

securitySchemeMembersRequest: SecuritySchemeMembersRequest

Example

Returns Promise<void>

Path

See

associateSchemesToProjects

Parameters

associateSecuritySchemeWithProjectDetails: AssociateSecuritySchemeWithProjectDetails

Example

Returns Promise<void>

Path

See

createIssueSecurityScheme

Parameters

createIssueSecuritySchemeDetails: CreateIssueSecuritySchemeDetails

Example

Returns Promise<SecuritySchemeId>

Path

See

deleteSecurityScheme

Parameters

schemeId: string

Returns Promise<void>

Path

See

getIssueSecurityScheme

Parameters

id: number

Returns Promise<SecurityScheme>

Path

See

getIssueSecuritySchemes

Returns Promise<SecuritySchemes>

Path

See

getSecurityLevelMembers

Parameters

Optionalexpand?: string

Optionalid?: string[]

OptionallevelId?: string[]

OptionalmaxResults?: string

OptionalschemeId?: string[]

OptionalstartAt?: string

Returns Promise<PageBeanSecurityLevelMember>

Path

See

getSecurityLevels

Parameters

Optionalid?: string[]

OptionalmaxResults?: string

OptionalonlyDefault?: boolean

OptionalschemeId?: string[]

OptionalstartAt?: string

Returns Promise<PageBeanSecurityLevel>

Path

See

`Optional`expand?: string

`Optional`id?: string[]

`Optional`levelId?: string[]

`Optional`maxResults?: string

`Optional`schemeId?: string[]

`Optional`startAt?: string

`Optional`id?: string[]

`Optional`maxResults?: string

`Optional`onlyDefault?: boolean

`Optional`schemeId?: string[]

`Optional`startAt?: string

`Optional`replaceWith?: string

`Optional`issueSecuritySchemeId?: string[]

`Optional`maxResults?: string

`Optional`projectId?: string[]

`Optional`startAt?: string

`Optional`id?: string[]

`Optional`maxResults?: string

`Optional`projectId?: string[]

`Optional`startAt?: string

`Protected` `Static`initialize