23.0.4.yml

openapi: 3.0.2
info:
  title: Keycloak Admin REST API
  description: This is a REST API reference for the Keycloak Admin REST API.
  contact:
    url: https://www.keycloak.org/documentation
  version: "1.0"
servers:
  - url: https://keycloak.example.com/admin/realms
paths:
  /:
    get:
      tags:
        - Realms Admin
      description: Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.
      operationId: get
      parameters:
        - in: query
          name: briefRepresentation
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RealmRepresentation'
    post:
      tags:
        - Realms Admin
      description: Import a realm. Imports a realm from a full representation of that realm.
      operationId: post
      requestBody:
        description: '[file]'
        content:
          application/json:
            schema:
              type: string
              format: binary
      responses:
        "200":
          description: OK
  /{realm}:
    get:
      tags:
        - Realms Admin
      description: Get the top-level representation of the realm It will not include nested information like User and Client representations.
      operationId: getByRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmRepresentation'
    put:
      tags:
        - Realms Admin
      description: Update the top-level information of the realm Any user, roles or client information in the representation will be ignored.
      operationId: putByRealm
      requestBody:
        description: RealmRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Realms Admin
      description: Delete the realm
      operationId: deleteByRealm
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/admin-events:
    get:
      tags:
        - Realms Admin
      description: Get admin events Returns all admin events, or filters events based on URL query parameters listed here
      operationId: getAdminEvents
      parameters:
        - in: query
          name: authClient
          schema:
            type: string
          style: form
        - in: query
          name: authIpAddress
          schema:
            type: string
          style: form
        - in: query
          name: authRealm
          schema:
            type: string
          style: form
        - in: query
          name: authUser
          description: user id
          schema:
            type: string
          style: form
        - in: query
          name: dateFrom
          schema:
            type: string
          style: form
        - in: query
          name: dateTo
          schema:
            type: string
          style: form
        - in: query
          name: first
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: Maximum results size (defaults to 100)
          schema:
            type: string
          style: form
        - in: query
          name: operationTypes
          description: '[String]'
          schema:
            type: string
          style: form
        - in: query
          name: resourcePath
          schema:
            type: string
          style: form
        - in: query
          name: resourceTypes
          description: '[String]'
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminEventRepresentation'
    delete:
      tags:
        - Realms Admin
      description: Delete all admin events
      operationId: deleteAdminEvents
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/attack-detection/brute-force/users:
    delete:
      tags:
        - Attack Detection
      description: Clear any user login failures for all users This can release temporary disabled users
      operationId: deleteUsers
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/attack-detection/brute-force/users/{userId}:
    get:
      tags:
        - Attack Detection
      description: Get status of a username in brute force detection
      operationId: getBruteForceUser
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
    delete:
      tags:
        - Attack Detection
      description: Clear any user login failures for the user This can release temporary disabled user
      operationId: deleteBruteForceUser
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: userId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/authenticator-providers:
    get:
      tags:
        - Authentication Management
      description: Get authenticator providers Returns a stream of authenticator providers.
      operationId: getAuthenticatorProviders
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/client-authenticator-providers:
    get:
      tags:
        - Authentication Management
      description: Get client authenticator providers Returns a stream of client authenticator providers.
      operationId: getClientAuthenticatorProviders
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/config:
    post:
      tags:
        - Authentication Management
      description: Create new authenticator configuration
      operationId: postAuthenticationConfig
      requestBody:
        description: AuthenticatorConfigRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/config-description/{providerId}:
    get:
      tags:
        - Authentication Management
      description: Get authenticator provider’s configuration description
      operationId: getConfigDescription
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticatorConfigInfoRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: providerId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/config/{id}:
    get:
      tags:
        - Authentication Management
      description: Get authenticator configuration
      operationId: getAuthenticationConfig
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
    put:
      tags:
        - Authentication Management
      description: Update authenticator configuration
      operationId: putAuthenticationConfig
      requestBody:
        description: AuthenticatorConfigRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Authentication Management
      description: Delete authenticator configuration
      operationId: deleteConfig
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        description: Configuration id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/executions:
    post:
      tags:
        - Authentication Management
      description: Add new authentication execution
      operationId: postExecutions
      requestBody:
        description: AuthenticationExecutionRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationExecutionRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/executions/{executionId}:
    get:
      tags:
        - Authentication Management
      description: Get Single Execution
      operationId: getExecution
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Authentication Management
      description: Delete execution
      operationId: deleteExecution
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: executionId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/executions/{executionId}/config:
    post:
      tags:
        - Authentication Management
      description: Update execution with new configuration
      operationId: postExecutionConfig
      requestBody:
        description: AuthenticatorConfigRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: executionId
        description: Execution id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/executions/{executionId}/config/{id}:
    get:
      tags:
        - Authentication Management
      description: Get execution’s configuration
      operationId: getExecutionConfig
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: executionId
        description: Execution id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        description: Configuration id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/executions/{executionId}/lower-priority:
    post:
      tags:
        - Authentication Management
      description: Lower execution’s priority
      operationId: postExecutionLowerPriority
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: executionId
        description: Execution id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/executions/{executionId}/raise-priority:
    post:
      tags:
        - Authentication Management
      description: Raise execution’s priority
      operationId: postExecutionRaisePriority
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: executionId
        description: Execution id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/flows:
    get:
      tags:
        - Authentication Management
      description: Get authentication flows Returns a stream of authentication flows.
      operationId: getFlows
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuthenticationFlowRepresentation'
    post:
      tags:
        - Authentication Management
      description: Create a new authentication flow
      operationId: postFlows
      requestBody:
        description: AuthenticationFlowRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationFlowRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/flows/{flowAlias}/copy:
    post:
      tags:
        - Authentication Management
      description: Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object
      operationId: postCopy
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: flowAlias
        description: name of the existing authentication flow
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/flows/{flowAlias}/executions:
    get:
      tags:
        - Authentication Management
      description: Get authentication executions for a flow
      operationId: getExecutions
      responses:
        "200":
          description: OK
    put:
      tags:
        - Authentication Management
      description: Update authentication executions of a Flow
      operationId: putExecutions
      requestBody:
        description: AuthenticationExecutionInfoRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationExecutionInfoRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: flowAlias
        description: Flow alias
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/flows/{flowAlias}/executions/execution:
    post:
      tags:
        - Authentication Management
      description: Add new authentication execution to a flow
      operationId: postExecution
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: flowAlias
        description: Alias of parent flow
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/flows/{flowAlias}/executions/flow:
    post:
      tags:
        - Authentication Management
      description: Add new flow with new execution to existing flow
      operationId: postFlow
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: flowAlias
        description: Alias of parent authentication flow
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/flows/{id}:
    get:
      tags:
        - Authentication Management
      description: Get authentication flow for id
      operationId: getFlow
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFlowRepresentation'
    put:
      tags:
        - Authentication Management
      description: Update an authentication flow
      operationId: putFlow
      requestBody:
        description: AuthenticationFlowRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationFlowRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Authentication Management
      description: Delete an authentication flow
      operationId: deleteFlow
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/form-action-providers:
    get:
      tags:
        - Authentication Management
      description: Get form action providers Returns a stream of form action providers.
      operationId: getFormActionProviders
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/form-providers:
    get:
      tags:
        - Authentication Management
      description: Get form providers Returns a stream of form providers.
      operationId: getFormProviders
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/per-client-config-description:
    get:
      tags:
        - Authentication Management
      description: Get configuration descriptions for all clients
      operationId: getPerClientConfigDescription
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/ConfigPropertyRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/register-required-action:
    post:
      tags:
        - Authentication Management
      description: Register a new required actions
      operationId: postRegisterRequiredAction
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/required-actions:
    get:
      tags:
        - Authentication Management
      description: Get required actions Returns a stream of required actions.
      operationId: getRequiredActions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RequiredActionProviderRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/required-actions/{alias}:
    get:
      tags:
        - Authentication Management
      description: Get required action for alias
      operationId: getRequiredAction
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequiredActionProviderRepresentation'
    put:
      tags:
        - Authentication Management
      description: Update required action
      operationId: putRequiredAction
      requestBody:
        description: RequiredActionProviderRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequiredActionProviderRepresentation'
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Authentication Management
      description: Delete required action
      operationId: deleteRequiredAction
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        description: Alias of required action
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/required-actions/{alias}/lower-priority:
    post:
      tags:
        - Authentication Management
      description: Lower required action’s priority
      operationId: postRequiredActionLowerPriority
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        description: Alias of required action
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/required-actions/{alias}/raise-priority:
    post:
      tags:
        - Authentication Management
      description: Raise required action’s priority
      operationId: postRequiredActionRaisePriority
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        description: Alias of required action
        required: true
        schema:
          type: string
        style: simple
  /{realm}/authentication/unregistered-required-actions:
    get:
      tags:
        - Authentication Management
      description: Get unregistered required actions Returns a stream of unregistered required actions.
      operationId: getUnregisteredRequiredActions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-description-converter:
    post:
      tags:
        - Realms Admin
      description: Base path for importing clients under this realm.
      operationId: postClientDescriptionConverter
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-policies/policies:
    get:
      tags:
        - Realms Admin
      operationId: getPolicies
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientPoliciesRepresentation'
    put:
      tags:
        - Realms Admin
      operationId: putPolicies
      requestBody:
        description: ClientPoliciesRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientPoliciesRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-policies/profiles:
    get:
      tags:
        - Realms Admin
      operationId: getProfiles
      parameters:
        - in: query
          name: include-global-profiles
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientProfilesRepresentation'
    put:
      tags:
        - Realms Admin
      operationId: putProfiles
      requestBody:
        description: ClientProfilesRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientProfilesRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-registration-policy/providers:
    get:
      tags:
        - Client Registration Policy
      description: Base path for retrieve providers with the configProperties properly filled
      operationId: getProviders
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentTypeRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes:
    get:
      tags:
        - Client Scopes
      description: Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm
      operationId: getClientScopes
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientScopeRepresentation'
    post:
      tags:
        - Client Scopes
      description: Create a new client scope Client Scope’s name must be unique!
      operationId: postClientScopes
      requestBody:
        description: ClientScopeRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientScopeRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}:
    get:
      tags:
        - Protocol Mappers
      description: Get mapper by id
      operationId: getClientScopeProtocolMappersModel
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
    put:
      tags:
        - Protocol Mappers
      description: Update the mapper
      operationId: putClientScopeProtocolMappersModel
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Protocol Mappers
      description: Delete the mapper
      operationId: deleteClientScopeProtocolMappersModel
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id1
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id2
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}:
    get:
      tags:
        - Client Scopes
      description: Get representation of the client scope
      operationId: getClientScope
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientScopeRepresentation'
    put:
      tags:
        - Client Scopes
      description: Update the client scope
      operationId: putClientScope
      requestBody:
        description: ClientScopeRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientScopeRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Client Scopes
      description: Delete the client scope
      operationId: deleteClientScope
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/protocol-mappers/add-models:
    post:
      tags:
        - Protocol Mappers
      description: Create multiple mappers
      operationId: postClientScopeProtocolMappersAddModels
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/protocol-mappers/models:
    get:
      tags:
        - Protocol Mappers
      description: Get mappers
      operationId: getClientScopeProtocolMappersModels
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
    post:
      tags:
        - Protocol Mappers
      description: Create a mapper
      operationId: postClientScopeProtocolMappersModels
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}:
    get:
      tags:
        - Protocol Mappers
      description: Get mappers by name for a specific protocol
      operationId: getClientScopeProtocolMappersProtocol
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: protocol
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/scope-mappings:
    get:
      tags:
        - Scope Mappings
      description: Get all scope mappings for the client
      operationId: getClientScopeScopeMappings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingsRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/scope-mappings/clients/{client}:
    get:
      tags:
        - Scope Mappings
      description: Get the roles associated with a client’s scope Returns roles for the client.
      operationId: getClientScopeScopeMappingsClient
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Scope Mappings
      description: Add client-level roles to the client’s scope
      operationId: postClientScopeScopeMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Scope Mappings
      description: Remove client-level roles from the client’s scope.
      operationId: deleteClientScopeScopeMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available:
    get:
      tags:
        - Scope Mappings
      description: The available client-level roles Returns the roles for the client that can be associated with the client’s scope
      operationId: getClientScopeScopeMappingsClientAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/scope-mappings/clients/{client}/composite:
    get:
      tags:
        - Scope Mappings
      description: Get effective client roles Returns the roles for the client that are associated with the client’s scope.
      operationId: getClientScopeScopeMappingsClientComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/scope-mappings/realm:
    get:
      tags:
        - Scope Mappings
      description: Get realm-level roles associated with the client’s scope
      operationId: getClientScopeScopeMappingsRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Scope Mappings
      description: Add a set of realm-level roles to the client’s scope
      operationId: postClientScopeScopeMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Scope Mappings
      description: Remove a set of realm-level roles from the client’s scope
      operationId: deleteClientScopeScopeMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/scope-mappings/realm/available:
    get:
      tags:
        - Scope Mappings
      description: Get realm-level roles that are available to attach to this client’s scope
      operationId: getClientScopeScopeMappingsRealmAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-scopes/{id}/scope-mappings/realm/composite:
    get:
      tags:
        - Scope Mappings
      description: Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.
      operationId: getClientScopeScopeMappingsRealmComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-session-stats:
    get:
      tags:
        - Realms Admin
      description: Get client session stats Returns a JSON map.
      operationId: getClientSessionStats
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates:
    get:
      tags:
        - Client Scopes
      description: Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm
      operationId: getClientTemplates
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientScopeRepresentation'
    post:
      tags:
        - Client Scopes
      description: Create a new client scope Client Scope’s name must be unique!
      operationId: postClientTemplates
      requestBody:
        description: ClientScopeRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientScopeRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id1}/protocol-mappers/models/{id2}:
    get:
      tags:
        - Protocol Mappers
      description: Get mapper by id
      operationId: getClientTemplateProtocolMappersModel
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
    put:
      tags:
        - Protocol Mappers
      description: Update the mapper
      operationId: putClientTemplateProtocolMappersModel
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Protocol Mappers
      description: Delete the mapper
      operationId: deleteClientTemplateProtocolMappersModel
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id1
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id2
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}:
    get:
      tags:
        - Client Scopes
      description: Get representation of the client scope
      operationId: getClientTemplate
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientScopeRepresentation'
    put:
      tags:
        - Client Scopes
      description: Update the client scope
      operationId: putClientTemplate
      requestBody:
        description: ClientScopeRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientScopeRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Client Scopes
      description: Delete the client scope
      operationId: deleteClientTemplate
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/protocol-mappers/add-models:
    post:
      tags:
        - Protocol Mappers
      description: Create multiple mappers
      operationId: postClientTemplateProtocolMappersAddModels
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/protocol-mappers/models:
    get:
      tags:
        - Protocol Mappers
      description: Get mappers
      operationId: getClientTemplateProtocolMappersModels
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
    post:
      tags:
        - Protocol Mappers
      description: Create a mapper
      operationId: postClientTemplateProtocolMappersModels
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/protocol-mappers/protocol/{protocol}:
    get:
      tags:
        - Protocol Mappers
      description: Get mappers by name for a specific protocol
      operationId: getClientTemplateProtocolMappersProtocol
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: protocol
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/scope-mappings:
    get:
      tags:
        - Scope Mappings
      description: Get all scope mappings for the client
      operationId: getClientTemplateScopeMappings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingsRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/scope-mappings/clients/{client}:
    get:
      tags:
        - Scope Mappings
      description: Get the roles associated with a client’s scope Returns roles for the client.
      operationId: getClientTemplateScopeMappingsClient
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Scope Mappings
      description: Add client-level roles to the client’s scope
      operationId: postClientTemplateScopeMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Scope Mappings
      description: Remove client-level roles from the client’s scope.
      operationId: deleteClientTemplateScopeMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/scope-mappings/clients/{client}/available:
    get:
      tags:
        - Scope Mappings
      description: The available client-level roles Returns the roles for the client that can be associated with the client’s scope
      operationId: getClientTemplateScopeMappingsClientAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/scope-mappings/clients/{client}/composite:
    get:
      tags:
        - Scope Mappings
      description: Get effective client roles Returns the roles for the client that are associated with the client’s scope.
      operationId: getClientTemplateScopeMappingsClientComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/scope-mappings/realm:
    get:
      tags:
        - Scope Mappings
      description: Get realm-level roles associated with the client’s scope
      operationId: getClientTemplateScopeMappingsRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Scope Mappings
      description: Add a set of realm-level roles to the client’s scope
      operationId: postClientTemplateScopeMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Scope Mappings
      description: Remove a set of realm-level roles from the client’s scope
      operationId: deleteClientTemplateScopeMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/scope-mappings/realm/available:
    get:
      tags:
        - Scope Mappings
      description: Get realm-level roles that are available to attach to this client’s scope
      operationId: getClientTemplateScopeMappingsRealmAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/client-templates/{id}/scope-mappings/realm/composite:
    get:
      tags:
        - Scope Mappings
      description: Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.
      operationId: getClientTemplateScopeMappingsRealmComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients:
    get:
      tags:
        - Clients
      description: Get clients belonging to the realm.
      operationId: getClients
      parameters:
        - in: query
          name: clientId
          description: filter by clientId
          schema:
            type: string
          style: form
        - in: query
          name: first
          description: the first result
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: the max results to return
          schema:
            type: string
          style: form
        - in: query
          name: q
          schema:
            type: string
          style: form
        - in: query
          name: search
          description: whether this is a search query or a getClientById query
          schema:
            type: string
          style: form
        - in: query
          name: viewableOnly
          description: filter clients that cannot be viewed in full by admin
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientRepresentation'
    post:
      tags:
        - Clients
      description: Create a new client Client’s client_id must be unique!
      operationId: postClients
      requestBody:
        description: ClientRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients-initial-access:
    get:
      tags:
        - Client Initial Access
      operationId: getClientsInitialAccess
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientInitialAccessPresentation'
    post:
      tags:
        - Client Initial Access
      description: Create a new initial access token.
      operationId: postClientsInitialAccess
      requestBody:
        description: ClientInitialAccessCreatePresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientInitialAccessCreatePresentation'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientInitialAccessPresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients-initial-access/{id}:
    delete:
      tags:
        - Client Initial Access
      operationId: deleteClientsInitialAcces
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id1}/protocol-mappers/models/{id2}:
    get:
      tags:
        - Protocol Mappers
      description: Get mapper by id
      operationId: getClientProtocolMappersModel
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtocolMapperRepresentation'
    put:
      tags:
        - Protocol Mappers
      description: Update the mapper
      operationId: putClientProtocolMappersModel
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Protocol Mappers
      description: Delete the mapper
      operationId: deleteClientProtocolMappersModel
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id1
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id2
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}:
    get:
      tags:
        - Clients
      description: Get representation of the client
      operationId: getClientByRealmById
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientRepresentation'
    put:
      tags:
        - Clients
      description: Update the client
      operationId: putClient
      requestBody:
        description: ClientRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Clients
      description: Delete the client
      operationId: deleteClientByRealmById
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/certificates/{attr}:
    get:
      tags:
        - Client Attribute Certificate
      description: Get key info
      operationId: getCertificate
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: attr
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/certificates/{attr}/download:
    post:
      tags:
        - Client Attribute Certificate
      description: Get a keystore file for the client, containing private key and public certificate
      operationId: postDownload
      requestBody:
        description: KeyStoreConfig
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyStoreConfig'
      responses:
        "200":
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: attr
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/certificates/{attr}/generate:
    post:
      tags:
        - Client Attribute Certificate
      description: Generate a new certificate with new key pair
      operationId: postGenerate
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: attr
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/certificates/{attr}/generate-and-download:
    post:
      tags:
        - Client Attribute Certificate
      description: Generate a new keypair and certificate, and get the private key file  Generates a keypair and certificate and serves the private key in a specified keystore format. Only generated public certificate is saved in Keycloak DB - the private key is not.
      operationId: postGenerateAndDownload
      requestBody:
        description: KeyStoreConfig
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyStoreConfig'
      responses:
        "200":
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: attr
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/certificates/{attr}/upload:
    post:
      tags:
        - Client Attribute Certificate
      description: Upload certificate and eventually private key
      operationId: postUpload
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: attr
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/certificates/{attr}/upload-certificate:
    post:
      tags:
        - Client Attribute Certificate
      description: Upload only certificate, not private key
      operationId: postUploadCertificate
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: attr
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/client-secret:
    get:
      tags:
        - Clients
      description: Get the client secret
      operationId: getClientSecret
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialRepresentation'
    post:
      tags:
        - Clients
      description: Generate a new secret for the client
      operationId: postClientSecret
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/client-secret/rotated:
    get:
      tags:
        - Clients
      description: Get the rotated client secret
      operationId: getRotated
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialRepresentation'
    delete:
      tags:
        - Clients
      description: Invalidate the rotated secret for the client
      operationId: deleteRotated
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/default-client-scopes:
    get:
      tags:
        - Clients
      description: Get default client scopes.  Only name and ids are returned.
      operationId: getDefaultClientScopes
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientScopeRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/default-client-scopes/{clientScopeId}:
    put:
      tags:
        - Clients
      operationId: putDefaultClientScope
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Clients
      operationId: deleteDefaultClientScope
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientScopeId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/evaluate-scopes/generate-example-access-token:
    get:
      tags:
        - Clients
      description: Create JSON with payload of example access token
      operationId: getGenerateExampleAccessToken
      parameters:
        - in: query
          name: scope
          schema:
            type: string
          style: form
        - in: query
          name: userId
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessToken'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/evaluate-scopes/generate-example-id-token:
    get:
      tags:
        - Clients
      description: Create JSON with payload of example id token
      operationId: getGenerateExampleIdToken
      parameters:
        - in: query
          name: scope
          schema:
            type: string
          style: form
        - in: query
          name: userId
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IDToken'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/evaluate-scopes/generate-example-userinfo:
    get:
      tags:
        - Clients
      description: Create JSON with payload of example user info
      operationId: getGenerateExampleUserinfo
      parameters:
        - in: query
          name: scope
          schema:
            type: string
          style: form
        - in: query
          name: userId
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/evaluate-scopes/protocol-mappers:
    get:
      tags:
        - Clients
      description: Return list of all protocol mappers, which will be used when generating tokens issued for particular client.
      operationId: getProtocolMappers
      parameters:
        - in: query
          name: scope
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperEvaluationRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted:
    get:
      tags:
        - Clients
      description: Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.
      operationId: getGranted
      parameters:
        - in: query
          name: scope
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: roleContainerId
        description: either realm name OR client UUID
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted:
    get:
      tags:
        - Clients
      description: Get roles, which this client doesn’t have scope for and can’t have them in the accessToken issued for him.
      operationId: getNotGranted
      parameters:
        - in: query
          name: scope
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: roleContainerId
        description: either realm name OR client UUID
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/installation/providers/{providerId}:
    get:
      tags:
        - Clients
      operationId: getInstallationProvider
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: providerId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/management/permissions:
    get:
      tags:
        - Clients
      description: Return object stating whether client Authorization permissions have been initialized or not and a reference
      operationId: getClientManagementPermissions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    put:
      tags:
        - Clients
      description: Return object stating whether client Authorization permissions have been initialized or not and a reference
      operationId: putClientManagementPermissions
      requestBody:
        description: ManagementPermissionReference
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementPermissionReference'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/nodes:
    post:
      tags:
        - Clients
      description: Register a cluster node with the client Manually register cluster node to this client - usually it’s not needed to call this directly as adapter should handle by sending registration request to Keycloak
      operationId: postNodes
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/nodes/{node}:
    delete:
      tags:
        - Clients
      description: Unregister a cluster node from the client
      operationId: deleteNode
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: node
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/offline-session-count:
    get:
      tags:
        - Clients
      description: 'Get application offline session count Returns a number of offline user sessions associated with this client { \"count\": number }'
      operationId: getOfflineSessionCount
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int64
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/offline-sessions:
    get:
      tags:
        - Clients
      description: Get offline sessions for client Returns a list of offline user sessions associated with this client
      operationId: getOfflineSessions
      parameters:
        - in: query
          name: first
          description: Paging offset
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: Maximum results size (defaults to 100)
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserSessionRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/optional-client-scopes:
    get:
      tags:
        - Clients
      description: Get optional client scopes.  Only name and ids are returned.
      operationId: getOptionalClientScopes
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientScopeRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/optional-client-scopes/{clientScopeId}:
    put:
      tags:
        - Clients
      operationId: putOptionalClientScope
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Clients
      operationId: deleteOptionalClientScope
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientScopeId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/protocol-mappers/add-models:
    post:
      tags:
        - Protocol Mappers
      description: Create multiple mappers
      operationId: postClientProtocolMappersAddModels
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/protocol-mappers/models:
    get:
      tags:
        - Protocol Mappers
      description: Get mappers
      operationId: getClientProtocolMappersModels
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
    post:
      tags:
        - Protocol Mappers
      description: Create a mapper
      operationId: postClientProtocolMappersModels
      requestBody:
        description: ProtocolMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProtocolMapperRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/protocol-mappers/protocol/{protocol}:
    get:
      tags:
        - Protocol Mappers
      description: Get mappers by name for a specific protocol
      operationId: getClientProtocolMappersProtocol
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProtocolMapperRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: protocol
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/push-revocation:
    post:
      tags:
        - Clients
      description: Push the client’s revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.
      operationId: postClientPushRevocation
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalRequestResult'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/registration-access-token:
    post:
      tags:
        - Clients
      description: Generate a new registration access token for the client
      operationId: postRegistrationAccessToken
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles:
    get:
      tags:
        - Roles
      description: Get all roles for the realm or client
      operationId: getClientRoles
      parameters:
        - in: query
          name: briefRepresentation
          schema:
            type: string
          style: form
        - in: query
          name: first
          schema:
            type: string
          style: form
        - in: query
          name: max
          schema:
            type: string
          style: form
        - in: query
          name: search
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Roles
      description: Create a new role for the realm or client
      operationId: postClientRoles
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles/{role-name}:
    get:
      tags:
        - Roles
      description: Get a role by name
      operationId: getClientRole
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleRepresentation'
    put:
      tags:
        - Roles
      description: Update a role by name
      operationId: putClientRole
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Roles
      description: Delete a role by name
      operationId: deleteClientRole
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles/{role-name}/composites:
    get:
      tags:
        - Roles
      description: Get composites of the role
      operationId: getClientRoleComposites
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Roles
      description: Add a composite to the role
      operationId: postClientRoleComposites
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Roles
      description: Remove roles from the role’s composite
      operationId: deleteClientRoleComposites
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles/{role-name}/composites/clients/{clientUuid}:
    get:
      tags:
        - Roles
      description: Get client-level roles for the client that are in the role’s composite
      operationId: getClientRoleCompositesClient
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientUuid
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles/{role-name}/composites/realm:
    get:
      tags:
        - Roles
      description: Get realm-level roles of the role’s composite
      operationId: getClientRoleCompositesRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles/{role-name}/groups:
    get:
      tags:
        - Roles
      description: Returns a stream of groups that have the specified role name
      operationId: getClientRoleGroups
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return a full representation of the {@code GroupRepresentation} objects.
          schema:
            type: string
          style: form
        - in: query
          name: first
          description: first result to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: maximum number of results to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: the role name.
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles/{role-name}/management/permissions:
    get:
      tags:
        - Roles
      description: Return object stating whether role Authorization permissions have been initialized or not and a reference
      operationId: getClientRoleManagementPermissions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    put:
      tags:
        - Roles
      description: Return object stating whether role Authorization permissions have been initialized or not and a reference
      operationId: putClientRoleManagementPermissions
      requestBody:
        description: ManagementPermissionReference
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementPermissionReference'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/roles/{role-name}/users:
    get:
      tags:
        - Roles
      description: Returns a stream of users that have the specified role name.
      operationId: getClientRoleUsers
      parameters:
        - in: query
          name: first
          description: first result to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: maximum number of results to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: the role name.
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/scope-mappings:
    get:
      tags:
        - Scope Mappings
      description: Get all scope mappings for the client
      operationId: getClientScopeMappings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingsRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/scope-mappings/clients/{client}:
    get:
      tags:
        - Scope Mappings
      description: Get the roles associated with a client’s scope Returns roles for the client.
      operationId: getClientScopeMappingsClient
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Scope Mappings
      description: Add client-level roles to the client’s scope
      operationId: postClientScopeMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Scope Mappings
      description: Remove client-level roles from the client’s scope.
      operationId: deleteClientScopeMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/scope-mappings/clients/{client}/available:
    get:
      tags:
        - Scope Mappings
      description: The available client-level roles Returns the roles for the client that can be associated with the client’s scope
      operationId: getClientScopeMappingsClientAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/scope-mappings/clients/{client}/composite:
    get:
      tags:
        - Scope Mappings
      description: Get effective client roles Returns the roles for the client that are associated with the client’s scope.
      operationId: getClientScopeMappingsClientComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/scope-mappings/realm:
    get:
      tags:
        - Scope Mappings
      description: Get realm-level roles associated with the client’s scope
      operationId: getClientScopeMappingsRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Scope Mappings
      description: Add a set of realm-level roles to the client’s scope
      operationId: postClientScopeMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Scope Mappings
      description: Remove a set of realm-level roles from the client’s scope
      operationId: deleteClientScopeMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/scope-mappings/realm/available:
    get:
      tags:
        - Scope Mappings
      description: Get realm-level roles that are available to attach to this client’s scope
      operationId: getClientScopeMappingsRealmAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/scope-mappings/realm/composite:
    get:
      tags:
        - Scope Mappings
      description: Get effective realm-level roles associated with the client’s scope What this does is recurse any composite roles associated with the client’s scope and adds the roles to this lists.
      operationId: getClientScopeMappingsRealmComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/service-account-user:
    get:
      tags:
        - Clients
      description: Get a user dedicated to the service account
      operationId: getServiceAccountUser
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/session-count:
    get:
      tags:
        - Clients
      description: 'Get application session count Returns a number of user sessions associated with this client { \"count\": number }'
      operationId: getSessionCount
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int64
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/test-nodes-available:
    get:
      tags:
        - Clients
      description: Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.
      operationId: getTestNodesAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalRequestResult'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/clients/{id}/user-sessions:
    get:
      tags:
        - Clients
      description: Get user sessions for client Returns a list of user sessions associated with this client
      operationId: getClientUserSessions
      parameters:
        - in: query
          name: first
          description: Paging offset
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: Maximum results size (defaults to 100)
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserSessionRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/components:
    get:
      tags:
        - Component
      operationId: getComponents
      parameters:
        - in: query
          name: name
          schema:
            type: string
          style: form
        - in: query
          name: parent
          schema:
            type: string
          style: form
        - in: query
          name: type
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentRepresentation'
    post:
      tags:
        - Component
      operationId: postComponents
      requestBody:
        description: ComponentRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/components/{id}:
    get:
      tags:
        - Component
      operationId: getComponent
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentRepresentation'
    put:
      tags:
        - Component
      operationId: putComponent
      requestBody:
        description: ComponentRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Component
      operationId: deleteComponent
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/components/{id}/sub-component-types:
    get:
      tags:
        - Component
      description: List of subcomponent types that are available to configure for a particular parent component.
      operationId: getSubComponentTypes
      parameters:
        - in: query
          name: type
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentTypeRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/credential-registrators:
    get:
      tags:
        - Realms Admin
      operationId: getCredentialRegistrators
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/default-default-client-scopes:
    get:
      tags:
        - Realms Admin
      description: Get realm default client scopes.  Only name and ids are returned.
      operationId: getDefaultDefaultClientScopes
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientScopeRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/default-default-client-scopes/{clientScopeId}:
    put:
      tags:
        - Realms Admin
      operationId: putDefaultDefaultClientScope
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Realms Admin
      operationId: deleteDefaultDefaultClientScope
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientScopeId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/default-groups:
    get:
      tags:
        - Realms Admin
      description: Get group hierarchy.  Only name and ids are returned.
      operationId: getDefaultGroups
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/default-groups/{groupId}:
    put:
      tags:
        - Realms Admin
      operationId: putDefaultGroup
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Realms Admin
      operationId: deleteDefaultGroup
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: groupId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/default-optional-client-scopes:
    get:
      tags:
        - Realms Admin
      description: Get realm optional client scopes.  Only name and ids are returned.
      operationId: getDefaultOptionalClientScopes
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientScopeRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/default-optional-client-scopes/{clientScopeId}:
    put:
      tags:
        - Realms Admin
      operationId: putDefaultOptionalClientScope
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Realms Admin
      operationId: deleteDefaultOptionalClientScope
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientScopeId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/events:
    get:
      tags:
        - Realms Admin
      description: Get events Returns all events, or filters them based on URL query parameters listed here
      operationId: getEvents
      parameters:
        - in: query
          name: client
          description: App or oauth client name
          schema:
            type: string
          style: form
        - in: query
          name: dateFrom
          description: From date
          schema:
            type: string
          style: form
        - in: query
          name: dateTo
          description: To date
          schema:
            type: string
          style: form
        - in: query
          name: first
          description: Paging offset
          schema:
            type: string
          style: form
        - in: query
          name: ipAddress
          description: IP Address
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: Maximum results size (defaults to 100)
          schema:
            type: string
          style: form
        - in: query
          name: type
          description: The types of events to return [String]
          schema:
            type: string
          style: form
        - in: query
          name: user
          description: User id
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventRepresentation'
    delete:
      tags:
        - Realms Admin
      description: Delete all events
      operationId: deleteEvents
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/events/config:
    get:
      tags:
        - Realms Admin
      description: Get the events provider configuration Returns JSON object with events provider configuration
      operationId: getEventsConfig
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmEventsConfigRepresentation'
    put:
      tags:
        - Realms Admin
      operationId: putEventsConfig
      requestBody:
        description: RealmEventsConfigRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmEventsConfigRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/group-by-path/{path}:
    get:
      tags:
        - Realms Admin
      operationId: getGroupByPath
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: path
        description: PathSegment
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups:
    get:
      tags:
        - Groups
      description: Get group hierarchy.  Only name and ids are returned.
      operationId: getGroupsByRealm
      parameters:
        - in: query
          name: briefRepresentation
          schema:
            type: string
          style: form
        - in: query
          name: exact
          schema:
            type: string
          style: form
        - in: query
          name: first
          schema:
            type: string
          style: form
        - in: query
          name: max
          schema:
            type: string
          style: form
        - in: query
          name: populateHierarchy
          schema:
            type: string
          style: form
        - in: query
          name: q
          schema:
            type: string
          style: form
        - in: query
          name: search
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupRepresentation'
    post:
      tags:
        - Groups
      description: create or add a top level realm groupSet or create child.
      operationId: postGroups
      requestBody:
        description: GroupRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/count:
    get:
      tags:
        - Groups
      description: Returns the groups counts.
      operationId: getGroupsCountByRealm
      parameters:
        - in: query
          name: search
          schema:
            type: string
          style: form
        - in: query
          name: top
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int64
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}:
    get:
      tags:
        - Groups
      operationId: getGroup
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupRepresentation'
    put:
      tags:
        - Groups
      description: Update group, ignores subgroups.
      operationId: putGroupByRealmById
      requestBody:
        description: GroupRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Groups
      operationId: deleteGroupByRealmById
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/children:
    get:
      tags:
        - Groups
      description: Return a paginated list of subgroups that have a parent group corresponding to the group on the URL
      operationId: getChildren
      parameters:
        - in: query
          name: briefRepresentation
          schema:
            type: string
          style: form
        - in: query
          name: first
          schema:
            type: string
          style: form
        - in: query
          name: max
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupRepresentation'
    post:
      tags:
        - Groups
      description: Set or create child.
      operationId: postChildren
      requestBody:
        description: GroupRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/management/permissions:
    get:
      tags:
        - Groups
      description: Return object stating whether client Authorization permissions have been initialized or not and a reference
      operationId: getGroupManagementPermissions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    put:
      tags:
        - Groups
      description: Return object stating whether client Authorization permissions have been initialized or not and a reference
      operationId: putGroupManagementPermissions
      requestBody:
        description: ManagementPermissionReference
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementPermissionReference'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/members:
    get:
      tags:
        - Groups
      description: Get users Returns a stream of users, filtered according to query parameters
      operationId: getMembers
      parameters:
        - in: query
          name: briefRepresentation
          description: Only return basic information (only guaranteed to return id, username, created, first and last name, email, enabled state, email verification state, federation link, and access. Note that it means that namely user attributes, required actions, and not before are not returned.)
          schema:
            type: string
          style: form
        - in: query
          name: first
          description: Pagination offset
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: Maximum results size (defaults to 100)
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/role-mappings:
    get:
      tags:
        - Role Mapper
      description: Get role mappings
      operationId: getGroupRoleMappings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingsRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/role-mappings/clients/{client}:
    get:
      tags:
        - Client Role Mappings
      description: Get client-level role mappings for the user, and the app
      operationId: getGroupRoleMappingsClient
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Client Role Mappings
      description: Add client-level roles to the user role mapping
      operationId: postGroupRoleMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Client Role Mappings
      description: Delete client-level roles from user role mapping
      operationId: deleteGroupRoleMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/role-mappings/clients/{client}/available:
    get:
      tags:
        - Client Role Mappings
      description: Get available client-level roles that can be mapped to the user
      operationId: getGroupRoleMappingsClientAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/role-mappings/clients/{client}/composite:
    get:
      tags:
        - Client Role Mappings
      description: Get effective client-level role mappings This recurses any composite roles
      operationId: getGroupRoleMappingsClientComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/role-mappings/realm:
    get:
      tags:
        - Role Mapper
      description: Get realm-level role mappings
      operationId: getGroupRoleMappingsRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Role Mapper
      description: Add realm-level role mappings to the user
      operationId: postGroupRoleMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Role Mapper
      description: Delete realm-level role mappings
      operationId: deleteGroupRoleMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/role-mappings/realm/available:
    get:
      tags:
        - Role Mapper
      description: Get realm-level roles that can be mapped
      operationId: getGroupRoleMappingsRealmAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/groups/{id}/role-mappings/realm/composite:
    get:
      tags:
        - Role Mapper
      description: Get effective realm-level role mappings This will recurse all composite roles to get the result.
      operationId: getGroupRoleMappingsRealmComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/import-config:
    post:
      tags:
        - Identity Providers
      description: Import identity provider from JSON body
      operationId: postImportConfig
      requestBody:
        description: '[AnyType]'
        content:
          application/json:
            schema:
              type: object
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/instances:
    get:
      tags:
        - Identity Providers
      description: List identity providers
      operationId: getInstances
      parameters:
        - in: query
          name: briefRepresentation
          description: 'Boolean which defines whether brief representations are returned (default: false)'
          schema:
            type: string
          style: form
        - in: query
          name: first
          description: Pagination offset
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: Maximum results size (defaults to 100)
          schema:
            type: string
          style: form
        - in: query
          name: search
          description: Filter specific providers by name. Search can be prefix (name*), contains (name) or exact ("name"). Default prefixed.
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdentityProviderRepresentation'
    post:
      tags:
        - Identity Providers
      description: Create a new identity provider
      operationId: postInstances
      requestBody:
        description: IdentityProviderRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/instances/{alias}:
    get:
      tags:
        - Identity Providers
      description: Get the identity provider
      operationId: getInstance
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderRepresentation'
    put:
      tags:
        - Identity Providers
      description: Update the identity provider
      operationId: putInstance
      requestBody:
        description: IdentityProviderRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Identity Providers
      description: Delete the identity provider
      operationId: deleteInstance
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/instances/{alias}/export:
    get:
      tags:
        - Identity Providers
      description: Export public broker configuration for identity provider
      operationId: getExport
      parameters:
        - in: query
          name: format
          description: Format to use
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/instances/{alias}/management/permissions:
    get:
      tags:
        - Identity Providers
      description: Return object stating whether client Authorization permissions have been initialized or not and a reference
      operationId: getInstanceManagementPermissions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    put:
      tags:
        - Identity Providers
      description: Return object stating whether client Authorization permissions have been initialized or not and a reference
      operationId: putInstanceManagementPermissions
      requestBody:
        description: ManagementPermissionReference
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementPermissionReference'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/instances/{alias}/mapper-types:
    get:
      tags:
        - Identity Providers
      description: Get mapper types for identity provider
      operationId: getMapperTypes
      responses:
        "200":
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/IdentityProviderMapperTypeRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/instances/{alias}/mappers:
    get:
      tags:
        - Identity Providers
      description: Get mappers for identity provider
      operationId: getMappers
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IdentityProviderMapperRepresentation'
    post:
      tags:
        - Identity Providers
      description: Add a mapper to identity provider
      operationId: postMappers
      requestBody:
        description: IdentityProviderMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderMapperRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/instances/{alias}/mappers/{id}:
    get:
      tags:
        - Identity Providers
      description: Get mapper by id for the identity provider
      operationId: getMapper
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderMapperRepresentation'
    put:
      tags:
        - Identity Providers
      description: Update a mapper for the identity provider
      operationId: putMapper
      requestBody:
        description: IdentityProviderMapperRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderMapperRepresentation'
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Identity Providers
      description: Delete a mapper for the identity provider
      operationId: deleteMapper
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: alias
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        description: Mapper id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/identity-provider/providers/{provider_id}:
    get:
      tags:
        - Identity Providers
      description: Get the identity provider factory for that provider id
      operationId: getIdentityProviderProvider
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: provider_id
        description: The provider id to get the factory
        required: true
        schema:
          type: string
        style: simple
  /{realm}/keys:
    get:
      tags:
        - Key
      operationId: getKeys
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeysMetadataRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/localization:
    get:
      tags:
        - Realms Admin
      operationId: getLocalizationByRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/localization/{locale}:
    get:
      tags:
        - Realms Admin
      operationId: getLocalizationByRealmByLocale
      parameters:
        - in: query
          name: useRealmDefaultLocaleFallback
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
    post:
      tags:
        - Realms Admin
      description: Import localization from uploaded JSON file
      operationId: postLocalization
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Realms Admin
      operationId: deleteLocalizationByRealmByLocale
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: locale
        required: true
        schema:
          type: string
        style: simple
  /{realm}/localization/{locale}/{key}:
    get:
      tags:
        - Realms Admin
      operationId: getLocalizationByRealmByLocaleByKey
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: string
    put:
      tags:
        - Realms Admin
      operationId: putLocalization
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Realms Admin
      operationId: deleteLocalizationByRealmByLocaleByKey
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: locale
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: key
        required: true
        schema:
          type: string
        style: simple
  /{realm}/logout-all:
    post:
      tags:
        - Realms Admin
      description: Removes all user sessions.
      operationId: postLogoutAll
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalRequestResult'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/partial-export:
    post:
      tags:
        - Realms Admin
      description: Partial export of existing realm into a JSON file.
      operationId: postPartialExport
      parameters:
        - in: query
          name: exportClients
          schema:
            type: string
          style: form
        - in: query
          name: exportGroupsAndRoles
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/partialImport:
    post:
      tags:
        - Realms Admin
      description: Partial import from a JSON file to an existing realm.
      operationId: postPartialImport
      requestBody:
        description: '[file]'
        content:
          application/json:
            schema:
              type: string
              format: binary
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/push-revocation:
    post:
      tags:
        - Realms Admin
      description: Push the realm’s revocation policy to any client that has an admin url associated with it.
      operationId: postPushRevocationByRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalRequestResult'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles:
    get:
      tags:
        - Roles
      description: Get all roles for the realm or client
      operationId: getRolesByRealm
      parameters:
        - in: query
          name: briefRepresentation
          schema:
            type: string
          style: form
        - in: query
          name: first
          schema:
            type: string
          style: form
        - in: query
          name: max
          schema:
            type: string
          style: form
        - in: query
          name: search
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Roles
      description: Create a new role for the realm or client
      operationId: postRolesByRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles-by-id/{role-id}:
    get:
      tags:
        - Roles (by ID)
      description: Get a specific role’s representation
      operationId: getRolesById
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleRepresentation'
    put:
      tags:
        - Roles (by ID)
      description: Update the role
      operationId: putRolesById
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Roles (by ID)
      description: Delete the role
      operationId: deleteRolesById
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-id
        description: id of role
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles-by-id/{role-id}/composites:
    get:
      tags:
        - Roles (by ID)
      description: Get role’s children Returns a set of role’s children provided the role is a composite.
      operationId: getRolesByIdComposites
      parameters:
        - in: query
          name: first
          schema:
            type: string
          style: form
        - in: query
          name: max
          schema:
            type: string
          style: form
        - in: query
          name: search
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Roles (by ID)
      description: Make the role a composite role by associating some child roles
      operationId: postRolesByIdComposites
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Roles (by ID)
      description: Remove a set of roles from the role’s composite
      operationId: deleteRolesByIdComposites
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}:
    get:
      tags:
        - Roles (by ID)
      description: Get client-level roles for the client that are in the role’s composite
      operationId: getRolesByIdCompositesClient
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientUuid
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles-by-id/{role-id}/composites/realm:
    get:
      tags:
        - Roles (by ID)
      description: Get realm-level roles that are in the role’s composite
      operationId: getRolesByIdCompositesRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles-by-id/{role-id}/management/permissions:
    get:
      tags:
        - Roles (by ID)
      description: Return object stating whether role Authorization permissions have been initialized or not and a reference
      operationId: getRolesByIdManagementPermissions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    put:
      tags:
        - Roles (by ID)
      description: Return object stating whether role Authorization permissions have been initialized or not and a reference
      operationId: putRolesByIdManagementPermissions
      requestBody:
        description: ManagementPermissionReference
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementPermissionReference'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles/{role-name}:
    get:
      tags:
        - Roles
      description: Get a role by name
      operationId: getRoleByRealmByRoleName
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleRepresentation'
    put:
      tags:
        - Roles
      description: Update a role by name
      operationId: putRoleByRealmByRoleName
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Roles
      description: Delete a role by name
      operationId: deleteRoleByRealmByRoleName
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles/{role-name}/composites:
    get:
      tags:
        - Roles
      description: Get composites of the role
      operationId: getRoleCompositesByRealmByRoleName
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Roles
      description: Add a composite to the role
      operationId: postRoleCompositesByRealmByRoleName
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Roles
      description: Remove roles from the role’s composite
      operationId: deleteRoleCompositesByRealmByRoleName
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles/{role-name}/composites/clients/{clientUuid}:
    get:
      tags:
        - Roles
      description: Get client-level roles for the client that are in the role’s composite
      operationId: getRoleCompositesClientByRealmByRoleNameByClientUuid
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientUuid
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles/{role-name}/composites/realm:
    get:
      tags:
        - Roles
      description: Get realm-level roles of the role’s composite
      operationId: getRoleCompositesRealmByRealmByRoleName
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: role's name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles/{role-name}/groups:
    get:
      tags:
        - Roles
      description: Returns a stream of groups that have the specified role name
      operationId: getRoleGroupsByRealmByRoleName
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return a full representation of the {@code GroupRepresentation} objects.
          schema:
            type: string
          style: form
        - in: query
          name: first
          description: first result to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: maximum number of results to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: the role name.
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles/{role-name}/management/permissions:
    get:
      tags:
        - Roles
      description: Return object stating whether role Authorization permissions have been initialized or not and a reference
      operationId: getRoleManagementPermissionsByRealmByRoleName
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    put:
      tags:
        - Roles
      description: Return object stating whether role Authorization permissions have been initialized or not and a reference
      operationId: putRoleManagementPermissionsByRealmByRoleName
      requestBody:
        description: ManagementPermissionReference
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementPermissionReference'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        required: true
        schema:
          type: string
        style: simple
  /{realm}/roles/{role-name}/users:
    get:
      tags:
        - Roles
      description: Returns a stream of users that have the specified role name.
      operationId: getRoleUsersByRealmByRoleName
      parameters:
        - in: query
          name: first
          description: first result to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: maximum number of results to return. Ignored if negative or {@code null}.
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: role-name
        description: the role name.
        required: true
        schema:
          type: string
        style: simple
  /{realm}/sessions/{session}:
    delete:
      tags:
        - Realms Admin
      description: Remove a specific user session.
      operationId: deleteSession
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: session
        required: true
        schema:
          type: string
        style: simple
  /{realm}/testSMTPConnection:
    post:
      tags:
        - Realms Admin
      description: Test SMTP connection with current logged in user
      operationId: postTestSmtpConnection
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users:
    get:
      tags:
        - Users
      description: Get users Returns a stream of users, filtered according to query parameters.
      operationId: getUsersByRealm
      parameters:
        - in: query
          name: briefRepresentation
          description: 'Boolean which defines whether brief representations are returned (default: false)'
          schema:
            type: string
          style: form
        - in: query
          name: email
          description: A String contained in email, or the complete email, if param "exact" is true
          schema:
            type: string
          style: form
        - in: query
          name: emailVerified
          description: whether the email has been verified
          schema:
            type: string
          style: form
        - in: query
          name: enabled
          description: Boolean representing if user is enabled or not
          schema:
            type: string
          style: form
        - in: query
          name: exact
          description: Boolean which defines whether the params "last", "first", "email" and "username" must match exactly
          schema:
            type: string
          style: form
        - in: query
          name: first
          description: Pagination offset
          schema:
            type: string
          style: form
        - in: query
          name: firstName
          description: A String contained in firstName, or the complete firstName, if param "exact" is true
          schema:
            type: string
          style: form
        - in: query
          name: idpAlias
          description: The alias of an Identity Provider linked to the user
          schema:
            type: string
          style: form
        - in: query
          name: idpUserId
          description: The userId at an Identity Provider linked to the user
          schema:
            type: string
          style: form
        - in: query
          name: lastName
          description: A String contained in lastName, or the complete lastName, if param "exact" is true
          schema:
            type: string
          style: form
        - in: query
          name: max
          description: Maximum results size (defaults to 100)
          schema:
            type: string
          style: form
        - in: query
          name: q
          description: A query to search for custom attributes, in the format 'key1:value2 key2:value2'
          schema:
            type: string
          style: form
        - in: query
          name: search
          description: A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search.
          schema:
            type: string
          style: form
        - in: query
          name: username
          description: A String contained in username, or the complete username, if param "exact" is true
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserRepresentation'
    post:
      tags:
        - Users
      description: Create a new user Username must be unique.
      operationId: postUsers
      requestBody:
        description: UserRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRepresentation'
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users-management-permissions:
    get:
      tags:
        - Realms Admin
      operationId: getUsersManagementPermissions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    put:
      tags:
        - Realms Admin
      operationId: putUsersManagementPermissions
      requestBody:
        description: ManagementPermissionReference
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementPermissionReference'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementPermissionReference'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/count:
    get:
      tags:
        - Users
      description: Returns the number of users that match the given criteria.
      operationId: getUsersCount
      parameters:
        - in: query
          name: email
          description: email filter
          schema:
            type: string
          style: form
        - in: query
          name: emailVerified
          schema:
            type: string
          style: form
        - in: query
          name: enabled
          description: Boolean representing if user is enabled or not
          schema:
            type: string
          style: form
        - in: query
          name: firstName
          description: first name filter
          schema:
            type: string
          style: form
        - in: query
          name: lastName
          description: last name filter
          schema:
            type: string
          style: form
        - in: query
          name: q
          schema:
            type: string
          style: form
        - in: query
          name: search
          description: arbitrary search string for all the fields below. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search.
          schema:
            type: string
          style: form
        - in: query
          name: username
          description: username filter
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: integer
                format: int32
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/profile:
    get:
      tags:
        - Users
      operationId: getProfile
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPConfig'
    put:
      tags:
        - Users
      operationId: putProfile
      requestBody:
        description: UPConfig
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UPConfig'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UPConfig'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/profile/metadata:
    get:
      tags:
        - Users
      operationId: getMetadata
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfileMetadata'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}:
    get:
      tags:
        - Users
      description: Get representation of the user
      operationId: getUserByRealmById
      parameters:
        - in: query
          name: userProfileMetadata
          description: Indicates if the user profile metadata should be added to the response
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRepresentation'
    put:
      tags:
        - Users
      description: Update the user
      operationId: putUser
      requestBody:
        description: UserRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRepresentation'
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Users
      description: Delete the user
      operationId: deleteUserByRealmById
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/configured-user-storage-credential-types:
    get:
      tags:
        - Users
      description: Return credential types, which are provided by the user storage where user is stored.
      operationId: getConfiguredUserStorageCredentialTypes
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/consents:
    get:
      tags:
        - Users
      description: Get consents granted by the user
      operationId: getConsents
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/consents/{client}:
    delete:
      tags:
        - Users
      description: Revoke consent and offline tokens for particular client from user
      operationId: deleteConsent
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        description: Client id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/credentials:
    get:
      tags:
        - Users
      operationId: getCredentials
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CredentialRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/credentials/{credentialId}:
    delete:
      tags:
        - Users
      description: Remove a credential for a user
      operationId: deleteCredential
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: credentialId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}:
    post:
      tags:
        - Users
      description: Move a credential to a position behind another credential
      operationId: postMoveAfter
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: credentialId
        description: The credential to move
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: newPreviousCredentialId
        description: The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list.
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/credentials/{credentialId}/moveToFirst:
    post:
      tags:
        - Users
      description: Move a credential to a first position in the credentials list of the user
      operationId: postMoveToFirst
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: credentialId
        description: The credential to move
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/credentials/{credentialId}/userLabel:
    put:
      tags:
        - Users
      description: Update a credential label for a user
      operationId: putUserLabel
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: credentialId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/disable-credential-types:
    put:
      tags:
        - Users
      description: Disable all credentials for a user of a specific type
      operationId: putDisableCredentialTypes
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/execute-actions-email:
    put:
      tags:
        - Users
      description: Send an email to the user with a link they can click to execute particular actions.
      operationId: putExecuteActionsEmail
      parameters:
        - in: query
          name: client_id
          description: Client id
          schema:
            type: string
          style: form
        - in: query
          name: lifespan
          description: Number of seconds after which the generated token expires
          schema:
            type: string
          style: form
        - in: query
          name: redirect_uri
          description: Redirect uri
          schema:
            type: string
          style: form
      requestBody:
        description: '[string]'
        content:
          application/json:
            schema:
              type: string
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/federated-identity:
    get:
      tags:
        - Users
      description: Get social logins associated with the user
      operationId: getFederatedIdentity
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FederatedIdentityRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/federated-identity/{provider}:
    post:
      tags:
        - Users
      description: Add a social login provider to the user
      operationId: postFederatedIdentity
      responses:
        "200":
          description: OK
    delete:
      tags:
        - Users
      description: Remove a social login provider from user
      operationId: deleteFederatedIdentity
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: provider
        description: Social login provider id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/groups:
    get:
      tags:
        - Users
      operationId: getUserGroups
      parameters:
        - in: query
          name: briefRepresentation
          schema:
            type: string
          style: form
        - in: query
          name: first
          schema:
            type: string
          style: form
        - in: query
          name: max
          schema:
            type: string
          style: form
        - in: query
          name: search
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/groups/count:
    get:
      tags:
        - Users
      operationId: getUserGroupsCount
      parameters:
        - in: query
          name: search
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int64
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/groups/{groupId}:
    put:
      tags:
        - Users
      operationId: putUserGroup
      responses:
        "204":
          description: No Content
    delete:
      tags:
        - Users
      operationId: deleteUserGroup
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: groupId
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/impersonation:
    post:
      tags:
        - Users
      description: Impersonate the user
      operationId: postImpersonation
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/logout:
    post:
      tags:
        - Users
      description: Remove all user sessions associated with the user Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user.
      operationId: postLogout
      responses:
        "201":
          description: Created
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/offline-sessions/{clientUuid}:
    get:
      tags:
        - Users
      description: Get offline sessions associated with the user and client
      operationId: getOfflineSession
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserSessionRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: clientUuid
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/reset-password:
    put:
      tags:
        - Users
      description: Set up a new password for the user.
      operationId: putResetPassword
      requestBody:
        description: CredentialRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/reset-password-email:
    put:
      tags:
        - Users
      description: Send an email to the user with a link they can click to reset their password.
      operationId: putResetPasswordEmail
      parameters:
        - in: query
          name: client_id
          description: client id
          schema:
            type: string
          style: form
        - in: query
          name: redirect_uri
          description: redirect uri
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/role-mappings:
    get:
      tags:
        - Role Mapper
      description: Get role mappings
      operationId: getUserRoleMappings
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingsRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/role-mappings/clients/{client}:
    get:
      tags:
        - Client Role Mappings
      description: Get client-level role mappings for the user, and the app
      operationId: getUserRoleMappingsClient
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Client Role Mappings
      description: Add client-level roles to the user role mapping
      operationId: postUserRoleMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Client Role Mappings
      description: Delete client-level roles from user role mapping
      operationId: deleteUserRoleMappingsClient
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/role-mappings/clients/{client}/available:
    get:
      tags:
        - Client Role Mappings
      description: Get available client-level roles that can be mapped to the user
      operationId: getUserRoleMappingsClientAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/role-mappings/clients/{client}/composite:
    get:
      tags:
        - Client Role Mappings
      description: Get effective client-level role mappings This recurses any composite roles
      operationId: getUserRoleMappingsClientComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: client
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/role-mappings/realm:
    get:
      tags:
        - Role Mapper
      description: Get realm-level role mappings
      operationId: getUserRoleMappingsRealm
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    post:
      tags:
        - Role Mapper
      description: Add realm-level role mappings to the user
      operationId: postUserRoleMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "201":
          description: Created
    delete:
      tags:
        - Role Mapper
      description: Delete realm-level role mappings
      operationId: deleteUserRoleMappingsRealm
      requestBody:
        description: RoleRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleRepresentation'
      responses:
        "204":
          description: No Content
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/role-mappings/realm/available:
    get:
      tags:
        - Role Mapper
      description: Get realm-level roles that can be mapped
      operationId: getUserRoleMappingsRealmAvailable
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/role-mappings/realm/composite:
    get:
      tags:
        - Role Mapper
      description: Get effective realm-level role mappings This will recurse all composite roles to get the result.
      operationId: getUserRoleMappingsRealmComposite
      parameters:
        - in: query
          name: briefRepresentation
          description: if false, return roles with their attributes
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoleRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/send-verify-email:
    put:
      tags:
        - Users
      description: Send an email-verification email to the user An email contains a link the user can click to verify their email address.
      operationId: putSendVerifyEmail
      parameters:
        - in: query
          name: client_id
          description: Client id
          schema:
            type: string
          style: form
        - in: query
          name: redirect_uri
          description: Redirect uri
          schema:
            type: string
          style: form
      responses:
        "200":
          description: OK
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
  /{realm}/users/{id}/sessions:
    get:
      tags:
        - Users
      description: Get sessions associated with the user
      operationId: getSessions
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserSessionRepresentation'
    parameters:
      - in: path
        name: realm
        description: realm name (not id!)
        required: true
        schema:
          type: string
        style: simple
      - in: path
        name: id
        required: true
        schema:
          type: string
        style: simple
