components:
  schemas:
    PageBeanSecurityLevel:
      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/SecurityLevel'
          readOnly: true
          type: array
      type: object
    PageBeanSecurityLevelMember:
      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/SecurityLevelMember'
          readOnly: true
          type: array
      type: object
    PageBeanIssueSecuritySchemeToProjectMapping:
      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/IssueSecuritySchemeToProjectMapping'
          readOnly: true
          type: array
      type: object
    PageBeanSecuritySchemeWithProjects:
      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/SecuritySchemeWithProjects'
          readOnly: true
          type: array
      type: object
    SecurityScheme:
      additionalProperties: false
      description: Details about a security scheme.
      properties:
        defaultSecurityLevelId:
          description: The ID of the default security level.
          format: int64
          readOnly: true
          type: integer
        description:
          description: The description of the issue security scheme.
          readOnly: true
          type: string
        id:
          description: The ID of the issue security scheme.
          format: int64
          readOnly: true
          type: integer
        levels:
          items:
            $ref: '#/components/schemas/SecurityLevel'
          type: array
        name:
          description: The name of the issue security scheme.
          readOnly: true
          type: string
        self:
          description: The URL of the issue security scheme.
          readOnly: true
          type: string
      type: object
    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
externalDocs:
  description: Find out more about Atlassian products and services.
  url: http://www.atlassian.com
info:
  contact:
    email: ecosystem@atlassian.com
  description: Needs description.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://atlassian.com/terms/
  title: 'Atlassian rest/api/3/issuesecurityschemes/'
  version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
