Keycloak Authentication Management API

openapi: 3.2.0
info:
  title: Keycloak Admin REST Authentication Management API
  description: This is a REST API reference for the Keycloak Admin REST API.
  version: '1.0'
tags:
- name: Authentication Management
paths:
  /admin/realms/{realm}/authentication/authenticator-providers:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get authenticator providers Returns a stream of authenticator providers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: {}
      operationId: getAdminRealmsByRealmAuthenticationAuthenticatorProviders
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/client-authenticator-providers:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get client authenticator providers Returns a stream of client authenticator…
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: {}
      operationId: getAdminRealmsByRealmAuthenticationClientAuthenticatorProviders
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/config:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Create new authenticator configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      deprecated: true
      operationId: postAdminRealmsByRealmAuthenticationConfig
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/config-description/{providerId}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get authenticator provider's configuration description
      parameters:
      - name: providerId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticatorConfigInfoRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationConfigDescriptionByProviderId
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/config/{id}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get authenticator configuration
      parameters:
      - name: id
        in: path
        description: Configuration id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationConfigById
      x-operation-id-source: derived
    put:
      tags:
      - Authentication Management
      summary: Update authenticator configuration
      parameters:
      - name: id
        in: path
        description: Configuration id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      responses:
        '204':
          description: No Content
      operationId: putAdminRealmsByRealmAuthenticationConfigById
      x-operation-id-source: derived
    delete:
      tags:
      - Authentication Management
      summary: Delete authenticator configuration
      parameters:
      - name: id
        in: path
        description: Configuration id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmAuthenticationConfigById
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/executions:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Add new authentication execution
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationExecutionRepresentation'
      responses:
        '201':
          description: Created
      operationId: postAdminRealmsByRealmAuthenticationExecutions
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/executions/{executionId}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get Single Execution
      parameters:
      - name: executionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationExecutionRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationExecutionsByExecutionId
      x-operation-id-source: derived
    delete:
      tags:
      - Authentication Management
      summary: Delete execution
      parameters:
      - name: executionId
        in: path
        description: Execution id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmAuthenticationExecutionsByExecutionId
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/executions/{executionId}/config:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Update execution with new configuration
      parameters:
      - name: executionId
        in: path
        description: Execution id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      operationId: postAdminRealmsByRealmAuthenticationExecutionsByExecutionIdConfig
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/executions/{executionId}/config/{id}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get execution's configuration
      parameters:
      - name: executionId
        in: path
        description: Execution id
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Configuration id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      deprecated: true
      operationId: getAdminRealmsByRealmAuthenticationExecutionsByExecutionIdConfigById
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/executions/{executionId}/lower-priority:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Lower execution's priority
      parameters:
      - name: executionId
        in: path
        description: Execution id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmAuthenticationExecutionsByExecutionIdLowerPriority
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/executions/{executionId}/raise-priority:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Raise execution's priority
      parameters:
      - name: executionId
        in: path
        description: Execution id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmAuthenticationExecutionsByExecutionIdRaisePriority
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/flows:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get authentication flows Returns a stream of authentication flows
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuthenticationFlowRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationFlows
      x-operation-id-source: derived
    post:
      tags:
      - Authentication Management
      summary: Create a new authentication flow
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationFlowRepresentation'
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      operationId: postAdminRealmsByRealmAuthenticationFlows
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/flows/{flowAlias}/copy:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Copy existing authentication flow under a new name The new name is given as…
      parameters:
      - name: flowAlias
        in: path
        description: name of the existing authentication flow
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: string
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      operationId: postAdminRealmsByRealmAuthenticationFlowsByFlowAliasCopy
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/flows/{flowAlias}/executions:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get authentication executions for a flow
      parameters:
      - name: flowAlias
        in: path
        description: Flow alias
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuthenticationExecutionInfoRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationFlowsByFlowAliasExecutions
      x-operation-id-source: derived
    put:
      tags:
      - Authentication Management
      summary: Update authentication executions of a Flow
      parameters:
      - name: flowAlias
        in: path
        description: Flow alias
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationExecutionInfoRepresentation'
      responses:
        '204':
          description: No Content
        '409':
          description: Conflict
      operationId: putAdminRealmsByRealmAuthenticationFlowsByFlowAliasExecutions
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/flows/{flowAlias}/executions/execution:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Add new authentication execution to a flow
      parameters:
      - name: flowAlias
        in: path
        description: Alias of parent flow
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
      operationId: postAdminRealmsByRealmAuthenticationFlowsByFlowAliasExecutionsExecution
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/flows/{flowAlias}/executions/flow:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Add new flow with new execution to existing flow
      parameters:
      - name: flowAlias
        in: path
        description: Alias of parent authentication flow
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
        '409':
          description: Conflict
      operationId: postAdminRealmsByRealmAuthenticationFlowsByFlowAliasExecutionsFlow
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/flows/{id}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get authentication flow for id
      parameters:
      - name: id
        in: path
        description: Flow id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFlowRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationFlowsById
      x-operation-id-source: derived
    put:
      tags:
      - Authentication Management
      summary: Update an authentication flow
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationFlowRepresentation'
      responses:
        '204':
          description: No Content
        '409':
          description: Conflict
      operationId: putAdminRealmsByRealmAuthenticationFlowsById
      x-operation-id-source: derived
    delete:
      tags:
      - Authentication Management
      summary: Delete an authentication flow
      parameters:
      - name: id
        in: path
        description: Flow id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmAuthenticationFlowsById
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/form-action-providers:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get form action providers Returns a stream of form action providers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: {}
      operationId: getAdminRealmsByRealmAuthenticationFormActionProviders
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/form-providers:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get form providers Returns a stream of form providers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: {}
      operationId: getAdminRealmsByRealmAuthenticationFormProviders
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/per-client-config-description:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get configuration descriptions for all clients
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    $ref: '#/components/schemas/ConfigPropertyRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationPerClientConfigDescription
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/register-required-action:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Register a new required actions
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: string
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmAuthenticationRegisterRequiredAction
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/required-actions:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get required actions Returns a stream of required actions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RequiredActionProviderRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationRequiredActions
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/required-actions/{alias}:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get required action for alias
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequiredActionProviderRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationRequiredActionsByAlias
      x-operation-id-source: derived
    put:
      tags:
      - Authentication Management
      summary: Update required action
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequiredActionProviderRepresentation'
      responses:
        '204':
          description: No Content
      operationId: putAdminRealmsByRealmAuthenticationRequiredActionsByAlias
      x-operation-id-source: derived
    delete:
      tags:
      - Authentication Management
      summary: Delete required action
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmAuthenticationRequiredActionsByAlias
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/required-actions/{alias}/config:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get RequiredAction configuration
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequiredActionConfigRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationRequiredActionsByAliasConfig
      x-operation-id-source: derived
    put:
      tags:
      - Authentication Management
      summary: Update RequiredAction configuration
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequiredActionConfigRepresentation'
      responses:
        '204':
          description: No Content
      operationId: putAdminRealmsByRealmAuthenticationRequiredActionsByAliasConfig
      x-operation-id-source: derived
    delete:
      tags:
      - Authentication Management
      summary: Delete RequiredAction configuration
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteAdminRealmsByRealmAuthenticationRequiredActionsByAliasConfig
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/required-actions/{alias}/config-description:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get RequiredAction provider configuration description
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequiredActionConfigInfoRepresentation'
      operationId: getAdminRealmsByRealmAuthenticationRequiredActionsByAliasConfigDescription
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/required-actions/{alias}/lower-priority:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Lower required action's priority
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmAuthenticationRequiredActionsByAliasLowerPriority
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/required-actions/{alias}/raise-priority:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication Management
      summary: Raise required action's priority
      parameters:
      - name: alias
        in: path
        description: Alias of required action
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: postAdminRealmsByRealmAuthenticationRequiredActionsByAliasRaisePriority
      x-operation-id-source: derived
  /admin/realms/{realm}/authentication/unregistered-required-actions:
    parameters:
    - name: realm
      in: path
      description: realm name (not id!)
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication Management
      summary: Get unregistered required actions Returns a stream of unregistered required…
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties:
                    type: string
      operationId: getAdminRealmsByRealmAuthenticationUnregisteredRequiredActions
      x-operation-id-source: derived
