Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to

Authenticate With

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


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

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.


redirectUrlstring 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.
redirectUrlCompletestringFull URL or path to navigate after the OAuth or SAML flow completes.
continueSignUpboolean | undefinedWhether to continue (i.e. PATCH) an existing SignUp (if present) or create a new SignUp.
strategystring One of the supported OAuth providers you can use to authenticate with, eg oauth_google. Or alternatively saml, to authenticate with SAML.
identifierstring | undefined Identifier to use for targeting a SAML connection at sign-up
emailAddressstring | 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.


identifierstringThe 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.
identifierstringThe user's Web3 ID
noncestringThe crypographic nonce used in the sign-in.


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

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


unsafeMetadataobject Custom fields that will be attached to the User object post-signup

What did you think of this content?

Clerk © 2023