schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
1.0.schema.json
message
Error page message (title)
{"type": "string", "examples": ["Bad Request"]}
1.0.schema.json
description
Error page description
{"type": "string", "examples": ["The server did not understand the request"]}
bozr.json
Bozr test suite schema definition
{"$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/bozr.json", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "ignore": {"type": "string", "minLength": 10}, "calls": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"args": {"type": "object", "minProperties": 1}, "on": {"type": "object", "minProperties": 1, "additionalProperties": false, "properties": {"method": {"type": "string", "enum": ["GET", "POST", "PUT", "DELETE", "HEAD", "OPTIONS", "PATCH", "CONNECT", "TRACE"]}, "url": {"type": "string"}, "headers": {"type": "object", "minProperties": 1, "properties": {"Accept": {"type": "string", "enum": ["application/json", "application/xml", "text/xml", "text/csv"]}, "Content-Type": {"type": "string", "enum": ["application/json", "application/xml", "text/xml", "text/csv"]}, "Authorization": {"type": "string"}}}, "params": {"type": "object", "minProperties": 1}, "body": {"oneOf": [{"type": "string"}, {"type": "object"}]}, "bodyFile": {"type": "string"}}, "required": ["method", "url"]}, "expect": {"type": "object", "minProperties": 1, "properties": {"statusCode": {"type": "integer", "enum": [200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511]}, "contentType": {"type": "string"}, "headers": {"type": "object", "minProperties": 1}, "body": {"type": "object", "minProperties": 1}, "exactBody": {"type": "object", "minProperties": 1}, "bodyPath": {"type": "object", "minProperties": 1}, "bodySchemaFile": {"type": "string"}, "bodySchema": {"type": "string"}, "bodySchemaURI": {"type": "string"}, "absent": {"type": "array", "minItems": 1}}, "additionalProperties": false}, "remember": {"type": "object", "minProperties": 1, "properties": {"bodyPath": {"type": "object", "minProperties": 1}, "headers": {"type": "object", "minProperties": 1}}, "additionalProperties": false}}, "required": ["on", "expect"]}}}, "required": ["calls"]}, "type": "array"}
bozr.json
name
Short name of the test that will be used in reports.
{"type": "string"}
bozr.json
description
Long description of the test.
{"type": "string"}
bozr.json
ignore
Ignore test due to a reason
{"type": "string", "minLength": 10}
secrethub.json
A repository of the current user https://github.com/DannyBen/secret_hub#bulk-operations
{"$schema": "http://json-schema.org/draft-07/schema", "type": "object", "patternProperties": {".": {"oneOf": [{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "minLength": 1, "examples": ["SECRET", "PASSWORD"]}}, {"type": "object", "patternProperties": {".": {"type": ["string", "null"]}}}]}}, "additionalProperties": false}
secrethub.json
.
Secrets of the current repository https://github.com/DannyBen/secret_hub#bulk-operations
{"oneOf": [{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "minLength": 1, "examples": ["SECRET", "PASSWORD"]}}, {"type": "object", "patternProperties": {".": {"type": ["string", "null"]}}}]}
secrethub.json
items
A secret of the current repository https://github.com/DannyBen/secret_hub#bulk-operations
{"type": "string", "minLength": 1, "examples": ["SECRET", "PASSWORD"]}
secrethub.json
.
A secret of the current repository https://github.com/DannyBen/secret_hub#bulk-operations
{"type": ["string", "null"]}
keycloak-19.0.0.json
info
This is a REST API reference for the Keycloak Admin
{"version": "1"}
keycloak-19.0.0.json
get
/ Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.
{"tags": ["RealmsAdmin"], "parameters": [{"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
/ Import a realm Imports a realm from a full representation of that realm. Realm name must be unique.
{"tags": ["RealmsAdmin"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
/{realm}
/{realm}
{"get": {"tags": ["RealmAdmin"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["RealmAdmin"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get the top-level representation of the realm It will not include nested information like User and Client representations.
{"tags": ["RealmAdmin"], "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 top-level information of the realm Any user, roles or client information in the representation will be ignored. This will only update top-level attributes of the realm.
{"tags": ["RealmAdmin"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Delete the 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}/admin-events
/{realm}/admin-events
{"get": {"tags": ["RealmAdmin"], "parameters": [{"name": "operationTypes", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "authRealm", "in": "query", "schema": {"type": "string"}}, {"name": "authClient", "in": "query", "schema": {"type": "string"}}, {"name": "authUser", "in": "query", "schema": {"type": "string"}}, {"name": "authIpAddress", "in": "query", "schema": {"type": "string"}}, {"name": "resourcePath", "in": "query", "schema": {"type": "string"}}, {"name": "dateFrom", "in": "query", "schema": {"type": "string"}}, {"name": "dateTo", "in": "query", "schema": {"type": "string"}}, {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "resourceTypes", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}], "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 admin events Returns all admin events, or filters events based on URL query parameters listed here
{"tags": ["RealmAdmin"], "parameters": [{"name": "operationTypes", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}, {"name": "authRealm", "in": "query", "schema": {"type": "string"}}, {"name": "authClient", "in": "query", "schema": {"type": "string"}}, {"name": "authUser", "in": "query", "schema": {"type": "string"}}, {"name": "authIpAddress", "in": "query", "schema": {"type": "string"}}, {"name": "resourcePath", "in": "query", "schema": {"type": "string"}}, {"name": "dateFrom", "in": "query", "schema": {"type": "string"}}, {"name": "dateTo", "in": "query", "schema": {"type": "string"}}, {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "resourceTypes", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}
keycloak-19.0.0.json
parameters
{"name": "operationTypes", "in": "query", "schema": {"type": "array", "items": {"type": "string"}}}
keycloak-19.0.0.json
parameters
{"name": "authRealm", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"name": "authClient", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
user id
{"name": "authUser", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"name": "authIpAddress", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"name": "resourcePath", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"name": "dateFrom", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"name": "dateTo", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
{"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 admin 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}/attack-detection/brute-force/users
/{realm}/attack-detection/brute-force/users
{"delete": {"tags": ["AttackDetection"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
delete
/ Clear any user login failures for all users This can release temporary disabled users /
{"tags": ["AttackDetection"], "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}/attack-detection/brute-force/users/{userId}
/{realm}/attack-detection/brute-force/users/{userId}
{"get": {"tags": ["AttackDetection"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "object"}}}}}}}, "delete": {"tags": ["AttackDetection"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "userId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get status of a username in brute force detection
{"tags": ["AttackDetection"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "object"}}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "object"}}}}}
keycloak-19.0.0.json
delete
/ Clear any user login failures for the user This can release temporary disabled user
{"tags": ["AttackDetection"], "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": "userId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/authenticator-providers
/{realm}/authentication/authenticator-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 authenticator providers Returns a stream of authenticator 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/client-authenticator-providers
/{realm}/authentication/client-authenticator-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 client authenticator providers Returns a stream of client authenticator 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/config
/{realm}/authentication/config
{"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
post
/ Create new authenticator configuration
{"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/config-description/{providerId}
/{realm}/authentication/config-description/{providerId}
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "providerId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get authenticator provider's configuration description /
{"tags": ["AuthenticationManagement"], "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}/authentication/config/{id}
/{realm}/authentication/config/{id}
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"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": "id", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get authenticator configuration
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}
keycloak-19.0.0.json
2XX
Success
{"content": {"application/json": {"schema": {}}}}
keycloak-19.0.0.json
delete
/ Delete authenticator configuration
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
put
/ Update authenticator configuration
{"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
Configuration id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/executions
/{realm}/authentication/executions
{"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
post
/ Add new authentication execution
{"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/executions/{executionId}
/{realm}/authentication/executions/{executionId}
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}, "delete": {"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
get
/ Get Single Execution /
{"tags": ["AuthenticationManagement"], "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Delete execution
{"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
/{realm}/authentication/executions/{executionId}/config
/{realm}/authentication/executions/{executionId}/config
{"post": {"tags": ["AuthenticationManagement"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "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
/ Update execution with new configuration
{"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
Execution id
{"name": "executionId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/executions/{executionId}/config/{id}
/{realm}/authentication/executions/{executionId}/config/{id}
{"get": {"tags": ["AuthenticationManagement"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "executionId", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
get
/ Get execution's configuration
{"tags": ["AuthenticationManagement"], "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
Execution id
{"name": "executionId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Configuration id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/authentication/executions/{executionId}/lower-priority
/{realm}/authentication/executions/{executionId}/lower-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
/ Lower 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"}}