Keycloak REST Services 1.5.0-Final
Resources
ResourceDescriptionMethods
/admin/realmsReturns a list of realms.GET, POST, POST
/admin/realms/{realm}Get the top-level representation of the realm.GET, PUT, DELETE
/admin/realms/{realm}/admin-eventsQuery admin events.GET, DELETE
/admin/realms/{realm}/attack-detection/brute-force/usernamesClear any user login failures for all users.DELETE
/admin/realms/{realm}/attack-detection/brute-force/usernames/{username}Get status of a username in brute force detectionGET, DELETE
/admin/realms/{realm}/authentication/authenticator-providersGET
/admin/realms/{realm}/authentication/client-authenticator-providersGET
/admin/realms/{realm}/authentication/configPOST
/admin/realms/{realm}/authentication/config/{id}GET, DELETE, PUT
/admin/realms/{realm}/authentication/config-description/{providerId}GET
/admin/realms/{realm}/authentication/executionsPOST
/admin/realms/{realm}/authentication/executions/{executionId}DELETE
/admin/realms/{realm}/authentication/executions/{executionId}/configPOST
/admin/realms/{realm}/authentication/executions/{executionId}/config/{id}GET
/admin/realms/{realm}/authentication/executions/{executionId}/lower-priorityPOST
/admin/realms/{realm}/authentication/executions/{executionId}/raise-priorityPOST
/admin/realms/{realm}/authentication/flowsGET, POST
/admin/realms/{realm}/authentication/flows/{flowAlias}/copyPOST
/admin/realms/{realm}/authentication/flows/{flowAlias}/executionsGET, PUT
/admin/realms/{realm}/authentication/flows/{flowAlias}/executions/executionPOST
/admin/realms/{realm}/authentication/flows/{flowAlias}/executions/flowPOST
/admin/realms/{realm}/authentication/flows/{id}GET, DELETE
/admin/realms/{realm}/authentication/form-action-providersGET
/admin/realms/{realm}/authentication/form-providersGET
/admin/realms/{realm}/authentication/per-client-config-descriptionGET
/admin/realms/{realm}/authentication/register-required-actionPOST
/admin/realms/{realm}/authentication/required-actionsGET
/admin/realms/{realm}/authentication/required-actions/{alias}GET, PUT, DELETE
/admin/realms/{realm}/authentication/unregistered-required-actionsGET
/admin/realms/{realm}/client-session-statsReturns a JSON map.GET
/admin/realms/{realm}/clientsList of clients belonging to this realm.GET, POST
/admin/realms/{realm}/clients/{id}Get representation of the client.PUT, GET, DELETE
/admin/realms/{realm}/clients/{id}/allowed-originsReturns set of allowed origin.GET, PUT, DELETE
/admin/realms/{realm}/clients/{id}/certificates/{attr}GET
/admin/realms/{realm}/clients/{id}/certificates/{attr}/downloadPOST
/admin/realms/{realm}/clients/{id}/certificates/{attr}/generatePOST
/admin/realms/{realm}/clients/{id}/certificates/{attr}/generate-and-downloadGenerate new keypair and certificate and downloads private key into specified keystore format.POST
/admin/realms/{realm}/clients/{id}/certificates/{attr}/uploadUpload certificate and eventually private keyPOST
/admin/realms/{realm}/clients/{id}/certificates/{attr}/upload-certificateUpload only certificate, not private keyPOST
/admin/realms/{realm}/clients/{id}/client-secretGet the secret of this clientPOST, GET
/admin/realms/{realm}/clients/{id}/installation/jbossReturn XML that can be included in the JBoss/Wildfly Keycloak subsystem to configure the adapter of that client.GET
/admin/realms/{realm}/clients/{id}/installation/jsonReturn keycloak.json file for this client to be used to configure the adapter of that client.GET
/admin/realms/{realm}/clients/{id}/logout-allIf the client has an admin URL, invalidate all sessions associated with that client directly.POST
/admin/realms/{realm}/clients/{id}/logout-user/{username}If the client has an admin URL, invalidate the sessions for a particular user directly.POST
/admin/realms/{realm}/clients/{id}/nodesManually register cluster node to this client - usually it's not needed to call this directly as adapter should handle by sending registration request to KeycloakPOST
/admin/realms/{realm}/clients/{id}/nodes/{node}Unregister cluster node from this clientDELETE
/admin/realms/{realm}/clients/{id}/protocol-mappers/add-modelscreates multiple mapperPOST
/admin/realms/{realm}/clients/{id}/protocol-mappers/modelscreates mapperPOST, GET
/admin/realms/{realm}/clients/{id}/protocol-mappers/models/{id}GET, PUT, DELETE
/admin/realms/{realm}/clients/{id}/protocol-mappers/protocol/{protocol}Map of mappers by name for a specific protocolGET
/admin/realms/{realm}/clients/{id}/push-revocationIf the client has an admin URL, push the client's revocation policy to it.POST
/admin/realms/{realm}/clients/{id}/rolesList all roles for this realm or clientGET, POST
/admin/realms/{realm}/clients/{id}/roles/{role-name}Get a role by nameGET, DELETE, PUT
/admin/realms/{realm}/clients/{id}/roles/{role-name}/compositesList composites of this rolePOST, GET, DELETE
/admin/realms/{realm}/clients/{id}/roles/{role-name}/composites/clients/{client}An app-level roles for a specific app for this role's compositeGET
/admin/realms/{realm}/clients/{id}/roles/{role-name}/composites/realmGet realm-level roles of this role's compositeGET
/admin/realms/{realm}/clients/{id}/scope-mappingsGet all scope mappings for this clientGET
/admin/realms/{realm}/clients/{id}/scope-mappings/clients/{client}Get the roles associated with a client's scope for a specific client.GET, POST, DELETE
/admin/realms/{realm}/clients/{id}/scope-mappings/clients/{client}/availableThe available client-level roles that can be associated with the client's scopeGET
/admin/realms/{realm}/clients/{id}/scope-mappings/clients/{client}/compositeGet effective client roles that are associated with the client's scope for a specific client.GET
/admin/realms/{realm}/clients/{id}/scope-mappings/realmGet list of realm-level roles associated with this client's scope.GET, POST, DELETE
/admin/realms/{realm}/clients/{id}/scope-mappings/realm/availableGet list of realm-level roles that are available to attach to this client's scope.GET
/admin/realms/{realm}/clients/{id}/scope-mappings/realm/compositeGet all effective realm-level roles that are associated with this client's scope.GET
/admin/realms/{realm}/clients/{id}/service-account-userReturns user dedicated to this service accountGET
/admin/realms/{realm}/clients/{id}/session-countNumber of user sessions associated with this client { "count": number }GET
/admin/realms/{realm}/clients/{id}/test-nodes-availableTest if registered cluster nodes are available by sending 'ping' request to all of themGET
/admin/realms/{realm}/clients/{id}/user-sessionsReturn a list of user sessions associated with this clientGET
/admin/realms/{realm}/eventsQuery events.GET, DELETE
/admin/realms/{realm}/events/configView the events provider and how it is configured.GET, PUT
/admin/realms/{realm}/identity-provider/import-configPOST, POST
/admin/realms/{realm}/identity-provider/instancesGET, POST
/admin/realms/{realm}/identity-provider/instances/{alias}GET, DELETE, PUT
/admin/realms/{realm}/identity-provider/instances/{alias}/exportGET
/admin/realms/{realm}/identity-provider/instances/{alias}/mapper-typesGET
/admin/realms/{realm}/identity-provider/instances/{alias}/mappersGET, POST
/admin/realms/{realm}/identity-provider/instances/{alias}/mappers/{id}GET, PUT, DELETE
/admin/realms/{realm}/identity-provider/providers/{provider_id}GET
/admin/realms/{realm}/logout-allRemoves all user sessions.POST
/admin/realms/{realm}/push-revocationPush the realm's revocation policy to any client that has an admin url associated with it.POST
/admin/realms/{realm}/rolesList all roles for this realm or clientGET, POST
/admin/realms/{realm}/roles/{role-name}Get a role by nameGET, DELETE, PUT
/admin/realms/{realm}/roles/{role-name}/compositesList composites of this rolePOST, GET, DELETE
/admin/realms/{realm}/roles/{role-name}/composites/clients/{client}An app-level roles for a specific app for this role's compositeGET
/admin/realms/{realm}/roles/{role-name}/composites/realmGet realm-level roles of this role's compositeGET
/admin/realms/{realm}/roles-by-id/{role-id}Get a specific role's representationGET, DELETE, PUT
/admin/realms/{realm}/roles-by-id/{role-id}/compositesIf this role is a composite, return a set of its childrenPOST, GET, DELETE
/admin/realms/{realm}/roles-by-id/{role-id}/composites/clients/{client}Return a set of client-level roles for a specific client that are in the role's compositeGET, GET
/admin/realms/{realm}/roles-by-id/{role-id}/composites/realmReturn a set of realm-level roles that are in the role's compositeGET
/admin/realms/{realm}/sessions/{session}Remove a specific user session.DELETE
/admin/realms/{realm}/testLDAPConnectionGET
/admin/realms/{realm}/user-federation/instanceslist configured providersPOST, GET
/admin/realms/{realm}/user-federation/instances/{id}get a providerPUT, GET, DELETE
/admin/realms/{realm}/user-federation/instances/{id}/mapper-typesList of available User Federation mapper typesGET
/admin/realms/{realm}/user-federation/instances/{id}/mappersGet mappers configured for this providerGET, POST
/admin/realms/{realm}/user-federation/instances/{id}/mappers/{id}Get mapperGET, PUT, DELETE
/admin/realms/{realm}/user-federation/instances/{id}/synctrigger sync of usersPOST
/admin/realms/{realm}/user-federation/providersGet List of available provider factoriesGET
/admin/realms/{realm}/user-federation/providers/{id}Get factory with given IDGET
/admin/realms/{realm}/usersQuery list of users.POST, GET
/admin/realms/{realm}/users/{id}Get represenation of the userPUT, GET, DELETE
/admin/realms/{realm}/users/{id}/consentsList set of consents granted by this user.GET
/admin/realms/{realm}/users/{id}/consents/{client}Revoke consent for particular clientDELETE
/admin/realms/{realm}/users/{id}/execute-actions-emailSend an email to the user with a link they can click to reset their password.PUT
/admin/realms/{realm}/users/{id}/federated-identityList set of social logins associated with this user.GET
/admin/realms/{realm}/users/{id}/federated-identity/{provider}POST, DELETE
/admin/realms/{realm}/users/{id}/impersonationPOST
/admin/realms/{realm}/users/{id}/logoutRemove all user sessions associated with this user.POST
/admin/realms/{realm}/users/{id}/remove-totpPUT
/admin/realms/{realm}/users/{id}/reset-passwordSet up a temporary password for this user.PUT
/admin/realms/{realm}/users/{id}/role-mappingsGet role mappings for this userGET
/admin/realms/{realm}/users/{id}/role-mappings/clients/{client}Get client-level role mappings for this user for a specific appGET, POST, DELETE
/admin/realms/{realm}/users/{id}/role-mappings/clients/{client}/availableGet available client-level roles that can be mapped to the userGET
/admin/realms/{realm}/users/{id}/role-mappings/clients/{client}/compositeGet effective client-level role mappings.GET
/admin/realms/{realm}/users/{id}/role-mappings/realmGet realm-level role mappings for this userGET, POST, DELETE
/admin/realms/{realm}/users/{id}/role-mappings/realm/availableRealm-level roles that can be mapped to this userGET
/admin/realms/{realm}/users/{id}/role-mappings/realm/compositeEffective realm-level role mappings for this user.GET
/admin/realms/{realm}/users/{id}/send-verify-emailSend an email to the user with a link they can click to verify their email address.PUT
/admin/realms/{realm}/users/{id}/sessionsList set of sessions associated with this user.GET
/admin/serverinfoReturns a list of themes, social providers, auth providers, and event listeners available on this serverGET

Keycloak REST Services 1.5.0-Final