schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
keycloak-19.0.0.json | put | /
Update a role by name
| {"tags": ["RoleContainer"], "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 | id of client (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | role's name (not id!) | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/roles/{role-name}/composites | /{realm}/clients/{id}/roles/{role-name}/composites | {"post": {"tags": ["RoleContainer"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}, "get": {"tags": ["RoleContainer"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "delete": {"tags": ["RoleContainer"], "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": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Add a composite to the role
| {"tags": ["RoleContainer"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | get | /
Get composites of the role
| {"tags": ["RoleContainer"], "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 | delete | /
Remove roles from the role's composite
| {"tags": ["RoleContainer"], "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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | role's name (not id!) | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/roles/{role-name}/composites/clients/{clientUuid} | /{realm}/clients/{id}/roles/{role-name}/composites/clients/{clientUuid} | {"get": {"tags": ["RoleContainer"], "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": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "clientUuid", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get client-level roles for the client that are in the role's composite
| {"tags": ["RoleContainer"], "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 | parameters | role's name (not id!) | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | {"name": "clientUuid", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/clients/{id}/roles/{role-name}/composites/realm | /{realm}/clients/{id}/roles/{role-name}/composites/realm | {"get": {"tags": ["RoleContainer"], "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": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get realm-level roles of the role's composite
| {"tags": ["RoleContainer"], "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 | parameters | role's name (not id!) | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/roles/{role-name}/groups | /{realm}/clients/{id}/roles/{role-name}/groups | {"get": {"tags": ["RoleContainer"], "parameters": [{"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"}}, {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Returns a stream of groups that have the specified role name
| {"tags": ["RoleContainer"], "parameters": [{"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 | parameters | first result to return. Ignored if negative or {@code null}. | {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}} |
keycloak-19.0.0.json | parameters | maximum number of results to return. Ignored if negative or {@code null}. | {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}} |
keycloak-19.0.0.json | parameters | if false, return a full representation of the {@code GroupRepresentation} objects. | {"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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | the role name. | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/roles/{role-name}/management/permissions | /{realm}/clients/{id}/roles/{role-name}/management/permissions | {"get": {"tags": ["RoleContainer"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["RoleContainer"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "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": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Return object stating whether role Authorization permissions have been initialized or not and a reference
| {"tags": ["RoleContainer"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {}}}} |
keycloak-19.0.0.json | put | /
Return object stating whether role Authorization permissions have been initialized or not and a reference
| {"tags": ["RoleContainer"], "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 | parameters | id of client (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/clients/{id}/roles/{role-name}/users | /{realm}/clients/{id}/roles/{role-name}/users | {"get": {"tags": ["RoleContainer"], "parameters": [{"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": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Returns a stream of users that have the specified role name.
| {"tags": ["RoleContainer"], "parameters": [{"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 | first result to return. Ignored if negative or {@code null}. | {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}} |
keycloak-19.0.0.json | parameters | maximum number of results to return. Ignored if negative or {@code null}. | {"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 | 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 | the role name. | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/scope-mappings | /{realm}/clients/{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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/scope-mappings/clients/{client} | /{realm}/clients/{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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/scope-mappings/clients/{client}/available | /{realm}/clients/{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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/scope-mappings/clients/{client}/composite | /{realm}/clients/{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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/scope-mappings/realm | /{realm}/clients/{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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/scope-mappings/realm/available | /{realm}/clients/{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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/scope-mappings/realm/composite | /{realm}/clients/{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 (not client-id) | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/clients/{id}/service-account-user | /{realm}/clients/{id}/service-account-user | {"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": "string"}}]} |
keycloak-19.0.0.json | get | /
Get a user dedicated to the service account
| {"tags": ["Client"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.