functions
The functions exposed by createAuthClient — sign-in, sign-up, session management, OAuth token management, and sign-out for client-side and browser contexts.
Signature
function createAuthClient<DefaultUser extends User = User, SignUpPayload extends Record<string, any> = Record<string, any>>(
options: AuthClientOptions
): {
getSession(): Promise<Session<User> | null>
signIn<Options extends SignInOptions>(
oauth: LiteralUnion<BuiltInOAuthProvider>,
options?: Options | undefined
): Promise<SignInReturn<Options>>
signInCredentials<Options extends SignInCredentialsOptions>(options: Options): Promise<SignInCredentialsReturn<Options>>
signUp<Options extends SignUpOptions<Record<string, any>>>(options: Options): Promise<SignUpReturn<Options>>
updateSession<Options extends UpdateSessionOptions<User>>(options: Options): Promise<UpdateSessionReturn<Options, User>>
signOut<Options extends SignOutOptions>(options?: Options): Promise<SignOutReturn<Options>>
getAccessToken(oauth: LiteralUnion<BuiltInOAuthProvider>): Promise<string | null>
getProviderTokens(oauth: LiteralUnion<BuiltInOAuthProvider>): Promise<GetProviderTokensReturn>
isProviderConnected(oauth: LiteralUnion<BuiltInOAuthProvider>): Promise<boolean>
refreshUserInfo(oauth: LiteralUnion<BuiltInOAuthProvider>): Promise<Session<User> | null>
revokeToken(oauth: LiteralUnion<BuiltInOAuthProvider>): Promise<boolean>
disconnectProvider(oauth: LiteralUnion<BuiltInOAuthProvider>): Promise<boolean>
}Unlike auth.api on the server, createAuthClient() returns a flat object — there's no client.functions namespace. This page exists purely as a browsable index; every method below is called directly on your authClient instance (e.g. authClient.signIn(...)).
All of these run in a client-side or browser context and read/write cookies automatically — none of them accept request,
headers, or skipCSRFCheck. For the equivalent server-side surface, see api.
signIn
Signs in a user with a built-in or custom OAuth provider.
signInCredentials
Signs in a user with a username/email and password.
signUp
Registers a new user.
getSession
Returns the current user's session.
updateSession
Updates the current user's session data.
isProviderConnected
Verifies whether the current session is connected to a specific OAuth provider.
getProviderTokens
Retrieves the full set of tokens for a specific OAuth provider.
getAccessToken
Retrieves the access token for a specific OAuth provider.
refreshUserInfo
Refreshes the user's profile information from the OAuth provider.
disconnectProvider
Disconnects the current session from a specific OAuth provider without revoking its token.
revokeToken
Revokes the access token for a specific OAuth provider.
signOut
Signs out the current user and invalidates the session.