KeyCloak

Keycloak is an open-source identity and access management (IAM) solution that provides comprehensive authentication, authorization, and single sign-on (SSO) capabilities for modern applications and services. It serves as a centralized identity provider and security gateway, enabling organizations to manage user identities, credentials, roles, groups, and access policies across their entire application ecosystem.

Category	Identity
Direction	Query source
Sign-in	Admin User
Query languages	SQLite
Website	www.keycloak.org

Before you start

Huntbase signs in to KeyCloak with Admin User. Create the credential in KeyCloak first, then keep it to hand for the Connect step.

1. In the Keycloak Admin Console, switch to the realm you want to query, open Users, and select Add user.
2. On the user's Credentials tab, set a password, turn Temporary to Off, and click Set Password.
3. On the Role mapping tab, click Assign role, filter by clients, and select roles from the realm-management client.

Permissions:

• Read-only realm-management roles such as view-users, view-clients, view-events and view-identity-providers, instead of realm-admin.

Watch out for

• The connection signs in to the realm you enter, so create the user in that realm, not in master, unless you're querying master.

For the vendor's own instructions, see Keycloak Server Administration Guide.

tip

Use a dedicated, read-only credential for Huntbase where the product allows it. Huntbase only needs to read.

Connect KeyCloak

1. Go to Connections and click New connection, or click New connection on the KeyCloak product page.
2. On Product, pick KeyCloak and choose the Owner.
3. On Details, give the connection a Name and, optionally, a Description.
4. On Connect, fill in the settings and credentials described below.
5. On Verify, review the summary and click Create & check.

For everything else on the setup page — saving a draft, I'll do this later, and what each check result means — see Connections.

Settings

Where your KeyCloak lives:

Field	Required	Notes
Base URL	No	The root URL of your Keycloak server, such as https://sso.mycompany.com/.
Realm	No	The realm you want to query. The admin user must belong to this realm.
Admin Username	Yes	The username of the admin user you created.

Credentials

The only Method is Admin User. Enter a Credential label (for example Production), then fill in:

Field	Required	Notes
Admin Password	Yes	Secret — not shown again after you save it.

Query it

Once connected, KeyCloak can serve these languages in a query tab, and Scout can use it when you ask in Auto:

Language	Use it for
SQLite	SQL across this source and every other connected source.

Next steps

• Connections — health, credentials and settings after you connect
• Query languages — syntax, parameters and time ranges
• Chatting with Scout — ask questions without writing a query
• All integrations — the rest of the catalog