schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
keycloak-19.0.0.json | get | /
Base path for managing client initial access tokens
| {"tags": ["ClientInitialAccess"], "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}/clients-initial-access/{id} | /{realm}/clients-initial-access/{id} | {"delete": {"tags": ["ClientInitialAccess"], "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 | delete | /
Base path for managing client initial access tokens
| {"tags": ["ClientInitialAccess"], "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}/clients/{id} | /{realm}/clients/{id} | {"put": {"tags": ["Client"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "get": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"tags": ["Client"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in":... |
keycloak-19.0.0.json | put | /
Update the client
| {"tags": ["Client"], "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
| {"tags": ["Client"], "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
/
| {"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}/certificates/{attr} | /{realm}/clients/{id}/certificates/{attr} | {"get": {"tags": ["ClientAttributeCertificate"], "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"}}, {"name": "attr", "in": ... |
keycloak-19.0.0.json | get | /
Get key info
| {"tags": ["ClientAttributeCertificate"], "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 | parameters | {"name": "attr", "in": "path", "required": true, "schema": {"type": "string"}} | |
keycloak-19.0.0.json | /{realm}/clients/{id}/certificates/{attr}/download | /{realm}/clients/{id}/certificates/{attr}/download | {"post": {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "s... |
keycloak-19.0.0.json | post | /
Get a keystore file for the client, containing private key and public certificate
| {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}} |
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": "attr", "in": "path", "required": true, "schema": {"type": "string"}} | |
keycloak-19.0.0.json | /{realm}/clients/{id}/certificates/{attr}/generate | /{realm}/clients/{id}/certificates/{attr}/generate | {"post": {"tags": ["ClientAttributeCertificate"], "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"}}, {"name": "attr", "in":... |
keycloak-19.0.0.json | post | /
Generate a new certificate with new key pair
| {"tags": ["ClientAttributeCertificate"], "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 | parameters | {"name": "attr", "in": "path", "required": true, "schema": {"type": "string"}} | |
keycloak-19.0.0.json | /{realm}/clients/{id}/certificates/{attr}/generate-and-download | /{realm}/clients/{id}/certificates/{attr}/generate-and-download | {"post": {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "s... |
keycloak-19.0.0.json | post | /
Generate a new keypair and certificate, and get the private key file
Generates a keypair and certificate and serves the private key in a specified keystore format.
Only generated public certificate is saved in Keycloak DB - the private key is not.
| {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}} |
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": "attr", "in": "path", "required": true, "schema": {"type": "string"}} | |
keycloak-19.0.0.json | /{realm}/clients/{id}/certificates/{attr}/upload | /{realm}/clients/{id}/certificates/{attr}/upload | {"post": {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object"}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", ... |
keycloak-19.0.0.json | post | /
Upload certificate and eventually private key
| {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object"}}}}, "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 | parameters | {"name": "attr", "in": "path", "required": true, "schema": {"type": "string"}} | |
keycloak-19.0.0.json | /{realm}/clients/{id}/certificates/{attr}/upload-certificate | /{realm}/clients/{id}/certificates/{attr}/upload-certificate | {"post": {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object"}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", ... |
keycloak-19.0.0.json | post | /
Upload only certificate, not private key
| {"tags": ["ClientAttributeCertificate"], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object"}}}}, "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 | parameters | {"name": "attr", "in": "path", "required": true, "schema": {"type": "string"}} | |
keycloak-19.0.0.json | /{realm}/clients/{id}/client-secret | /{realm}/clients/{id}/client-secret | {"post": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "get": {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in... |
keycloak-19.0.0.json | post | /
Generate a new secret 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 | get | /
Get the client secret
| {"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}/client-secret/rotated | /{realm}/clients/{id}/client-secret/rotated | {"delete": {"tags": ["Client"], "responses": {"2XX": {}}}, "get": {"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... |
keycloak-19.0.0.json | delete | /
Invalidate the rotated secret for the client
| {"tags": ["Client"], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | get | /
Get the rotated client secret
| {"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}/default-client-scopes | /{realm}/clients/{id}/default-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 default 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}/default-client-scopes/{clientScopeId} | /{realm}/clients/{id}/default-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": ... |
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}/evaluate-scopes/generate-example-access-token | /{realm}/clients/{id}/evaluate-scopes/generate-example-access-token | {"get": {"tags": ["ClientScopeEvaluate"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}, {"name": "userId", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": ... |
keycloak-19.0.0.json | get | /
Create JSON with payload of example access token
| {"tags": ["ClientScopeEvaluate"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}, {"name": "userId", "in": "query", "schema": {"type": "string"}}], "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}/evaluate-scopes/generate-example-id-token | /{realm}/clients/{id}/evaluate-scopes/generate-example-id-token | {"get": {"tags": ["ClientScopeEvaluate"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}, {"name": "userId", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": ... |
keycloak-19.0.0.json | get | /
Create JSON with payload of example id token
| {"tags": ["ClientScopeEvaluate"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}, {"name": "userId", "in": "query", "schema": {"type": "string"}}], "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}/evaluate-scopes/generate-example-userinfo | /{realm}/clients/{id}/evaluate-scopes/generate-example-userinfo | {"get": {"tags": ["ClientScopeEvaluate"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}, {"name": "userId", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "object"}}}}}}},... |
keycloak-19.0.0.json | get | /
Create JSON with payload of example user info
| {"tags": ["ClientScopeEvaluate"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}, {"name": "userId", "in": "query", "schema": {"type": "string"}}], "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 | 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}/evaluate-scopes/protocol-mappers | /{realm}/clients/{id}/evaluate-scopes/protocol-mappers | {"get": {"tags": ["ClientScopeEvaluate"], "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"}}, ... |
keycloak-19.0.0.json | get | /
Return list of all protocol mappers, which will be used when generating tokens issued for particular client. This means
protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.
| {"tags": ["ClientScopeEvaluate"], "parameters": [{"name": "scope", "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 | 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}/evaluate-scopes/scope-mappings/{roleContainerId}/granted | /{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/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":... |
keycloak-19.0.0.json | get | /
Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.
This contains scope mappings, which this client has directly, as well as scope mappings, which are granted to all client scopes,
which are linked with this client.
| {"tags": ["ClientScopeEvaluateScopeMappings"], "parameters": [{"name": "scope", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.