Atlassian The Confluence Cloud REST API — Group

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Confluence Cloud REST API — Group
  description: 'Atlassian The Confluence Cloud REST API — Group. 15 operations. Lead operation: Atlassian Get Groups. Self-contained
    Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Group
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: confluence-group
    baseUri: ''
    description: Atlassian The Confluence Cloud REST API — Group business capability. Self-contained, no shared references.
    resources:
    - name: wiki-rest-api-group
      path: /wiki/rest/api/group
      operations:
      - name: atlassiangetgroups
        method: GET
        description: Atlassian Get Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start
          in: query
          type: integer
          description: The starting index of the returned groups.
        - name: limit
          in: query
          type: integer
          description: The maximum number of groups to return per page.
        - name: accessType
          in: query
          type: string
          description: The group permission level for which to filter results.
      - name: atlassiancreategroup
        method: POST
        description: Atlassian Create New User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: atlassianremovegroup
        method: DELETE
        description: Atlassian Delete User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Name of the group to delete.
          required: true
    - name: wiki-rest-api-group-by-id
      path: /wiki/rest/api/group/by-id
      operations:
      - name: atlassiangetgroupbygroupid
        method: GET
        description: Atlassian Get Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: The id of the group.
          required: true
      - name: atlassianremovegroupbyid
        method: DELETE
        description: Atlassian Delete User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: Id of the group to delete.
          required: true
    - name: wiki-rest-api-group-by-name
      path: /wiki/rest/api/group/by-name
      operations:
      - name: atlassiangetgroupbyqueryparam
        method: GET
        description: Atlassian Get Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: The name of the group. This is the same as the group name shown in
          required: true
    - name: wiki-rest-api-group-member
      path: /wiki/rest/api/group/member
      operations:
      - name: atlassiangetmembersbyqueryparam
        method: GET
        description: Atlassian Get Group Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: The name of the group to be queried for its members.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned users.
        - name: limit
          in: query
          type: integer
          description: The maximum number of users to return per page.
        - name: shouldReturnTotalSize
          in: query
          type: boolean
          description: Whether to include total size parameter in the results.
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the user to
    - name: wiki-rest-api-group-picker
      path: /wiki/rest/api/group/picker
      operations:
      - name: atlassiansearchgroups
        method: GET
        description: Atlassian Search Groups By Partial Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: the search term used to query results.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned groups.
        - name: limit
          in: query
          type: integer
          description: The maximum number of groups to return per page.
        - name: shouldReturnTotalSize
          in: query
          type: boolean
          description: Whether to include total size parameter in the results.
    - name: wiki-rest-api-group-user
      path: /wiki/rest/api/group/user
      operations:
      - name: atlassianaddusertogroup
        method: POST
        description: Atlassian Add Member To Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Name of the group whose membership is updated
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: atlassianremovememberfromgroup
        method: DELETE
        description: Atlassian Remove Member From Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Name of the group whose membership is updated.
          required: true
    - name: wiki-rest-api-group-userByGroupId
      path: /wiki/rest/api/group/userByGroupId
      operations:
      - name: atlassianaddusertogroupbygroupid
        method: POST
        description: Atlassian Add Member To Group By Groupid
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: query
          type: string
          description: GroupId of the group whose membership is updated
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: atlassianremovememberfromgroupbygroupid
        method: DELETE
        description: Atlassian Remove Member From Group Using Group Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: query
          type: string
          description: Id of the group whose membership is updated.
          required: true
    - name: wiki-rest-api-group-groupId-membersByGroupId
      path: /wiki/rest/api/group/{groupId}/membersByGroupId
      operations:
      - name: atlassiangetgroupmembersbygroupid
        method: GET
        description: Atlassian Get Group Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: The id of the group to be queried for its members.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned users.
        - name: limit
          in: query
          type: integer
          description: The maximum number of users to return per page.
        - name: shouldReturnTotalSize
          in: query
          type: boolean
          description: Whether to include total size parameter in the results.
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the user to
    - name: wiki-rest-api-group-groupName
      path: /wiki/rest/api/group/{groupName}
      operations:
      - name: atlassiangetgroupbyname
        method: GET
        description: Atlassian Get Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupName
          in: path
          type: string
          description: The name of the group. This is the same as the group name shown in
          required: true
    - name: wiki-rest-api-group-groupName-member
      path: /wiki/rest/api/group/{groupName}/member
      operations:
      - name: atlassiangetgroupmembers
        method: GET
        description: Atlassian Get Group Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupName
          in: path
          type: string
          description: The name of the group to be queried for its members.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned users.
        - name: limit
          in: query
          type: integer
          description: The maximum number of users to return per page.
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: confluence-group-rest
    port: 8080
    description: REST adapter for Atlassian The Confluence Cloud REST API — Group. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/wiki/rest/api/group
      name: wiki-rest-api-group
      description: REST surface for wiki-rest-api-group.
      operations:
      - method: GET
        name: atlassiangetgroups
        description: Atlassian Get Groups
        call: confluence-group.atlassiangetgroups
        with:
          start: rest.start
          limit: rest.limit
          accessType: rest.accessType
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreategroup
        description: Atlassian Create New User Group
        call: confluence-group.atlassiancreategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: atlassianremovegroup
        description: Atlassian Delete User Group
        call: confluence-group.atlassianremovegroup
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/by-id
      name: wiki-rest-api-group-by-id
      description: REST surface for wiki-rest-api-group-by-id.
      operations:
      - method: GET
        name: atlassiangetgroupbygroupid
        description: Atlassian Get Group
        call: confluence-group.atlassiangetgroupbygroupid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: atlassianremovegroupbyid
        description: Atlassian Delete User Group
        call: confluence-group.atlassianremovegroupbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/by-name
      name: wiki-rest-api-group-by-name
      description: REST surface for wiki-rest-api-group-by-name.
      operations:
      - method: GET
        name: atlassiangetgroupbyqueryparam
        description: Atlassian Get Group
        call: confluence-group.atlassiangetgroupbyqueryparam
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/member
      name: wiki-rest-api-group-member
      description: REST surface for wiki-rest-api-group-member.
      operations:
      - method: GET
        name: atlassiangetmembersbyqueryparam
        description: Atlassian Get Group Members
        call: confluence-group.atlassiangetmembersbyqueryparam
        with:
          name: rest.name
          start: rest.start
          limit: rest.limit
          shouldReturnTotalSize: rest.shouldReturnTotalSize
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/picker
      name: wiki-rest-api-group-picker
      description: REST surface for wiki-rest-api-group-picker.
      operations:
      - method: GET
        name: atlassiansearchgroups
        description: Atlassian Search Groups By Partial Query
        call: confluence-group.atlassiansearchgroups
        with:
          query: rest.query
          start: rest.start
          limit: rest.limit
          shouldReturnTotalSize: rest.shouldReturnTotalSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/user
      name: wiki-rest-api-group-user
      description: REST surface for wiki-rest-api-group-user.
      operations:
      - method: POST
        name: atlassianaddusertogroup
        description: Atlassian Add Member To Group
        call: confluence-group.atlassianaddusertogroup
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: atlassianremovememberfromgroup
        description: Atlassian Remove Member From Group
        call: confluence-group.atlassianremovememberfromgroup
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/userbygroupid
      name: wiki-rest-api-group-userbygroupid
      description: REST surface for wiki-rest-api-group-userByGroupId.
      operations:
      - method: POST
        name: atlassianaddusertogroupbygroupid
        description: Atlassian Add Member To Group By Groupid
        call: confluence-group.atlassianaddusertogroupbygroupid
        with:
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: atlassianremovememberfromgroupbygroupid
        description: Atlassian Remove Member From Group Using Group Id
        call: confluence-group.atlassianremovememberfromgroupbygroupid
        with:
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/{groupid}/membersbygroupid
      name: wiki-rest-api-group-groupid-membersbygroupid
      description: REST surface for wiki-rest-api-group-groupId-membersByGroupId.
      operations:
      - method: GET
        name: atlassiangetgroupmembersbygroupid
        description: Atlassian Get Group Members
        call: confluence-group.atlassiangetgroupmembersbygroupid
        with:
          groupId: rest.groupId
          start: rest.start
          limit: rest.limit
          shouldReturnTotalSize: rest.shouldReturnTotalSize
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/{groupname}
      name: wiki-rest-api-group-groupname
      description: REST surface for wiki-rest-api-group-groupName.
      operations:
      - method: GET
        name: atlassiangetgroupbyname
        description: Atlassian Get Group
        call: confluence-group.atlassiangetgroupbyname
        with:
          groupName: rest.groupName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/group/{groupname}/member
      name: wiki-rest-api-group-groupname-member
      description: REST surface for wiki-rest-api-group-groupName-member.
      operations:
      - method: GET
        name: atlassiangetgroupmembers
        description: Atlassian Get Group Members
        call: confluence-group.atlassiangetgroupmembers
        with:
          groupName: rest.groupName
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: confluence-group-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Confluence Cloud REST API — Group. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-get-groups
      description: Atlassian Get Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiangetgroups
      with:
        start: tools.start
        limit: tools.limit
        accessType: tools.accessType
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-new-user-group
      description: Atlassian Create New User Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: confluence-group.atlassiancreategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-user-group
      description: Atlassian Delete User Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: confluence-group.atlassianremovegroup
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-group
      description: Atlassian Get Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiangetgroupbygroupid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-user-group-2
      description: Atlassian Delete User Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: confluence-group.atlassianremovegroupbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-group-2
      description: Atlassian Get Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiangetgroupbyqueryparam
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-group-members
      description: Atlassian Get Group Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiangetmembersbyqueryparam
      with:
        name: tools.name
        start: tools.start
        limit: tools.limit
        shouldReturnTotalSize: tools.shouldReturnTotalSize
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-search-groups-partial-query
      description: Atlassian Search Groups By Partial Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiansearchgroups
      with:
        query: tools.query
        start: tools.start
        limit: tools.limit
        shouldReturnTotalSize: tools.shouldReturnTotalSize
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-add-member-group
      description: Atlassian Add Member To Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: confluence-group.atlassianaddusertogroup
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-remove-member-group
      description: Atlassian Remove Member From Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: confluence-group.atlassianremovememberfromgroup
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-add-member-group-groupid
      description: Atlassian Add Member To Group By Groupid
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: confluence-group.atlassianaddusertogroupbygroupid
      with:
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-remove-member-group-using
      description: Atlassian Remove Member From Group Using Group Id
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: confluence-group.atlassianremovememberfromgroupbygroupid
      with:
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-group-members-2
      description: Atlassian Get Group Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiangetgroupmembersbygroupid
      with:
        groupId: tools.groupId
        start: tools.start
        limit: tools.limit
        shouldReturnTotalSize: tools.shouldReturnTotalSize
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-group-3
      description: Atlassian Get Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiangetgroupbyname
      with:
        groupName: tools.groupName
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-group-members-3
      description: Atlassian Get Group Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-group.atlassiangetgroupmembers
      with:
        groupName: tools.groupName
        start: tools.start
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.