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
whether the email has been verified
{"name": "emailVerified", "in": "query", "schema": {"type": "boolean"}}
keycloak-19.0.0.json
parameters
The alias of an Identity Provider linked to the user
{"name": "idpAlias", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
The userId at an Identity Provider linked to the user
{"name": "idpUserId", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Pagination 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
parameters
Boolean representing if user is enabled or not
{"name": "enabled", "in": "query", "schema": {"type": "boolean"}}
keycloak-19.0.0.json
parameters
Boolean which defines whether brief representations are returned (default: false)
{"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}
keycloak-19.0.0.json
parameters
Boolean which defines whether the params "last", "first", "email" and "username" must match exactly
{"name": "exact", "in": "query", "schema": {"type": "boolean"}}
keycloak-19.0.0.json
parameters
A query to search for custom attributes, in the format 'key1:value2 key2:value2'
{"name": "q", "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
/{realm}/users-management-permissions
/{realm}/users-management-permissions
{"get": {"tags": ["RealmAdmin"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["RealmAdmin"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "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": {}}}}}}
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": ["RealmAdmin"], "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
/{realm}/users/{id}
/{realm}/users/{id}
{"put": {"tags": ["User"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "get": {"tags": ["User"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"tags": ["User"], "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 user
{"tags": ["User"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
get
/ Get representation of the user
{"tags": ["User"], "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 user /
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/configured-user-storage-credential-types
/{realm}/users/{id}/configured-user-storage-credential-types
{"get": {"tags": ["User"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}}}, "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 credential types, which are provided by the user storage where user is stored. Returned values can contain for example "password", "otp" etc. This will always return empty list for "local" users, which are not backed by any user storage
{"tags": ["User"], "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
parameters
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/consents
/{realm}/users/{id}/consents
{"get": {"tags": ["User"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"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
/ Get consents granted by the user
{"tags": ["User"], "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
parameters
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/consents/{client}
/{realm}/users/{id}/consents/{client}
{"delete": {"tags": ["User"], "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
delete
/ Revoke consent and offline tokens for particular client from user
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Client id
{"name": "client", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/credentials
/{realm}/users/{id}/credentials
{"get": {"tags": ["User"], "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 representation of the user
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/credentials/{credentialId}
/{realm}/users/{id}/credentials/{credentialId}
{"delete": {"tags": ["User"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "credentialId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
delete
/ Remove a credential for a user /
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}
/{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}
{"post": {"tags": ["User"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "credentialId", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "newPreviousCredentialId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Move a credential to a position behind another credential
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
The credential to move
{"name": "credentialId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list.
{"name": "newPreviousCredentialId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/credentials/{credentialId}/moveToFirst
/{realm}/users/{id}/credentials/{credentialId}/moveToFirst
{"post": {"tags": ["User"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "credentialId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Move a credential to a first position in the credentials list of the user
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
The credential to move
{"name": "credentialId", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/credentials/{credentialId}/userLabel
/{realm}/users/{id}/credentials/{credentialId}/userLabel
{"put": {"tags": ["User"], "requestBody": {"content": {"text/plain": {"schema": {"type": "string"}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "credentialId", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
put
/ Update a credential label for a user /
{"tags": ["User"], "requestBody": {"content": {"text/plain": {"schema": {"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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/disable-credential-types
/{realm}/users/{id}/disable-credential-types
{"put": {"tags": ["User"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {"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
put
/ Disable all credentials for a user of a specific type
{"tags": ["User"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {"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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/execute-actions-email
/{realm}/users/{id}/execute-actions-email
{"put": {"tags": ["User"], "parameters": [{"name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "schema": {"type": "string"}}, {"name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "schema": {"type": "string"}}, {"name": "lifespan", "in": "query", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {"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
put
/ Send a update account email to the user An email contains a link the user can click to perform a set of required actions. The redirectUri and clientId parameters are optional. If no redirect is given, then there will be no link back to click after actions have completed. Redirect uri must be a valid uri for the particular clientId.
{"tags": ["User"], "parameters": [{"name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "schema": {"type": "string"}}, {"name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "schema": {"type": "string"}}, {"name": "lifespan", "in": "query", "schema": {"type": "integer", "format": "int32"}}], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
parameters
Redirect uri
{"name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Client id
{"name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Number of seconds after which the generated token expires
{"name": "lifespan", "in": "query", "schema": {"type": "integer", "format": "int32"}}
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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/federated-identity
/{realm}/users/{id}/federated-identity
{"get": {"tags": ["User"], "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 social logins associated with the user
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/federated-identity/{provider}
/{realm}/users/{id}/federated-identity/{provider}
{"post": {"tags": ["User"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["User"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "provider", "in": "path", "required": true, "schema": {"type": "string"}}]}
keycloak-19.0.0.json
post
/ Add a social login provider to the user
{"tags": ["User"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}
keycloak-19.0.0.json
2XX
Success
{}
keycloak-19.0.0.json
delete
/ Remove a social login provider from user
{"tags": ["User"], "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
User id
{"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
parameters
Social login provider id
{"name": "provider", "in": "path", "required": true, "schema": {"type": "string"}}
keycloak-19.0.0.json
/{realm}/users/{id}/groups
/{realm}/users/{id}/groups
{"get": {"tags": ["User"], "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": {}}}}}}}, "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 representation of the user
{"tags": ["User"], "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
parameters
realm name (not id!)
{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}