schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
keycloak-19.0.0.json | put | /
Update the role
| {"tags": ["RoleById"], "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 role | {"name": "role-id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/roles-by-id/{role-id}/composites | /{realm}/roles-by-id/{role-id}/composites | {"post": {"tags": ["RoleById"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}, "get": {"tags": ["RoleById"], "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"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "delete": {"tags": ["RoleById"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "role-id", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Make the role a composite role by associating some child roles
| {"tags": ["RoleById"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | get | /
Get role's children
Returns a set of role's children provided the role is a composite.
| {"tags": ["RoleById"], "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"}}], "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 a set of roles from the role's composite
| {"tags": ["RoleById"], "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 | {"name": "role-id", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid} | /{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid} | {"get": {"tags": ["RoleById"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "role-id", "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": ["RoleById"], "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 | {"name": "role-id", "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}/roles-by-id/{role-id}/composites/realm | /{realm}/roles-by-id/{role-id}/composites/realm | {"get": {"tags": ["RoleById"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "role-id", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get realm-level roles that are in the role's composite
| {"tags": ["RoleById"], "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 | {"name": "role-id", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/roles-by-id/{role-id}/management/permissions | /{realm}/roles-by-id/{role-id}/management/permissions | {"get": {"tags": ["RoleById"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["RoleById"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "role-id", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Return object stating whether role Authoirzation permissions have been initialized or not and a reference
| {"tags": ["RoleById"], "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 Authoirzation permissions have been initialized or not and a reference
| {"tags": ["RoleById"], "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 | {"name": "role-id", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/roles/{role-name} | /{realm}/roles/{role-name} | {"get": {"tags": ["RoleContainer"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"tags": ["RoleContainer"], "responses": {"2XX": {}}}, "put": {"tags": ["RoleContainer"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get a role by name
| {"tags": ["RoleContainer"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {}}}} |
keycloak-19.0.0.json | delete | /
Delete a role by name
| {"tags": ["RoleContainer"], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
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 | role's name (not id!) | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/roles/{role-name}/composites | /{realm}/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": "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 | role's name (not id!) | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/roles/{role-name}/composites/clients/{clientUuid} | /{realm}/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": "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 | 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}/roles/{role-name}/composites/realm | /{realm}/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": "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 | role's name (not id!) | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/roles/{role-name}/groups | /{realm}/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": "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 | the role name. | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/roles/{role-name}/management/permissions | /{realm}/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": "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 | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/roles/{role-name}/users | /{realm}/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": "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 | the role name. | {"name": "role-name", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/sessions/{session} | /{realm}/sessions/{session} | {"delete": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "session", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | delete | /
Remove a specific user session. Any client that has an admin url will also be told to invalidate this
particular session.
| {"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 | parameters | {"name": "session", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/testSMTPConnection | /{realm}/testSMTPConnection | {"post": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Test SMTP connection with current logged in user
| {"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}/users | /{realm}/users | {"post": {"tags": ["Users"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "get": {"tags": ["Users"], "parameters": [{"name": "search", "in": "query", "schema": {"type": "string"}}, {"name": "lastName", "in": "query", "schema": {"type": "string"}}, {"name": "firstName", "in": "query", "schema": {"type": "string"}}, {"name": "email", "in": "query", "schema": {"type": "string"}}, {"name": "username", "in": "query", "schema": {"type": "string"}}, {"name": "emailVerified", "in": "query", "schema": {"type": "boolean"}}, {"name": "idpAlias", "in": "query", "schema": {"type": "string"}}, {"name": "idpUserId", "in": "query", "schema": {"type": "string"}}, {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "enabled", "in": "query", "schema": {"type": "boolean"}}, {"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}, {"name": "exact", "in": "query", "schema": {"type": "boolean"}}, {"name": "q", "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 | post | /
Create a new user
Username must be unique.
| {"tags": ["Users"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | get | /
Get users
Returns a stream of users, filtered according to query parameters.
| {"tags": ["Users"], "parameters": [{"name": "search", "in": "query", "schema": {"type": "string"}}, {"name": "lastName", "in": "query", "schema": {"type": "string"}}, {"name": "firstName", "in": "query", "schema": {"type": "string"}}, {"name": "email", "in": "query", "schema": {"type": "string"}}, {"name": "username", "in": "query", "schema": {"type": "string"}}, {"name": "emailVerified", "in": "query", "schema": {"type": "boolean"}}, {"name": "idpAlias", "in": "query", "schema": {"type": "string"}}, {"name": "idpUserId", "in": "query", "schema": {"type": "string"}}, {"name": "first", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "max", "in": "query", "schema": {"type": "integer", "format": "int32"}}, {"name": "enabled", "in": "query", "schema": {"type": "boolean"}}, {"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}, {"name": "exact", "in": "query", "schema": {"type": "boolean"}}, {"name": "q", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}} |
keycloak-19.0.0.json | parameters | A String contained in username, first or last name, or email | {"name": "search", "in": "query", "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | A String contained in lastName, or the complete lastName, if param "exact" is true | {"name": "lastName", "in": "query", "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | A String contained in firstName, or the complete firstName, if param "exact" is true | {"name": "firstName", "in": "query", "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | A String contained in email, or the complete email, if param "exact" is true | {"name": "email", "in": "query", "schema": {"type": "string"}} |
keycloak-19.0.0.json | parameters | A String contained in username, or the complete username, if param "exact" is true | {"name": "username", "in": "query", "schema": {"type": "string"}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.