Skip to content

Home > @opengovsg/logging > LoginSucceededInput

LoginSucceededInput interface ​

Input for AuthnAudit.loginSucceeded().

Signature:

typescript
export interface LoginSucceededInput extends AuditInputBase

Extends: AuditInputBase

Properties ​

PropertyModifiersTypeDescription
privilegedbooleanWhether this is a privileged account login (flagged in the matrix).
rolestringThe user's role at login.
sessionId?string(Optional) Session identifier, if a session was created. Absent for stateless auth.
userIdstringThe authenticated user. Promoted to the canonical user_id facet.
username?string(Optional) The login handle (may differ from userId). Optional.