Skip to main content

BeforeLoginConfirmationFunction()

BeforeLoginConfirmationFunction: (params?) => Promise<object>

Allow to get user data before login confirmation, will triger when user try to login.

Parameters

ParameterTypeDescription
params?object-
params.adminUser?AdminUserAdmin user performing the action.
params.adminforth?IAdminForthAdminforth instance.
params.extra?HttpExtraExtra HTTP information. Prefer using extra.response over the top-level response field.
params.response?IAdminForthHttpResponse

HTTP response object.

Deprecated

Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.

params.sessionDuration?stringDuration of session in format "1s", "1m", "1h", or "1d" (e.g., "30d" for 30 days)

Returns

Promise<object>

body

body: object

body.allowedLogin?

optional allowedLogin: boolean

body.redirectTo?

optional redirectTo: string

error?

optional error: string