keycloak-rest-registration/README.md

Registration API Provider

Keycloak Provider for performing realm registration via REST API. After registration the user is automatically signed in and redirected to a customizable target URI.

Supported are both HTTP Form requests and XHR requests.

How to install this provider

To install the provider you will need to aquire the JAR file of the provider. You can either do that by downloading it from the repository artifacts or building it yourself (see build instructions below.).

Once you have the JAR file put it in the /opt/keycloak/providers folder of Keycloak and restart Keycloak.

The end-point demo form will be accessible under /realms/your-realm/register.

How to build this provider

To use this provider in Keycloak run the following command:

Unix/Mac: ./gradlew jar Windows: gradlew.bat jar

Then copy the jar from build/libs/ folder into your Keycloak /opt/keycloak/providers folder and restart Keycloak.

A demo docker-compose.yml file has been provided in the repository as an example.