openapi: 3.0.1
paths:
  /rest/api/3/issuesecurityschemes/level:
    get:
      deprecated: false
      description: >-
        Returns a [paginated](#pagination) list of issue security
        levels.<br><br>Only issue security levels in the context of classic
        projects are returned.<br><br>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.<br><br>**[Permissions](#permissions) required:**
        *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianGetsecuritylevels
      parameters:
        - description: >-
            The index of the first item to return in a page of results (page
            offset).
          in: query
          name: startAt
          schema:
            default: '0'
            type: string
        - description: The maximum number of items to return per page.
          in: query
          name: maxResults
          schema:
            default: '50'
            type: string
        - description: >-
            The list of issue security scheme level IDs. To include multiple
            issue security levels, separate IDs with an ampersand:
            `id=10000&id=10001`.
          in: query
          name: id
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
        - description: >-
            The list of issue security scheme IDs. To include multiple issue
            security schemes, separate IDs with an ampersand:
            `schemeId=10000&schemeId=10001`.
          in: query
          name: schemeId
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
        - description: >-
            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.
          in: query
          name: onlyDefault
          schema:
            default: false
            type: boolean
      responses:
        '200':
          content:
            application/json:
              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"}]}
              schema:
                $ref: '#/components/schemas/PageBeanSecurityLevel'
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["-1000 is not a valid value. id must be zero
                or a positive integer."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Get Issue Security Levels
      tags:
        - Issue Security Schemes
      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:issue-security-level:jira
            - read:issue-security-scheme:jira
          state: Beta
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/level/default:
    put:
      deprecated: false
      description: >-
        Sets default issue security levels for
        schemes.<br><br>**[Permissions](#permissions) required:** *Administer
        Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianSetdefaultlevels
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              defaultValues:
                - defaultLevelId: '20000'
                  issueSecuritySchemeId: '10000'
                - defaultLevelId: '30000'
                  issueSecuritySchemeId: '12000'
            schema:
              $ref: '#/components/schemas/SetDefaultLevelsRequest'
        required: true
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["some-wrong-string is not a valid value. The
                issue security scheme ID must be a positive
                integer."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the issue resolution isn't found.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Set Default Issue Security Levels
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/level/member:
    get:
      deprecated: false
      description: >-
        Returns a [paginated](#pagination) list of issue security level
        members.<br><br>Only issue security level members in the context of
        classic projects are returned.<br><br>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.<br><br>**[Permissions](#permissions) required:**
        *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianGetsecuritylevelmembers
      parameters:
        - description: >-
            The index of the first item to return in a page of results (page
            offset).
          in: query
          name: startAt
          schema:
            default: '0'
            type: string
        - description: The maximum number of items to return per page.
          in: query
          name: maxResults
          schema:
            default: '50'
            type: string
        - description: >-
            The list of issue security level member IDs. To include multiple
            issue security level members separate IDs with an ampersand:
            `id=10000&id=10001`.
          in: query
          name: id
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
        - description: >-
            The list of issue security scheme IDs. To include multiple issue
            security schemes separate IDs with an ampersand:
            `schemeId=10000&schemeId=10001`.
          in: query
          name: schemeId
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
        - description: >-
            The list of issue security level IDs. To include multiple issue
            security levels separate IDs with an ampersand:
            `levelId=10000&levelId=10001`.
          in: query
          name: levelId
          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:

             *  `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
          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":"20010","issueSecuritySchemeId":"10010","holder":{"expand":"group","type":"group"}}]}
              schema:
                $ref: '#/components/schemas/PageBeanSecurityLevelMember'
          description: Returned if the request is successful.
        '400':
          description: Returned if the request is invalid.
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
          description: Returned if the user doesn't have the necessary permission.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Get Issue Security Level Members
      tags:
        - Issue Security Schemes
      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:issue-security-level:jira
            - read:issue-security-scheme:jira
          state: Beta
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/project:
    get:
      deprecated: false
      description: >-
        Returns a [paginated](#pagination) 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](#permissions)
        required:** *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianSearchprojectsusingsecurityschemes
      parameters:
        - description: >-
            The index of the first item to return in a page of results (page
            offset).
          in: query
          name: startAt
          schema:
            default: '0'
            type: string
        - description: The maximum number of items to return per page.
          in: query
          name: maxResults
          schema:
            default: '50'
            type: string
        - description: The list of security scheme IDs to be filtered out.
          in: query
          name: issueSecuritySchemeId
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
        - description: The list of project IDs to be filtered out.
          in: query
          name: projectId
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
      responses:
        '200':
          content:
            application/json:
              example: '{"issueSecuritySchemeId":"10000","projectId":"10000"}'
              schema:
                $ref: >-
                  #/components/schemas/PageBeanIssueSecuritySchemeToProjectMapping
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: >-
            Returned if the search criteria is invalid.If you specify the
            project ID parameter
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Get Projects Using Issue Security Schemes
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
    put:
      deprecated: false
      description: >-
        Associates an issue security scheme with a project and remaps security
        levels of issues to the new levels, if provided.<br><br>This operation
        is [asynchronous](#async). Follow the `location` link in the response to
        determine the status of the task and use [Get
        task](#api-rest-api-3-task-taskId-get) to obtain subsequent
        updates.<br><br>**[Permissions](#permissions) required:** *Administer
        Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianAssociateschemestoprojects
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              oldToNewSecurityLevelMappings:
                - newLevelId: '30001'
                  oldLevelId: '30000'
              projectId: '10000'
              schemeId: '20000'
            schema:
              $ref: '#/components/schemas/AssociateSecuritySchemeWithProjectDetails'
        required: true
      responses:
        '303':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskProgressBeanObject'
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["some-wrong-string is not a valid value. The
                issue security scheme ID must be a positive
                integer."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the security scheme isn't found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: >-
            Returned if a task to remove the issue security level is already
            running.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Associate Security Scheme To Project
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/search:
    get:
      deprecated: false
      description: >-
        Returns a [paginated](#pagination) list of issue security schemes.  <br>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.<br><br>Only issue security schemes in the context of classic
        projects are returned.<br><br>**[Permissions](#permissions) required:**
        *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianSearchsecurityschemes
      parameters:
        - description: >-
            The index of the first item to return in a page of results (page
            offset).
          in: query
          name: startAt
          schema:
            default: '0'
            type: string
        - description: The maximum number of items to return per page.
          in: query
          name: maxResults
          schema:
            default: '50'
            type: string
        - description: >-
            The list of issue security scheme IDs. To include multiple issue
            security scheme IDs, separate IDs with an ampersand:
            `id=10000&id=10001`.
          in: query
          name: id
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
        - description: >-
            The list of project IDs. To include multiple project IDs, separate
            IDs with an ampersand: `projectId=10000&projectId=10001`.
          in: query
          name: projectId
          schema:
            items:
              type: string
            type: array
            uniqueItems: true
      responses:
        '200':
          content:
            application/json:
              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]}
              schema:
                $ref: '#/components/schemas/PageBeanSecuritySchemeWithProjects'
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["-1000 is not a valid value. id must be zero
                or a positive integer."],"errors":{}}
          description: Returned if the request is invalid.
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
          description: Returned if the user doesn't have the necessary permission.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Search Issue Security Schemes
      tags:
        - Issue Security Schemes
      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:issue-security-level:jira
            - read:issue-security-scheme:jira
          state: Beta
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/{id}:
    get:
      deprecated: false
      description: >-
        Returns an issue security scheme along with its security
        levels.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).<br> *  *Administer Projects* [project
        permission](https://confluence.atlassian.com/x/yodKLg) for a project
        that uses the requested issue security scheme.
      operationId: atlassianGetissuesecurityscheme
      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: id
          required: true
          schema:
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              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"}
              schema:
                $ref: '#/components/schemas/SecurityScheme'
          description: Returned if the request is successful.
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          description: >-
            Returned if the user does not have the administrator permission and
            the scheme is not used in any project where the user has
            administrative permission.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-project
      summary: Atlassian Get Issue Security Scheme
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-atlassian-oauth2-scopes:
        - scheme: OAuth2
          scopes:
            - manage:jira-project
          state: Current
        - scheme: OAuth2
          scopes:
            - read:issue-security-level:jira
            - read:issue-security-scheme:jira
          state: Beta
      x-atlassian-connect-scope: ADMIN
    put:
      deprecated: false
      description: >-
        Updates the issue security scheme.<br><br>**[Permissions](#permissions)
        required:** *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianUpdateissuesecurityscheme
      parameters:
        - description: The ID of the issue security scheme.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              description: My issue security scheme description
              name: My issue security scheme name
            schema:
              $ref: '#/components/schemas/UpdateIssueSecuritySchemeRequestBean'
        required: true
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["The length of the description must not exceed
                4,000 characters."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the issue security scheme isn't found.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Update Issue Security Scheme
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members:
    get:
      deprecated: false
      description: >-
        Returns issue security level members.<br><br>Only issue security level
        members in context of classic projects are
        returned.<br><br>**[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:

             *  `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.
          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/issuesecurityschemes/{schemeId}:
    delete:
      deprecated: false
      description: >-
        Deletes an issue security scheme.<br><br>**[Permissions](#permissions)
        required:** *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianDeletesecurityscheme
      parameters:
        - description: The ID of the issue security scheme.
          in: path
          name: schemeId
          required: true
          schema:
            type: string
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                "You can't delete an issue security scheme if any projects are
                associated with it."
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the issue security scheme isn't found.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Delete Issue Security Scheme
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/{schemeId}/level:
    put:
      deprecated: false
      description: >-
        Adds levels and levels' members to the issue security scheme. You can
        add up to 100 levels per request.<br><br>**[Permissions](#permissions)
        required:** *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianAddsecuritylevel
      parameters:
        - description: The ID of the issue security scheme.
          in: path
          name: schemeId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              levels:
                - description: First Level Description
                  isDefault: true
                  members:
                    - type: reporter
                    - parameter: jira-administrators
                      type: group
                  name: First Level
            schema:
              $ref: '#/components/schemas/AddSecuritySchemeLevelsRequestBean'
        required: true
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["some-wrong-string is not a valid value. The
                issue security scheme ID must be a positive
                integer."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the security scheme isn't found.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Add Issue Security Levels
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}:
    delete:
      deprecated: false
      description: >-
        Deletes an issue security level.<br><br>This operation is
        [asynchronous](#async). Follow the `location` link in the response to
        determine the status of the task and use [Get
        task](#api-rest-api-3-task-taskId-get) to obtain subsequent
        updates.<br><br>**[Permissions](#permissions) required:** *Administer
        Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianRemovelevel
      parameters:
        - description: The ID of the issue security scheme.
          in: path
          name: schemeId
          required: true
          schema:
            type: string
        - description: The ID of the issue security level to remove.
          in: path
          name: levelId
          required: true
          schema:
            type: string
        - description: >-
            The ID of the issue security level that will replace the currently
            selected level.
          in: query
          name: replaceWith
          schema:
            type: string
      responses:
        '303':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskProgressBeanObject'
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                "You can't delete an issue security scheme if any projects are
                associated with it."
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request isn't valid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the issue security level isn't found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: >-
            Returned if a task to remove the issue security level is already
            running.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Remove Issue Security Level
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
    put:
      deprecated: false
      description: >-
        Updates the issue security level.<br><br>**[Permissions](#permissions)
        required:** *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianUpdatesecuritylevel
      parameters:
        - description: The ID of the issue security scheme level belongs to.
          in: path
          name: schemeId
          required: true
          schema:
            type: string
        - description: The ID of the issue security level to update.
          in: path
          name: levelId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              description: New level description
              name: New level name
            schema:
              $ref: '#/components/schemas/UpdateIssueSecurityLevelDetails'
        required: true
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["The length of the description must not exceed
                4,000 characters."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request isn't valid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the issue security level isn't found.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Update Issue Security Level
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member:
    put:
      deprecated: false
      description: >-
        Adds members to the issue security level. You can add up to 100 members
        per request.<br><br>**[Permissions](#permissions) required:**
        *Administer Jira* [global
        permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianAddsecuritylevelmembers
      parameters:
        - description: The ID of the issue security scheme.
          in: path
          name: schemeId
          required: true
          schema:
            type: string
        - description: The ID of the issue security level.
          in: path
          name: levelId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              members:
                - type: reporter
                - parameter: jira-administrators
                  type: group
            schema:
              $ref: '#/components/schemas/SecuritySchemeMembersRequest'
        required: true
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example: >-
                {"errorMessages":["some-wrong-string is not a valid value. The
                issue security scheme ID must be a positive
                integer."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the security scheme isn't found.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Add Issue Security Level Members
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
  /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}:
    delete:
      deprecated: false
      description: >-
        Removes an issue security level member from an issue security
        scheme.<br><br>**[Permissions](#permissions) required:** *Administer
        Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
      operationId: atlassianRemovememberfromsecuritylevel
      parameters:
        - description: The ID of the issue security scheme.
          in: path
          name: schemeId
          required: true
          schema:
            type: string
        - description: The ID of the issue security level.
          in: path
          name: levelId
          required: true
          schema:
            type: string
        - description: The ID of the issue security level member to be removed.
          in: path
          name: memberId
          required: true
          schema:
            type: string
      responses:
        '204':
          content:
            application/json:
              schema: {}
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the request is invalid.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the authentication credentials are incorrect or missing.
        '403':
          content:
            application/json:
              example: >-
                {"errorMessages":["You are not authorized to perform this
                action. Administrator privileges are required."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the user doesn't have the necessary permission.
        '404':
          content:
            application/json:
              example: >-
                {"errorMessages":["Issue security scheme with ID 10000 not
                found."],"errors":{}}
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if the security scheme isn't found.
      security:
        - basicAuth: []
        - OAuth2:
            - manage:jira-configuration
      summary: Atlassian Remove Member From Issue Security Level
      tags:
        - Issue Security Schemes
      x-atlassian-data-security-policy:
        - app-access-rule-exempt: true
      x-experimental: true
      x-atlassian-connect-scope: ADMIN
servers:
  - url: https://your-domain.atlassian.net
tags:
  - name: Issue Security Level
  - name: Issue Security Schemes
x-atlassian-narrative:
  documents:
    - anchor: about
      body: >-
        The Jira REST API enables you to interact with Jira programmatically.
        Use this API to 

        [build
        apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/),
        script interactions with 

        Jira, or develop any other type of integration. This page documents the
        REST resources available in Jira Cloud, including 

        the HTTP response codes and example requests and responses.
      title: About
    - anchor: version
      body: >
        This documentation is for **version 3** of the Jira Cloud platform REST
        API, which is the latest version

        but is in **beta**. [Version
        2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and 

        version 3 of the API offer the same collection of operations. However,
        version 3 provides support for 

        the [Atlassian Document
        Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) 

        (ADF) in: 

        - `body` in comments, including where comments are used in issue, issue
        link, and transition resources.

        - `comment` in worklogs.

        - `description` and `environment` fields in issues.

        - `textarea` type custom fields (multi-line text fields) in issues.
        Single line custom fields 
          (`textfield`) accept a string and don't handle Atlassian Document Format content.

        However, these new features are under development and may change.
      title: Version
    - anchor: authentication
      body: >
        ### Forge apps


        For Forge apps, [REST API
        scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) 

        are used when authenticating with Jira Cloud platform. See [Add scopes
        to call an Atlassian REST
        API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/)
        for more details.


        The URIs for Forge app REST API calls have this structure:


        `/rest/api/3/<resource-name>`


        For example, `/rest/api/3/issue/DEMO-1`


        ### Connect apps


        For Connect apps, authentication (JWT-based) is built into the Connect
        libraries. Authorization is implemented using either 

        scopes (shown as _App scope required_ for operations on this page) or
        user impersonation. See 

        [Security for Connect
        apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) 

        for details.


        The URIs for Connect app REST API calls have this structure:


        `https://<site-url>/rest/api/3/<resource-name>`


        For example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`


        ### Other integrations


        For integrations that are not Forge or Connect apps, use OAuth 2.0
        authorization code grants (3LO) for security 

        (3LO scopes are shown as for operations _OAuth scopes required_). See 

        [OAuth 2.0 (3LO)
        apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) 

        for details.


        The URIs for OAuth 2.0 (3LO) app REST API calls have this structure:


        `https://api.atlassian.com/ex/jira/<cloudId>/rest/api/3/<resource-name>`


        For example,
        `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`


        ### Ad-hoc API calls


        For personal scripts, bots, and ad-hoc execution of the REST APIs use
        basic authentication. See [Basic auth for REST
        APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/)
        for details. 


        The URIs for basic authentication REST API calls have this structure:


        `https://<site-url>/rest/api/3/<resource-name>`


        For example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`
      title: Authentication and authorization
    - anchor: permissions
      body: >
        ### Operation permissions


        Most operations in this API require permissions. The calling user must
        have the required permissions for an operation to 

        use it. Note that for Connect apps, the app user must have the required
        permissions for the operation and the app must 

        have scopes that permit the operation.


        A permission can be granted to a group, project role, or issue role that
        the user is a member of, or granted directly to a user. 

        See [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ)
        for details. The most common permissions are:


        - **Administer the Cloud site**: Users in the _site-admins_ group have
        this 

        permission. See [Manage
        groups](https://confluence.atlassian.com/x/24xjL) for details.

        - **Administer Jira**: Granted by the _Jira Administrators_ global
        permission. There is a default group for this permission. 

        See [Manage groups](https://confluence.atlassian.com/x/24xjL) and
        [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg)
        for details.

        - **Administer a project in Jira**: Granted by the _Administer projects_
        project permission for a project. This can be 

        granted to a user, a group, a project role, and more. 

        See [Managing project
        permissions](https://confluence.atlassian.com/x/yodKLg) for details.

        - **Access a project in Jira**: Granted by the _Browse projects_ project
        permission for a project. This can be 

        granted to a user, a group, a project role, and more. 

        See [Managing project
        permissions](https://confluence.atlassian.com/x/yodKLg) for details.

        - **Access Jira**: Granted by the _Jira Users_ global permission. Users
        in the default product access group (for example, 

        _jira-software-users-acmesite_) have this permission. 

        See [Manage groups](https://confluence.atlassian.com/x/24xjL) and 

        [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg)
        for details.


        ### Anonymous access


        Some operations provide support for anonymous access. However, anonymous
        access is only available if 

        the Jira permission needed to access the object or records returned by
        the operation is granted to 

        the _Public_ group. See [Allowing anonymous access to your
        project](https://confluence.atlassian.com/x/GDxxLg) 

        for details.


        If an operation is called anonymously and anonymous access is not
        available, the operation will return 

        an error. Note that not all operations that correspond to objects that
        can be given public access 

        provide for anonymous access.
      title: Permissions
    - anchor: expansion
      body: >+
        ### Expansion


        The Jira REST API uses resource expansion, which means that some parts
        of a resource are not returned unless specified 

        in the request. This simplifies responses and minimizes network traffic.


        To expand part of a resource in a request, use the expand query
        parameter and specify the object(s) to be expanded. 

        If you need to expand nested objects, use the `.` dot notation. If you
        need to expand multiple objects, use a 

        comma-separated list. 


        For example, the following request expands the `names` and
        `renderedFields` properties for the _JRACLOUD-34423_ issue:


        `GET issue/JRACLOUD-34423?expand=names,renderedFields`


        To discover which object can be expanded, refer to the `expand` property
        in the object. 

        In the JSON example below, the resource declares `widgets` as
        expandable.


        ```json

        {
          "expand": "widgets", 
          "self": "https://your-domain.atlassian.net/rest/api/3/resource/KEY-1", 
          "widgets": {
            "widgets": [],
            "size": 5
           }
        }

        ```


        ### Pagination


        The Jira REST API uses pagination to improve performance. Pagination is
        enforced for operations that could return a large 

        collection of items. When you make a request to a paginated resource,
        the response wraps the returned array of values in 

        a JSON object with paging metadata. For example:


        ```json

        {
            "startAt" : 0,
            "maxResults" : 10,
            "total": 200,
            "isLast": false,
            "values": [
                { /* result 0 */ },
                { /* result 1 */ },
                { /* result 2 */ }
            ]
        }

        ```


        *   `startAt` is the index of the first item returned in the page.

        *   `maxResults` is the maximum number of items that a page can return.
        Each operation can have a different limit for
            the number of items returned, and these limits may change without notice. To find the maximum number of items 
            that an operation could return, set `maxResults` to a large number—for example, over 1000—and if the returned value of `maxResults` is less than the requested value, the returned value is the maximum.
        *    `total` is the total number of items contained in all pages. This
        number **_may change_** as the client 

        requests the subsequent pages, therefore the client should always assume
        that the requested page can be empty. Note 

        that this property is not returned for all operations.

        *   `isLast` indicates whether the page returned is the last one. Note
        that this property is not returned for all operations.


        ### Ordering


        Some operations support ordering the elements of a response by a field.
        Check the documentation for the operation to 

        confirm whether ordering of a response is supported and which fields can
        be used. Responses are listed in ascending order 

        by default. You can change the order using the `orderby` query parameter
        with a `-` or `+` symbol. For example:


        *   `?orderBy=name` to order by `name` field ascending.

        *   `?orderBy=+name` to order by `name` field ascending.

        *   `?orderBy=-name` to order by `name` field descending.


      title: Expansion, pagination, and ordering
    - anchor: timestamps
      body: >
        By default, top-level timestamps (e.g. updated and created) are returned
        in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, in the system
        default user time zone.


        To return date time data in the logged in user's timezone, please refer
        to `renderedFields` property under the `expand` query parameter in
        relevant APIs.
      title: Timestamps
    - anchor: special-request-headers
      body: >-
        The following request and response headers define important metadata for
        the Jira Cloud REST API resources.


        -   `X-Atlassian-Token` (request): Operations that accept
        multipart/form-data must include the `X-Atlassian-Token: no-check`

        header in requests. Otherwise the request is blocked by cross-site
        request forgery (CSRF/XSRF) protection.

        -   `X-Force-Accept-Language` (request): controls how the standard HTTP
        `Accept-Language` header is processed.

        By default `Accept-Language` is ignored and the response is in the
        language configured in the user's profile or,

        when no language is configured for the user, the default Jira instance
        language. For the response to recognize

        `Accept-Language` send `X-Force-Accept-Language = true` as well. If
        `Accept-Language` requests a language that Jira

        can return the response is in that language, otherwise Jira returns the
        response in the default language. If

        `Accept-Language` is not specified the response is in the default
        language.

        -   `X-AAccountId` (response): This response header contains the
        Atlassian account ID of the authenticated user.
      title: Special headers
    - anchor: anonymous-operations
      body: |2-
         Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. 

         The operations that provide anonymous access are annotated "This operation can be accessed anonymously."
      title: Anonymous operations
    - anchor: async-operations
      body: >-
        Some Jira REST API operations may trigger long-running or
        computationally expensive tasks. In these cases, the operation 

        will schedule an asynchronous task and return a `303 (See Other)`
        response, indicating the location of the queued task 

        in the `Location` header. You can query this task to get progress
        updates.


        When the task finishes, the response object will contain the `result`
        field. The content of the field is specific to the 

        operation that created the task. Refer to the operation’s documentation
        for more information.


        Note that asynchronous tasks are not guaranteed to be run in order. In
        other words, if you need your tasks to execute 

        in a certain order, you should start a task only after the prerequisite
        task(s) have finished.
      title: Asynchronous operations
    - anchor: experimental
      body: >
        Features and methods marked as experimental may change without notice.
        Feedback on experimental functionality is welcome. 

        Report your suggestions and bugs in the [ACJIRA
        project](https://ecosystem.atlassian.net/projects/ACJIRA) (preferred) or
        use the 

        **Give docs feedback** link at the top of this page. 
      title: Experimental features
    - anchor: status-codes
      body: >-
        The Jira Cloud platform REST API uses the [standard HTTP status
        codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).


        Operations that return an error status code may also return a response
        body containing details of the error or errors. 

        The schema for the response body is shown below:



        ```json

        {
          "id": "https://docs.atlassian.com/jira/REST/schema/error-collection#",
          "title": "Error Collection",
          "type": "object",
          "properties": {
            "errorMessages": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "errors": {
              "type": "object",
              "patternProperties": {
                ".+": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "status": { 
              "type": "integer"
            }
          },
          "additionalProperties": false
        }

        ```
      title: Status codes