Skip to main content

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.

Roles​

RBAC roles that must be assigned to the integration principal.

Show Roles (7)
  • realm-management: query-clients
  • realm-management: query-groups
  • realm-management: query-users
  • realm-management: view-clients
  • realm-management: view-clients (service-account users)
  • realm-management: view-realm
  • realm-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

Links to provider documentation relevant to setup and configuration.

Show Documentation Links (12)

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 SourceRolesEndpoints
Keycloak Clientsrealm-management: query-clients, realm-management: view-clients/admin/realms, /admin/realms/{realm}/clients, /admin/realms/{realm}/clients/{client-uuid}/roles
Keycloak Groupsrealm-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 Realmsrealm-management: view-realm/admin/realms
Keycloak Rolesrealm-management: view-realm/admin/realms, /admin/realms/{realm}/roles
Keycloak Usersrealm-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)
StepRolesEndpoints
Build Group Assigned Role Relationshipsrealm-management: view-users, realm-management: view-realm/admin/realms, /admin/realms/{realm}/groups/{group-id}/role-mappings
Build Role Has Role Relationshipsrealm-management: view-realm/admin/realms/{realm}/roles-by-id/{role-id}/composites
Build User Assigned Role Relationshipsrealm-management: view-users, realm-management: view-realm/admin/realms, /admin/realms/{realm}/users/{user-id}/role-mappings
Fetch Client Rolesrealm-management: view-clients/admin/realms/{realm}/clients/{client-uuid}/roles
Fetch Client Service Accountsrealm-management: view-clients, realm-management: view-users/admin/realms/{realm}/clients/{client-uuid}/service-account-user
Fetch Group Membersrealm-management: view-users/admin/realms/{realm}/groups/{group-id}/members