Keycloak

Keycloak Identity Providers API

Manage identity providers for federated authentication

GitHub OpenAPI

Operations 5

GET /{realm}/identity-provider/instances Keycloak List identity providers #
POST /{realm}/identity-provider/instances Keycloak Create an identity provider #
GET /{realm}/identity-provider/instances/{alias} Keycloak Get an identity provider #
PUT /{realm}/identity-provider/instances/{alias} Keycloak Update an identity provider #
DELETE /{realm}/identity-provider/instances/{alias} Keycloak Delete an identity provider #

Documentation

📖
Documentation
https://www.keycloak.org/docs-api/latest/rest-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/keycloak/refs/heads/main/openapi/keycloak-identity-providers-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/keycloak/refs/heads/main/json-schema/realm.yml
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/keycloak/refs/heads/main/json-schema/client.yml
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/keycloak/refs/heads/main/json-schema/user.yml

Other Resources

🔗
Reference
https://www.keycloak.org/docs/latest/server_admin/
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/keycloak/refs/heads/main/json-ld/keycloak-context.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/keycloak/refs/heads/main/errors/keycloak-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/keycloak/refs/heads/main/data-model/keycloak-data-model.yml

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/keycloak-identity-providers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

keycloak-identity-providers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Keycloak Admin REST Clients Identity Providers API
  description: The Keycloak Admin REST API provides endpoints for managing all aspects of a Keycloak deployment, including realms, users, clients, roles, groups, and identity providers. All endpoints require authentication via a bearer token obtained from the Keycloak token endpoint.
  version: 26.0.0
  contact:
    name: Keycloak
    url: https://www.keycloak.org/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{host}/admin/realms
  description: Keycloak Admin REST API
  variables:
    host:
      default: localhost:8080
      description: Keycloak server host and port
security:
- bearerAuth: []
tags:
- name: Identity Providers
  description: Manage identity providers for federated authentication
paths:
  /{realm}/identity-provider/instances:
    parameters:
    - $ref: '#/components/parameters/realm'
    get:
      operationId: getIdentityProviders
      summary: Keycloak List identity providers
      description: Returns a list of identity providers configured in the realm.
      tags:
      - Identity Providers
      responses:
        '200':
          description: A list of identity provider representations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdentityProviderRepresentation'
    post:
      operationId: createIdentityProvider
      summary: Keycloak Create an identity provider
      tags:
      - Identity Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderRepresentation'
      responses:
        '201':
          description: Identity provider created successfully
  /{realm}/identity-provider/instances/{alias}:
    parameters:
    - $ref: '#/components/parameters/realm'
    - name: alias
      in: path
      required: true
      description: The alias of the identity provider
      schema:
        type: string
    get:
      operationId: getIdentityProvider
      summary: Keycloak Get an identity provider
      tags:
      - Identity Providers
      responses:
        '200':
          description: An identity provider representation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderRepresentation'
        '404':
          description: Identity provider not found
    put:
      operationId: updateIdentityProvider
      summary: Keycloak Update an identity provider
      tags:
      - Identity Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderRepresentation'
      responses:
        '204':
          description: Identity provider updated
    delete:
      operationId: deleteIdentityProvider
      summary: Keycloak Delete an identity provider
      tags:
      - Identity Providers
      responses:
        '204':
          description: Identity provider deleted
components:
  schemas:
    IdentityProviderRepresentation:
      type: object
      description: Representation of a federated identity provider
      properties:
        alias:
          type: string
          description: Unique alias for the identity provider
        displayName:
          type: string
        internalId:
          type: string
          readOnly: true
        providerId:
          type: string
          description: The identity provider type (e.g., oidc, saml, google, github, facebook)
        enabled:
          type: boolean
        trustEmail:
          type: boolean
        storeToken:
          type: boolean
        addReadTokenRoleOnCreate:
          type: boolean
        authenticateByDefault:
          type: boolean
        linkOnly:
          type: boolean
        firstBrokerLoginFlowAlias:
          type: string
        postBrokerLoginFlowAlias:
          type: string
        config:
          type: object
          additionalProperties:
            type: string
          description: Provider-specific configuration (e.g., clientId, clientSecret, authorizationUrl, tokenUrl for OIDC providers)
  parameters:
    realm:
      name: realm
      in: path
      required: true
      description: The name of the realm
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token obtained from the Keycloak token endpoint. Use the master realm admin credentials or a service account with appropriate realm-management roles.