Skip to content

@saflib/identity-common


Interface: IdentityServiceCallbacks

Callbacks for events which occur in the identity service. This is the main way to hook into the identity service.

Properties

onPasswordReset()?

optional onPasswordReset: (user, resetUrl) => Promise<void>

Parameters

ParameterType
user{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }
user.createdAtDate
user.emailstring
user.emailVerifiednull | boolean
user.familyNamenull | string
user.givenNamenull | string
user.idnumber
user.lastLoginAtnull | Date
user.namenull | string
resetUrlstring

Returns

Promise<void>


onPasswordUpdated()?

optional onPasswordUpdated: (user) => Promise<void>

Parameters

ParameterType
user{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }
user.createdAtDate
user.emailstring
user.emailVerifiednull | boolean
user.familyNamenull | string
user.givenNamenull | string
user.idnumber
user.lastLoginAtnull | Date
user.namenull | string

Returns

Promise<void>


onUserCreated()?

optional onUserCreated: (user) => Promise<void>

Parameters

ParameterType
user{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }
user.createdAtDate
user.emailstring
user.emailVerifiednull | boolean
user.familyNamenull | string
user.givenNamenull | string
user.idnumber
user.lastLoginAtnull | Date
user.namenull | string

Returns

Promise<void>


onVerificationTokenCreated()?

optional onVerificationTokenCreated: (user, verificationUrl, isResend) => Promise<void>

Parameters

ParameterType
user{ createdAt: Date; email: string; emailVerified: null | boolean; familyName: null | string; givenName: null | string; id: number; lastLoginAt: null | Date; name: null | string; }
user.createdAtDate
user.emailstring
user.emailVerifiednull | boolean
user.familyNamenull | string
user.givenNamenull | string
user.idnumber
user.lastLoginAtnull | Date
user.namenull | string
verificationUrlstring
isResendboolean

Returns

Promise<void>