validateCallback - Auth Module Reference

This documentation provides a reference to the validateCallback method. This belongs to the Auth Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

When authenticating users with a third-party provider, such as Google, the user performs an action to finish the authentication, such as enter their credentials in Google's sign-in form.

In those cases, you must create an API route or endpoint that's called by the third-party provider when the user finishes performing the required action.

In that API route, you can call this method to validate the third-party provider's callback and authenticate the user.

Learn more about this authentication flow in this guide.

Example#

The following example is in the context of an API route, where req is an instance of the MedusaRequest object:

Code
1const { success, authIdentity, error } =2  await authModuleService.validateCallback("google", {3    url: req.url,4    headers: req.headers,5    query: req.query,6    body: req.body,7    protocol: req.protocol,8  } as AuthenticationInput)

Parameters#

providerstring

The ID of the provider to use to validate the callback.

providerDataAuthenticationInput

The data to pass to the provider to validate the callback.

Returns#

PromisePromise<AuthenticationResponse>

The details of the authentication result.

Was this page helpful?