auth() - SDK Reference - TanStack React Start | Clerk Docs
Docs
The auth() helper returns the Auth object of the currently active user.
Parameters
- Name
opts?- Type
{acceptsToken: TokenType, treatPendingAsSignedOut: boolean }- Description
An optional object that can be used to configure the behavior of the
auth()function. It accepts the following properties:-
acceptsToken?: The type of authentication token(s) to accept. Valid values are:'session_token'- authenticates a user session.'oauth_token'- authenticates a machine request using OAuth.'m2m_token'- authenticates a machine to machine request.'api_key'- authenticates a machine request using API keys.
Can be set to:
- A single token type.
- An array of token types.
'any'to accept all available token types.
Defaults to
'session_token'.
-