Atlassian Dynamic Modules API

openapi: 3.2.0
info:
  title: Atlassian Dynamic Modules API
  version: '1.0'
  description: 'Operations tagged Dynamic Modules across 2 of this provider''s published API definitions: confluence-openapi-original.yml, jira-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: //your-domain.atlassian.net
- url: https://your-domain.atlassian.net
tags:
- name: Dynamic Modules
  description: ''
paths:
  /atlassian-connect/1/app/module/dynamic:
    get:
      tags:
      - Dynamic Modules
      summary: Atlassian Get Modules
      description: Returns all modules registered dynamically by the calling app.<br><br>**[Permissions](#permissions) required:** Only Connect apps can make this request.
      operationId: atlassianGetmodules
      responses:
        '200':
          description: Returned if the request is successful.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ConnectModules'
        '401':
          description: Returned if the call is not from a Connect app.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DynamicModulesErrorMessage'
            message:
              example: The request is not from a Connect app.
      deprecated: false
      x-experimental: true
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: INACCESSIBLE
    post:
      tags:
      - Dynamic Modules
      summary: Atlassian Register Modules
      description: Registers a list of modules. For the list of modules that support dynamic registration, see [Dynamic modules](https://developer.atlassian.com/cloud/confluence/dynamic-modules/).<br><br>**[Permissions](#permissions) required:** Only Connect apps can make this request.
      operationId: atlassianRegistermodules
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ConnectModules'
        required: true
      responses:
        '200':
          description: Returned if the request is successful.
          content: {}
        '400':
          description: 'Returned if:

            * any of the provided modules is invalid. For example, required properties are missing.

            * any of the modules conflict with registered dynamic modules or modules defined in the app descriptor. For example, there are duplicate keys.


            Details of the issues encountered are included in the error message.'
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DynamicModulesErrorMessage'
            message:
              example: 'Installation failed. The app com.example.app.key has duplicate module keys: [module-key]. Please contact the app vendor.'
        '401':
          description: Returned if the call is not from a Connect app.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DynamicModulesErrorMessage'
            message:
              example: The request is not from a Connect app.
      deprecated: false
      x-experimental: true
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-codegen-request-body-name: body
      x-atlassian-connect-scope: INACCESSIBLE
    delete:
      tags:
      - Dynamic Modules
      summary: Atlassian Remove Modules
      description: Remove all or a list of modules registered by the calling app.<br><br>**[Permissions](#permissions) required:** Only Connect apps can make this request.
      operationId: atlassianRemovemodules
      parameters:
      - name: moduleKey
        in: query
        description: 'The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter.

          For example, `moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field`.

          Nonexistent keys are ignored.'
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '204':
          description: Returned if the request is successful.
          content: {}
        '401':
          description: Returned if the call is not from a Connect app.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DynamicModulesErrorMessage'
            message:
              example: The request is not from a Connect app.
      deprecated: false
      x-experimental: true
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-connect-scope: INACCESSIBLE
    servers:
    - url: //your-domain.atlassian.net
  /rest/atlassian-connect/1/app/module/dynamic:
    delete:
      deprecated: false
      description: Remove all or a list of modules registered by the calling app.<br><br>**[Permissions](#permissions) required:** Only Connect apps can make this request.
      operationId: atlassianDynamicmodulesresourceRemovemodulesDelete
      parameters:
      - description: 'The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter.

          For example, `moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field`.

          Nonexistent keys are ignored.'
        in: query
        name: moduleKey
        required: false
        schema:
          items:
            type: string
          type: array
      responses:
        '204':
          description: Returned if the request is successful.
        '401':
          content:
            application/json:
              example:
                message: The request is not from a Connect app.
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Returned if the call is not from a Connect app.
      summary: Atlassian Remove Modules
      tags:
      - Dynamic Modules
      x-atlassian-connect-scope: NONE
    get:
      deprecated: false
      description: Returns all modules registered dynamically by the calling app.<br><br>**[Permissions](#permissions) required:** Only Connect apps can make this request.
      operationId: atlassianDynamicmodulesresourceGetmodulesGet
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectModules_2'
          description: Returned if the request is successful.
        '401':
          content:
            application/json:
              example:
                message: The request is not from a Connect app.
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Returned if the call is not from a Connect app.
      summary: Atlassian Get Modules
      tags:
      - Dynamic Modules
      x-atlassian-connect-scope: NONE
    post:
      deprecated: false
      description: Registers a list of modules.<br><br>**[Permissions](#permissions) required:** Only Connect apps can make this request.
      operationId: atlassianDynamicmodulesresourceRegistermodulesPost
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectModules_2'
        required: true
      responses:
        '200':
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              example:
                message: 'Installation failed. The app com.example.app.key has duplicate module keys: [module-key]. Please contact the app vendor.'
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: 'Returned if:

            * any of the provided modules is invalid. For example, required properties are missing.

            * any of the modules conflict with registered dynamic modules or modules defined in the app descriptor. For example, there are duplicate keys.


            Details of the issues encountered are included in the error message.'
        '401':
          content:
            application/json:
              example:
                message: The request is not from a Connect app.
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: Returned if the call is not from a Connect app.
      summary: Atlassian Register Modules
      tags:
      - Dynamic Modules
      x-atlassian-connect-scope: NONE
    servers:
    - url: https://your-domain.atlassian.net
components:
  schemas:
    ConnectModules:
      required:
      - modules
      type: object
      properties:
        modules:
          type: array
          items:
            $ref: '#/components/schemas/ConnectModule'
          description: 'A list of app modules in the same format as the `modules` property in the

            [app descriptor](https://developer.atlassian.com/cloud/confluence/app-descriptor/).'
      example:
        webItems:
        - key: my-webitem
          location: system.admin/globalsettings
          url: /my-web-item
          name:
            value: My Web Item
        adminPages:
        - key: my-admin-page
          name:
            value: My Admin Page
          url: /my-admin-page
    DynamicModulesErrorMessage:
      required:
      - message
      type: object
      properties:
        message:
          type: string
          description: The error message.
      example:
        message: The request is not from a Connect app.
    ConnectModule:
      type: object
      description: 'A [Connect module](https://developer.atlassian.com/cloud/confluence/modules/admin-page/) in the same format as in the

        [app descriptor](https://developer.atlassian.com/cloud/confluence/app-descriptor/).'
      example:
        key: my-webitem
        location: system.admin/globalsettings
        url: /my-web-item
        name:
          value: My Web Item
    ConnectModules_2:
      example:
        jiraEntityProperties:
        - keyConfigurations:
          - extractions:
            - objectName: extension
              type: text
              alias: attachmentExtension
            propertyKey: attachment
          entityType: issue
          name:
            value: Attachment Index Document
          key: dynamic-attachment-entity-property
        jiraIssueFields:
        - description:
            value: A dynamically added single-select field
          type: single_select
          extractions:
          - path: category
            type: text
            name: categoryName
          name:
            value: Dynamic single select
          key: dynamic-select-field
      properties:
        modules:
          description: 'A list of app modules in the same format as the `modules` property in the

            [app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).'
          items:
            $ref: '#/components/schemas/ConnectModule_2'
          type: array
      required:
      - modules
      type: object
    ErrorMessage:
      additionalProperties: false
      example:
        message: The request is not from a Connect app.
      properties:
        message:
          description: The error message.
          type: string
      required:
      - message
      type: object
    ConnectModule_2:
      description: 'A [Connect module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) in the same format as in the

        [app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).'
      example:
        description:
          value: field with team
        type: single_select
        extractions:
        - path: category
          type: text
          name: categoryName
        name:
          value: Team
        key: team-field
      type: object
  securitySchemes:
    basicAuth:
      type: http
      description: You can access this resource via basic auth.
      scheme: basic
    oAuthDefinitions:
      type: oauth2
      description: This API uses OAuth 2 with the authorizationCode grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          tokenUrl: https://auth.atlassian.com/oauth/token
          scopes:
            read:confluence-content.all: Read all content, including content body (expansions permitted). Note, APIs using this scope may also return data allowed by read:confluence-space.summary. However, this scope is not a substitute for read:confluence-space.summary.
            read:confluence-content.permission: Read content permissions.
            read:confluence-content.summary: Read a summary of the content, which is the content without expansions. Note, APIs using this scope may also return data allowed by read:confluence-space.summary. However, this scope is not a substitute for read:confluence-space.summary.
            write:confluence-content: Permits the creation of pages, blogs, comments and questions.
            read:confluence-space.summary: Read a summary of space information without expansions.
            write:confluence-space: Create, update and delete space information.
            write:confluence-file: Upload attachments.
            read:confluence-props: Read content properties.
            write:confluence-props: Write content properties.
            search:confluence: Search Confluence. Note, APIs using this scope may also return data allowed by read:confluence-space.summary and read:confluence-content.summary. However, this scope is not a substitute for read:confluence-space.summary or read:confluence-content.summary.
            manage:confluence-configuration: Manage global settings.
            read:confluence-groups: Read user groups.
            write:confluence-groups: Create, remove and update user groups.
            read:confluence-user: Read users.
            readonly:content.attachment:confluence: Download attachments of a Confluence page or blogpost that you have access to.
            read:content:confluence: View content.
            read:content-details:confluence: View content details.
            write:content:confluence: Create and update content.
            delete:content:confluence: Delete content.
            read:space-details:confluence: View space details.
            read:analytics.content:confluence: View analytics for content.
            read:audit-log:confluence: View audit records.
            write:audit-log:confluence: Create audit records.
            read:configuration:confluence: View Confluence settings.
            write:configuration:confluence: Update Confluence settings.
            read:page:confluence: View pages.
            write:page:confluence: Create and update pages.
            delete:page:confluence: Delete pages.
            read:blogpost:confluence: View blogposts.
            write:blogpost:confluence: Create and update blogposts.
            delete:blogpost:confluence: Delete blogposts.
            read:whiteboard:confluence: View whiteboards.
            write:whiteboard:confluence: Create and update whiteboards.
            delete:whiteboard:confluence: Delete whiteboards.
            read:custom-content:confluence: View custom content.
            write:custom-content:confluence: Create and update custom content.
            delete:custom-content:confluence: Delete custom content.
            read:attachment:confluence: View and download content attachments.
            write:attachment:confluence: Create and update attachments.
            delete:attachment:confluence: Delete attachments.
            read:comment:confluence: View comments.
            write:comment:confluence: Create and update comments.
            delete:comment:confluence: Delete comments.
            read:template:confluence: View content templates.
            write:template:confluence: Create, update and delete content templates.
            read:label:confluence: View labels.
            write:label:confluence: Add and remove labels.
            read:content.permission:confluence: Check content permissions.
            read:content.property:confluence: View content properties.
            write:content.property:confluence: Create, update and delete content properties.
            read:content.restriction:confluence: View content restrictions.
            write:content.restriction:confluence: Update content restrictions.
            read:content.metadata:confluence: View content summaries.
            read:watcher:confluence: View content watchers.
            write:watcher:confluence: Add and remove content watchers.
            read:group:confluence: View groups.
            write:group:confluence: Create and delete groups.
            read:inlinetask:confluence: View tasks.
            write:inlinetask:confluence: Update tasks.
            read:relation:confluence: View entity relationships.
            write:relation:confluence: Create and update entity relationships.
            read:space:confluence: View spaces.
            write:space:confluence: Create and update spaces.
            delete:space:confluence: Delete spaces.
            read:space.permission:confluence: View space permissions.
            write:space.permission:confluence: Update space permissions.
            read:space.property:confluence: View space properties.
            write:space.property:confluence: Create, update and delete space properties.
            read:user.property:confluence: View user properties.
            write:user.property:confluence: Create, update and delete user properties.
            read:space.setting:confluence: View space settings.
            write:space.setting:confluence: Update space settings.
            read:user:confluence: View user details.
    OAuth2:
      description: OAuth2 scopes for Jira
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          scopes:
            delete:async-task:jira: Delete asynchronous task.
            delete:attachment:jira: Delete issue attachments.
            delete:avatar:jira: Delete system and custom avatars.
            delete:comment.property:jira: Delete issue comment properties.
            delete:comment:jira: Delete issue comments.
            delete:dashboard.property:jira: Delete dashboard properties.
            delete:dashboard:jira: Delete dashboards.
            delete:field-configuration-scheme:jira: Delete field configuration schemes.
            delete:field-configuration:jira: Delete field configurations.
            delete:field.option:jira: Delete field options.
            delete:field:jira: Delete fields.
            delete:filter.column:jira: Delete filter columns.
            delete:filter:jira: Delete filters.
            delete:group:jira: Delete user groups.
            delete:issue-link-type:jira: Delete issue link types.
            delete:issue-link:jira: Delete issue links.
            delete:issue-type-scheme:jira: Delete issue type schemes.
            delete:issue-type-screen-scheme:jira: Delete issue type screen schemes.
            delete:issue-type.property:jira: Delete issue type properties.
            delete:issue-type:jira: Delete issue types.
            delete:issue-worklog.property:jira: Delete issue worklog properties.
            delete:issue-worklog:jira: Delete issue worklogs.
            delete:issue.property:jira: Delete issue properties.
            delete:issue.remote-link:jira: Delete issue remote links.
            delete:issue:jira: Delete issues.
            delete:permission-scheme:jira: Delete permission schemes.
            delete:permission:jira: Delete permissions.
            delete:project-category:jira: Delete project categories.
            delete:project-role:jira: Delete project roles.
            delete:project-version:jira: Delete project versions.
            delete:project.avatar:jira: Delete project avatars.
            delete:project.component:jira: Delete project components.
            delete:project.property:jira: Delete project properties.
            delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars.
            delete:screen-scheme:jira: Delete screen schemes.
            delete:screen-tab:jira: Delete screen tabs.
            delete:screen:jira: Delete screens.
            delete:screenable-field:jira: Delete screenable fields.
            delete:user-configuration:jira: Delete user configurations.
            delete:user.property:jira: Delete user properties.
            delete:webhook:jira: Delete webhooks.
            delete:workflow-scheme:jira: Delete workflow schemes.
            delete:workflow.property:jira: Delete workflow properties.
            delete:workflow:jira: Delete workflows.
            manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types.
            manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components.
            manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks.
            read:application-role:jira: View application roles.
            read:attachment:jira: View issue attachments.
            read:audit-log:jira: View audit logs.
            read:avatar:jira: View system and custom avatars.
            read:comment.property:jira: View issue comment properties.
            read:comment:jira: View issue comments.
            read:custom-field-contextual-configuration:jira: Read custom field contextual configurations.
            read:dashboard.property:jira: View dashboard properties.
            read:dashboard:jira: View dashboards.
            read:field-configuration-scheme:jira: View field configuration schemes.
            read:field-configuration:jira: Read field configurations.
            read:field.default-value:jira: View field default values.
            read:field.option:jira: View field options.
            read:field.options:jira: Read field options.
            read:field:jira: View fields.
            read:filter.column:jira: View filter columns.
            read:filter.default-share-scope:jira: View filter default share scopes.
            read:filter:jira: View filters.
            read:group:jira: View user groups.
            read:instance-configuration:jira: View instance configurations.
            read:issue-details:jira: View issue details.
            read:issue-event:jira: Read issue events.
            read:issue-field-values:jira: View issue field valueses.
            read:issue-link-type:jira: View issue link types.
            read:issue-link:jira: View issue links.
            read:issue-meta:jira: View issue meta.
            read:issue-security-level:jira: View issue security levels.
            read:issue-security-scheme:jira: View issue security schemes.
            read:issue-status:jira: View issue statuses.
            read:issue-type-hierarchy:jira: Read issue type hierarchies.
            read:issue-type-scheme:jira: View issue type schemes.
            read:issue-type-screen-scheme:jira: View issue type screen schemes.
            read:issue-type.property:jira: View issue type properties.
            read:issue-type:jira: View issue types.
            read:issue-worklog.property:jira: View issue worklog properties.
            read:issue-worklog:jira: View issue worklogs.
            read:issue.changelog:jira: View issue changelogs.
            read:issue.property:jira: View issue properties.
            read:issue.remote-link:jira: View issue remote links.
            read:issue.time-tracking:jira: View issue time trackings.
            read:issue.transition:jira: View issue transitions.
            read:issue.vote:jira: View issue votes.
            read:issue.votes:jira: View issue voteses.
            read:issue.watcher:jira: View issue watchers.
            read:issue:jira: View issues.
            read:jira-expressions:jira: View jira expressions.
            read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars.
            read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).
            read:jql:jira: View JQL.
            read:label:jira: View labels.
            read:license:jira: View licenses.
            read:notification-scheme:jira: View notification schemes.
            read:permission-scheme:jira: View permission schemes.
            read:permission:jira: View permissions.
            read:priority:jira: View priorities.
            read:project-category:jira: View project categories.
            read:project-role:jira: View project roles.
            read:project-type:jira: View project types.
            read:project-version:jira: View project versions.
            read:project.avatar:jira: Read project avatars.
            read:project.component:jira: View project components.
            read:project.email:jira: View project emails.
            read:project.feature:jira: Read project features.
            read:project.property:jira: View project properties.
            read:project:jira: View projects.
            read:resolution:jira: View resolutions.
            read:role:jira: View roles.
            read:screen-field:jira: View screen fields.
            read:screen-scheme:jira: View screen schemes.
            read:screen-tab:jira: View screen tabs.
            read:screen:jira: View screens.
            read:screenable-field:jira: View screenable fields.
            read:status:jira: View statuses.
            read:user-configuration:jira: View user configurations.
            read:user.columns:jira: View user columnses.
            read:user.property:jira: View user properties.
            read:user:jira: View users.
            read:webhook:jira: View webhooks.
            read:workflow-scheme:jira: View workflow schemes.
            read:workflow.property:jira: View workflow properties.
            read:workflow:jira: View workflows.
            send:notification:jira: Send notifications.
            validate:jql:jira: Validate JQL.
            write:attachment:jira: Create and update issue attachments.
            write:avatar:jira: Create and update system and custom avatars.
            write:comment.property:jira: Create and update issue comment properties.
            write:comment:jira: Create and update issue comments.
            write:custom-field-contextual-configuration:jira: Save custom field contextual configurations.
            write:dashboard.property:jira: Create and update dashboard properties.
            write:dashboard:jira: Create and update dashboards.
            write:field-configuration-scheme:jira: Create and update field configuration schemes.
            write:field-configuration:jira: Save field configurations.
            write:field.default-value:jira: Create and update field default values.
            write:field.option:jira: Create and update field options.
            write:field:jira: Create and update fields.
            write:filter.column:jira: Create and update filter columns.
            write:filter.default-share-scope:jira: Create and update filter default share scopes.
            write:filter:jira: Create and update filters.
            write:group:jira: Create and update user groups.
            write:instance-configuration:jira: Create and update instance configurations.
            write:issue-link-type:jira: Create and update issue link types.
            write:issue-link:jira: Create and update issue links.
            write:issue-type-scheme:jira: Create and update issue type schemes.
            write:issue-type-screen-scheme:jira: Create and update issue type screen schemes.
            write:issue-type.property:jira: Create and update issue type properties.
            write:issue-type:jira: Create and update issue types.
            write:issue-worklog.property:jira: Create and update issue worklog properties.
            write:issue-worklog:jira: Create and update issue worklogs.
            write:issue.property:jira: Create and update issue properties.
            write:issue.remote-link:jira: Create and update issue remote links.
            write:issue.time-tracking:jira: Create and update issue time trackings.
            write:issue.vote:jira: Create and update issue votes.
            write:issue.watcher:jira: Create and update issue watchers.
            write:issue:jira: Create and update issues.
            write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues.
            write:permission-scheme:jira: Create and update permission schemes.
            write:permission:jira: Create and update permissions.
            write:project-category:jira: Create and update project categories.
            write:project-role:jira: Create and update project roles.
            write:project-version:jira: Create and update project versions.
            write:project.avatar:jira: Create and update project avatars.
            write:project.component:jira: Create and update project components.
            write:project.email:jira: Create and update project emails.
            write:project.feature:jira: Save project features.
            write:project.property:jira: Create and update project properties.
            write:project:jira: Create and update projects.
            write:screen-scheme:jira: Create and update screen schemes.
            write:screen-tab:jira: Create and update screen tabs.
            write:screen:jira: Create and update screens.
            write:screenable-field:jira: Create and update screenable fields.
            write:user-configuration:jira: Create and update user configurations.
            write:user.property:jira: Create and update user properties.
            write:webhook:jira: Create and update webhooks.
            write:workflow-scheme:jira: Create and update workflow schemes.
            write:workflow.property:jira: Create and update workflow properties.
            write:workflow:jira: Create and update workflows.
          tokenUrl: https://auth.atlassian.com/oauth/token
      type: oauth2
x-refined-from:
- confluence-openapi-original.yml
- jira-openapi-original.yml