components:
  schemas:
    AuthenticationFlowRepresentation:
      type: object
      properties:
        id:
          type: string
        alias:
          type: string
        description:
          type: string
        providerId:
          type: string
        topLevel:
          type: boolean
        builtIn:
          type: boolean
        authenticationExecutions:
          type: array
          items:
            $ref: '#/components/schemas/AuthenticationExecutionExportRepresentation'
    AuthenticationExecutionInfoRepresentation:
      type: object
      properties:
        id:
          type: string
        requirement:
          type: string
        displayName:
          type: string
        alias:
          type: string
        description:
          type: string
        requirementChoices:
          type: array
          items:
            type: string
        configurable:
          type: boolean
        authenticationFlow:
          type: boolean
        providerId:
          type: string
        authenticationConfig:
          type: string
        flowId:
          type: string
        level:
          format: int32
          type: integer
        index:
          format: int32
          type: integer
        priority:
          format: int32
          type: integer
    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
    AuthenticationExecutionExportRepresentation:
      type: object
      properties:
        authenticatorConfig:
          type: string
        authenticator:
          type: string
        authenticatorFlow:
          type: boolean
        requirement:
          type: string
        priority:
          format: int32
          type: integer
        autheticatorFlow:
          type: boolean
          deprecated: true
        flowAlias:
          type: string
        userSetupAllowed:
          type: boolean
    RequiredActionConfigRepresentation:
      type: object
      properties:
        config:
          type: object
          additionalProperties:
            type: string
    RequiredActionProviderRepresentation:
      type: object
      properties:
        alias:
          type: string
        name:
          type: string
        providerId:
          type: string
        enabled:
          type: boolean
        defaultAction:
          type: boolean
        priority:
          format: int32
          type: integer
        config:
          type: object
          additionalProperties:
            type: string
    AuthenticatorConfigInfoRepresentation:
      type: object
      properties:
        name:
          type: string
        providerId:
          type: string
        helpText:
          type: string
        properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigPropertyRepresentation'
    AuthenticatorConfigRepresentation:
      type: object
      properties:
        id:
          type: string
        alias:
          type: string
        config:
          type: object
          additionalProperties:
            type: string
    AuthenticationExecutionRepresentation:
      type: object
      properties:
        authenticatorConfig:
          type: string
        authenticator:
          type: string
        authenticatorFlow:
          type: boolean
        requirement:
          type: string
        priority:
          format: int32
          type: integer
        autheticatorFlow:
          type: boolean
          deprecated: true
        id:
          type: string
        flowId:
          type: string
        parentFlow:
          type: string
    RequiredActionConfigInfoRepresentation:
      type: object
      properties:
        properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigPropertyRepresentation'