Atlassian rest/api/3/group/ — Groups

naftiko: 1.0.0-alpha2
info:
  label: Atlassian rest/api/3/group/ — Groups
  description: 'Atlassian rest/api/3/group/ — Groups. 4 operations. Lead operation: Atlassian Bulk Get Groups. 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: rest-api-3-group--groups
    baseUri: https://your-domain.atlassian.net
    description: Atlassian rest/api/3/group/ — Groups business capability. Self-contained, no shared references.
    resources:
    - 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
  exposes:
  - type: rest
    namespace: rest-api-3-group--groups-rest
    port: 8080
    description: REST adapter for Atlassian rest/api/3/group/ — Groups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - 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: rest-api-3-group--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: rest-api-3-group--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: rest-api-3-group--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: rest-api-3-group--groups.atlassianaddusertogroup
        with:
          groupname: rest.groupname
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-api-3-group--groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian rest/api/3/group/ — Groups. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: atlassian-bulk-get-groups
      description: Atlassian Bulk Get Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-api-3-group--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: rest-api-3-group--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: rest-api-3-group--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: rest-api-3-group--groups.atlassianaddusertogroup
      with:
        groupname: tools.groupname
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.