Keycloak Security Events
Keycloak defines two types of events: admin events and the others. Both types of events are logged as security events where appropriate.
The event’s name for logging an admin event as security event is built from a verb and a resource type, prefixed with a 'X_'.
Example: X_CREATE_GROUP
The other keycloak events are logged as described in the table below. Some are mapped to security-event types like LOGIN_FAILED while most of them are module specific and therefore are prefixed with 'X_'.
|
Keycloak logs the technical realm Id as
|
| Keycloak Event | Security Log Event |
|---|---|
LOGIN |
LOGIN_SUCCESSFUL |
LOGIN_ERROR |
LOGIN_FAILED |
INVALID_SIGNATURE |
TOKEN_SIGNATURE_INVALID |
INVALID_SIGNATURE_ERROR |
TOKEN_SIGNATURE_INVALID |
VALIDATE_ACCESS_TOKEN_ERROR |
TOKEN_VALIDATION_FAILED |
INTROSPECT_TOKEN_ERROR |
TOKEN_VALIDATION_FAILED |
SEND_RESET_PASSWORD |
SENSITIVE_DATA_ACCESSED |
SEND_RESET_PASSWORD_ERROR |
SENSITIVE_DATA_ACCESSED |
RESET_PASSWORD |
SENSITIVE_DATA_ACCESSED |
RESET_PASSWORD_ERROR |
SENSITIVE_DATA_ACCESSED |
CLIENT_INFO |
SENSITIVE_DATA_ACCESSED |
CLIENT_INFO_ERROR |
SENSITIVE_DATA_ACCESSED |
CLIENT_UPDATE |
SENSITIVE_DATA_ACCESSED |
CLIENT_UPDATE_ERROR |
SENSITIVE_DATA_ACCESSED |
CLIENT_DELETE |
SENSITIVE_DATA_ACCESSED |
CLIENT_DELETE_ERROR |
SENSITIVE_DATA_ACCESSED |
DELETE_ACCOUNT |
SENSITIVE_DATA_ACCESSED |
DELETE_ACCOUNT_ERROR |
SENSITIVE_DATA_ACCESSED |
REGISTER |
X_REGISTER |
REGISTER_ERROR |
X_REGISTER_ERROR |
LOGOUT |
X_LOGOUT |
LOGOUT_ERROR |
X_LOGOUT_ERROR |
CODE_TO_TOKEN |
X_CODE_TO_TOKEN |
CODE_TO_TOKEN_ERROR |
X_CODE_TO_TOKEN_ERROR |
CLIENT_LOGIN |
X_CLIENT_LOGIN |
CLIENT_LOGIN_ERROR |
X_CLIENT_LOGIN_ERROR |
REFRESH_TOKEN |
X_REFRESH_TOKEN |
REFRESH_TOKEN_ERROR |
X_REFRESH_TOKEN_ERROR |
INTROSPECT_TOKEN |
X_INTROSPECT_TOKEN |
FEDERATED_IDENTITY_LINK |
X_FEDERATED_IDENTITY_LINK |
FEDERATED_IDENTITY_LINK_ERROR |
X_FEDERATED_IDENTITY_LINK_ERROR |
REMOVE_FEDERATED_IDENTITY |
X_REMOVE_FEDERATED_IDENTITY |
REMOVE_FEDERATED_IDENTITY_ERROR |
X_REMOVE_FEDERATED_IDENTITY_ERROR |
UPDATE_EMAIL |
X_UPDATE_EMAIL |
UPDATE_EMAIL_ERROR |
X_UPDATE_EMAIL_ERROR |
UPDATE_PROFILE |
X_UPDATE_PROFILE |
UPDATE_PROFILE_ERROR |
X_UPDATE_PROFILE_ERROR |
UPDATE_PASSWORD |
X_UPDATE_PASSWORD |
UPDATE_PASSWORD_ERROR |
X_UPDATE_PASSWORD_ERROR |
UPDATE_TOTP |
X_UPDATE_TOTP |
UPDATE_TOTP_ERROR |
X_UPDATE_TOTP_ERROR |
VERIFY_EMAIL |
X_VERIFY_EMAIL |
VERIFY_EMAIL_ERROR |
X_VERIFY_EMAIL_ERROR |
VERIFY_PROFILE |
X_VERIFY_PROFILE |
VERIFY_PROFILE_ERROR |
X_VERIFY_PROFILE_ERROR |
REMOVE_TOTP |
X_REMOVE_TOTP |
REMOVE_TOTP_ERROR |
X_REMOVE_TOTP_ERROR |
GRANT_CONSENT |
X_GRANT_CONSENT |
GRANT_CONSENT_ERROR |
X_GRANT_CONSENT_ERROR |
UPDATE_CONSENT |
X_UPDATE_CONSENT |
UPDATE_CONSENT_ERROR |
X_UPDATE_CONSENT_ERROR |
REVOKE_GRANT |
X_REVOKE_GRANT |
REVOKE_GRANT_ERROR |
X_REVOKE_GRANT_ERROR |
SEND_VERIFY_EMAIL |
X_SEND_VERIFY_EMAIL |
SEND_VERIFY_EMAIL_ERROR |
X_SEND_VERIFY_EMAIL_ERROR |
SEND_IDENTITY_PROVIDER_LINK |
X_SEND_IDENTITY_PROVIDER_LINK |
SEND_IDENTITY_PROVIDER_LINK_ERROR |
X_SEND_IDENTITY_PROVIDER_LINK_ERROR |
RESTART_AUTHENTICATION |
X_RESTART_AUTHENTICATION |
RESTART_AUTHENTICATION_ERROR |
X_RESTART_AUTHENTICATION_ERROR |
REGISTER_NODE |
X_REGISTER_NODE |
REGISTER_NODE_ERROR |
X_REGISTER_NODE_ERROR |
UNREGISTER_NODE |
X_UNREGISTER_NODE |
UNREGISTER_NODE_ERROR |
X_UNREGISTER_NODE_ERROR |
USER_INFO_REQUEST |
X_USER_INFO_REQUEST |
USER_INFO_REQUEST_ERROR |
X_USER_INFO_REQUEST_ERROR |
IDENTITY_PROVIDER_LINK_ACCOUNT |
X_IDENTITY_PROVIDER_LINK_ACCOUNT |
IDENTITY_PROVIDER_LINK_ACCOUNT_ERROR |
X_IDENTITY_PROVIDER_LINK_ACCOUNT_ERROR |
IDENTITY_PROVIDER_LOGIN |
X_IDENTITY_PROVIDER_LOGIN |
IDENTITY_PROVIDER_LOGIN_ERROR |
X_IDENTITY_PROVIDER_LOGIN_ERROR |
IDENTITY_PROVIDER_FIRST_LOGIN |
X_IDENTITY_PROVIDER_FIRST_LOGIN |
IDENTITY_PROVIDER_FIRST_LOGIN_ERROR |
X_IDENTITY_PROVIDER_FIRST_LOGIN_ERROR |
IDENTITY_PROVIDER_POST_LOGIN |
X_IDENTITY_PROVIDER_POST_LOGIN |
IDENTITY_PROVIDER_POST_LOGIN_ERROR |
X_IDENTITY_PROVIDER_POST_LOGIN_ERROR |
IDENTITY_PROVIDER_RESPONSE |
X_IDENTITY_PROVIDER_RESPONSE |
IDENTITY_PROVIDER_RESPONSE_ERROR |
X_IDENTITY_PROVIDER_RESPONSE_ERROR |
IDENTITY_PROVIDER_RETRIEVE_TOKEN |
X_IDENTITY_PROVIDER_RETRIEVE_TOKEN |
IDENTITY_PROVIDER_RETRIEVE_TOKEN_ERROR |
X_IDENTITY_PROVIDER_RETRIEVE_TOKEN_ERROR |
IMPERSONATE |
X_IMPERSONATE |
IMPERSONATE_ERROR |
X_IMPERSONATE_ERROR |
CUSTOM_REQUIRED_ACTION |
X_CUSTOM_REQUIRED_ACTION |
CUSTOM_REQUIRED_ACTION_ERROR |
X_CUSTOM_REQUIRED_ACTION_ERROR |
EXECUTE_ACTIONS |
X_EXECUTE_ACTIONS |
EXECUTE_ACTIONS_ERROR |
X_EXECUTE_ACTIONS_ERROR |
EXECUTE_ACTION_TOKEN |
X_EXECUTE_ACTION_TOKEN |
EXECUTE_ACTION_TOKEN_ERROR |
X_EXECUTE_ACTION_TOKEN_ERROR |
CLIENT_REGISTER |
X_CLIENT_REGISTER |
CLIENT_REGISTER_ERROR |
X_CLIENT_REGISTER_ERROR |
CLIENT_INITIATED_ACCOUNT_LINKING |
X_CLIENT_INITIATED_ACCOUNT_LINKING |
CLIENT_INITIATED_ACCOUNT_LINKING_ERROR |
X_CLIENT_INITIATED_ACCOUNT_LINKING_ERROR |
TOKEN_EXCHANGE |
X_TOKEN_EXCHANGE |
TOKEN_EXCHANGE_ERROR |
X_TOKEN_EXCHANGE_ERROR |
OAUTH2_DEVICE_AUTH |
X_OAUTH2_DEVICE_AUTH |
OAUTH2_DEVICE_AUTH_ERROR |
X_OAUTH2_DEVICE_AUTH_ERROR |
OAUTH2_DEVICE_VERIFY_USER_CODE |
X_OAUTH2_DEVICE_VERIFY_USER_CODE |
OAUTH2_DEVICE_VERIFY_USER_CODE_ERROR |
X_OAUTH2_DEVICE_VERIFY_USER_CODE_ERROR |
OAUTH2_DEVICE_CODE_TO_TOKEN |
X_OAUTH2_DEVICE_CODE_TO_TOKEN |
OAUTH2_DEVICE_CODE_TO_TOKEN_ERROR |
X_OAUTH2_DEVICE_CODE_TO_TOKEN_ERROR |
AUTHREQID_TO_TOKEN |
X_AUTHREQID_TO_TOKEN |
AUTHREQID_TO_TOKEN_ERROR |
X_AUTHREQID_TO_TOKEN_ERROR |
PERMISSION_TOKEN |
X_PERMISSION_TOKEN |
PERMISSION_TOKEN_ERROR |
X_PERMISSION_TOKEN_ERROR |
PUSHED_AUTHORIZATION_REQUEST |
X_PUSHED_AUTHORIZATION_REQUEST |
PUSHED_AUTHORIZATION_REQUEST_ERROR |
X_PUSHED_AUTHORIZATION_REQUEST_ERROR |