issuesecurityschemes
add-security-level
Add issue security levels
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.
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--schemeId | string | Yes | The ID of the issue security scheme. |
Example:
jr issuesecurityschemes add-security-level --schemeId <schemeId>add-security-level-members
Add issue security level members
Adds members to the issue security level. You can add up to 100 members per request.
Permissions required: Administer Jira global permission.
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--levelId | string | Yes | The ID of the issue security level. |
--schemeId | string | Yes | The ID of the issue security scheme. |
Example:
jr issuesecurityschemes add-security-level-members --levelId <levelId> --schemeId <schemeId>associate-schemes-to-projects
Associate security scheme to project
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.
PUT /rest/api/3/issuesecurityschemes/project
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr issuesecurityschemes associate-schemes-to-projectscreate-issue-security-scheme
Create issue security scheme
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.
POST /rest/api/3/issuesecurityschemes
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr issuesecurityschemes create-issue-security-schemedelete-security-scheme
Delete issue security scheme
Deletes an issue security scheme.
Permissions required: Administer Jira global permission.
DELETE /rest/api/3/issuesecurityschemes/{schemeId}
| Flag | Type | Required | Description |
|---|---|---|---|
--schemeId | string | Yes | The ID of the issue security scheme. |
Example:
jr issuesecurityschemes delete-security-scheme --schemeId <schemeId>get-issue-security-level-members
Get issue security level members by issue security scheme
Returns issue security level members.
Only issue security level members in context of classic projects are returned.
Permissions required: Administer Jira global permission.
GET /rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members
| Flag | Type | Required | Description |
|---|---|---|---|
--expand | string | No | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: |
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission. | |--issueSecurityLevelId| string | No | The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand:issueSecurityLevelId=10000&issueSecurityLevelId=10001. | |--issueSecuritySchemeId| string | Yes | The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs. | |--maxResults| string | No | The maximum number of items to return per page. | |--startAt| string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr issuesecurityschemes get-issue-security-level-members --issueSecuritySchemeId <issueSecuritySchemeId>get-issue-security-scheme
Get issue security scheme
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.
GET /rest/api/3/issuesecurityschemes/{id}
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs. |
Example:
jr issuesecurityschemes get-issue-security-scheme --id <id>get-issue-security-schemes
Get issue security schemes
Returns all issue security schemes.
Permissions required: Administer Jira global permission.
GET /rest/api/3/issuesecurityschemes
Example:
jr issuesecurityschemes get-issue-security-schemesget-security-level-members
Get issue security level members
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.
GET /rest/api/3/issuesecurityschemes/level/member
| Flag | Type | Required | Description |
|---|---|---|---|
--expand | string | No | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: |
allReturns all expandable informationfieldReturns information about the custom field granted the permissiongroupReturns information about the group that is granted the permissionprojectRoleReturns information about the project role granted the permissionuserReturns information about the user who is granted the permission | |--id| string | No | The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand:id=10000&id=10001. | |--levelId| string | No | The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand:levelId=10000&levelId=10001. | |--maxResults| string | No | The maximum number of items to return per page. | |--schemeId| string | No | The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand:schemeId=10000&schemeId=10001. | |--startAt| string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr issuesecurityschemes get-security-level-membersget-security-levels
Get issue security levels
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.
GET /rest/api/3/issuesecurityschemes/level
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | No | The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an ampersand: id=10000&id=10001. |
--maxResults | string | No | The maximum number of items to return per page. |
--onlyDefault | string | No | 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. |
--schemeId | string | No | The list of issue security scheme IDs. To include multiple issue security schemes, separate IDs with an ampersand: schemeId=10000&schemeId=10001. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr issuesecurityschemes get-security-levelsremove-level
Remove issue security level
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.
DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
| Flag | Type | Required | Description |
|---|---|---|---|
--levelId | string | Yes | The ID of the issue security level to remove. |
--replaceWith | string | No | The ID of the issue security level that will replace the currently selected level. |
--schemeId | string | Yes | The ID of the issue security scheme. |
Example:
jr issuesecurityschemes remove-level --levelId <levelId> --schemeId <schemeId>remove-member-from-security-level
Remove member from issue security level
Removes an issue security level member from an issue security scheme.
Permissions required: Administer Jira global permission.
DELETE /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}
| Flag | Type | Required | Description |
|---|---|---|---|
--levelId | string | Yes | The ID of the issue security level. |
--memberId | string | Yes | The ID of the issue security level member to be removed. |
--schemeId | string | Yes | The ID of the issue security scheme. |
Example:
jr issuesecurityschemes remove-member-from-security-level --levelId <levelId> --memberId <memberId> --schemeId <schemeId>search-projects-using-security-schemes
Get projects using issue security schemes
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.
GET /rest/api/3/issuesecurityschemes/project
| Flag | Type | Required | Description |
|---|---|---|---|
--issueSecuritySchemeId | string | No | The list of security scheme IDs to be filtered out. |
--maxResults | string | No | The maximum number of items to return per page. |
--projectId | string | No | The list of project IDs to be filtered out. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr issuesecurityschemes search-projects-using-security-schemessearch-security-schemes
Search issue security schemes
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.
GET /rest/api/3/issuesecurityschemes/search
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | No | The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an ampersand: id=10000&id=10001. |
--maxResults | string | No | The maximum number of items to return per page. |
--projectId | string | No | The list of project IDs. To include multiple project IDs, separate IDs with an ampersand: projectId=10000&projectId=10001. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr issuesecurityschemes search-security-schemesset-default-levels
Set default issue security levels
Sets default issue security levels for schemes.
Permissions required: Administer Jira global permission.
PUT /rest/api/3/issuesecurityschemes/level/default
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr issuesecurityschemes set-default-levelsupdate-issue-security-scheme
Update issue security scheme
Updates the issue security scheme.
Permissions required: Administer Jira global permission.
PUT /rest/api/3/issuesecurityschemes/{id}
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--id | string | Yes | The ID of the issue security scheme. |
Example:
jr issuesecurityschemes update-issue-security-scheme --id <id>update-security-level
Update issue security level
Updates the issue security level.
Permissions required: Administer Jira global permission.
PUT /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--levelId | string | Yes | The ID of the issue security level to update. |
--schemeId | string | Yes | The ID of the issue security scheme level belongs to. |
Example:
jr issuesecurityschemes update-security-level --levelId <levelId> --schemeId <schemeId>