Back to Pocketbase

Interface recordAuthResponse

static/jsvm/interfaces/apis.recordAuthResponse.html

latest1.0 KB
Original Source

Interface recordAuthResponse

Hierarchy

  • recordAuthResponse

  • recordAuthResponse(e, authRecord, authMethod, meta): void

RecordAuthResponse writes standardized json record auth response into the specified request context.

The authMethod argument specify the name of the current authentication method (eg. password, oauth2, etc.) that it is used primarily as an auth identifier during MFA and for login alerts.

Set authMethod to empty string if you want to ignore the MFA checks and the login alerts (can be also adjusted additionally via the OnRecordAuthRequest hook).

Parameters

e: RequestEvent
authRecord: core.Record
authMethod: string
meta: any

Returns void

Settings

Member Visibility

  • Inherited

Theme

OSLightDark

Generated using TypeDoc