`getAuth()`

Parameters
Returns
Usage

The getAuth() helper retrieves authentication state from the request object.

Parameters

Name
request
Description
The request object.
Name
opts?
Description
An optional object that can be used to configure the behavior of the getAuth() function. It accepts the following properties:

secretKey?: A string that represents the Secret Key used to sign the session token. If not provided, the Secret Key is retrieved from the environment variable CLERK_SECRET_KEY.

Returns

getAuth() returns the Auth object.

Usage

See the dedicated guide for example usage.

Last updated on May 21, 2025