Keycloak

Keycloak Protocol Mappers API

The Protocol Mappers API from Keycloak — 12 operation(s) for protocol mappers.

GitHub OpenAPI

Operations 21

POST /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/add-models Create multiple mappers #
GET /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models Get mappers #
POST /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models Create a mapper #
GET /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id} Get mapper by id #
PUT /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id} Update the mapper #
DELETE /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id} Delete the mapper #
GET /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/protocol/{protocol} Get mappers by name for a specific protocol #
POST /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/add-models Create multiple mappers #
GET /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models Get mappers #
POST /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models Create a mapper #
GET /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id} Get mapper by id #
PUT /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id} Update the mapper #
DELETE /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id} Delete the mapper #
GET /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/protocol/{protocol} Get mappers by name for a specific protocol #
POST /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/add-models Create multiple mappers #
GET /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models Get mappers #
POST /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models Create a mapper #
GET /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id} Get mapper by id #
PUT /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id} Update the mapper #
DELETE /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id} Delete the mapper #
GET /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/protocol/{protocol} Get mappers by name for a specific protocol #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/keycloak/openapi/keycloak-protocol-mappers-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-protocol-mappers-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

keycloak-protocol-mappers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Keycloak Admin REST Protocol Mappers API
  description: This is a REST API reference for the Keycloak Admin REST API.
  version: '1.0'
tags:
- name: Protocol Mappers
paths:
  /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/add-models:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Protocol Mappers
      summary: Create multiple mappers
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmClientScopesByClientScopeIdProtocolMappersAddModels
      x-operation-id-source: derived
  /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mappers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientScopesByClientScopeIdProtocolMappersModels
      x-operation-id-source: derived
    post:
      tags:
      - Protocol Mappers
      summary: Create a mapper
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      operationId: postAdminRealmsByRealmClientScopesByClientScopeIdProtocolMappersModels
      x-operation-id-source: derived
  /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/models/{id}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mapper by id
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientScopesByClientScopeIdProtocolMappersModelsById
      x-operation-id-source: derived
    put:
      tags:
      - Protocol Mappers
      summary: Update the mapper
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '204':
          description: No Content
      operationId: putAdminRealmsByRealmClientScopesByClientScopeIdProtocolMappersModelsById
      x-operation-id-source: derived
    delete:
      tags:
      - Protocol Mappers
      summary: Delete the mapper
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmClientScopesByClientScopeIdProtocolMappersModelsById
      x-operation-id-source: derived
  /admin/realms/{realm}/client-scopes/{client-scope-id}/protocol-mappers/protocol/{protocol}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mappers by name for a specific protocol
      parameters:
      - name: protocol
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientScopesByClientScopeIdProtocolMappersProtocolByProtocol
      x-operation-id-source: derived
  /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/add-models:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Protocol Mappers
      summary: Create multiple mappers
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmClientTemplatesByClientScopeIdProtocolMappersAddModels
      x-operation-id-source: derived
  /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mappers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientTemplatesByClientScopeIdProtocolMappersModels
      x-operation-id-source: derived
    post:
      tags:
      - Protocol Mappers
      summary: Create a mapper
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      operationId: postAdminRealmsByRealmClientTemplatesByClientScopeIdProtocolMappersModels
      x-operation-id-source: derived
  /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/models/{id}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mapper by id
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientTemplatesByClientScopeIdProtocolMappersModelsById
      x-operation-id-source: derived
    put:
      tags:
      - Protocol Mappers
      summary: Update the mapper
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '204':
          description: No Content
      operationId: putAdminRealmsByRealmClientTemplatesByClientScopeIdProtocolMappersModelsById
      x-operation-id-source: derived
    delete:
      tags:
      - Protocol Mappers
      summary: Delete the mapper
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmClientTemplatesByClientScopeIdProtocolMappersModelsById
      x-operation-id-source: derived
  /admin/realms/{realm}/client-templates/{client-scope-id}/protocol-mappers/protocol/{protocol}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-scope-id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mappers by name for a specific protocol
      parameters:
      - name: protocol
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientTemplatesByClientScopeIdProtocolMappersProtocolByProtocol
      x-operation-id-source: derived
  /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/add-models:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-uuid
      in: path
      description: id of client (not client-id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Protocol Mappers
      summary: Create multiple mappers
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmClientsByClientUuidProtocolMappersAddModels
      x-operation-id-source: derived
  /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-uuid
      in: path
      description: id of client (not client-id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mappers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientsByClientUuidProtocolMappersModels
      x-operation-id-source: derived
    post:
      tags:
      - Protocol Mappers
      summary: Create a mapper
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      operationId: postAdminRealmsByRealmClientsByClientUuidProtocolMappersModels
      x-operation-id-source: derived
  /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/models/{id}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-uuid
      in: path
      description: id of client (not client-id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mapper by id
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientsByClientUuidProtocolMappersModelsById
      x-operation-id-source: derived
    put:
      tags:
      - Protocol Mappers
      summary: Update the mapper
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        '204':
          description: No Content
      operationId: putAdminRealmsByRealmClientsByClientUuidProtocolMappersModelsById
      x-operation-id-source: derived
    delete:
      tags:
      - Protocol Mappers
      summary: Delete the mapper
      parameters:
      - name: id
        in: path
        description: Mapper id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmClientsByClientUuidProtocolMappersModelsById
      x-operation-id-source: derived
  /admin/realms/{realm}/clients/{client-uuid}/protocol-mappers/protocol/{protocol}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    - name: client-uuid
      in: path
      description: id of client (not client-id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Protocol Mappers
      summary: Get mappers by name for a specific protocol
      parameters:
      - name: protocol
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
      operationId: getAdminRealmsByRealmClientsByClientUuidProtocolMappersProtocolByProtocol
      x-operation-id-source: derived
components:
  schemas:
    ProtocolMapperRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        protocol:
          type: string
        protocolMapper:
          type: string
        consentRequired:
          type: boolean
          deprecated: true
        consentText:
          type: string
          deprecated: true
        config:
          type: object
          additionalProperties:
            type: string