Gravitee Authentication API

The Authentication API from Gravitee — 4 operation(s) for authentication.

Operations 4

POST /organizations/{orgId}/auth/oauth2/{identity} Exchange authorization code 1 #
POST /organizations/{orgId}/auth/oauth2/{identity}/exchange Token exchange 2 #
POST /organizations/{orgId}/environments/{envId}/auth/oauth2/{identity} Exchange authorization code #
POST /organizations/{orgId}/environments/{envId}/auth/oauth2/{identity}/exchange Token exchange 1 #

Documentation

Specifications

SDKs

Schemas & Data

Other Resources

🔗
ChangeLog
https://documentation.gravitee.io/apim/release-information/changelog
🔗
License
https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
🔗
SDKs
https://github.com/gravitee-io/gravitee-clients-sdk
🔗
SDKs
https://github.com/gravitee-io/terraform-provider-apim
🔗
CLI
https://github.com/gravitee-io/graviteeio-cli
🔗
KubernetesOperator
https://github.com/gravitee-io/gravitee-kubernetes-operator
🔗
HelmChart
https://github.com/gravitee-io/helm-charts
🔗
DockerImage
https://hub.docker.com/r/graviteeio/apim-gateway
🔗
JSONLDContext
https://artifacts.apis.io/gravitee/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_notifications.yaml
🔗
Plans
https://artifacts.apis.io/gravitee/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/gravitee/finops/gravitee-finops.yml
🔗
Reference
https://documentation.gravitee.io/am/reference/am-api-reference
🔗
ChangeLog
https://documentation.gravitee.io/am/releases-and-changelog/release-notes
🔗
License
https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE
🔗
SDKs
https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java
🔗
HelmChart
https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am
🔗
DockerImage
https://hub.docker.com/r/graviteeio/am-gateway

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-authentication-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.

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

OpenAPI Specification

gravitee-authentication-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gravitee.io - Management Authentication 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: Authentication
paths:
  /organizations/{orgId}/auth/oauth2/{identity}:
    post:
      tags:
      - Authentication
      operationId: exchangeAuthorizationCode_1
      parameters:
      - name: identity
        in: path
        required: true
        schema:
          type: string
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/Payload'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Exchange authorization code 1
      x-summary-source: derived
  /organizations/{orgId}/auth/oauth2/{identity}/exchange:
    post:
      tags:
      - Authentication
      operationId: tokenExchange_2
      parameters:
      - name: identity
        in: path
        required: true
        schema:
          type: string
      - name: token
        in: query
        schema:
          type: string
      - 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: {}
      summary: Token exchange 2
      x-summary-source: derived
  /organizations/{orgId}/environments/{envId}/auth/oauth2/{identity}:
    post:
      tags:
      - Authentication
      operationId: exchangeAuthorizationCode
      parameters:
      - name: identity
        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:
          '*/*':
            schema:
              $ref: '#/components/schemas/Payload'
        required: true
      responses:
        default:
          description: default response
          content:
            application/json: {}
      summary: Exchange authorization code
      x-summary-source: derived
  /organizations/{orgId}/environments/{envId}/auth/oauth2/{identity}/exchange:
    post:
      tags:
      - Authentication
      operationId: tokenExchange_1
      parameters:
      - name: identity
        in: path
        required: true
        schema:
          type: string
      - name: token
        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: {}
      summary: Token exchange 1
      x-summary-source: derived
components:
  schemas:
    Payload:
      required:
      - clientId
      - code
      - redirectUri
      type: object
      properties:
        clientId:
          type: string
        code:
          type: string
        redirectUri:
          type: string
        state:
          type: string
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic