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
{}
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-registration-policy/providers
/{realm}/client-registration-policy/providers
{"get": {"tags": ["ClientRegistrationPolicy"], "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
/ Base path for retrieve providers with the configProperties properly filled
{"tags": ["ClientRegistrationPolicy"], "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}/client-scopes
/{realm}/client-scopes
{"get": {"tags": ["ClientScopes"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["ClientScopes"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm /
{"tags": ["ClientScopes"], "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 client scope Client Scope's name must be unique!
{"tags": ["ClientScopes"], "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-scopes/{id}
/{realm}/client-scopes/{id}
{"put": {"tags": ["ClientScope"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "get": {"tags": ["ClientScope"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"tags": ["ClientScope"], "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
put
/ Update the client scope
{"tags": ["ClientScope"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
get
/ Get representation of the client scope
{"tags": ["ClientScope"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
delete
/ Delete the client scope /
{"tags": ["ClientScope"], "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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/protocol-mappers/add-models
/{realm}/client-scopes/{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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/protocol-mappers/models
/{realm}/client-scopes/{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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}
/{realm}/client-scopes/{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 scope (not name)
{"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}/client-scopes/{id}/scope-mappings
/{realm}/client-scopes/{id}/scope-mappings
{"get": {"tags": ["ScopeMapped"], "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
/ Get all scope mappings for the client
{"tags": ["ScopeMapped"], "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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/scope-mappings/clients/{client}
/{realm}/client-scopes/{id}/scope-mappings/clients/{client}
{"get": {"tags": ["ScopeMappedClient"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["ScopeMappedClient"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["ScopeMappedClient"], "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"}}, {"name": "client", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get the roles associated with a client's scope Returns roles for the client.
{"tags": ["ScopeMappedClient"], "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
/ Add client-level roles to the client's scope
{"tags": ["ScopeMappedClient"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Remove client-level roles from the client's scope.
{"tags": ["ScopeMappedClient"], "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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available
/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available
{"get": {"tags": ["ScopeMappedClient"], "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": "client", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ The available client-level roles Returns the roles for the client that can be associated with the client's scope
{"tags": ["ScopeMappedClient"], "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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/composite
/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/composite
{"get": {"tags": ["ScopeMappedClient"], "parameters": [{"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "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": "client", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get effective client roles Returns the roles for the client that are associated with the client's scope.
{"tags": ["ScopeMappedClient"], "parameters": [{"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
parameters
if false, return roles with their attributes
{"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}
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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/scope-mappings/realm
/{realm}/client-scopes/{id}/scope-mappings/realm
{"get": {"tags": ["ScopeMapped"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["ScopeMapped"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["ScopeMapped"], "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
get
/ Get realm-level roles associated with the client's scope
{"tags": ["ScopeMapped"], "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
/ Add a set of realm-level roles to the client's scope
{"tags": ["ScopeMapped"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Remove a set of realm-level roles from the client's scope
{"tags": ["ScopeMapped"], "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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/scope-mappings/realm/available
/{realm}/client-scopes/{id}/scope-mappings/realm/available
{"get": {"tags": ["ScopeMapped"], "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 realm-level roles that are available to attach to this client's scope
{"tags": ["ScopeMapped"], "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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id}/scope-mappings/realm/composite
/{realm}/client-scopes/{id}/scope-mappings/realm/composite
{"get": {"tags": ["ScopeMapped"], "parameters": [{"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "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 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. The method is really to show a comprehensive total view of realm-level roles associated with the client.
{"tags": ["ScopeMapped"], "parameters": [{"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
parameters
if false, return roles with their attributes
{"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}
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 scope (not name)
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}
/{realm}/client-scopes/{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 scope (not name)
{"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}/client-session-stats
/{realm}/client-session-stats
{"get": {"tags": ["RealmAdmin"], "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 client session stats Returns a JSON map. The key is the client id, the value is the number of sessions that currently are active with that client. Only clients that actually have a session associated with them will be in this map.
{"tags": ["RealmAdmin"], "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-templates
/{realm}/client-templates
{"get": {"tags": ["ClientScopes"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["ClientScopes"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm /
{"tags": ["ClientScopes"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}