openapi-directory/api/keycloak.local.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.2","servers":[{"url":"http://keycloak.local"}],"info":{"description":"This is a REST API reference for the Keycloak Admin","title":"Keycloak Admin REST API","version":"1","x-apisguru-categories":["developer_tools"],"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/ccouzens/keycloak-openapi/master/keycloak/10.0.json","version":"3.0"}],"x-providerName":"keycloak.local"},"externalDocs":{"description":"Schema source code","url":"https://github.com/keycloak/keycloak/tree/6.0.1/core/src/main/java/org/keycloak/representations"},"security":[{"access_token":[]}],"paths":{"/":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerInfoRepresentation"}}},"description":"success"}},"summary":"Get themes, social providers, auth providers, and event listeners available on this server","tags":["Root"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealmRepresentation"}}},"description":"JSON representation of the realm","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Import a realm   Imports a realm from a full representation of that realm.","tags":["Realms Admin"]}},"/{id}/name":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"description":"success"}},"summary":"Need this for admin console to display simple name of provider when displaying client detail   KEYCLOAK-4328","tags":["User Storage Provider"]},"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete the realm","tags":["Realms Admin"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealmRepresentation"}}},"description":"success"}},"summary":"Get the top-level representation of the realm   It will not include nested information like User and Client representations.","tags":["Realms Admin"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealmRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update the top-level information of the realm   Any user, roles or client information in the representation  will be ignored.","tags":["Realms Admin"]}},"/{realm}/admin-events":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete all admin events","tags":["Realms Admin"]},"get":{"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"},{"description":"user id","in":"query","name":"authUser","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":{"format":"int32","type":"integer"},"style":"form"},{"description":"Maximum results size (defaults to 100)","in":"query","name":"max","schema":{"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"operationTypes","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"in":"query","name":"resourcePath","schema":{"type":"string"},"style":"form"},{"in":"query","name":"resourceTypes","schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AdminEventRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get admin events   Returns all admin events, or filters events based on URL query parameters listed here","tags":["Realms Admin"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/attack-detection/brute-force/users":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Clear any user login failures for all users   This can release temporary disabled users","tags":["Attack Detection"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/attack-detection/brute-force/users/{userId}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Clear any user login failures for the user   This can release temporary disabled user","tags":["Attack Detection"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"description":"success"}},"summary":"Get status of a username in brute force detection","tags":["Attack Detection"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"userId","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/authenticator-providers":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array"}}},"description":"success"}},"summary":"Get authenticator providers   Returns a list of authenticator providers.","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/client-authenticator-providers":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array"}}},"description":"success"}},"summary":"Get client authenticator providers   Returns a list of client authenticator providers.","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/config-description/{providerId}":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticatorConfigInfoRepresentation"}}},"description":"success"}},"summary":"Get authenticator provider’s configuration description","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"providerId","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/config/{id}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete authenticator configuration","tags":["Authentication Management"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticatorConfigRepresentation"}}},"description":"success"}},"summary":"Get authenticator configuration","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Configuration id","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticatorConfigRepresentation"}}},"description":"JSON describing new state of authenticator configuration","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update authenticator configuration","tags":["Authentication Management"]}},"/{realm}/authentication/executions":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExecutionRepresentation"}}},"description":"JSON model describing authentication execution","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Add new authentication execution","tags":["Authentication Management"]}},"/{realm}/authentication/executions/{executionId}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete execution","tags":["Authentication Management"]},"get":{"responses":{"2XX":{"description":"success"}},"summary":"Get Single Execution","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Execution id","in":"path","name":"executionId","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/executions/{executionId}/config":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Execution id","in":"path","name":"executionId","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticatorConfigRepresentation"}}},"description":"JSON with new configuration","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update execution with new configuration","tags":["Authentication Management"]}},"/{realm}/authentication/executions/{executionId}/lower-priority":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Execution id","in":"path","name":"executionId","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"description":"success"}},"summary":"Lower execution’s priority","tags":["Authentication Management"]}},"/{realm}/authentication/executions/{executionId}/raise-priority":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Execution id","in":"path","name":"executionId","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"description":"success"}},"summary":"Raise execution’s priority","tags":["Authentication Management"]}},"/{realm}/authentication/flows":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AuthenticationFlowRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get authentication flows   Returns a list of authentication flows.","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationFlowRepresentation"}}},"description":"Authentication flow representation","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Create a new authentication flow","tags":["Authentication Management"]}},"/{realm}/authentication/flows/{flowAlias}/copy":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Name of the existing authentication flow","in":"path","name":"flowAlias","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"description":"JSON containing 'newName' attribute","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Copy existing authentication flow under a new name   The new name is given as 'newName' attribute of the passed JSON object","tags":["Authentication Management"]}},"/{realm}/authentication/flows/{flowAlias}/executions":{"get":{"responses":{"2XX":{"description":"success"}},"summary":"Get authentication executions for a flow","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Flow alias","in":"path","name":"flowAlias","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationExecutionInfoRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update authentication executions of a flow","tags":["Authentication Management"]}},"/{realm}/authentication/flows/{flowAlias}/executions/execution":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Alias of parent flow","in":"path","name":"flowAlias","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"description":"New execution JSON data containing 'provider' attribute","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Add new authentication execution to a flow","tags":["Authentication Management"]}},"/{realm}/authentication/flows/{flowAlias}/executions/flow":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Alias of parent authentication flow","in":"path","name":"flowAlias","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"description":"New authentication flow / execution JSON data containing 'alias', 'type', 'provider', and 'description' attributes","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Add new flow with new execution to existing flow","tags":["Authentication Management"]}},"/{realm}/authentication/flows/{id}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete an authentication flow","tags":["Authentication Management"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationFlowRepresentation"}}},"description":"success"}},"summary":"Get authentication flow for id","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Flow id","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationFlowRepresentation"}}},"description":"Authentication flow representation","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update an authentication flow","tags":["Authentication Management"]}},"/{realm}/authentication/form-action-providers":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array"}}},"description":"success"}},"summary":"Get form action providers   Returns a list of form action providers.","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/form-providers":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array"}}},"description":"success"}},"summary":"Get form providers   Returns a list of form providers.","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/per-client-config-description":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"description":"success"}},"summary":"Get configuration descriptions for all clients","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/register-required-action":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"description":"JSON containing 'providerId', and 'name' attributes.","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Register a new required actions","tags":["Authentication Management"]}},"/{realm}/authentication/required-actions":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RequiredActionProviderRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get required actions   Returns a list of required actions.","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/authentication/required-actions/{alias}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete required action","tags":["Authentication Management"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequiredActionProviderRepresentation"}}},"description":"success"}},"summary":"Get required action for alias","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Alias of required action","in":"path","name":"alias","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequiredActionProviderRepresentation"}}},"description":"JSON describing new state of required action","required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update required action","tags":["Authentication Management"]}},"/{realm}/authentication/required-actions/{alias}/lower-priority":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Alias of required action","in":"path","name":"alias","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"description":"success"}},"summary":"Lower required action’s priority","tags":["Authentication Management"]}},"/{realm}/authentication/required-actions/{alias}/raise-priority":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Alias of required action","in":"path","name":"alias","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"description":"success"}},"summary":"Raise required action’s priority","tags":["Authentication Management"]}},"/{realm}/authentication/unregistered-required-actions":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array"}}},"description":"success"}},"summary":"Get unregistered required actions   Returns a list of unregistered required actions.","tags":["Authentication Management"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/clear-keys-cache":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"description":"success"}},"summary":"Clear cache of external public keys (Public keys of clients or Identity providers)","tags":["Realms Admin"]}},"/{realm}/clear-realm-cache":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"description":"success"}},"summary":"Clear realm cache","tags":["Realms Admin"]}},"/{realm}/clear-user-cache":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"description":"success"}},"summary":"Clear user cache","tags":["Realms Admin"]}},"/{realm}/client-description-converter":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRepresentation"}}},"description":"success"}},"summary":"Base path for importing clients under this realm.","tags":["Realms Admin"]}},"/{realm}/client-registration-policy/providers":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ComponentTypeRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Base path for retrieve providers with the configProperties properly filled","tags":["Client Registration Policy"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/client-scopes":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ClientScopeRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get client scopes belonging to the realm   Returns a list of client scopes belonging to the realm","tags":["Client Scopes"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientScopeRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Create a new client scope   Client Scope’s name must be unique!","tags":["Client Scopes"]}},"/{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete the mapper","tags":["Protocol Mappers"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"}}},"description":"success"}},"summary":"Get mapper by id","tags":["Protocol Mappers"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","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"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update the mapper","tags":["Protocol Mappers"]}},"/{realm}/client-scopes/{id}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete the client scope","tags":["Client Scopes"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientScopeRepresentation"}}},"description":"success"}},"summary":"Get representation of the client scope","tags":["Client Scopes"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientScopeRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update the client scope","tags":["Client Scopes"]}},"/{realm}/client-scopes/{id}/protocol-mappers/add-models":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"},"type":"array"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Create multiple mappers","tags":["Protocol Mappers"]}},"/{realm}/client-scopes/{id}/protocol-mappers/models":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get mappers","tags":["Protocol Mappers"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Create a mapper","tags":["Protocol Mappers"]}},"/{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get mappers by name for a specific protocol","tags":["Protocol Mappers"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","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":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MappingsRepresentation"}}},"description":"success"}},"summary":"Get all scope mappings for the client","tags":["Scope Mappings"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/client-scopes/{id}/scope-mappings/clients/{client}":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Remove client-level roles from the client’s scope.","tags":["Scope Mappings"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get the roles associated with a client’s scope   Returns roles for the client.","tags":["Scope Mappings"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"client","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Add client-level roles to the client’s scope","tags":["Scope Mappings"]}},"/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"The available client-level roles   Returns the roles for the client that can be associated with the client’s scope","tags":["Scope Mappings"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","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":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get effective client roles   Returns the roles for the client that are associated with the client’s scope.","tags":["Scope Mappings"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","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":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Remove a set of realm-level roles from the client’s scope","tags":["Scope Mappings"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get realm-level roles associated with the client’s scope","tags":["Scope Mappings"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Add a set of realm-level roles to the client’s scope","tags":["Scope Mappings"]}},"/{realm}/client-scopes/{id}/scope-mappings/realm/available":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get realm-level roles that are available to attach to this client’s scope","tags":["Scope Mappings"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/client-scopes/{id}/scope-mappings/realm/composite":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"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.","tags":["Scope Mappings"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client scope (not name)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/client-session-stats":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array"}}},"description":"success"}},"summary":"Get client session stats   Returns a JSON map.","tags":["Realms Admin"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/clients":{"get":{"parameters":[{"description":"filter by clientId","in":"query","name":"clientId","schema":{"type":"string"},"style":"form"},{"description":"the first result","in":"query","name":"first","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"the max results to return","in":"query","name":"max","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"whether this is a search query or a getClientById query","in":"query","name":"search","schema":{"type":"boolean"},"style":"form"},{"description":"filter clients that cannot be viewed in full by admin","in":"query","name":"viewableOnly","schema":{"type":"boolean"},"style":"form"}],"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ClientRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get clients belonging to the realm   Returns a list of clients belonging to the realm","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Create a new client   Client’s client_id must be unique!","tags":["Clients"]}},"/{realm}/clients-initial-access":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ClientInitialAccessPresentation"},"type":"array"}}},"description":"success"}},"tags":["Client Initial Access"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientInitialAccessCreatePresentation"}}},"required":true},"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientInitialAccessPresentation"}}},"description":"success"}},"summary":"Create a new initial access token.","tags":["Client Initial Access"]}},"/{realm}/clients-initial-access/{id}":{"delete":{"responses":{"2XX":{"description":"success"}},"tags":["Client Initial Access"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","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}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete the mapper","tags":["Protocol Mappers"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"}}},"description":"success"}},"summary":"Get mapper by id","tags":["Protocol Mappers"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","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"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtocolMapperRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update the mapper","tags":["Protocol Mappers"]}},"/{realm}/clients/{id}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Delete the client","tags":["Clients"]},"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRepresentation"}}},"description":"success"}},"summary":"Get representation of the client","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRepresentation"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"Update the client","tags":["Clients"]}},"/{realm}/clients/{id}/certificates/{attr}":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateRepresentation"}}},"description":"success"}},"summary":"Get key info","tags":["Client Attribute Certificate"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","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":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"attr","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyStoreConfig"}}},"description":"Keystore configuration as JSON","required":true},"responses":{"2XX":{"content":{"application/octet-stream":{"schema":{"format":"byte","type":"string"}}},"description":"success"}},"summary":"Get a keystore file for the client, containing private key and public certificate","tags":["Client Attribute Certificate"]}},"/{realm}/clients/{id}/certificates/{attr}/generate":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"attr","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateRepresentation"}}},"description":"success"}},"summary":"Generate a new certificate with new key pair","tags":["Client Attribute Certificate"]}},"/{realm}/clients/{id}/certificates/{attr}/generate-and-download":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"attr","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyStoreConfig"}}},"description":"Keystore configuration as JSON","required":true},"responses":{"2XX":{"content":{"application/octet-stream":{"schema":{"format":"byte","type":"string"}}},"description":"success"}},"summary":"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.","tags":["Client Attribute Certificate"]}},"/{realm}/clients/{id}/certificates/{attr}/upload":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"attr","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateRepresentation"}}},"description":"success"}},"summary":"Upload certificate and eventually private key","tags":["Client Attribute Certificate"]}},"/{realm}/clients/{id}/certificates/{attr}/upload-certificate":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"attr","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateRepresentation"}}},"description":"success"}},"summary":"Upload only certificate, not private key","tags":["Client Attribute Certificate"]}},"/{realm}/clients/{id}/client-secret":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialRepresentation"}}},"description":"success"}},"summary":"Get the client secret","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialRepresentation"}}},"description":"success"}},"summary":"Generate a new secret for the client","tags":["Clients"]}},"/{realm}/clients/{id}/default-client-scopes":{"get":{"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ClientScopeRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get default client scopes.","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/clients/{id}/default-client-scopes/{clientScopeId}":{"delete":{"responses":{"2XX":{"description":"success"}},"tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"clientScopeId","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"responses":{"2XX":{"description":"success"}},"tags":["Clients"]}},"/{realm}/clients/{id}/evaluate-scopes/generate-example-access-token":{"get":{"parameters":[{"in":"query","name":"scope","schema":{"type":"string"},"style":"form"},{"in":"query","name":"userId","schema":{"type":"string"},"style":"form"}],"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}},"description":"success"}},"summary":"Create JSON with payload of example access token","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/clients/{id}/evaluate-scopes/protocol-mappers":{"get":{"parameters":[{"in":"query","name":"scope","schema":{"type":"string"},"style":"form"}],"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ClientScopeEvaluateResource-ProtocolMapperEvaluationRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Return list of all protocol mappers, which will be used when generating tokens issued for particular client.","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted":{"get":{"parameters":[{"in":"query","name":"scope","schema":{"type":"string"},"style":"form"}],"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"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.","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"either realm name OR client UUID","in":"path","name":"roleContainerId","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted":{"get":{"parameters":[{"in":"query","name":"scope","schema":{"type":"string"},"style":"form"}],"responses":{"2XX":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleRepresentation"},"type":"array"}}},"description":"success"}},"summary":"Get roles, which this client doesn’t have scope for and can’t have them in the accessToken issued for him.","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"either realm name OR client UUID","in":"path","name":"roleContainerId","required":true,"schema":{"type":"string"},"style":"simple"}]},"/{realm}/clients/{id}/installation/providers/{providerId}":{"get":{"responses":{"2XX":{"description":"success"}},"tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","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":{"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagementPermissionReference"}}},"description":"success"}},"summary":"Return object stating whether client Authorization permissions have been initialized or not and a reference","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"put":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagementPermissionReference"}}},"required":true},"responses":{"2XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagementPermissionReference"}}},"description":"success"}},"summary":"Return object stating whether client Authorization permissions have been initialized or not and a reference","tags":["Clients"]}},"/{realm}/clients/{id}/nodes":{"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","in":"path","name":"id","required":true,"schema":{"type":"string"},"style":"simple"}],"post":{"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object"}}},"required":true},"responses":{"2XX":{"description":"success"}},"summary":"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","tags":["Clients"]}},"/{realm}/clients/{id}/nodes/{node}":{"delete":{"responses":{"2XX":{"description":"success"}},"summary":"Unregister a cluster node from the client","tags":["Clients"]},"parameters":[{"description":"realm name (not id!)","in":"path","name":"realm","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"id of client (not client-id)","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":{"responses":{"2XX":{"content":{"application/json":{"schema":{"additionalProperties":true,