schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
keycloak-19.0.0.json
parameters
Execution id
{"name": "executionId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/executions/{executionId}/raise-priority
/{realm}/authentication/executions/{executionId}/raise-priority
{"post": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "executionId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Raise execution's priority
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Execution id
{"name": "executionId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/flows
/{realm}/authentication/flows
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get authentication flows Returns a stream of authentication flows. /
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}
keycloak-19.0.0.json
post
/ Create a new authentication flow
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/flows/{flowAlias}/copy
/{realm}/authentication/flows/{flowAlias}/copy
{"post": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Copy existing authentication flow under a new name The new name is given as 'newName' attribute of the passed JSON object
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Name of the existing authentication flow
{"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/flows/{flowAlias}/executions
/{realm}/authentication/flows/{flowAlias}/executions
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}, "put": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get authentication executions for a flow
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
put
/ Update authentication executions of a Flow
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Flow alias
{"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/flows/{flowAlias}/executions/execution
/{realm}/authentication/flows/{flowAlias}/executions/execution
{"post": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Add new authentication execution to a flow
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Alias of parent flow
{"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/flows/{flowAlias}/executions/flow
/{realm}/authentication/flows/{flowAlias}/executions/flow
{"post": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Add new flow with new execution to existing flow
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Alias of parent authentication flow
{"name": "flowAlias", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/flows/{id}
/{realm}/authentication/flows/{id}
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get authentication flow for id
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
put
/ Update an authentication flow
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Delete an authentication flow
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Flow id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/form-action-providers
/{realm}/authentication/form-action-providers
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object"}}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get form action providers Returns a stream of form action providers. /
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object"}}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object"}}}}}}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/form-providers
/{realm}/authentication/form-providers
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object"}}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get form providers Returns a stream of form providers. /
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object"}}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object"}}}}}}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/per-client-config-description
/{realm}/authentication/per-client-config-description
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "array", "items": {}}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get configuration descriptions for all clients /
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "array", "items": {}}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "array", "items": {}}}}}}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/register-required-action
/{realm}/authentication/register-required-action
{"post": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Register a new required actions
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/required-actions
/{realm}/authentication/required-actions
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get required actions Returns a stream of required actions. /
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/required-actions/{alias}
/{realm}/authentication/required-actions/{alias}
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get required action for alias
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
put
/ Update required action
{"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Delete required action
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Alias of required action
{"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/required-actions/{alias}/lower-priority
/{realm}/authentication/required-actions/{alias}/lower-priority
{"post": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Lower required action's priority
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Alias of required action
{"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/required-actions/{alias}/raise-priority
/{realm}/authentication/required-actions/{alias}/raise-priority
{"post": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Raise required action's priority
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Alias of required action
{"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/unregistered-required-actions
/{realm}/authentication/unregistered-required-actions
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get unregistered required actions Returns a stream of unregistered required actions. /
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "string"}}}}}}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-description-converter
/{realm}/client-description-converter
{"post": {"tags": ["RealmAdmin"], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}, "application/xml": {"schema": {"type": "string"}}, "text/plain": {"schema": {"type": "string"}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Base path for importing clients under this realm.
{"tags": ["RealmAdmin"], "requestBody": {"content": {"application/json": {"schema": {"type": "string"}}, "application/xml": {"schema": {"type": "string"}}, "text/plain": {"schema": {"type": "string"}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-policies/policies
/{realm}/client-policies/policies
{"get": {"tags": ["ClientPolicies"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["ClientPolicies"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Base path for the admin REST API for one particular realm.
{"tags": ["ClientPolicies"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
put
/ Base path for the admin REST API for one particular realm.
{"tags": ["ClientPolicies"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-policies/profiles
/{realm}/client-policies/profiles
{"get": {"tags": ["ClientProfiles"], "parameters": [{"name": "include-global-profiles", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["ClientProfiles"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Base path for the admin REST API for one particular realm.
{"tags": ["ClientProfiles"], "parameters": [{"name": "include-global-profiles", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
put
/ Base path for the admin REST API for one particular realm.
{"tags": ["ClientProfiles"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}