Interface: AuthAdapter

Properties

Name	Type	Description
`enabled`	Boolean	Is `true` if the auth adapter is enabled, `false` otherwise.

Methods

afterFind(authData, options) → {Promise.<Object>}

Triggered when auth data is fetched

Parameters:

Name	Type	Description
`authData`	Object	authData
`options`	Object	additional adapter options

Returns:

Any overrides required to authData

Type:: Promise.<Object>

challenge(challengeData, authData, options, request) → {Promise.<Object>}

Triggered in pre authentication process if needed (like webauthn, SMS OTP)

Parameters:

Name	Type	Description
`challengeData`	Object	Data provided by the client
`authData`	Object \| undefined	Auth data provided by the client, can be used for validation
`options`	Object	additional adapter options
`request`	Parse.Cloud.TriggerRequest

Returns:

A promise that resolves, resolved value will be added to challenge response under challenge key

Type:: Promise.<Object>

validateAppId(appIds, authData, options, request) → {Promise.<(undefined|void)>|void|undefined}

Parameters:

Name	Type	Description
`appIds`		The specified app IDs in the configuration
`authData`	Object	The client provided authData
`options`	Object	additional adapter options
`request`	Parse.Cloud.TriggerRequest

Returns:

resolves or returns if the applicationId is valid

Type:: Promise.<(undefined|void)> | void | undefined

validateAuthData(authData, request, options) → {Promise.<(ParseAuthResponse|void|undefined)>}

Legacy usage, if provided it will be triggered when authData related to this provider is touched (signup/update/login) otherwise you should implement validateSetup, validateLogin and validateUpdate

Parameters:

Name	Type	Description
`authData`	Object	The client provided authData
`request`	Parse.Cloud.TriggerRequest
`options`	Object	additional adapter options

Returns:

Type:: Promise.<(ParseAuthResponse|void|undefined)>

validateLogin(authData, request, options) → {Promise.<(ParseAuthResponse|void|undefined)>}

Triggered when user provide authData related to this provider The user is not logged in and has already set this provider before

Parameters:

Name	Type	Description
`authData`	Object	The client provided authData
`request`	Parse.Cloud.TriggerRequest
`options`	Object	additional adapter options

Returns:

Type:: Promise.<(ParseAuthResponse|void|undefined)>

validateOptions(options)

Triggered when the adapter is first attached to Parse Server

Parameters:

Name	Type	Description
`options`	Object	Adapter Options

validateSetUp(authData, request, options) → {Promise.<(ParseAuthResponse|void|undefined)>}

Triggered when user provide for the first time this auth provider could be a register or the user adding a new auth service

Parameters:

Name	Type	Description
`authData`	Object	The client provided authData
`request`	Parse.Cloud.TriggerRequest
`options`	Object	additional adapter options

Returns:

Type:: Promise.<(ParseAuthResponse|void|undefined)>

validateUpdate(authData, options, request) → {Promise.<(ParseAuthResponse|void|undefined)>}

Triggered when user provide authData related to this provider the user is logged in and has already set this provider before

Parameters:

Name	Type	Description
`authData`	Object	The client provided authData
`options`	Object	additional adapter options
`request`	Parse.Cloud.TriggerRequest

Returns:

Type:: Promise.<(ParseAuthResponse|void|undefined)>