Atlassian The Jira Cloud platform REST API — Groups

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Groups
  description: 'Atlassian The Jira Cloud platform REST API — Groups. 8 operations. Lead operation: Atlassian Remove Group.
    Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-groups
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: rest-api-3-group
      path: /rest/api/3/group
      operations:
      - name: atlassianremovegroup
        method: DELETE
        description: Atlassian Remove Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupname
          in: query
          type: string
        - name: groupId
          in: query
          type: string
          description: The ID of the group. This parameter cannot be used with the `groupname` parameter.
        - name: swapGroup
          in: query
          type: string
          description: 'As a group''s name can change, use of `swapGroupId` is recommended to identify a group.  '
        - name: swapGroupId
          in: query
          type: string
          description: The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions
            are not transferred, comments and worklogs are inac
      - name: atlassiangetgroup
        method: GET
        description: Atlassian Get Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupname
          in: query
          type: string
          description: 'As a group''s name can change, use of `groupId` is recommended to identify a group.  '
        - name: groupId
          in: query
          type: string
          description: The ID of the group. This parameter cannot be used with the `groupName` parameter.
        - name: expand
          in: query
          type: string
          description: List of fields to expand.
      - name: atlassiancreategroup
        method: POST
        description: Atlassian Create Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-group-bulk
      path: /rest/api/3/group/bulk
      operations:
      - name: atlassianbulkgetgroups
        method: GET
        description: Atlassian Bulk Get Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: groupId
          in: query
          type: array
          description: The ID of a group. To specify multiple IDs, pass multiple `groupId` parameters. For example, `groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5`
        - name: groupName
          in: query
          type: array
          description: The name of a group. To specify multiple names, pass multiple `groupName` parameters. For example,
            `groupName=administrators&groupName=jira-software-users`.
        - name: accessType
          in: query
          type: string
          description: 'The access level of a group. Valid values: ''site-admin'', ''admin'', ''user''.'
        - name: applicationKey
          in: query
          type: string
          description: 'The application key of the product user groups to search for. Valid values: ''jira-servicedesk'',
            ''jira-software'', ''jira-product-discovery'', ''jira-core''.'
    - name: rest-api-3-group-member
      path: /rest/api/3/group/member
      operations:
      - name: atlassiangetusersfromgroup
        method: GET
        description: Atlassian Get Users From Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupname
          in: query
          type: string
          description: 'As a group''s name can change, use of `groupId` is recommended to identify a group.  '
        - name: groupId
          in: query
          type: string
          description: The ID of the group. This parameter cannot be used with the `groupName` parameter.
        - name: includeInactiveUsers
          in: query
          type: boolean
          description: Include inactive users.
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
    - name: rest-api-3-group-user
      path: /rest/api/3/group/user
      operations:
      - name: atlassianremoveuserfromgroup
        method: DELETE
        description: Atlassian Remove User From Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupname
          in: query
          type: string
          description: 'As a group''s name can change, use of `groupId` is recommended to identify a group.  '
        - name: groupId
          in: query
          type: string
          description: The ID of the group. This parameter cannot be used with the `groupName` parameter.
        - name: username
          in: query
          type: string
          description: This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migr
        - name: accountId
          in: query
          type: string
          description: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
            *5b10ac8d82e05b22cc7d4ef5*.
          required: true
      - name: atlassianaddusertogroup
        method: POST
        description: Atlassian Add User To Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupname
          in: query
          type: string
          description: 'As a group''s name can change, use of `groupId` is recommended to identify a group.  '
        - name: groupId
          in: query
          type: string
          description: The ID of the group. This parameter cannot be used with the `groupName` parameter.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-groups-picker
      path: /rest/api/3/groups/picker
      operations:
      - name: atlassianfindgroups
        method: GET
        description: Atlassian Find Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: query
          type: string
          description: This parameter is deprecated, setting it does not affect the results. To find groups containing a particular
            user, use [Get user groups](#api-rest-api-3-user-gr
        - name: query
          in: query
          type: string
          description: The string to find in group names.
        - name: exclude
          in: query
          type: array
          description: 'As a group''s name can change, use of `excludeGroupIds` is recommended to identify a group.  '
        - name: excludeId
          in: query
          type: array
          description: 'A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated
            list. For example, `excludeId=group1-id&excludeId=group2-id`. '
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of groups to return. The maximum number of groups that can be returned is limited
            by the system property `jira.ajax.autocomplete.limit`.
        - name: caseInsensitive
          in: query
          type: boolean
          description: Whether the search for groups should be case insensitive.
        - name: userName
          in: query
          type: string
          description: This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migr
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-groups-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Groups. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/group
      name: rest-api-3-group
      description: REST surface for rest-api-3-group.
      operations:
      - method: DELETE
        name: atlassianremovegroup
        description: Atlassian Remove Group
        call: jira-groups.atlassianremovegroup
        with:
          groupname: rest.groupname
          groupId: rest.groupId
          swapGroup: rest.swapGroup
          swapGroupId: rest.swapGroupId
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetgroup
        description: Atlassian Get Group
        call: jira-groups.atlassiangetgroup
        with:
          groupname: rest.groupname
          groupId: rest.groupId
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreategroup
        description: Atlassian Create Group
        call: jira-groups.atlassiancreategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/group/bulk
      name: rest-api-3-group-bulk
      description: REST surface for rest-api-3-group-bulk.
      operations:
      - method: GET
        name: atlassianbulkgetgroups
        description: Atlassian Bulk Get Groups
        call: jira-groups.atlassianbulkgetgroups
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
          groupId: rest.groupId
          groupName: rest.groupName
          accessType: rest.accessType
          applicationKey: rest.applicationKey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/group/member
      name: rest-api-3-group-member
      description: REST surface for rest-api-3-group-member.
      operations:
      - method: GET
        name: atlassiangetusersfromgroup
        description: Atlassian Get Users From Group
        call: jira-groups.atlassiangetusersfromgroup
        with:
          groupname: rest.groupname
          groupId: rest.groupId
          includeInactiveUsers: rest.includeInactiveUsers
          startAt: rest.startAt
          maxResults: rest.maxResults
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/group/user
      name: rest-api-3-group-user
      description: REST surface for rest-api-3-group-user.
      operations:
      - method: DELETE
        name: atlassianremoveuserfromgroup
        description: Atlassian Remove User From Group
        call: jira-groups.atlassianremoveuserfromgroup
        with:
          groupname: rest.groupname
          groupId: rest.groupId
          username: rest.username
          accountId: rest.accountId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassianaddusertogroup
        description: Atlassian Add User To Group
        call: jira-groups.atlassianaddusertogroup
        with:
          groupname: rest.groupname
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/groups/picker
      name: rest-api-3-groups-picker
      description: REST surface for rest-api-3-groups-picker.
      operations:
      - method: GET
        name: atlassianfindgroups
        description: Atlassian Find Groups
        call: jira-groups.atlassianfindgroups
        with:
          accountId: rest.accountId
          query: rest.query
          exclude: rest.exclude
          excludeId: rest.excludeId
          maxResults: rest.maxResults
          caseInsensitive: rest.caseInsensitive
          userName: rest.userName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Groups. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-remove-group
      description: Atlassian Remove Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-groups.atlassianremovegroup
      with:
        groupname: tools.groupname
        groupId: tools.groupId
        swapGroup: tools.swapGroup
        swapGroupId: tools.swapGroupId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-group
      description: Atlassian Get Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-groups.atlassiangetgroup
      with:
        groupname: tools.groupname
        groupId: tools.groupId
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-group
      description: Atlassian Create Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-groups.atlassiancreategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-bulk-get-groups
      description: Atlassian Bulk Get Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-groups.atlassianbulkgetgroups
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
        groupId: tools.groupId
        groupName: tools.groupName
        accessType: tools.accessType
        applicationKey: tools.applicationKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-users-group
      description: Atlassian Get Users From Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-groups.atlassiangetusersfromgroup
      with:
        groupname: tools.groupname
        groupId: tools.groupId
        includeInactiveUsers: tools.includeInactiveUsers
        startAt: tools.startAt
        maxResults: tools.maxResults
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-remove-user-group
      description: Atlassian Remove User From Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-groups.atlassianremoveuserfromgroup
      with:
        groupname: tools.groupname
        groupId: tools.groupId
        username: tools.username
        accountId: tools.accountId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-add-user-group
      description: Atlassian Add User To Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-groups.atlassianaddusertogroup
      with:
        groupname: tools.groupname
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-find-groups
      description: Atlassian Find Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-groups.atlassianfindgroups
      with:
        accountId: tools.accountId
        query: tools.query
        exclude: tools.exclude
        excludeId: tools.excludeId
        maxResults: tools.maxResults
        caseInsensitive: tools.caseInsensitive
        userName: tools.userName
      outputParameters:
      - type: object
        mapping: $.