How 4nass/keycloak-access-requests works
Keycloak Access Requests is a realm-scoped Keycloak extension for cataloguing requestable roles and groups, collecting access requests, approving or rejecting them, and provisioning approved access. The principal flow runs from the Account console or REST API through request services, with approval followed by synchronous provisioning; audit history and administration are additional capabilities. The graph includes the documented console and notification integrations, but source excerpts do not establish all runtime wiring, so uncertain connections are omitted or marked unverified.
Main entry points: RequestService.java Request service · resource Realm REST · CatalogService.java Catalog service · AccessRequestRepository.java Request repository
Components 19
Keycloak API
- Realm REST
src/main/java/ch/anass/keycloak/accessrequests/spi/realm/resource - Catalog handler
src/main/java/ch/anass/keycloak/accessrequests/spi/realm/resource/AccessRequestCatalogHandler.java - Requester handler
src/main/java/ch/anass/keycloak/accessrequests/spi/realm/resource/AccessRequestRequesterHandler.java - Approval handler
src/main/java/ch/anass/keycloak/accessrequests/spi/realm/resource/AccessRequestApprovalHandler.java - Email notifications
src/main/java/ch/anass/keycloak/accessrequests/spi/notification
Access workflow
- Catalog service
src/main/java/ch/anass/keycloak/accessrequests/core/service/CatalogService.java - Request service
src/main/java/ch/anass/keycloak/accessrequests/core/service/RequestService.java - Approval queue
src/main/java/ch/anass/keycloak/accessrequests/core/service/ApprovalQueueService.java - Request state
src/main/java/ch/anass/keycloak/accessrequests/core/domain/request/AccessRequest.java - Entitlement provisioning
src/main/java/ch/anass/keycloak/accessrequests/core/port/EntitlementProvisioner.java
Persistence
- Entitlement repository
src/main/java/ch/anass/keycloak/accessrequests/core/port/EntitlementRepository.java - Request repository
src/main/java/ch/anass/keycloak/accessrequests/core/port/AccessRequestRepository.java - JPA persistence
src/main/java/ch/anass/keycloak/accessrequests/persistence/jpa
Account console
- Account flows
themes/access-requests-ui/src/account/routes.tsx - Account API client
themes/access-requests-ui/src/account/api/AccessRequestsApi.ts
Admin console
- Admin pages
themes/access-requests-ui/src/admin/routes.tsx - Admin API client
themes/access-requests-ui/src/admin/api/EntitlementsAdminApi.ts
Other components
- Requester
- Approver
Connections 21
- Requester → Account flows: uses
README.md - Approver → Account flows: uses
README.md - Requester → Realm REST: calls
README.md - Realm REST → Catalog handler: routes
src/main/java/ch/anass/keycloak/accessrequests/spi/realm/resource/AccessRequestCatalogHandler.java - Realm REST → Requester handler: routes
- Realm REST → Approval handler: routes
- Catalog handler → Catalog service: invokes
- Requester handler → Request service: invokes
- Approval handler → Request service: invokes
- Catalog service → Entitlement repository: queries
src/main/java/ch/anass/keycloak/accessrequests/core/service/CatalogService.java - Catalog service → Request repository: checks pending
src/main/java/ch/anass/keycloak/accessrequests/core/service/CatalogService.java - Catalog service → Request service: checks access
src/main/java/ch/anass/keycloak/accessrequests/core/service/CatalogService.java - Request service → Request repository: persists requests
src/main/java/ch/anass/keycloak/accessrequests/core/service/RequestService.java - Request service → Entitlement repository: loads entitlement
src/main/java/ch/anass/keycloak/accessrequests/core/service/RequestService.java - Request service → Entitlement provisioning: provisions access
src/main/java/ch/anass/keycloak/accessrequests/core/service/RequestService.java - Request service → Request state: updates state
src/main/java/ch/anass/keycloak/accessrequests/core/service/RequestService.java - Approval queue → Request repository: queries queue
src/main/java/ch/anass/keycloak/accessrequests/core/service/ApprovalQueueService.java - Request repository → JPA persistence: implemented by
src/main/java/ch/anass/keycloak/accessrequests/persistence/jpa/repository/JpaAccessRequestRepository.java - Entitlement repository → JPA persistence: implemented by
- Account flows → Account API client: loads API client
- Admin pages → Admin API client: loads API client