getAuth()
The getAuth() helper retrieves the current user's authentication state from the request object.
Parameters
- Name
args- Type
LoaderFunctionArgs- Description
The arguments object.
- Name
opts?- Type
{acceptsToken: TokenType, treatPendingAsSignedOut: boolean }- Description
An optional object that can be used to configure the behavior of the
getAuth()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'. -
treatPendingAsSignedOut?: A boolean that indicates whether to treat pending session status as signed out. Defaults totrue.
-
Returns
getAuth() returns the Auth object. This JavaScript object contains important information like the current user's session ID, user ID, and Organization ID. Learn more about the Auth object.
Usage
See the dedicated guide for example usage.
Feedback
Last updated on