schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
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}/groups/{groupId} | /{realm}/users/{id}/groups/{groupId} | {"delete": {"tags": ["User"], "responses": {"2XX": {}}}, "put": {"tags": ["User"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "groupId", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | delete | /
Get representation of the user
| {"tags": ["User"], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | put | /
Get representation 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 | /{realm}/users/{id}/groups/count | /{realm}/users/{id}/groups/count | {"get": {"tags": ["User"], "parameters": [{"name": "search", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "integer", "format": "int64"}}}}}}}, "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"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "integer", "format": "int64"}}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "integer", "format": "int64"}}}}} |
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}/impersonation | /{realm}/users/{id}/impersonation | {"post": {"tags": ["User"], "responses": {"2XX": {"content": {"application/json": {"schema": {"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 | post | /
Impersonate the user
| {"tags": ["User"], "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 | User id | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/users/{id}/logout | /{realm}/users/{id}/logout | {"post": {"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 | post | /
Remove all user sessions associated with the user
Also send notification to all clients that have an admin URL to invalidate the sessions for the particular 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}/offline-sessions/{clientUuid} | /{realm}/users/{id}/offline-sessions/{clientUuid} | {"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"}}, {"name": "clientUuid", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get offline sessions associated with the user and client
| {"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}/reset-password | /{realm}/users/{id}/reset-password | {"put": {"tags": ["User"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "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 | /
Set up a new password for the user.
| {"tags": ["User"], "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 | User id | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/users/{id}/reset-password-email | /{realm}/users/{id}/reset-password-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"}}], "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 an email to the user with a link they can click to reset their password.
The redirectUri and clientId parameters are optional. The default for the
redirect is the account client.
This endpoint has been deprecated. Please use the execute-actions-email passing a list with
UPDATE_PASSWORD within it.
| {"tags": ["User"], "parameters": [{"name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "schema": {"type": "string"}}, {"name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "schema": {"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 | 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}/role-mappings | /{realm}/users/{id}/role-mappings | {"get": {"tags": ["RoleMapper"], "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 role mappings
| {"tags": ["RoleMapper"], "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 | User id | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/users/{id}/role-mappings/clients/{client} | /{realm}/users/{id}/role-mappings/clients/{client} | {"get": {"tags": ["ClientRoleMappings"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["ClientRoleMappings"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["ClientRoleMappings"], "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 client-level role mappings for the user, and the app
| {"tags": ["ClientRoleMappings"], "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 user role mapping
| {"tags": ["ClientRoleMappings"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | delete | /
Delete client-level roles from user role mapping
| {"tags": ["ClientRoleMappings"], "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 | User id | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/users/{id}/role-mappings/clients/{client}/available | /{realm}/users/{id}/role-mappings/clients/{client}/available | {"get": {"tags": ["ClientRoleMappings"], "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 available client-level roles that can be mapped to the user
| {"tags": ["ClientRoleMappings"], "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}/role-mappings/clients/{client}/composite | /{realm}/users/{id}/role-mappings/clients/{client}/composite | {"get": {"tags": ["ClientRoleMappings"], "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-level role mappings
This recurses any composite roles
| {"tags": ["ClientRoleMappings"], "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 | User id | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/users/{id}/role-mappings/realm | /{realm}/users/{id}/role-mappings/realm | {"get": {"tags": ["RoleMapper"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["RoleMapper"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["RoleMapper"], "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 role mappings
| {"tags": ["RoleMapper"], "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 realm-level role mappings to the user
| {"tags": ["RoleMapper"], "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | delete | /
Delete realm-level role mappings
| {"tags": ["RoleMapper"], "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 | User id | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/users/{id}/role-mappings/realm/available | /{realm}/users/{id}/role-mappings/realm/available | {"get": {"tags": ["RoleMapper"], "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 can be mapped
| {"tags": ["RoleMapper"], "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}/role-mappings/realm/composite | /{realm}/users/{id}/role-mappings/realm/composite | {"get": {"tags": ["RoleMapper"], "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 role mappings
This will recurse all composite roles to get the result.
| {"tags": ["RoleMapper"], "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 | User id | {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/users/{id}/send-verify-email | /{realm}/users/{id}/send-verify-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"}}], "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 an email-verification email to the user
An email contains a link the user can click to verify their email address.
The redirectUri and clientId parameters are optional. The default for the
redirect is the account client.
| {"tags": ["User"], "parameters": [{"name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "schema": {"type": "string"}}, {"name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "schema": {"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 | 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}/sessions | /{realm}/users/{id}/sessions | {"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 sessions 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/count | /{realm}/users/count | {"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": "emailVerified", "in": "query", "schema": {"type": "boolean"}}, {"name": "username", "in": "query", "schema": {"type": "string"}}, {"name": "enabled", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "integer", "format": "int32"}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Returns the number of users that match the given criteria.
It can be called in three different ways.
1. Don't specify any criteria and pass { | {"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": "emailVerified", "in": "query", "schema": {"type": "boolean"}}, {"name": "username", "in": "query", "schema": {"type": "string"}}, {"name": "enabled", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "integer", "format": "int32"}}}}}} |
keycloak-19.0.0.json | parameters | arbitrary search string for all the fields below | {"name": "search", "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.