Gravitee

Gravitee Groups API

The Groups API from Gravitee — 3 operation(s) for groups.

Documentation GitHub OpenAPI

Operations 7

GET /organizations/{orgId}/environments/{envId}/configuration/groups Find groups #

POST /organizations/{orgId}/environments/{envId}/configuration/groups Create group #

GET /organizations/{orgId}/environments/{envId}/configuration/groups/{group} Get a group #

PUT /organizations/{orgId}/environments/{envId}/configuration/groups/{group} Update an existing group #

DELETE /organizations/{orgId}/environments/{envId}/configuration/groups/{group} Delete an existing group #

GET /organizations/{orgId}/environments/{envId}/configuration/groups/{group}/memberships List APIs or applications linked to this group #

POST /organizations/{orgId}/environments/{envId}/configuration/groups/{group}/memberships Associate a group to existing APIs or Applications #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/gravitee:gravitee-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Gravitee.io - Management Groups API
  description: Some news resources are in alpha version. This implies that they are likely to be modified or even removed in future versions. They are marked with the 🧪 symbol
  version: 3.20.0
servers:
- url: http://localhost:8083/management
security:
- gravitee-auth: []
tags:
- name: Groups
paths:
  /organizations/{orgId}/environments/{envId}/configuration/groups:
    get:
      tags:
      - Groups
      summary: Find groups
      description: Find all groups, or a specific type of groups.Only administrators could see all groups.Only users with MANAGE_API permissions could see API groups.
      operationId: getGroups
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: List of groups
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupEntity'
        '500':
          description: Internal server error
    post:
      tags:
      - Groups
      summary: Create group
      description: Create a new group.
      operationId: createGroup
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewGroupEntity'
        required: true
      responses:
        '201':
          description: Group successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEntity'
        '500':
          description: Internal Server Error
  /organizations/{orgId}/environments/{envId}/configuration/groups/{group}:
    get:
      tags:
      - Groups
      summary: Get a group
      operationId: getGroup
      parameters:
      - name: group
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Group definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEntity'
        '500':
          description: Internal server error
    put:
      tags:
      - Groups
      summary: Update an existing group
      operationId: updateGroup
      parameters:
      - name: group
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGroupEntity'
        required: true
      responses:
        '200':
          description: Group successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEntity'
        '500':
          description: Internal server error
    delete:
      tags:
      - Groups
      summary: Delete an existing group
      operationId: deleteGroup
      parameters:
      - name: group
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '204':
          description: Group successfully deleted
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/configuration/groups/{group}/memberships:
    get:
      tags:
      - Groups
      summary: List APIs or applications linked to this group
      operationId: getGroupMemberships
      parameters:
      - name: group
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        default:
          description: default response
          content:
            application/json: {}
    post:
      tags:
      - Groups
      summary: Associate a group to existing APIs or Applications
      operationId: addGroupMember
      parameters:
      - name: group
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Group successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEntity'
        '500':
          description: Internal server error
components:
  schemas:
    GroupEventRuleEntity:
      type: object
      properties:
        event:
          type: string
    NewGroupEntity:
      required:
      - name
      type: object
      properties:
        disable_membership_notifications:
          type: boolean
        email_invitation:
          type: boolean
        event_rules:
          type: array
          items:
            $ref: '#/components/schemas/GroupEventRuleEntity'
        lock_api_role:
          type: boolean
        lock_application_role:
          type: boolean
        max_invitation:
          type: integer
          format: int32
        name:
          type: string
        system_invitation:
          type: boolean
    GroupEntity:
      type: object
      properties:
        apiPrimaryOwner:
          type: string
        created_at:
          type: string
          format: date-time
        disable_membership_notifications:
          type: boolean
        email_invitation:
          type: boolean
        event_rules:
          type: array
          items:
            $ref: '#/components/schemas/GroupEventRuleEntity'
        id:
          type: string
        lock_api_role:
          type: boolean
        lock_application_role:
          type: boolean
        manageable:
          type: boolean
        max_invitation:
          type: integer
          format: int32
        name:
          type: string
        primary_owner:
          type: boolean
        roles:
          type: object
          additionalProperties:
            type: string
        system_invitation:
          type: boolean
        updated_at:
          type: string
          format: date-time
    UpdateGroupEntity:
      required:
      - name
      type: object
      properties:
        disable_membership_notifications:
          type: boolean
        email_invitation:
          type: boolean
        event_rules:
          type: array
          items:
            $ref: '#/components/schemas/GroupEventRuleEntity'
        lock_api_role:
          type: boolean
        lock_application_role:
          type: boolean
        max_invitation:
          type: integer
          format: int32
        name:
          type: string
        roles:
          type: object
          additionalProperties:
            type: string
        system_invitation:
          type: boolean
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic

Gravitee Groups API

Operations 7

Documentation

Specifications

SDKs

Schemas & Data

Other Resources