Keycloak

Keycloak Component API

The Component API from Keycloak — 3 operation(s) for component.

Documentation GitHub OpenAPI

Operations 6

GET /admin/realms/{realm}/components Get admin realms by realm components #

POST /admin/realms/{realm}/components Create admin realms by realm components #

GET /admin/realms/{realm}/components/{id} Get admin realms by realm components by id #

PUT /admin/realms/{realm}/components/{id} Replace admin realms by realm components by id #

DELETE /admin/realms/{realm}/components/{id} Delete admin realms by realm components by id #

GET /admin/realms/{realm}/components/{id}/sub-component-types List of subcomponent types that are available to configure for a particular… #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/keycloak/openapi/keycloak-component-api-openapi.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:keycloak-component-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: Keycloak Admin REST Component API
  description: This is a REST API reference for the Keycloak Admin REST API.
  version: '1.0'
tags:
- name: Component
paths:
  /admin/realms/{realm}/components:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Component
      parameters:
      - name: name
        in: query
        schema:
          type: string
      - name: parent
        in: query
        schema:
          type: string
      - name: providerId
        in: query
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentRepresentation'
      summary: Get admin realms by realm components
      x-summary-source: derived
      operationId: getAdminRealmsByRealmComponents
      x-operation-id-source: derived
    post:
      tags:
      - Component
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentRepresentation'
      responses:
        '200':
          description: OK
      summary: Create admin realms by realm components
      x-summary-source: derived
      operationId: postAdminRealmsByRealmComponents
      x-operation-id-source: derived
  /admin/realms/{realm}/components/{id}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Component
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentRepresentation'
      summary: Get admin realms by realm components by id
      x-summary-source: derived
      operationId: getAdminRealmsByRealmComponentsById
      x-operation-id-source: derived
    put:
      tags:
      - Component
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentRepresentation'
      responses:
        '200':
          description: OK
      summary: Replace admin realms by realm components by id
      x-summary-source: derived
      operationId: putAdminRealmsByRealmComponentsById
      x-operation-id-source: derived
    delete:
      tags:
      - Component
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      summary: Delete admin realms by realm components by id
      x-summary-source: derived
      operationId: deleteAdminRealmsByRealmComponentsById
      x-operation-id-source: derived
  /admin/realms/{realm}/components/{id}/sub-component-types:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Component
      summary: List of subcomponent types that are available to configure for a particular…
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentTypeRepresentation'
      operationId: getAdminRealmsByRealmComponentsByIdSubComponentTypes
      x-operation-id-source: derived
components:
  schemas:
    ConfigPropertyRepresentation:
      type: object
      properties:
        name:
          type: string
        label:
          type: string
        helpText:
          type: string
        type:
          type: string
        defaultValue: {}
        options:
          type: array
          items:
            type: string
        secret:
          type: boolean
        required:
          type: boolean
        readOnly:
          type: boolean
    ComponentTypeRepresentation:
      type: object
      properties:
        id:
          type: string
        helpText:
          type: string
        properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigPropertyRepresentation'
        clientProperties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigPropertyRepresentation'
        metadata:
          type: object
          additionalProperties: {}
    ComponentRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        providerId:
          type: string
        providerType:
          type: string
        parentId:
          type: string
        subType:
          type: string
        config:
          $ref: '#/components/schemas/MultivaluedHashMapStringString'
    MultivaluedHashMapStringString:
      type: object
      additionalProperties:
        type: array
        items:
          type: string