Skip to content
Tutorials Center
My learning

Topics

Lesson 4 of 37 ยท Getting Started

A Tour of the Keycloak Admin Console

Walk through the Keycloak admin console menu by menu: realms, clients, users, roles, groups, sessions, events, authentication and realm settings, plus the account console.

The admin console is where you configure everything in Keycloak, so it pays to know the map before you start. This lesson walks through the left-hand menu and the most important tabs in the order you will use them. Menu names are those of Keycloak 26; a few labels move between versions, but the structure has been stable for years.

This is a description, not a recording: the console cannot run inside this site. Follow along on your own server from Running Keycloak with Docker. The runnable block at the end is a small stand-in that quizzes you on where settings live.

Signing in and the master realm

Open http://localhost:8080/admin/ and sign in as the bootstrap admin. You land in the master realm, a special realm that exists to manage the server itself. Do not put your application users in it. At the top left, a realm selector lists every realm and has a Create realm button. Everything below belongs to the selected realm, so check the selector before changing anything.

flowchart TD
  S["Server"] --> M["master realm: manages the server"]
  S --> R1["realm: shop"]
  S --> R2["realm: staff"]
  R1 --> C1["clients, users, roles, groups"]
  R2 --> C2["clients, users, roles, groups"]

Realms are isolated: each has its own users, clients and settings.

The left menu

The menu has two blocks. The first (Manage) is for objects, the second (Configure) for settings.

Manage

Item What you do there
Clients Register applications and APIs. Settings: client ID, access type, redirect URIs, flows, credentials, roles, client scopes.
Client scopes Reusable bundles of claims and mappers that clients share (for example profile, email, roles).
Realm roles Roles that apply across the whole realm, including composite roles.
Users Create, search and edit users: attributes, credentials, role mapping, groups, sessions, consents.
Groups Hierarchies of users that inherit roles and attributes.
Sessions Active sessions in the realm; see who is logged in and sign them out.
Events Login events and admin events (an audit trail), if enabled.

Configure

Item What you do there
Realm settings General settings, login options, email, themes, keys, token lifetimes, sessions, security defenses.
Authentication Authentication flows (login, registration, browser, reset credentials), required actions, password policy, OTP policy.
Identity providers Add "sign in with Google/GitHub/OIDC/SAML" (brokering).
User federation Connect LDAP, Active Directory or Kerberos, or your own provider.

Newer versions also show an Organizations entry for multi-tenant (B2B) setups, once enabled for the realm.

Clients in detail

Open a client and you see tabs. The ones you will use all the time:

  • Settings: client ID, name, Root URL, Valid redirect URIs, Web origins, and under Capability config the switches Client authentication (on = confidential client with a secret, off = public client), Authorization, Standard flow (the authorization code flow), Direct access grants (the old password grant), Implicit flow and Service accounts roles.
  • Credentials: shown only for confidential clients; the client secret or other authenticator.
  • Roles: client roles that belong to this one client.
  • Client scopes: which scopes (and therefore claims) the client's tokens get by default or on request.
  • Sessions: sessions of users logged in through this client.
  • Advanced: token lifespans per client, PKCE enforcement, advanced settings.

Treat Valid redirect URIs like a security boundary: a precise URL such as https://app.example.com/callback, never a bare *. You will see why in Authorization Code Flow with PKCE.

Users in detail

A user page has tabs for Details (username, email, first and last name, required user actions, Email verified switch), Attributes (custom key and value pairs), Credentials (set or reset a password, with a Temporary switch that forces a change at next login, plus OTP and WebAuthn entries), Role mapping, Groups, Consents and Sessions. The Impersonate action in the top-right menu opens the app as that user, useful for support and dangerous for security, so restrict it.

Realm settings tabs

  • General: display name, User-managed access, Unmanaged attributes.
  • Login: user registration, forgot password, remember me, email as username, verify email.
  • Email: SMTP server for verification and reset mails.
  • Themes: login, account and email themes.
  • Keys: the realm's signing keys (RS256 by default) and rotation providers.
  • Events: store login and admin events and their retention.
  • Sessions and Tokens: idle and maximum SSO session lifetimes, access token lifespan, and more.
  • Security defenses: headers (such as X-Frame-Options) and brute force detection, which temporarily locks accounts after repeated failures.
  • User profile: define which user attributes exist, which are required and who may edit them.

The Account Console

Users do not use the admin console. They manage their own data at /realms/{realm}/account: personal info, change password, set up an authenticator, see signed-in devices and revoke consents. Admins can restrict what is visible via the realm's user profile and authentication settings.

Where do I find it? (stand-in)

Use this stand-in as flash cards. It stores the map from this lesson as data and lets you look tasks up, or reverse-search a keyword. Edit the questions to test yourself.

Node.js Stand-in: console map flash cards

Press Run (or Ctrl + Enter) to see the result here.

Program input ยท what you'd type while the program runs

Type the answers before you press Run, one per line. Each time the program reads a line (with node:readline or process.stdin), it gets the next line from this box.

Habits that save you pain

  1. Look at the realm selector before every change.
  2. Create a separate realm for your applications; leave master for administering.
  3. Give each admin a personal account rather than sharing the bootstrap user.
  4. Turn on admin events early so changes are recorded.
  5. Prefer groups and composite roles to per-user role assignments (see Realm and Client Roles).

Check your understanding

Quick check ยท 4 questions

of 4 answered You scored / 4 ยท perfect!

  1. 1. Which realm exists to manage the Keycloak server itself?

    The master realm holds the server administrators. Application users belong in separate realms.
  2. 2. Where do you register a new application that will use Keycloak for login?

    Every application or API is a client. You set its redirect URIs, flows and credentials there.
  3. 3. What does turning Client authentication Off make the client?

    Public clients cannot keep a secret, so they rely on PKCE and exact redirect URIs.
  4. 4. Where does an end user change their own password?

    The Account Console is the self-service area for personal info, credentials and sessions.

Summary

  • You sign in to the master realm, then pick or create a realm for your applications.
  • The left menu: Clients, Client scopes, Realm roles, Users, Groups, Sessions, Events to manage objects; Realm settings, Authentication, Identity providers, User federation to configure behavior.
  • Client capability switches (client authentication, standard flow, service accounts) define how an app may get tokens.
  • Realm settings hold lifetimes, keys, themes, email, brute-force protection and the user profile.
  • End users manage themselves in the Account Console, not in the admin console.

Next: Keycloak Core Concepts