Class IssueSecuritySchemes

Index

Constructors

Methods

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

Constructors

constructor

new IssueSecuritySchemes(client: Client): Version2.IssueSecuritySchemes
Parameters
- client: Client
Returns Version2.IssueSecuritySchemes
- Defined in src/version2/issueSecuritySchemes.ts:9

Methods

addSecurityLevel

addSecurityLevel<T = void>(
parameters: Version2Parameters.AddSecurityLevel,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.AddSecurityLevel
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:456
addSecurityLevel<T = void>(
parameters: Version2Parameters.AddSecurityLevel,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.AddSecurityLevel
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:463

addSecurityLevelMembers

addSecurityLevelMembers<T = void>(
parameters: Version2Parameters.AddSecurityLevelMembers,
callback: Callback<T>,
): Promise<void>
Adds members to the issue security level. You can add up to 100 members per request.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.AddSecurityLevelMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:548
addSecurityLevelMembers<T = void>(
parameters: Version2Parameters.AddSecurityLevelMembers,
callback?: undefined,
): Promise<T>
Adds members to the issue security level. You can add up to 100 members per request.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.AddSecurityLevelMembers
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:558

associateSchemesToProjects

associateSchemesToProjects<T = Version2Models.TaskProgressObject>(
parameters: Version2Parameters.AssociateSchemesToProjects,
callback: Callback<T>,
): 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.
Type Parameters
- T = Version2Models.TaskProgressObject
Parameters
- parameters: Version2Parameters.AssociateSchemesToProjects
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:262
associateSchemesToProjects<T = Version2Models.TaskProgressObject>(
parameters: Version2Parameters.AssociateSchemesToProjects,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.TaskProgressObject
Parameters
- parameters: Version2Parameters.AssociateSchemesToProjects
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:278

createIssueSecurityScheme

createIssueSecurityScheme<T = Version2Models.SecuritySchemeId>(
parameters: Version2Parameters.CreateIssueSecurityScheme,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.SecuritySchemeId
Parameters
- parameters: Version2Parameters.CreateIssueSecurityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:41
createIssueSecurityScheme<T = Version2Models.SecuritySchemeId>(
parameters: Version2Parameters.CreateIssueSecurityScheme,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.SecuritySchemeId
Parameters
- parameters: Version2Parameters.CreateIssueSecurityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:52

deleteSecurityScheme

deleteSecurityScheme<T = void>(
parameters: Version2Parameters.DeleteSecurityScheme,
callback: Callback<T>,
): Promise<void>
Deletes an issue security scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.DeleteSecurityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:427
deleteSecurityScheme<T = void>(
parameters: Version2Parameters.DeleteSecurityScheme,
callback?: undefined,
): Promise<T>
Deletes an issue security scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.DeleteSecurityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:437

getIssueSecurityScheme

getIssueSecurityScheme<T = Version2Models.SecurityScheme>(
parameters: string | Version2Parameters.GetIssueSecurityScheme,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.SecurityScheme
Parameters
- parameters: string | Version2Parameters.GetIssueSecurityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:354
getIssueSecurityScheme<T = Version2Models.SecurityScheme>(
parameters: string | Version2Parameters.GetIssueSecurityScheme,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.SecurityScheme
Parameters
- parameters: string | Version2Parameters.GetIssueSecurityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:367

getIssueSecuritySchemes

getIssueSecuritySchemes<T = Version2Models.SecuritySchemes>(
callback: Callback<T>,
): Promise<void>
Returns all issue security schemes.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2Models.SecuritySchemes
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:17
getIssueSecuritySchemes<T = Version2Models.SecuritySchemes>(
callback?: undefined,
): Promise<T>
Returns all issue security schemes.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2Models.SecuritySchemes
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:24

getSecurityLevelMembers

getSecurityLevelMembers<T = Version2Models.PageSecurityLevelMember>(
parameters: undefined | Version2Parameters.GetSecurityLevelMembers,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.PageSecurityLevelMember
Parameters
- parameters: undefined | Version2Parameters.GetSecurityLevelMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:168
getSecurityLevelMembers<T = Version2Models.PageSecurityLevelMember>(
parameters?: Version2Parameters.GetSecurityLevelMembers,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.PageSecurityLevelMember
Parameters
- Optionalparameters: Version2Parameters.GetSecurityLevelMembers
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:184

getSecurityLevels

getSecurityLevels<T = Version2Models.PageSecurityLevel>(
parameters: undefined | Version2Parameters.GetSecurityLevels,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.PageSecurityLevel
Parameters
- parameters: undefined | Version2Parameters.GetSecurityLevels
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:85
getSecurityLevels<T = Version2Models.PageSecurityLevel>(
parameters?: Version2Parameters.GetSecurityLevels,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.PageSecurityLevel
Parameters
- Optionalparameters: Version2Parameters.GetSecurityLevels
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:101

removeLevel

removeLevel<T = unknown>(
parameters: Version2Parameters.RemoveLevel,
callback: Callback<T>,
): 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.
Type Parameters
- T = unknown
Parameters
- parameters: Version2Parameters.RemoveLevel
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:517
removeLevel<T = unknown>(
parameters: Version2Parameters.RemoveLevel,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version2Parameters.RemoveLevel
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:529

removeMemberFromSecurityLevel

removeMemberFromSecurityLevel<T = void>(
parameters: Version2Parameters.RemoveMemberFromSecurityLevel,
callback: Callback<T>,
): Promise<void>
Removes an issue security level member from an issue security scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.RemoveMemberFromSecurityLevel
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:580
removeMemberFromSecurityLevel<T = void>(
parameters: Version2Parameters.RemoveMemberFromSecurityLevel,
callback?: undefined,
): Promise<T>
Removes an issue security level member from an issue security scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.RemoveMemberFromSecurityLevel
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:590

searchProjectsUsingSecuritySchemes

searchProjectsUsingSecuritySchemes<
    T = Version2Models.PageIssueSecuritySchemeToProjectMapping,
>(
    parameters:
        | undefined
        | Version2Parameters.SearchProjectsUsingSecuritySchemes,
    callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version2Models.PageIssueSecuritySchemeToProjectMapping
Parameters
- parameters: undefined | Version2Parameters.SearchProjectsUsingSecuritySchemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:216
searchProjectsUsingSecuritySchemes<
    T = Version2Models.PageIssueSecuritySchemeToProjectMapping,
>(
    parameters?: Version2Parameters.SearchProjectsUsingSecuritySchemes,
    callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version2Models.PageIssueSecuritySchemeToProjectMapping
Parameters
- Optionalparameters: Version2Parameters.SearchProjectsUsingSecuritySchemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:228

searchSecuritySchemes

searchSecuritySchemes<T = Version2Models.PageSecuritySchemeWithProjects>(
parameters: undefined | Version2Parameters.SearchSecuritySchemes,
callback: Callback<T>,
): Promise<void>
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.

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

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2Models.PageSecuritySchemeWithProjects
Parameters
- parameters: undefined | Version2Parameters.SearchSecuritySchemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:309
searchSecuritySchemes<T = Version2Models.PageSecuritySchemeWithProjects>(
parameters?: Version2Parameters.SearchSecuritySchemes,
callback?: undefined,
): Promise<T>
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.

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

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2Models.PageSecuritySchemeWithProjects
Parameters
- Optionalparameters: Version2Parameters.SearchSecuritySchemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:323

setDefaultLevels

setDefaultLevels<T = void>(
parameters: undefined | Version2Parameters.SetDefaultLevels,
callback: Callback<T>,
): Promise<void>
Sets default issue security levels for schemes.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: undefined | Version2Parameters.SetDefaultLevels
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:130
setDefaultLevels<T = void>(
parameters?: Version2Parameters.SetDefaultLevels,
callback?: undefined,
): Promise<T>
Sets default issue security levels for schemes.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- Optionalparameters: Version2Parameters.SetDefaultLevels
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:140

updateIssueSecurityScheme

updateIssueSecurityScheme<T = void>(
parameters: Version2Parameters.UpdateIssueSecurityScheme,
callback: Callback<T>,
): Promise<void>
Updates the issue security scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.UpdateIssueSecurityScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:391
updateIssueSecurityScheme<T = void>(
parameters: Version2Parameters.UpdateIssueSecurityScheme,
callback?: undefined,
): Promise<T>
Updates the issue security scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.UpdateIssueSecurityScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:401

updateSecurityLevel

updateSecurityLevel<T = void>(
parameters: Version2Parameters.UpdateSecurityLevel,
callback: Callback<T>,
): Promise<void>
Updates the issue security level.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.UpdateSecurityLevel
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueSecuritySchemes.ts:482
updateSecurityLevel<T = void>(
parameters: Version2Parameters.UpdateSecurityLevel,
callback?: undefined,
): Promise<T>
Updates the issue security level.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.UpdateSecurityLevel
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueSecuritySchemes.ts:489

Class IssueSecuritySchemes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version2.IssueSecuritySchemes

Methods

addSecurityLevel

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

addSecurityLevelMembers

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

associateSchemesToProjects

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createIssueSecurityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteSecurityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueSecurityScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueSecuritySchemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSecurityLevelMembers

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSecurityLevels

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeLevel

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeMemberFromSecurityLevel