client
SignInOptions
Extends
Record<string,unknown>
Properties
callbackUrl?
optional callbackUrl: string;Specify to which URL the user will be redirected after signing in. Defaults to the page URL the sign-in is initiated from.
redirect?
optional redirect: boolean;SignInAuthorizationParams
type SignInAuthorizationParams: string | string[][] | Record<string, string> | URLSearchParams;Match inputType of new URLSearchParams(inputType)
signIn()
signIn<P>(
providerId?,
options?,
authorizationParams?): Promise<undefined | Response>Client-side method to initiate a signin flow or send the user to the signin page listing all possible providers.
Type parameters
| Type parameter | Value |
|---|---|
P extends undefined | RedirectableProviderType | undefined |
Parameters
| Parameter | Type |
|---|---|
providerId? | LiteralUnion<P extends RedirectableProviderType ? BuiltInProviderType | P : BuiltInProviderType> |
options? | SignInOptions |
authorizationParams? | SignInAuthorizationParams |
Returns
signOut()
signOut(options?): Promise<void>Signs the user out, by removing the session cookie.
Parameters
| Parameter | Type |
|---|---|
options? | SignOutParams<true> |
Returns
Promise<void>