In this blog post I want to show, how to create a new realm with Keycloak REST API , because later I want to automate the Keycloak realm creation for a workshop using curl in a bash script.
The reason of that blog post is, that the information in the REST API documentation wasn’t detailed enough for me. The image shows what I found first in the Keycloak REST API documentation .
In common it’s very simple to use the Keycloak REST API. For more details see in my blog post Getting started to secure a simple Java Microservice with Keycloak, MicroProfile and OpenLiberty.
First you need a bearer authorization token for an administration user and with that token you create a new realm using the realm json exported before.
Here is what I found:
- … for the Authorization user for administrative tasks, I got the missing pieces in the Keycloak documentation here.
- … for the submit of the realm json, I got the missing pieces as a part of the answer on StackOverflow “Unable to create Keycloak realm via the rest admin API: Unsupported Media Type“.
I used POSTMAN to check it out. These are the steps I did in POSTMAN.
1. Authorize user for administrative tasks
These are the values I used for the REST API POST request to get the access_token.
In the following section you see the URL structure, the needed header and body with the values I used and also the response of the request.
- RESTful command: POST
- URL: https://KEYCLOAKSERVER/auth/realms/master/protocol/openid-connect/token
- Header:
| Key | Value |
| Content-Type | application/x-www-form-urlencoded |
- Body:
| Key | Value |
| grant_type | password |
| client_id | admin-cli |
| username | admin |
| password | admin |
- Response:
The image shows request response with the access_token, I used for the next realm creation request.
2. Create the realm
These are the values I used for the POST request to get the new realm.
In the following section you see the URL structure, the needed header and body with the values I used and also the response of the request.
- RESTful command: POST
- URL: https://KEYCLOAKSERVER/auth/admin/realms
- Header:
Copy the access_token value and past the token value into the authorization.
| Key | Value |
| Authorization | bearer access_token value |
| Content-Type | application/x-www-form-urlencoded |
- Body:
| raw | JSON(application/json) |
The image shows the body with the realm json, I used to create the new realm.
- Response:
The image below shows, now I got the 201 response and the new realm was created.
I verified the creation in the Keycloak server instance, and you see in the following image “it worked”.
The objective of this blog post is to share with you an extract of the “simple” example project on GitHub I created to get started with: How to access a Java Microservice using the Open Source Identity and Access Management with Keycloak and JavaWebToken (JWT).