AuthenticateWith

These are all methods on the SignUp class that allow you to authenticate with different methods.

`authenticateWithRedirect()`

Signs up users via OAuth, where an external account provider is used to verify the user's identity and provide certain information about the user.


function authenticateWithRedirect(params: AuthenticateWithRedirectParams): Promise<void>;

Name	Type	Description
`redirectUrl`	`string`	Full URL or path to the route that will complete the OAuth or SAML flow. Typically, this will be a simple `/sso-callback` route that calls `Clerk.handleRedirectCallback` or mounts the `<AuthenticateWithRedirectCallback />` component.
`redirectUrlComplete`	`string`	Full URL or path to navigate after the OAuth or SAML flow completes.
`continueSignUp`	`boolean \| undefined`	Whether to continue (i.e. PATCH) an existing `SignUp` (if present) or create a new `SignUp`.
`strategy`	`'oauth_<provider>' \| 'saml'`	The strategy to use for authentication. The following strategies are supported: `oauth_<provider>`: The user will be authenticated with their social sign-in account. See available OAuth providers. `saml`: The user will be authenticated with SAML.
`identifier`	`string \| undefined`	Identifier to use for targeting a SAML connection at sign-up.
`emailAddress`	`string \| undefined`	Email address to use for targeting a SAML connection at sign-up.

Starts a sign-up flow that authenticates the user against their public wallet address.


function authenticateWithWeb3(params: AuthenticateWithWeb3Params): Promise<SignUpResource>;

Name	Type	Description
`identifier`	`string`	The user's Web3 ID
`generateSignature`	`(opts: GenerateSignatureParams) => Promise<string>`	The method of how to generate the signature for the Web3 sign-in. See `GenerateSignatureParams` for more details.

Name	Type	Description
`identifier`	`string`	The user's Web3 ID
`nonce`	`string`	The cryptographic nonce(opens in a new tab) used in the sign-in.

Type	Description
`Promise<SignUpResource>`	A `Promise` which resolves to the current `SignUp`.

Starts a sign-up flow that uses the Metamask browser extension to authenticate the user using their public wallet address.


function authenticateWithMetamask(params?: SignUpAuthenticateWithMetamaskParams): Promise<SignUpResource>;

Name	Type	Description
`unsafeMetadata`	`{[string]: any}`	Custom fields that will be attached to the `User` object post-signup.

Type	Description
`Promise<SignUpResource>`	A `Promise` which resolves to the current `SignUp`.

Last updated on March 25, 2024