components:
  securitySchemes:
    access_token:
      type: http
      scheme: bearer
  schemas:
    Access:
      type: object
      properties:
        roles:
          type: array
          items:
            type: string
          uniqueItems: true
        verify_caller:
          type: boolean
    AccessToken:
      type: object
      properties:
        jti:
          type: string
        exp:
          type: integer
          format: int64
        nbf:
          type: integer
          format: int64
        iat:
          type: integer
          format: int64
        iss:
          type: string
        sub:
          type: string
        typ:
          type: string
        azp:
          type: string
        otherClaims:
          type: object
          additionalProperties:
            type: object
        nonce:
          type: string
        auth_time:
          type: integer
          format: int64
        session_state:
          type: string
        at_hash:
          type: string
        c_hash:
          type: string
        name:
          type: string
        given_name:
          type: string
        family_name:
          type: string
        middle_name:
          type: string
        nickname:
          type: string
        preferred_username:
          type: string
        profile:
          type: string
        picture:
          type: string
        website:
          type: string
        email:
          type: string
        email_verified:
          type: boolean
        gender:
          type: string
        birthdate:
          type: string
        zoneinfo:
          type: string
        locale:
          type: string
        phone_number:
          type: string
        phone_number_verified:
          type: boolean
        address:
          $ref: '#/components/schemas/AddressClaimSet'
        updated_at:
          type: integer
          format: int64
        claims_locales:
          type: string
        acr:
          type: string
        s_hash:
          type: string
        authTime:
          type: integer
          format: int32
        sid:
          type: string
        trusted-certs:
          type: array
          items:
            type: string
          uniqueItems: true
        allowed-origins:
          type: array
          items:
            type: string
          uniqueItems: true
        realm_access:
          $ref: '#/components/schemas/Access'
        resource_access:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Access'
        authorization:
          $ref: '#/components/schemas/Authorization'
        cnf:
          $ref: '#/components/schemas/Confirmation'
        scope:
          type: string
    AddressClaimSet:
      type: object
      properties:
        formatted:
          type: string
        street_address:
          type: string
        locality:
          type: string
        region:
          type: string
        postal_code:
          type: string
        country:
          type: string
    AdminEventRepresentation:
      type: object
      properties:
        time:
          type: integer
          format: int64
        realmId:
          type: string
        authDetails:
          $ref: '#/components/schemas/AuthDetailsRepresentation'
        operationType:
          type: string
        resourceType:
          type: string
        resourcePath:
          type: string
        representation:
          type: string
        error:
          type: string
    ApplicationRepresentation:
      type: object
      properties:
        id:
          type: string
        clientId:
          type: string
        description:
          type: string
        rootUrl:
          type: string
        adminUrl:
          type: string
        baseUrl:
          type: string
        surrogateAuthRequired:
          type: boolean
        enabled:
          type: boolean
        alwaysDisplayInConsole:
          type: boolean
        clientAuthenticatorType:
          type: string
        secret:
          type: string
        registrationAccessToken:
          type: string
        defaultRoles:
          type: array
          items:
            type: string
        redirectUris:
          type: array
          items:
            type: string
        webOrigins:
          type: array
          items:
            type: string
        notBefore:
          type: integer
          format: int32
        bearerOnly:
          type: boolean
        consentRequired:
          type: boolean
        standardFlowEnabled:
          type: boolean
        implicitFlowEnabled:
          type: boolean
        directAccessGrantsEnabled:
          type: boolean
        serviceAccountsEnabled:
          type: boolean
        oauth2DeviceAuthorizationGrantEnabled:
          type: boolean
        authorizationServicesEnabled:
          type: boolean
        directGrantsOnly:
          type: boolean
        publicClient:
          type: boolean
        frontchannelLogout:
          type: boolean
        protocol:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: string
        authenticationFlowBindingOverrides:
          type: object
          additionalProperties:
            type: string
        fullScopeAllowed:
          type: boolean
        nodeReRegistrationTimeout:
          type: integer
          format: int32
        registeredNodes:
          type: object
          additionalProperties:
            type: integer
            format: int32
        protocolMappers:
          type: array
          items:
            $ref: '#/components/schemas/ProtocolMapperRepresentation'
        clientTemplate:
          type: string
        useTemplateConfig:
          type: boolean
        useTemplateScope:
          type: boolean
        useTemplateMappers:
          type: boolean
        defaultClientScopes:
          type: array
          items:
            type: string
        optionalClientScopes:
          type: array
          items:
            type: string
        authorizationSettings:
          $ref: '#/components/schemas/ResourceServerRepresentation'
        access:
          type: object
          additionalProperties:
            type: boolean
        origin:
          type: string
        name:
          type: string
        claims:
          $ref: '#/components/schemas/ApplicationRepresentationClaims'
    ApplicationRepresentationClaims:
      type: object
      properties:
        name:
          type: boolean
        username:
          type: boolean
        profile:
          type: boolean
        picture:
          type: boolean
        website:
          type: boolean
        email:
          type: boolean
        gender:
          type: boolean
        locale:
          type: boolean
        address:
          type: boolean
        phone:
          type: boolean
    AuthDetailsRepresentation:
      type: object
      properties:
        realmId:
          type: string
        clientId:
          type: string
        userId:
          type: string
        ipAddress:
          type: string
    AuthenticationExecutionExportRepresentation:
      type: object
      properties:
        authenticatorConfig:
          type: string
        authenticator:
          type: string
        authenticatorFlow:
          type: boolean
        requirement:
          type: string
        priority:
          type: integer
          format: int32
        autheticatorFlow:
          type: boolean
        flowAlias:
          type: string
        userSetupAllowed:
          type: boolean
    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:
          type: integer
          format: int32
        index:
          type: integer
          format: int32
    AuthenticationExecutionRepresentation:
      type: object
      properties:
        authenticatorConfig:
          type: string
        authenticator:
          type: string
        authenticatorFlow:
          type: boolean
        requirement:
          type: string
        priority:
          type: integer
          format: int32
        autheticatorFlow:
          type: boolean
        id:
          type: string
        flowId:
          type: string
        parentFlow:
          type: string
    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'
    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
    Authorization:
      type: object
      properties:
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
    CertificateRepresentation:
      type: object
      properties:
        privateKey:
          type: string
        publicKey:
          type: string
        certificate:
          type: string
        kid:
          type: string
    ClaimRepresentation:
      type: object
      properties:
        name:
          type: boolean
        username:
          type: boolean
        profile:
          type: boolean
        picture:
          type: boolean
        website:
          type: boolean
        email:
          type: boolean
        gender:
          type: boolean
        locale:
          type: boolean
        address:
          type: boolean
        phone:
          type: boolean
    ClientInitialAccessCreatePresentation:
      type: object
      properties:
        expiration:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
    ClientInitialAccessPresentation:
      type: object
      properties:
        id:
          type: string
        token:
          type: string
        timestamp:
          type: integer
          format: int32
        expiration:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
        remainingCount:
          type: integer
          format: int32
    ClientMappingsRepresentation:
      type: object
      properties:
        id:
          type: string
        client:
          type: string
        mappings:
          type: array
          items:
            $ref: '#/components/schemas/RoleRepresentation'
    ClientPoliciesRepresentation:
      type: object
      properties:
        policies:
          type: array
          items:
            $ref: '#/components/schemas/ClientPolicyRepresentation'
    ClientPolicyConditionRepresentation:
      type: object
      properties:
        condition:
          type: string
        configuration:
          type: array
          items:
            type: object
    ClientPolicyExecutorRepresentation:
      type: object
      properties:
        executor:
          type: string
        configuration:
          type: array
          items:
            type: object
    ClientPolicyRepresentation:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/ClientPolicyConditionRepresentation'
        profiles:
          type: array
          items:
            type: string
    ClientProfileRepresentation:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        executors:
          type: array
          items:
            $ref: '#/components/schemas/ClientPolicyExecutorRepresentation'
    ClientProfilesRepresentation:
      type: object
      properties:
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/ClientProfileRepresentation'
        globalProfiles:
          type: array
          items:
            $ref: '#/components/schemas/ClientProfileRepresentation'
    ClientRepresentation:
      type: object
      properties:
        id:
          type: string
        clientId:
          type: string
        name:
          type: string
        description:
          type: string
        rootUrl:
          type: string
        adminUrl:
          type: string
        baseUrl:
          type: string
        surrogateAuthRequired:
          type: boolean
        enabled:
          type: boolean
        alwaysDisplayInConsole:
          type: boolean
        clientAuthenticatorType:
          type: string
        secret:
          type: string
        registrationAccessToken:
          type: string
        defaultRoles:
          type: array
          items:
            type: string
        redirectUris:
          type: array
          items:
            type: string
        webOrigins:
          type: array
          items:
            type: string
        notBefore:
          type: integer
          format: int32
        bearerOnly:
          type: boolean
        consentRequired:
          type: boolean
        standardFlowEnabled:
          type: boolean
        implicitFlowEnabled:
          type: boolean
        directAccessGrantsEnabled:
          type: boolean
        serviceAccountsEnabled:
          type: boolean
        oauth2DeviceAuthorizationGrantEnabled:
          type: boolean
        authorizationServicesEnabled:
          type: boolean
        directGrantsOnly:
          type: boolean
        publicClient:
          type: boolean
        frontchannelLogout:
          type: boolean
        protocol:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: string
        authenticationFlowBindingOverrides:
          type: object
          additionalProperties:
            type: string
        fullScopeAllowed:
          type: boolean
        nodeReRegistrationTimeout:
          type: integer
          format: int32
        registeredNodes:
          type: object
          additionalProperties:
            type: integer
            format: int32
        protocolMappers:
          type: array
          items:
            $ref: '#/components/schemas/ProtocolMapperRepresentation'
        clientTemplate:
          type: string
        useTemplateConfig:
          type: boolean
        useTemplateScope:
          type: boolean
        useTemplateMappers:
          type: boolean
        defaultClientScopes:
          type: array
          items:
            type: string
        optionalClientScopes:
          type: array
          items:
            type: string
        authorizationSettings:
          $ref: '#/components/schemas/ResourceServerRepresentation'
        access:
          type: object
          additionalProperties:
            type: boolean
        origin:
          type: string
    ClientScopeRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        protocol:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: string
        protocolMappers:
          type: array
          items:
            $ref: '#/components/schemas/ProtocolMapperRepresentation'
    ClientTemplateRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        protocol:
          type: string
        fullScopeAllowed:
          type: boolean
        bearerOnly:
          type: boolean
        consentRequired:
          type: boolean
        standardFlowEnabled:
          type: boolean
        implicitFlowEnabled:
          type: boolean
        directAccessGrantsEnabled:
          type: boolean
        serviceAccountsEnabled:
          type: boolean
        publicClient:
          type: boolean
        frontchannelLogout:
          type: boolean
        attributes:
          type: object
          additionalProperties:
            type: string
        protocolMappers:
          type: array
          items:
            $ref: '#/components/schemas/ProtocolMapperRepresentation'
    ComponentExportRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        providerId:
          type: string
        subType:
          type: string
        subComponents:
          type: object
          additionalProperties:
            type: array
        config:
          type: object
          additionalProperties:
            type: array
    ComponentRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        providerId:
          type: string
        providerType:
          type: string
        parentId:
          type: string
        subType:
          type: string
        config:
          type: object
          additionalProperties:
            type: array
    ComponentTypeRepresentation:
      type: object
      properties:
        id:
          type: string
        helpText:
          type: string
        properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigPropertyRepresentation'
        metadata:
          type: object
          additionalProperties:
            type: object
    Composites:
      type: object
      properties:
        realm:
          type: array
          items:
            type: string
          uniqueItems: true
        client:
          type: object
          additionalProperties:
            type: array
        application:
          type: object
          additionalProperties:
            type: array
    ConfigPropertyRepresentation:
      type: object
      properties:
        name:
          type: string
        label:
          type: string
        helpText:
          type: string
        type:
          type: string
        defaultValue:
          $ref: '#/components/schemas/oas_any_type_not_mapped'
        options:
          type: array
          items:
            type: string
        secret:
          type: boolean
        required:
          type: boolean
        readOnly:
          type: boolean
    Confirmation:
      type: object
      properties:
        x5t#S256:
          type: string
        jkt:
          type: string
    CredentialRepresentation:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        userLabel:
          type: string
        createdDate:
          type: integer
          format: int64
        secretData:
          type: string
        credentialData:
          type: string
        priority:
          type: integer
          format: int32
        value:
          type: string
        temporary:
          type: boolean
        device:
          type: string
        hashedSaltedValue:
          type: string
        salt:
          type: string
        hashIterations:
          type: integer
          format: int32
        counter:
          type: integer
          format: int32
        algorithm:
          type: string
        digits:
          type: integer
          format: int32
        period:
          type: integer
          format: int32
        config:
          type: object
          additionalProperties: true
    DecisionStrategy:
      type: object
    EnforcementMode:
      type: object
    EventRepresentation:
      type: object
      properties:
        time:
          type: integer
          format: int64
        type:
          type: string
        realmId:
          type: string
        clientId:
          type: string
        userId:
          type: string
        sessionId:
          type: string
        ipAddress:
          type: string
        error:
          type: string
        details:
          type: object
          additionalProperties:
            type: string
    FederatedIdentityRepresentation:
      type: object
      properties:
        identityProvider:
          type: string
        userId:
          type: string
        userName:
          type: string
    GlobalRequestResult:
      type: object
      properties:
        successRequests:
          type: array
          items:
            type: string
        failedRequests:
          type: array
          items:
            type: string
    GroupRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        path:
          type: string
        parentId:
          type: string
        subGroupCount:
          type: integer
          format: int64
        subGroups:
          type: array
          items:
            $ref: '#/components/schemas/GroupRepresentation'
        attributes:
          type: object
          additionalProperties:
            type: array
        realmRoles:
          type: array
          items:
            type: string
        clientRoles:
          type: object
          additionalProperties:
            type: array
        access:
          type: object
          additionalProperties:
            type: boolean
    IDToken:
      type: object
      properties:
        jti:
          type: string
        exp:
          type: integer
          format: int64
        nbf:
          type: integer
          format: int64
        iat:
          type: integer
          format: int64
        iss:
          type: string
        sub:
          type: string
        typ:
          type: string
        azp:
          type: string
        otherClaims:
          type: object
          additionalProperties:
            type: object
        nonce:
          type: string
        auth_time:
          type: integer
          format: int64
        session_state:
          type: string
        at_hash:
          type: string
        c_hash:
          type: string
        name:
          type: string
        given_name:
          type: string
        family_name:
          type: string
        middle_name:
          type: string
        nickname:
          type: string
        preferred_username:
          type: string
        profile:
          type: string
        picture:
          type: string
        website:
          type: string
        email:
          type: string
        email_verified:
          type: boolean
        gender:
          type: string
        birthdate:
          type: string
        zoneinfo:
          type: string
        locale:
          type: string
        phone_number:
          type: string
        phone_number_verified:
          type: boolean
        address:
          $ref: '#/components/schemas/AddressClaimSet'
        updated_at:
          type: integer
          format: int64
        claims_locales:
          type: string
        acr:
          type: string
        s_hash:
          type: string
        authTime:
          type: integer
          format: int32
        sid:
          type: string
    IdentityProviderMapperRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        identityProviderAlias:
          type: string
        identityProviderMapper:
          type: string
        config:
          type: object
          additionalProperties:
            type: string
    IdentityProviderMapperTypeRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        category:
          type: string
        helpText:
          type: string
        properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigPropertyRepresentation'
    IdentityProviderRepresentation:
      type: object
      properties:
        alias:
          type: string
        displayName:
          type: string
        internalId:
          type: string
        providerId:
          type: string
        enabled:
          type: boolean
        updateProfileFirstLoginMode:
          type: string
        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
        updateProfileFirstLogin:
          type: boolean
    InstallationAdapterConfig:
      type: object
      properties:
        realm:
          type: string
        realm-public-key:
          type: string
        auth-server-url:
          type: string
        ssl-required:
          type: string
        bearer-only:
          type: boolean
        resource:
          type: string
        public-client:
          type: boolean
        verify-token-audience:
          type: boolean
        credentials:
          type: object
          additionalProperties:
            type: object
        use-resource-role-mappings:
          type: boolean
        confidential-port:
          type: integer
          format: int32
        policy-enforcer:
          $ref: '#/components/schemas/PolicyEnforcerConfig'
    KeyMetadataRepresentation:
      type: object
      properties:
        providerId:
          type: string
        providerPriority:
          type: integer
          format: int64
        kid:
          type: string
        status:
          type: string
        type:
          type: string
        algorithm:
          type: string
        publicKey:
          type: string
        certificate:
          type: string
        use:
          $ref: '#/components/schemas/KeyUse'
        validTo:
          type: integer
          format: int64
    KeyStoreConfig:
      type: object
      properties:
        realmCertificate:
          type: boolean
        storePassword:
          type: string
        keyPassword:
          type: string
        keyAlias:
          type: string
        realmAlias:
          type: string
        format:
          type: string
    KeyUse:
      type: object
    KeysMetadataRepresentation:
      type: object
      properties:
        active:
          type: object
          additionalProperties:
            type: string
        keys:
          type: array
          items:
            $ref: '#/components/schemas/KeyMetadataRepresentation'
    Logic:
      type: object
    ManagementPermissionReference:
      type: object
      properties:
        enabled:
          type: boolean
        resource:
          type: string
        scopePermissions:
          type: object
          additionalProperties:
            type: string
    MappingsRepresentation:
      type: object
      properties:
        realmMappings:
          type: array
          items:
            $ref: '#/components/schemas/RoleRepresentation'
        clientMappings:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ClientMappingsRepresentation'
    MethodConfig:
      type: object
      properties:
        method:
          type: string
        scopes:
          type: array
          items:
            type: string
        scopes-enforcement-mode:
          $ref: '#/components/schemas/ScopeEnforcementMode'
    OAuthClientRepresentation:
      type: object
      properties:
        id:
          type: string
        clientId:
          type: string
        description:
          type: string
        rootUrl:
          type: string
        adminUrl:
          type: string
        baseUrl:
          type: string
        surrogateAuthRequired:
          type: boolean
        enabled:
          type: boolean
        alwaysDisplayInConsole:
          type: boolean
        clientAuthenticatorType:
          type: string
        secret:
          type: string
        registrationAccessToken:
          type: string
        defaultRoles:
          type: array
          items:
            type: string
        redirectUris:
          type: array
          items:
            type: string
        webOrigins:
          type: array
          items:
            type: string
        notBefore:
          type: integer
          format: int32
        bearerOnly:
          type: boolean
        consentRequired:
          type: boolean
        standardFlowEnabled:
          type: boolean
        implicitFlowEnabled:
          type: boolean
        directAccessGrantsEnabled:
          type: boolean
        serviceAccountsEnabled:
          type: boolean
        oauth2DeviceAuthorizationGrantEnabled:
          type: boolean
        authorizationServicesEnabled:
          type: boolean
        directGrantsOnly:
          type: boolean
        publicClient:
          type: boolean
        frontchannelLogout:
          type: boolean
        protocol:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: string
        authenticationFlowBindingOverrides:
          type: object
          additionalProperties:
            type: string
        fullScopeAllowed:
          type: boolean
        nodeReRegistrationTimeout:
          type: integer
          format: int32
        registeredNodes:
          type: object
          additionalProperties:
            type: integer
            format: int32
        protocolMappers:
          type: array
          items:
            $ref: '#/components/schemas/ProtocolMapperRepresentation'
        clientTemplate:
          type: string
        useTemplateConfig:
          type: boolean
        useTemplateScope:
          type: boolean
        useTemplateMappers:
          type: boolean
        defaultClientScopes:
          type: array
          items:
            type: string
        optionalClientScopes:
          type: array
          items:
            type: string
        authorizationSettings:
          $ref: '#/components/schemas/ResourceServerRepresentation'
        access:
          type: object
          additionalProperties:
            type: boolean
        origin:
          type: string
        name:
          type: string
        claims:
          $ref: '#/components/schemas/ApplicationRepresentationClaims'
    PathCacheConfig:
      type: object
      properties:
        max-entries:
          type: integer
          format: int32
        lifespan:
          type: integer
          format: int64
    PathConfig:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        path:
          type: string
        methods:
          type: array
          items:
            $ref: '#/components/schemas/MethodConfig'
        scopes:
          type: array
          items:
            type: string
        id:
          type: string
        enforcement-mode:
          $ref: '#/components/schemas/EnforcementMode'
        claim-information-point:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
        invalidated:
          type: boolean
        staticPath:
          type: boolean
        static:
          type: boolean
    PathSegment:
      type: object
      properties:
        path:
          type: string
        matrixParameters:
          type: object
          additionalProperties:
            type: array
    Permission:
      type: object
      properties:
        rsid:
          type: string
        rsname:
          type: string
        scopes:
          type: array
          items:
            type: string
          uniqueItems: true
        claims:
          type: object
          additionalProperties:
            type: array
            uniqueItems: true
    PolicyEnforcementMode:
      type: object
    PolicyEnforcerConfig:
      type: object
      properties:
        enforcement-mode:
          $ref: '#/components/schemas/EnforcementMode'
        paths:
          type: array
          items:
            $ref: '#/components/schemas/PathConfig'
        path-cache:
          $ref: '#/components/schemas/PathCacheConfig'
        lazy-load-paths:
          type: boolean
        on-deny-redirect-to:
          type: string
        user-managed-access:
          type: object
        claim-information-point:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
        http-method-as-scope:
          type: boolean
        realm:
          type: string
        auth-server-url:
          type: string
        credentials:
          type: object
          additionalProperties:
            type: object
        resource:
          type: string
    PolicyRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        type:
          type: string
        policies:
          type: array
          items:
            type: string
          uniqueItems: true
        resources:
          type: array
          items:
            type: string
          uniqueItems: true
        scopes:
          type: array
          items:
            type: string
          uniqueItems: true
        logic:
          $ref: '#/components/schemas/Logic'
        decisionStrategy:
          $ref: '#/components/schemas/DecisionStrategy'
        owner:
          type: string
        resourcesData:
          type: array
          items:
            $ref: '#/components/schemas/ResourceRepresentation'
          uniqueItems: true
        scopesData:
          type: array
          items:
            $ref: '#/components/schemas/ScopeRepresentation'
          uniqueItems: true
        config:
          type: object
          additionalProperties:
            type: string
    ProtocolMapperEvaluationRepresentation:
      type: object
      properties:
        mapperId:
          type: string
        mapperName:
          type: string
        containerId:
          type: string
        containerName:
          type: string
        containerType:
          type: string
        protocolMapper:
          type: string
    ProtocolMapperRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        protocol:
          type: string
        protocolMapper:
          type: string
        consentRequired:
          type: boolean
        consentText:
          type: string
        config:
          type: object
          additionalProperties:
            type: string
    PublishedRealmRepresentation:
      type: object
      properties:
        realm:
          type: string
        public_key:
          type: string
        token-service:
          type: string
        account-service:
          type: string
        tokens-not-before:
          type: integer
          format: int32
    RealmEventsConfigRepresentation:
      type: object
      properties:
        eventsEnabled:
          type: boolean
        eventsExpiration:
          type: integer
          format: int64
        eventsListeners:
          type: array
          items:
            type: string
        enabledEventTypes:
          type: array
          items:
            type: string
        adminEventsEnabled:
          type: boolean
        adminEventsDetailsEnabled:
          type: boolean
    RealmRepresentation:
      type: object
      properties:
        id:
          type: string
        realm:
          type: string
        displayName:
          type: string
        displayNameHtml:
          type: string
        notBefore:
          type: integer
          format: int32
        defaultSignatureAlgorithm:
          type: string
        revokeRefreshToken:
          type: boolean
        refreshTokenMaxReuse:
          type: integer
          format: int32
        accessTokenLifespan:
          type: integer
          format: int32
        accessTokenLifespanForImplicitFlow:
          type: integer
          format: int32
        ssoSessionIdleTimeout:
          type: integer
          format: int32
        ssoSessionMaxLifespan:
          type: integer
          format: int32
        ssoSessionIdleTimeoutRememberMe:
          type: integer
          format: int32
        ssoSessionMaxLifespanRememberMe:
          type: integer
          format: int32
        offlineSessionIdleTimeout:
          type: integer
          format: int32
        offlineSessionMaxLifespanEnabled:
          type: boolean
        offlineSessionMaxLifespan:
          type: integer
          format: int32
        clientSessionIdleTimeout:
          type: integer
          format: int32
        clientSessionMaxLifespan:
          type: integer
          format: int32
        clientOfflineSessionIdleTimeout:
          type: integer
          format: int32
        clientOfflineSessionMaxLifespan:
          type: integer
          format: int32
        accessCodeLifespan:
          type: integer
          format: int32
        accessCodeLifespanUserAction:
          type: integer
          format: int32
        accessCodeLifespanLogin:
          type: integer
          format: int32
        actionTokenGeneratedByAdminLifespan:
          type: integer
          format: int32
        actionTokenGeneratedByUserLifespan:
          type: integer
          format: int32
        oauth2DeviceCodeLifespan:
          type: integer
          format: int32
        oauth2DevicePollingInterval:
          type: integer
          format: int32
        enabled:
          type: boolean
        sslRequired:
          type: string
        passwordCredentialGrantAllowed:
          type: boolean
        registrationAllowed:
          type: boolean
        registrationEmailAsUsername:
          type: boolean
        rememberMe:
          type: boolean
        verifyEmail:
          type: boolean
        loginWithEmailAllowed:
          type: boolean
        duplicateEmailsAllowed:
          type: boolean
        resetPasswordAllowed:
          type: boolean
        editUsernameAllowed:
          type: boolean
        userCacheEnabled:
          type: boolean
        realmCacheEnabled:
          type: boolean
        bruteForceProtected:
          type: boolean
        permanentLockout:
          type: boolean
        maxFailureWaitSeconds:
          type: integer
          format: int32
        minimumQuickLoginWaitSeconds:
          type: integer
          format: int32
        waitIncrementSeconds:
          type: integer
          format: int32
        quickLoginCheckMilliSeconds:
          type: integer
          format: int64
        maxDeltaTimeSeconds:
          type: integer
          format: int32
        failureFactor:
          type: integer
          format: int32
        privateKey:
          type: string
        publicKey:
          type: string
        certificate:
          type: string
        codeSecret:
          type: string
        roles:
          $ref: '#/components/schemas/RolesRepresentation'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/GroupRepresentation'
        defaultRoles:
          type: array
          items:
            type: string
        defaultRole:
          $ref: '#/components/schemas/RoleRepresentation'
        defaultGroups:
          type: array
          items:
            type: string
        requiredCredentials:
          type: array
          items:
            type: string
          uniqueItems: true
        passwordPolicy:
          type: string
        otpPolicyType:
          type: string
        otpPolicyAlgorithm:
          type: string
        otpPolicyInitialCounter:
          type: integer
          format: int32
        otpPolicyDigits:
          type: integer
          format: int32
        otpPolicyLookAheadWindow:
          type: integer
          format: int32
        otpPolicyPeriod:
          type: integer
          format: int32
        otpPolicyCodeReusable:
          type: boolean
        otpSupportedApplications:
          type: array
          items:
            type: string
        localizationTexts:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
        webAuthnPolicyRpEntityName:
          type: string
        webAuthnPolicySignatureAlgorithms:
          type: array
          items:
            type: string
        webAuthnPolicyRpId:
          type: string
        webAuthnPolicyAttestationConveyancePreference:
          type: string
        webAuthnPolicyAuthenticatorAttachment:
          type: string
        webAuthnPolicyRequireResidentKey:
          type: string
        webAuthnPolicyUserVerificationRequirement:
          type: string
        webAuthnPolicyCreateTimeout:
          type: integer
          format: int32
        webAuthnPolicyAvoidSameAuthenticatorRegister:
          type: boolean
        webAuthnPolicyAcceptableAaguids:
          type: array
          items:
            type: string
        webAuthnPolicyExtraOrigins:
          type: array
          items:
            type: string
        webAuthnPolicyPasswordlessRpEntityName:
          type: string
        webAuthnPolicyPasswordlessSignatureAlgorithms:
          type: array
          items:
            type: string
        webAuthnPolicyPasswordlessRpId:
          type: string
        webAuthnPolicyPasswordlessAttestationConveyancePreference:
          type: string
        webAuthnPolicyPasswordlessAuthenticatorAttachment:
          type: string
        webAuthnPolicyPasswordlessRequireResidentKey:
          type: string
        webAuthnPolicyPasswordlessUserVerificationRequirement:
          type: string
        webAuthnPolicyPasswordlessCreateTimeout:
          type: integer
          format: int32
        webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister:
          type: boolean
        webAuthnPolicyPasswordlessAcceptableAaguids:
          type: array
          items:
            type: string
        webAuthnPolicyPasswordlessExtraOrigins:
          type: array
          items:
            type: string
        clientProfiles:
          $ref: '#/components/schemas/ClientProfilesRepresentation'
        clientPolicies:
          $ref: '#/components/schemas/ClientPoliciesRepresentation'
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserRepresentation'
        federatedUsers:
          type: array
          items:
            $ref: '#/components/schemas/UserRepresentation'
        scopeMappings:
          type: array
          items:
            $ref: '#/components/schemas/ScopeMappingRepresentation'
        clientScopeMappings:
          type: object
          additionalProperties:
            type: array
        clients:
          type: array
          items:
            $ref: '#/components/schemas/ClientRepresentation'
        clientScopes:
          type: array
          items:
            $ref: '#/components/schemas/ClientScopeRepresentation'
        defaultDefaultClientScopes:
          type: array
          items:
            type: string
        defaultOptionalClientScopes:
          type: array
          items:
            type: string
        browserSecurityHeaders:
          type: object
          additionalProperties:
            type: string
        smtpServer:
          type: object
          additionalProperties:
            type: string
        userFederationProviders:
          type: array
          items:
            $ref: '#/components/schemas/UserFederationProviderRepresentation'
        userFederationMappers:
          type: array
          items:
            $ref: '#/components/schemas/UserFederationMapperRepresentation'
        loginTheme:
          type: string
        accountTheme:
          type: string
        adminTheme:
          type: string
        emailTheme:
          type: string
        eventsEnabled:
          type: boolean
        eventsExpiration:
          type: integer
          format: int64
        eventsListeners:
          type: array
          items:
            type: string
        enabledEventTypes:
          type: array
          items:
            type: string
        adminEventsEnabled:
          type: boolean
        adminEventsDetailsEnabled:
          type: boolean
        identityProviders:
          type: array
          items:
            $ref: '#/components/schemas/IdentityProviderRepresentation'
        identityProviderMappers:
          type: array
          items:
            $ref: '#/components/schemas/IdentityProviderMapperRepresentation'
        protocolMappers:
          type: array
          items:
            $ref: '#/components/schemas/ProtocolMapperRepresentation'
        components:
          type: object
          additionalProperties:
            type: array
        internationalizationEnabled:
          type: boolean
        supportedLocales:
          type: array
          items:
            type: string
          uniqueItems: true
        defaultLocale:
          type: string
        authenticationFlows:
          type: array
          items:
            $ref: '#/components/schemas/AuthenticationFlowRepresentation'
        authenticatorConfig:
          type: array
          items:
            $ref: '#/components/schemas/AuthenticatorConfigRepresentation'
        requiredActions:
          type: array
          items:
            $ref: '#/components/schemas/RequiredActionProviderRepresentation'
        browserFlow:
          type: string
        registrationFlow:
          type: string
        directGrantFlow:
          type: string
        resetCredentialsFlow:
          type: string
        clientAuthenticationFlow:
          type: string
        dockerAuthenticationFlow:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: string
        keycloakVersion:
          type: string
        userManagedAccessAllowed:
          type: boolean
        social:
          type: boolean
        updateProfileOnInitialSocialLogin:
          type: boolean
        socialProviders:
          type: object
          additionalProperties:
            type: string
        applicationScopeMappings:
          type: object
          additionalProperties:
            type: array
        applications:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationRepresentation'
        oauthClients:
          type: array
          items:
            $ref: '#/components/schemas/OAuthClientRepresentation'
        clientTemplates:
          type: array
          items:
            $ref: '#/components/schemas/ClientTemplateRepresentation'
        oAuth2DeviceCodeLifespan:
          type: integer
          format: int32
        oAuth2DevicePollingInterval:
          type: integer
          format: int32
    RequiredActionProviderRepresentation:
      type: object
      properties:
        alias:
          type: string
        name:
          type: string
        providerId:
          type: string
        enabled:
          type: boolean
        defaultAction:
          type: boolean
        priority:
          type: integer
          format: int32
        config:
          type: object
          additionalProperties:
            type: string
    ResourceOwnerRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    ResourceRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        uris:
          type: array
          items:
            type: string
          uniqueItems: true
        type:
          type: string
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/ScopeRepresentation'
          uniqueItems: true
        icon_uri:
          type: string
        owner:
          $ref: '#/components/schemas/ResourceRepresentationOwner'
        ownerManagedAccess:
          type: boolean
        displayName:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: array
        uri:
          type: string
        scopesUma:
          type: array
          items:
            $ref: '#/components/schemas/ScopeRepresentation'
          uniqueItems: true
    ResourceRepresentationOwner:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    ResourceServerRepresentation:
      type: object
      properties:
        id:
          type: string
        clientId:
          type: string
        name:
          type: string
        allowRemoteResourceManagement:
          type: boolean
        policyEnforcementMode:
          $ref: '#/components/schemas/PolicyEnforcementMode'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceRepresentation'
        policies:
          type: array
          items:
            $ref: '#/components/schemas/PolicyRepresentation'
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/ScopeRepresentation'
        decisionStrategy:
          $ref: '#/components/schemas/DecisionStrategy'
    RoleRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        scopeParamRequired:
          type: boolean
        composite:
          type: boolean
        composites:
          $ref: '#/components/schemas/Composites'
        clientRole:
          type: boolean
        containerId:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: array
    RolesRepresentation:
      type: object
      properties:
        realm:
          type: array
          items:
            $ref: '#/components/schemas/RoleRepresentation'
        client:
          type: object
          additionalProperties:
            type: array
        application:
          type: object
          additionalProperties:
            type: array
    ScopeEnforcementMode:
      type: object
    ScopeMappingRepresentation:
      type: object
      properties:
        self:
          type: string
        client:
          type: string
        clientTemplate:
          type: string
        clientScope:
          type: string
        roles:
          type: array
          items:
            type: string
          uniqueItems: true
    ScopeRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        iconUri:
          type: string
        policies:
          type: array
          items:
            $ref: '#/components/schemas/PolicyRepresentation'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceRepresentation'
        displayName:
          type: string
    SocialLinkRepresentation:
      type: object
      properties:
        socialProvider:
          type: string
        socialUserId:
          type: string
        socialUsername:
          type: string
    UPAttribute:
      type: object
      properties:
        name:
          type: string
        displayName:
          type: string
        validations:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
        annotations:
          type: object
          additionalProperties:
            type: object
        required:
          $ref: '#/components/schemas/UPAttributeRequired'
        permissions:
          $ref: '#/components/schemas/UPAttributePermissions'
        selector:
          $ref: '#/components/schemas/UPAttributeSelector'
        group:
          type: string
    UPAttributePermissions:
      type: object
      properties:
        view:
          type: array
          items:
            type: string
          uniqueItems: true
        edit:
          type: array
          items:
            type: string
          uniqueItems: true
    UPAttributeRequired:
      type: object
      properties:
        roles:
          type: array
          items:
            type: string
          uniqueItems: true
        scopes:
          type: array
          items:
            type: string
          uniqueItems: true
    UPAttributeSelector:
      type: object
      properties:
        scopes:
          type: array
          items:
            type: string
          uniqueItems: true
    UPConfig:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/UPAttribute'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/UPGroup'
    UPGroup:
      type: object
      properties:
        name:
          type: string
        displayHeader:
          type: string
        displayDescription:
          type: string
        annotations:
          type: object
          additionalProperties:
            type: object
    UserConsentRepresentation:
      type: object
      properties:
        clientId:
          type: string
        grantedClientScopes:
          type: array
          items:
            type: string
        createdDate:
          type: integer
          format: int64
        lastUpdatedDate:
          type: integer
          format: int64
        grantedRealmRoles:
          type: array
          items:
            type: string
    UserFederationMapperRepresentation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        federationProviderDisplayName:
          type: string
        federationMapperType:
          type: string
        config:
          type: object
          additionalProperties:
            type: string
    UserFederationProviderRepresentation:
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        providerName:
          type: string
        config:
          type: object
          additionalProperties:
            type: string
        priority:
          type: integer
          format: int32
        fullSyncPeriod:
          type: integer
          format: int32
        changedSyncPeriod:
          type: integer
          format: int32
        lastSync:
          type: integer
          format: int32
    UserProfileAttributeGroupMetadata:
      type: object
      properties:
        name:
          type: string
        displayHeader:
          type: string
        displayDescription:
          type: string
        annotations:
          type: object
          additionalProperties:
            type: object
    UserProfileAttributeMetadata:
      type: object
      properties:
        name:
          type: string
        displayName:
          type: string
        required:
          type: boolean
        readOnly:
          type: boolean
        annotations:
          type: object
          additionalProperties:
            type: object
        validators:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
        group:
          type: string
    UserProfileMetadata:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/UserProfileAttributeMetadata'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/UserProfileAttributeGroupMetadata'
    UserRepresentation:
      type: object
      properties:
        self:
          type: string
        id:
          type: string
        origin:
          type: string
        createdTimestamp:
          type: integer
          format: int64
        username:
          type: string
        enabled:
          type: boolean
        totp:
          type: boolean
        emailVerified:
          type: boolean
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        federationLink:
          type: string
        serviceAccountClientId:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: array
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/CredentialRepresentation'
        disableableCredentialTypes:
          type: array
          items:
            type: string
          uniqueItems: true
        requiredActions:
          type: array
          items:
            type: string
        federatedIdentities:
          type: array
          items:
            $ref: '#/components/schemas/FederatedIdentityRepresentation'
        realmRoles:
          type: array
          items:
            type: string
        clientRoles:
          type: object
          additionalProperties:
            type: array
        clientConsents:
          type: array
          items:
            $ref: '#/components/schemas/UserConsentRepresentation'
        notBefore:
          type: integer
          format: int32
        applicationRoles:
          type: object
          additionalProperties:
            type: array
        socialLinks:
          type: array
          items:
            $ref: '#/components/schemas/SocialLinkRepresentation'
        groups:
          type: array
          items:
            type: string
        access:
          type: object
          additionalProperties:
            type: boolean
        userProfileMetadata:
          $ref: '#/components/schemas/UserProfileMetadata'
    UserSessionRepresentation:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        userId:
          type: string
        ipAddress:
          type: string
        start:
          type: integer
          format: int64
        lastAccess:
          type: integer
          format: int64
        rememberMe:
          type: boolean
        clients:
          type: object
          additionalProperties:
            type: string
security:
  - access_token: []
tags:
  - name: Attack Detection
  - name: Authentication Management
  - name: Client Attribute Certificate
  - name: Client Initial Access
  - name: Client Registration Policy
  - name: Client Role Mappings
  - name: Client Scopes
  - name: Clients
  - name: Component
  - name: Groups
  - name: Identity Providers
  - name: Key
  - name: Protocol Mappers
  - name: Realms Admin
  - name: Role Mapper
  - name: Roles
  - name: Roles (by ID)
  - name: Scope Mappings
  - name: Users