Auth
This guide assists with setting up Keycloak on your developer portal. Follow the steps below:
1. Access your devportal Admin-UI, click on "Go to settings"and select “Auth” and then "keycloak" in sidebar menu.
2. Fill in the data according to your Keycloak, and then click "Save".
Below, we provide a table with descriptions of the fields you need to fill in.
- Keycloak
| Field | Description |
|---|---|
| Metadata url | Your well-known url. |
| Client Id | Your keycloak clientId. |
| Client secret | The URL of the Keycloak API. For self-hosted installations, it is commonly at https://host/api/v4. For Keycloak.com, this configuration is not needed as it can be inferred. |
| Host | Location of the Keycloak server. Note that the newer versions of Keycloak omit the /auth context path. |
| Realm | Realm to synchronize. |
| Login realm | Realm used to authenticate. |
| Username | Username to authenticate. |
| Password | Password to authenticate. |
| Frequency | Time in minutes to refresh the catalog. |
| Timeout | Time in minutes to timeout after the refresh request. |
3.After filling out the necessary information, click on “Preview” in the left-hand side menu.
4. On the preview page, you can view all the set information and redeploy the application to upload the new settings. To do this, simply click on "Apply and Re-deploy".
Additional Important Information on Authentication:
If you already have a Keycloak setup and wish to configure a client for Devportal, add the Devportal client to your Keycloak realm. Then, reference the client ID and client secret information in the Admin UI.
Creating a Realm
In Keycloak, a Realm is essentially a logical grouping. Within a Realm, you’ll find users, credentials, profiles, and groups. It’s crucial to note that each Realm is entirely isolated from others. This means you can only manage users within the specific Realm itself.