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": {"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-templates/{id} | /{realm}/client-templates/{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-templates/{id}/protocol-mappers/add-models | /{realm}/client-templates/{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-templates/{id}/protocol-mappers/models | /{realm}/client-templates/{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-templates/{id}/protocol-mappers/protocol/{protocol} | /{realm}/client-templates/{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-templates/{id}/scope-mappings | /{realm}/client-templates/{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-templates/{id}/scope-mappings/clients/{client} | /{realm}/client-templates/{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-templates/{id}/scope-mappings/clients/{client}/available | /{realm}/client-templates/{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-templates/{id}/scope-mappings/clients/{client}/composite | /{realm}/client-templates/{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-templates/{id}/scope-mappings/realm | /{realm}/client-templates/{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-templates/{id}/scope-mappings/realm/available | /{realm}/client-templates/{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-templates/{id}/scope-mappings/realm/composite | /{realm}/client-templates/{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-templates/{id1}/protocol-mappers/models/{id2} | /{realm}/client-templates/{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}/clients | /{realm}/clients | {"get": {"tags": ["Clients"], "parameters": [{"name": "clientId", "in": "query", "schema": {"type": "string"}}, {"name": "viewableOnly", "in": "query", "schema": {"type": "boolean"}}, {"name": "search", "in": "query", "schema": {"type": "boolean"}}, {"name": "q", "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": {}}}}}}}, "post": {"tags": ["Clients"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get clients belonging to the realm.
If a client can't be retrieved from the storage due to a problem with the underlying storage,
it is silently removed from the returned list.
This ensures that concurrent modifications to the list don't prevent callers from retrieving this list.
| {"tags": ["Clients"], "parameters": [{"name": "clientId", "in": "query", "schema": {"type": "string"}}, {"name": "viewableOnly", "in": "query", "schema": {"type": "boolean"}}, {"name": "search", "in": "query", "schema": {"type": "boolean"}}, {"name": "q", "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 | filter by clientId | {"name": "clientId", "in": "query", "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | filter clients that cannot be viewed in full by admin | {"name": "viewableOnly", "in": "query", "schema": {"type": "boolean"}} |
keycloak-19.0.0.json | parameters | whether this is a search query or a getClientById query | {"name": "search", "in": "query", "schema": {"type": "boolean"}} |
keycloak-19.0.0.json | parameters | the first result | {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}} |
keycloak-19.0.0.json | parameters | the max results to return | {"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 | post | /
Create a new client
Client's client_id must be unique!
| {"tags": ["Clients"], "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}/clients-initial-access | /{realm}/clients-initial-access | {"post": {"tags": ["ClientInitialAccess"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "get": {"tags": ["ClientInitialAccess"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Create a new initial access token.
| {"tags": ["ClientInitialAccess"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {}}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.