openapi: 3.1.0
info:
title: Atlassian Admin Account Issue Security Level API
description: The Atlassian Admin API provides programmatic access to manage Atlassian organizations, users, domains, policies, and events. It enables administrators to automate organization management tasks, integrate with identity providers, and ensure appropriate access to Atlassian products.
version: 1.0.0
contact:
name: Atlassian Developer
url: https://developer.atlassian.com/cloud/admin/
license:
name: Atlassian Developer Terms
url: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
x-logo:
url: https://wac-cdn.atlassian.com/assets/img/favicons/atlassian/favicon.png
servers:
- url: https://api.atlassian.com
description: Atlassian Cloud API
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Issue Security Level
paths:
/rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members:
get:
deprecated: false
description: Returns issue security level members.
Only issue security level members in context of classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianGetissuesecuritylevelmembers
parameters:
- description: The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs.
in: path
name: issueSecuritySchemeId
required: true
schema:
format: int64
type: integer
- description: The index of the first item to return in a page of results (page offset).
in: query
name: startAt
schema:
default: 0
format: int64
type: integer
- description: The maximum number of items to return per page.
in: query
name: maxResults
schema:
default: 50
format: int32
type: integer
- description: 'The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: `issueSecurityLevelId=10000&issueSecurityLevelId=10001`.'
in: query
name: issueSecurityLevelId
schema:
items:
type: string
type: array
uniqueItems: true
- description: "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission."
in: query
name: expand
schema:
type: string
responses:
'200':
content:
application/json:
example: '{"isLast":true,"maxResults":100,"startAt":0,"total":3,"values":[{"id":10000,"issueSecurityLevelId":10020,"holder":{"expand":"user","type":"user","user":{"accountId":"5b10a2844c20165700ede21g","active":true,"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32","48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"},"displayName":"Mia Krystof","emailAddress":"mia@example.com","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","timeZone":"Australia/Sydney"}}},{"id":10001,"issueSecurityLevelId":10020,"holder":{"expand":"group","parameter":"jira-core-users","type":"group","value":"9c559b11-6c5d-4f96-992c-a746cabab28b"}},{"id":10002,"issueSecurityLevelId":10021,"holder":{"type":"assignee"}}]}'
schema:
$ref: '#/components/schemas/PageBeanIssueSecurityLevelMember'
description: Returned if the request is successful.
'400':
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
description: Returned if the user does not have the necessary permission.
'404':
description: Returned if no issue security level members are found.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Get Issue Security Level Members By Issue Security Scheme
tags:
- Issue Security Level
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- read:field:jira
- read:issue-security-level:jira
- read:project-role:jira
- read:user:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/securitylevel/{id}:
get:
deprecated: false
description: Returns details of an issue security level.
Use [Get issue security scheme](#api-rest-api-3-issuesecurityschemes-id-get) to obtain the IDs of issue security levels associated with the issue security scheme.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** None.
operationId: atlassianGetissuesecuritylevel
parameters:
- description: The ID of the issue security level.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
example: '{"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"}'
schema:
$ref: '#/components/schemas/SecurityLevel'
description: Returned if the request is successful.
'401':
description: Returned if the authentication credentials are incorrect.
'404':
description: Returned if the issue security level is not found.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
- {}
summary: Atlassian Get Issue Security Level
tags:
- Issue Security Level
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- read:field:jira
- read:issue-security-level:jira
- read:project-role:jira
- read:user:jira
state: Beta
x-atlassian-connect-scope: PROJECT_ADMIN
components:
schemas:
PageBeanIssueSecurityLevelMember:
additionalProperties: false
description: A page of items.
properties:
isLast:
description: Whether this is the last page.
readOnly: true
type: boolean
maxResults:
description: The maximum number of items that could be returned.
format: int32
readOnly: true
type: integer
nextPage:
description: If there is another page of results, the URL of the next page.
format: uri
readOnly: true
type: string
self:
description: The URL of the page.
format: uri
readOnly: true
type: string
startAt:
description: The index of the first item returned.
format: int64
readOnly: true
type: integer
total:
description: The number of items returned.
format: int64
readOnly: true
type: integer
values:
description: The list of items.
items:
$ref: '#/components/schemas/IssueSecurityLevelMember'
readOnly: true
type: array
type: object
SecurityLevel:
additionalProperties: false
description: Details of an issue level security item.
properties:
description:
description: The description of the issue level security item.
readOnly: true
type: string
id:
description: The ID of the issue level security item.
readOnly: true
type: string
isDefault:
description: Whether the issue level security item is the default.
readOnly: true
type: boolean
issueSecuritySchemeId:
description: The ID of the issue level security scheme.
readOnly: true
type: string
name:
description: The name of the issue level security item.
readOnly: true
type: string
self:
description: The URL of the issue level security item.
readOnly: true
type: string
type: object
PermissionHolder:
additionalProperties: false
description: Details of a user, group, field, or project role that holds a permission. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information.
properties:
expand:
description: Expand options that include additional permission holder details in the response.
readOnly: true
type: string
parameter:
description: As a group's name can change, use of `value` is recommended. The identifier associated withthe `type` value that defines the holder of the permission.
type: string
type:
description: The type of permission holder.
type: string
value:
description: The identifier associated with the `type` value that defines the holder of the permission.
type: string
required:
- type
type: object
IssueSecurityLevelMember:
additionalProperties: false
description: Issue security level member.
properties:
holder:
allOf:
- $ref: '#/components/schemas/PermissionHolder'
description: The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information.
id:
description: The ID of the issue security level member.
format: int64
type: integer
issueSecurityLevelId:
description: The ID of the issue security level.
format: int64
type: integer
managed:
type: boolean
writeOnly: true
required:
- holder
- id
- issueSecurityLevelId
type: object
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API Key
description: Use an Atlassian API key as a Bearer token. Create API keys at https://admin.atlassian.com.
oauth2:
type: oauth2
description: OAuth 2.0 authorization for Atlassian Cloud APIs.
flows:
authorizationCode:
authorizationUrl: https://auth.atlassian.com/authorize
tokenUrl: https://auth.atlassian.com/oauth/token
scopes:
read:org:admin: Read organization information.
write:org:admin: Modify organization settings.
read:user:admin: Read user information.
write:user:admin: Modify user accounts.
read:policy:admin: Read organization policies.
write:policy:admin: Modify organization policies.
read:event:admin: Read organization events.
externalDocs:
description: Atlassian Admin REST API Documentation
url: https://developer.atlassian.com/cloud/admin/organization/rest/intro/