Keycloak
Visualize Keycloak realms, users, groups, roles and clients, see who has access to what through role assignments, group membership and composite roles, find client service accounts, and monitor changes through queries and alerts.
- Authorization
- Data Model
- Types
Roles
RBAC roles that must be assigned to the integration principal.
Show Roles (7)
realm-management: query-clientsrealm-management: query-groupsrealm-management: query-usersrealm-management: view-clientsrealm-management: view-clients (service-account users)realm-management: view-realmrealm-management: view-users
Endpoints
API endpoints that the integration makes requests to.
Show Endpoints (12)
/admin/realms/admin/realms/{realm}/clients/admin/realms/{realm}/clients/{client-uuid}/roles/admin/realms/{realm}/clients/{client-uuid}/service-account-user/admin/realms/{realm}/groups/admin/realms/{realm}/groups/{group-id}/children/admin/realms/{realm}/groups/{group-id}/members/admin/realms/{realm}/groups/{group-id}/role-mappings/admin/realms/{realm}/roles/admin/realms/{realm}/roles-by-id/{role-id}/composites/admin/realms/{realm}/users/admin/realms/{realm}/users/{user-id}/role-mappings
Documentation Links
Links to provider documentation relevant to setup and configuration.
Show Documentation Links (12)
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealms
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmclients
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmclientsclient_uuidroles
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmclientsclient_uuidservice_account_user
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmgroups
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmgroupsgroup_idchildren
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmgroupsgroup_idmembers
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmgroupsgroup_idrole_mappings
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmroles
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmroles_by_idrole_idcomposites
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmusers
- https://www.keycloak.org/docs-api/latest/rest-api/index.html#_get_adminrealmsrealmusersuser_idrole_mappings
Per-Data-Source Breakdown
Authorization required by the steps that make up each data source. Steps that depend on a data source are listed in the Per-Step Breakdown; the complete lists are in the sections above.
Show all data sources (5)
| Data Source | Roles | Endpoints |
|---|---|---|
| Keycloak Clients | realm-management: query-clients, realm-management: view-clients | /admin/realms, /admin/realms/{realm}/clients, /admin/realms/{realm}/clients/{client-uuid}/roles |
| Keycloak Groups | realm-management: query-groups, realm-management: view-users | /admin/realms, /admin/realms/{realm}/groups, /admin/realms/{realm}/groups/{group-id}/children, /admin/realms/{realm}/groups/{group-id}/members |
| Keycloak Realms | realm-management: view-realm | /admin/realms |
| Keycloak Roles | realm-management: view-realm | /admin/realms, /admin/realms/{realm}/roles |
| Keycloak Users | realm-management: query-users, realm-management: view-clients (service-account users), realm-management: view-users | /admin/realms, /admin/realms/{realm}/clients, /admin/realms/{realm}/clients/{client-uuid}/service-account-user, /admin/realms/{realm}/users |
Per-Step Breakdown
Detailed authorization requirements for each ingestion step.
Show all steps (6)
| Step | Roles | Endpoints |
|---|---|---|
| Build Group Assigned Role Relationships | realm-management: view-users, realm-management: view-realm | /admin/realms, /admin/realms/{realm}/groups/{group-id}/role-mappings |
| Build Role Has Role Relationships | realm-management: view-realm | /admin/realms/{realm}/roles-by-id/{role-id}/composites |
| Build User Assigned Role Relationships | realm-management: view-users, realm-management: view-realm | /admin/realms, /admin/realms/{realm}/users/{user-id}/role-mappings |
| Fetch Client Roles | realm-management: view-clients | /admin/realms/{realm}/clients/{client-uuid}/roles |
| Fetch Client Service Accounts | realm-management: view-clients, realm-management: view-users | /admin/realms/{realm}/clients/{client-uuid}/service-account-user |
| Fetch Group Members | realm-management: view-users | /admin/realms/{realm}/groups/{group-id}/members |
Entities
The following entities are created:
| Resources | Entity _type | Entity _class |
|---|---|---|
| Account | keycloak_account | Account |
| Client | keycloak_client | Application |
| Group | keycloak_group | UserGroup |
| Realm | keycloak_realm | Configuration |
| Role | keycloak_role | AccessRole |
| Service | keycloak_service | Service |
| User | keycloak_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
|---|---|---|
keycloak_account | PROVIDES | keycloak_service |
keycloak_account | HAS | keycloak_realm |
keycloak_client | HAS | keycloak_role |
keycloak_client | HAS | keycloak_user |
keycloak_group | HAS | keycloak_group |
keycloak_group | HAS | keycloak_user |
keycloak_group | ASSIGNED | keycloak_role |
keycloak_realm | HAS | keycloak_group |
keycloak_realm | HAS | keycloak_role |
keycloak_realm | HAS | keycloak_client |
keycloak_role | HAS | keycloak_role |
keycloak_user | ASSIGNED | keycloak_role |
Keycloak Account
keycloak_account inherits from Account
| Property | Type | Description | Specifications |
|---|---|---|---|
instanceHost * | string | The Keycloak server host this account represents. |
Keycloak Client
keycloak_client inherits from Application
| Property | Type | Description | Specifications |
|---|---|---|---|
clientId | string | null | The human-facing client identifier (clientId). | |
hasServiceAccount | boolean | null | Whether the client has a service account (serviceAccountsEnabled). | |
isPublicClient | boolean | null | Whether the client is public (no client secret) rather than confidential. | |
protocol | string | null | The client protocol, e.g. "openid-connect" or "saml". | |
realm * | string | The name of the Keycloak realm this client belongs to. |
Keycloak Group
keycloak_group inherits from UserGroup
| Property | Type | Description | Specifications |
|---|---|---|---|
path | string | null | The full group path, e.g. "/parent/child". | |
realm * | string | The name of the Keycloak realm this group belongs to. |
Keycloak Realm
keycloak_realm inherits from Configuration
| Property | Type | Description | Specifications |
|---|---|---|---|
isEnabled | boolean | null | Whether the realm is enabled. | |
realm * | string | The realm name (the identifier most Keycloak calls key by). | |
realmId | string | null | The realm UUID (RealmRepresentation.id). |
Keycloak Role
keycloak_role inherits from AccessRole
| Property | Type | Description | Specifications |
|---|---|---|---|
isClientRole | boolean | null | Whether the role is a client role (true) or a realm role (false). | |
isComposite | boolean | null | Whether the role is composite (aggregates other realm/client roles). | |
isDefaultRole | boolean | null | Whether this is the realm's default role (default-roles-{realm}), which Keycloak maps to every user. Its per-user ASSIGNED edges are not ingested. | |
realm * | string | The name of the Keycloak realm this role belongs to. |
Keycloak Service
keycloak_service inherits from Service
Keycloak User
keycloak_user inherits from User
| Property | Type | Description | Specifications |
|---|---|---|---|
isEmailVerified | boolean | null | Whether the user's email address is verified. | |
isServiceAccount | boolean | null | Whether the user is a client service account. | |
realm * | string | The name of the Keycloak realm this user belongs to. | |
serviceAccountClientId | string | null | The clientId of the client this user is the service account of (a non-human, often privileged, principal); null for human users. |