Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
keycloak-19.0.0.json
parameters
{"name": "scope", "in": "query", "schema": {"type": "string"}}
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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
either realm name OR client UUID
{"name": "roleContainerId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted
/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted
{"get": {"tags": ["ClientScopeEvaluateScopeMappings"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "roleContainerId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get roles, which this client doesn't have scope for and can't have them in the accessToken issued for him. Defacto all the other roles of particular role container, which are not in {
{"tags": ["ClientScopeEvaluateScopeMappings"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
parameters
{"name": "scope", "in": "query", "schema": {"type": "string"}}
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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
either realm name OR client UUID
{"name": "roleContainerId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/installation/providers/{providerId}
/{realm}/clients/{id}/installation/providers/{providerId}
{"get": {"tags": ["Client"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "providerId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Base path for managing a specific client.
{"tags": ["Client"], "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
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/management/permissions
/{realm}/clients/{id}/management/permissions
{"get": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["Client"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "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
/ Return object stating whether client Authorization permissions have been initialized or not and a reference
{"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
put
/ Return object stating whether client Authorization permissions have been initialized or not and a reference
{"tags": ["Client"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/nodes
/{realm}/clients/{id}/nodes
{"post": {"tags": ["Client"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}, "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
post
/ 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": ["Client"], "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
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/nodes/{node}
/{realm}/clients/{id}/nodes/{node}
{"delete": {"tags": ["Client"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "node", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
delete
/ Unregister a cluster node from the client
{"tags": ["Client"], "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
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"name": "node", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/offline-session-count
/{realm}/clients/{id}/offline-session-count
{"get": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "integer", "format": "int64"}}}}}}}, "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 application offline session count Returns a number of offline user sessions associated with this client { "count": number }
{"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "integer", "format": "int64"}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "integer", "format": "int64"}}}}}
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
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/offline-sessions
/{realm}/clients/{id}/offline-sessions
{"get": {"tags": ["Client"], "parameters": [{"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "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 offline sessions for client Returns a list of offline user sessions associated with this client
{"tags": ["Client"], "parameters": [{"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
parameters
Paging offset
{"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}
keycloak-19.0.0.json
parameters
Maximum results size (defaults to 100)
{"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}
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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/optional-client-scopes
/{realm}/clients/{id}/optional-client-scopes
{"get": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "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 optional client scopes. Only name and ids are returned.
{"tags": ["Client"], "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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/optional-client-scopes/{clientScopeId}
/{realm}/clients/{id}/optional-client-scopes/{clientScopeId}
{"put": {"tags": ["Client"], "responses": {"2XX": {}}}, "delete": {"tags": ["Client"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "clientScopeId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
put
/ Base path for managing a specific client.
{"tags": ["Client"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Base path for managing a specific client.
{"tags": ["Client"], "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
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/protocol-mappers/add-models
/{realm}/clients/{id}/protocol-mappers/add-models
{"post": {"tags": ["ProtocolMappers"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "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
post
/ Create multiple mappers /
{"tags": ["ProtocolMappers"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "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
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/protocol-mappers/models
/{realm}/clients/{id}/protocol-mappers/models
{"post": {"tags": ["ProtocolMappers"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "get": {"tags": ["ProtocolMappers"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Create a mapper
{"tags": ["ProtocolMappers"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
get
/ Get mappers
{"tags": ["ProtocolMappers"], "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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/protocol-mappers/protocol/{protocol}
/{realm}/clients/{id}/protocol-mappers/protocol/{protocol}
{"get": {"tags": ["ProtocolMappers"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "protocol", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get mappers by name for a specific protocol
{"tags": ["ProtocolMappers"], "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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"name": "protocol", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/push-revocation
/{realm}/clients/{id}/push-revocation
{"post": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object"}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Push the client's revocation policy to its admin URL If the client has an admin URL, push revocation policy to it. /
{"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object"}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "object"}}}}
keycloak-19.0.0.json
schema
GlobalRequestResult
{"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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/registration-access-token
/{realm}/clients/{id}/registration-access-token
{"post": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Generate a new registration access token for the client
{"tags": ["Client"], "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
parameters
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/roles
/{realm}/clients/{id}/roles
{"get": {"tags": ["RoleContainer"], "parameters": [{"name": "search", "in": "query", "schema": {"type": "string"}}, {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["RoleContainer"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "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 all roles for the realm or client
{"tags": ["RoleContainer"], "parameters": [{"name": "search", "in": "query", "schema": {"type": "string"}}, {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "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 role for the realm or client
{"tags": ["RoleContainer"], "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
id of client (not client-id)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/clients/{id}/roles/{role-name}
/{realm}/clients/{id}/roles/{role-name}
{"get": {"tags": ["RoleContainer"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"tags": ["RoleContainer"], "responses": {"2XX": {}}}, "put": {"tags": ["RoleContainer"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get a role by name
{"tags": ["RoleContainer"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
delete
/ Delete a role by name
{"tags": ["RoleContainer"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}