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
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}/session-count
/{realm}/clients/{id}/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 session count Returns a number of 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}/test-nodes-available
/{realm}/clients/{id}/test-nodes-available
{"get": {"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
get
/ Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.
{"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}/user-sessions
/{realm}/clients/{id}/user-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 user sessions for client Returns a list of 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/{id1}/protocol-mappers/models/{id2}
/{realm}/clients/{id1}/protocol-mappers/models/{id2}
{"get": {"tags": ["ProtocolMappers"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["ProtocolMappers"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["ProtocolMappers"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id1", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id2", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get mapper by id
{"tags": ["ProtocolMappers"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
put
/ Update the mapper
{"tags": ["ProtocolMappers"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Delete the mapper
{"tags": ["ProtocolMappers"], "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": "id1", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Mapper id
{"name": "id2", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/components
/{realm}/components
{"get": {"tags": ["Component"], "parameters": [{"name": "parent", "in": "query", "schema": {"type": "string"}}, {"name": "type", "in": "query", "schema": {"type": "string"}}, {"name": "name", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["Component"], "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 managing components under this realm.
{"tags": ["Component"], "parameters": [{"name": "parent", "in": "query", "schema": {"type": "string"}}, {"name": "type", "in": "query", "schema": {"type": "string"}}, {"name": "name", "in": "query", "schema": {"type": "string"}}], "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
/ Base path for managing components under this realm.
{"tags": ["Component"], "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}/components/{id}
/{realm}/components/{id}
{"get": {"tags": ["Component"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["Component"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["Component"], "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
/ Base path for managing components under this realm.
{"tags": ["Component"], "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 managing components under this realm.
{"tags": ["Component"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Base path for managing components under this realm.
{"tags": ["Component"], "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}/components/{id}/sub-component-types
/{realm}/components/{id}/sub-component-types
{"get": {"tags": ["Component"], "parameters": [{"name": "type", "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"}}]}
keycloak-19.0.0.json
get
/ List of subcomponent types that are available to configure for a particular parent component.
{"tags": ["Component"], "parameters": [{"name": "type", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
parameters
{"name": "type", "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
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/credential-registrators
/{realm}/credential-registrators
{"get": {"tags": ["RealmAdmin"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}}}, "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": ["RealmAdmin"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "array", "items": {"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}/default-default-client-scopes
/{realm}/default-default-client-scopes
{"get": {"tags": ["RealmAdmin"], "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 realm default client scopes. Only name and ids are returned.
{"tags": ["RealmAdmin"], "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}/default-default-client-scopes/{clientScopeId}
/{realm}/default-default-client-scopes/{clientScopeId}
{"put": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "delete": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "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 the admin REST API for one particular realm.
{"tags": ["RealmAdmin"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Base path for the admin REST API for one particular realm.
{"tags": ["RealmAdmin"], "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}/default-groups
/{realm}/default-groups
{"get": {"tags": ["RealmAdmin"], "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 group hierarchy. Only name and ids are returned.
{"tags": ["RealmAdmin"], "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}/default-groups/{groupId}
/{realm}/default-groups/{groupId}
{"put": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "delete": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "groupId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
put
/ Base path for the admin REST API for one particular realm.
{"tags": ["RealmAdmin"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Base path for the admin REST API for one particular realm.
{"tags": ["RealmAdmin"], "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}/default-optional-client-scopes
/{realm}/default-optional-client-scopes
{"get": {"tags": ["RealmAdmin"], "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 realm optional client scopes. Only name and ids are returned.
{"tags": ["RealmAdmin"], "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}/default-optional-client-scopes/{clientScopeId}
/{realm}/default-optional-client-scopes/{clientScopeId}
{"put": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "delete": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "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 the admin REST API for one particular realm.
{"tags": ["RealmAdmin"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Base path for the admin REST API for one particular realm.
{"tags": ["RealmAdmin"], "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}/events
/{realm}/events
{"get": {"tags": ["RealmAdmin"], "parameters": [{"name": "type", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "client", "in": "query", "schema": {"type": "string"}}, {"name": "user", "in": "query", "schema": {"type": "string"}}, {"name": "dateFrom", "in": "query", "schema": {"type": "string"}}, {"name": "dateTo", "in": "query", "schema": {"type": "string"}}, {"name": "ipAddress", "in": "query", "schema": {"type": "string"}}, {"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": {}}}}}}}, "delete": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get events Returns all events, or filters them based on URL query parameters listed here
{"tags": ["RealmAdmin"], "parameters": [{"name": "type", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "client", "in": "query", "schema": {"type": "string"}}, {"name": "user", "in": "query", "schema": {"type": "string"}}, {"name": "dateFrom", "in": "query", "schema": {"type": "string"}}, {"name": "dateTo", "in": "query", "schema": {"type": "string"}}, {"name": "ipAddress", "in": "query", "schema": {"type": "string"}}, {"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
The types of events to return
{"name": "type", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}
keycloak-19.0.0.json
parameters
App or oauth client name
{"name": "client", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
User id
{"name": "user", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
From date
{"name": "dateFrom", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
To date
{"name": "dateTo", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
IP address
{"name": "ipAddress", "in": "query", "schema": {"type": "string"}}
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
delete
/ Delete all events /
{"tags": ["RealmAdmin"], "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}/events/config
/{realm}/events/config
{"get": {"tags": ["RealmAdmin"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["RealmAdmin"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}