schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
keycloak-19.0.0.json | post | /
Create a new identity provider
| {"tags": ["IdentityProviders"], "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}/identity-provider/instances/{alias} | /{realm}/identity-provider/instances/{alias} | {"get": {"tags": ["IdentityProvider"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"tags": ["IdentityProvider"], "responses": {"2XX": {}}}, "put": {"tags": ["IdentityProvider"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get the identity provider
| {"tags": ["IdentityProvider"], "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 identity provider
| {"tags": ["IdentityProvider"], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | put | /
Update the identity provider
| {"tags": ["IdentityProvider"], "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}/identity-provider/instances/{alias}/export | /{realm}/identity-provider/instances/{alias}/export | {"get": {"tags": ["IdentityProvider"], "parameters": [{"name": "format", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Export public broker configuration for identity provider
| {"tags": ["IdentityProvider"], "parameters": [{"name": "format", "in": "query", "schema": {"type": "string"}}], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | parameters | Format to use | {"name": "format", "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 | /{realm}/identity-provider/instances/{alias}/management/permissions | /{realm}/identity-provider/instances/{alias}/management/permissions | {"get": {"tags": ["IdentityProvider"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["IdentityProvider"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Return object stating whether client Authorization permissions have been initialized or not and a reference
| {"tags": ["IdentityProvider"], "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 client Authorization permissions have been initialized or not and a reference
| {"tags": ["IdentityProvider"], "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 | /{realm}/identity-provider/instances/{alias}/mapper-types | /{realm}/identity-provider/instances/{alias}/mapper-types | {"get": {"tags": ["IdentityProvider"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get mapper types for identity provider
/
| {"tags": ["IdentityProvider"], "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}/identity-provider/instances/{alias}/mappers | /{realm}/identity-provider/instances/{alias}/mappers | {"get": {"tags": ["IdentityProvider"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["IdentityProvider"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get mappers for identity provider
/
| {"tags": ["IdentityProvider"], "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 mapper to identity provider
| {"tags": ["IdentityProvider"], "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}/identity-provider/instances/{alias}/mappers/{id} | /{realm}/identity-provider/instances/{alias}/mappers/{id} | {"get": {"tags": ["IdentityProvider"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "put": {"tags": ["IdentityProvider"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["IdentityProvider"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "alias", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "id", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get mapper by id for the identity provider
| {"tags": ["IdentityProvider"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {}}}} |
keycloak-19.0.0.json | put | /
Update a mapper for the identity provider
| {"tags": ["IdentityProvider"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | delete | /
Delete a mapper for the identity provider
| {"tags": ["IdentityProvider"], "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": "id", "in": "path", "required": true, "schema": {"type": "string"}} |
|
keycloak-19.0.0.json | /{realm}/identity-provider/providers/{provider_id} | /{realm}/identity-provider/providers/{provider_id} | {"get": {"tags": ["IdentityProviders"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "provider_id", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get identity providers
| {"tags": ["IdentityProviders"], "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 | Provider id | {"name": "provider_id", "in": "path", "required": true, "schema": {"type": "string"}} |
keycloak-19.0.0.json | /{realm}/keys | /{realm}/keys | {"get": {"tags": ["Key"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Base path for the admin REST API for one particular realm.
| {"tags": ["Key"], "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 | /{realm}/localization | /{realm}/localization | {"get": {"tags": ["RealmLocalization"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Base path for managing localization under this realm.
/
| {"tags": ["RealmLocalization"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}} |
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}/localization/{locale} | /{realm}/localization/{locale} | {"post": {"tags": ["RealmLocalization"], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object"}}, "application/json": {"schema": {"type": "object"}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["RealmLocalization"], "responses": {"2XX": {}}}, "get": {"tags": ["RealmLocalization"], "parameters": [{"name": "useRealmDefaultLocaleFallback", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "locale", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Import localization from uploaded JSON file
/
| {"tags": ["RealmLocalization"], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object"}}, "application/json": {"schema": {"type": "object"}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | delete | /
Base path for managing localization under this realm.
/
| {"tags": ["RealmLocalization"], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | get | /
Base path for managing localization under this realm.
/
| {"tags": ["RealmLocalization"], "parameters": [{"name": "useRealmDefaultLocaleFallback", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}} |
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}/localization/{locale}/{key} | /{realm}/localization/{locale}/{key} | {"put": {"tags": ["RealmLocalization"], "requestBody": {"content": {"text/plain": {"schema": {"type": "string"}}}}, "responses": {"2XX": {}}}, "delete": {"tags": ["RealmLocalization"], "responses": {"2XX": {}}}, "get": {"tags": ["RealmLocalization"], "responses": {"2XX": {"content": {"text/plain": {"schema": {"type": "string"}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "locale", "in": "path", "required": true, "schema": {"type": "string"}}, {"name": "key", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | put | /
Base path for managing localization under this realm.
/
| {"tags": ["RealmLocalization"], "requestBody": {"content": {"text/plain": {"schema": {"type": "string"}}}}, "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | delete | /
Base path for managing localization under this realm.
/
| {"tags": ["RealmLocalization"], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
keycloak-19.0.0.json | get | /
Base path for managing localization under this realm.
/
| {"tags": ["RealmLocalization"], "responses": {"2XX": {"content": {"text/plain": {"schema": {"type": "string"}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"text/plain": {"schema": {"type": "string"}}}} |
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}/logout-all | /{realm}/logout-all | {"post": {"tags": ["RealmAdmin"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object"}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Removes all user sessions. Any client that has an admin url will also be told to invalidate any sessions
they have.
/
| {"tags": ["RealmAdmin"], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "object"}}}}}} |
keycloak-19.0.0.json | 2XX | Success | {"content": {"application/json": {"schema": {"type": "object"}}}} |
keycloak-19.0.0.json | schema | GlobalRequestResult | {"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 | /{realm}/partial-export | /{realm}/partial-export | {"post": {"tags": ["RealmAdmin"], "parameters": [{"name": "exportGroupsAndRoles", "in": "query", "schema": {"type": "boolean"}}, {"name": "exportClients", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Partial export of existing realm into a JSON file.
| {"tags": ["RealmAdmin"], "parameters": [{"name": "exportGroupsAndRoles", "in": "query", "schema": {"type": "boolean"}}, {"name": "exportClients", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}} |
keycloak-19.0.0.json | parameters | {"name": "exportGroupsAndRoles", "in": "query", "schema": {"type": "boolean"}} |
|
keycloak-19.0.0.json | parameters | {"name": "exportClients", "in": "query", "schema": {"type": "boolean"}} |
|
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 | /{realm}/partialImport | /{realm}/partialImport | {"post": {"tags": ["RealmAdmin"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Partial import from a JSON file to an existing realm.
| {"tags": ["RealmAdmin"], "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}/push-revocation | /{realm}/push-revocation | {"post": {"tags": ["RealmAdmin"], "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | post | /
Push the realm's revocation policy to any client that has an admin url associated with it.
/
| {"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}/roles | /{realm}/roles | {"get": {"tags": ["RoleContainer"], "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"}}, {"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "responses": {"2XX": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}}, "post": {"tags": ["RoleContainer"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"2XX": {}}}, "parameters": [{"name": "realm", "in": "path", "required": true, "schema": {"type": "string"}}]} |
keycloak-19.0.0.json | get | /
Get all roles for the realm or client
| {"tags": ["RoleContainer"], "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"}}, {"name": "briefRepresentation", "in": "query", "schema": {"type": "boolean"}}], "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 | /
Create a new role for the realm or client
| {"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 | /{realm}/roles-by-id/{role-id} | /{realm}/roles-by-id/{role-id} | {"get": {"tags": ["RoleById"], "responses": {"2XX": {"content": {"application/json": {"schema": {}}}}}}, "delete": {"tags": ["RoleById"], "responses": {"2XX": {}}}, "put": {"tags": ["RoleById"], "requestBody": {"content": {"application/json": {"schema": {}}}}, "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 | get | /
Get a specific role's representation
| {"tags": ["RoleById"], "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 role
| {"tags": ["RoleById"], "responses": {"2XX": {}}} |
keycloak-19.0.0.json | 2XX | Success | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.