Gravitee

Gravitee Organization API

The Organization API from Gravitee — 2 operation(s) for organization.

Documentation GitHub OpenAPI

Operations 3

GET /organizations/{orgId} GET organization #

PUT /organizations/{orgId} Update organization #

PUT /organizations/{orgId}/identities Update available organization identities #

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-organization-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 Organization 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: Organization
paths:
  /organizations/{orgId}:
    get:
      tags:
      - Organization
      summary: GET organization
      operationId: get
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationEntity'
        '500':
          description: Internal server error
    put:
      tags:
      - Organization
      summary: Update organization
      operationId: update
      parameters:
      - 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/UpdateOrganizationEntity'
      responses:
        '204':
          description: Organization successfully updated
        '500':
          description: Internal server error
  /organizations/{orgId}/identities:
    put:
      tags:
      - Organization
      summary: Update available organization identities
      operationId: updateOrganizationIdentities
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/IdentityProviderActivationEntity'
      responses:
        '204':
          description: Organization successfully updated
        '500':
          description: Internal server error
components:
  schemas:
    PathOperator:
      type: object
      properties:
        operator:
          type: string
          enum:
          - STARTS_WITH
          - EQUALS
        path:
          type: string
    Consumer:
      type: object
      properties:
        consumerId:
          type: string
        consumerType:
          type: string
          enum:
          - TAG
    Flow:
      type: object
      properties:
        condition:
          type: string
        consumers:
          type: array
          items:
            $ref: '#/components/schemas/Consumer'
        enabled:
          type: boolean
        methods:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
            - CONNECT
            - DELETE
            - GET
            - HEAD
            - OPTIONS
            - PATCH
            - POST
            - PUT
            - TRACE
            - OTHER
        name:
          type: string
        path-operator:
          $ref: '#/components/schemas/PathOperator'
        post:
          type: array
          items:
            $ref: '#/components/schemas/Step'
        pre:
          type: array
          items:
            $ref: '#/components/schemas/Step'
    UpdateOrganizationEntity:
      required:
      - name
      type: object
      properties:
        cockpitId:
          type: string
        description:
          type: string
        domainRestrictions:
          type: array
          items:
            type: string
        flowMode:
          type: string
          enum:
          - DEFAULT
          - BEST_MATCH
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flow'
        hrids:
          type: array
          items:
            type: string
        name:
          maxLength: 2147483647
          minLength: 1
          type: string
    IdentityProviderActivationEntity:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
        identityProvider:
          type: string
        referenceId:
          type: string
        referenceType:
          $ref: '#/components/schemas/IdentityProviderActivationReferenceType'
    Step:
      type: object
      properties:
        condition:
          type: string
        configuration:
          type: object
        description:
          type: string
        enabled:
          type: boolean
        name:
          type: string
        policy:
          type: string
    OrganizationEntity:
      required:
      - name
      type: object
      properties:
        cockpitId:
          type: string
        description:
          type: string
        domainRestrictions:
          type: array
          items:
            type: string
        flowMode:
          type: string
          enum:
          - DEFAULT
          - BEST_MATCH
        flows:
          type: array
          items:
            $ref: '#/components/schemas/Flow'
        hrids:
          type: array
          items:
            type: string
        id:
          type: string
        name:
          maxLength: 2147483647
          minLength: 1
          type: string
    IdentityProviderActivationReferenceType:
      type: string
      enum:
      - ENVIRONMENT
      - ORGANIZATION
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic

Gravitee Organization API

Operations 3

Documentation

Specifications

SDKs

Schemas & Data

Other Resources