AuthenticateWith

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

Methods

Signs in users via OAuth. This is commonly known as Single Sign On (SSO), where an external account is used for verifying the user's identity.


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

Name	Type	Description
`strategy`	`OAuthStrategy \| 'saml'`	The strategy corresponding to the OAuth provider. For example: `oauth_facebook`, `oauth_github`, etc.
`redirectUrl`	`string`	The URL that the OAuth provider should redirect to, on successful authorization on their part.
`redirectUrlComplete`	`string`	The URL that the user will be redirected to, after successful authorization from the OAuth provider and Clerk sign in.

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


function authenticateWithMetamask(): Promise<SignInResource>;

Type	Description
`Promise<SignInResource>`	A `Promise` which resolves to the current `SignIn`.

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


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

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<SignInResource>`	A `Promise` which resolves to the current `SignIn`.

Last updated on March 19, 2024