- 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 variableCLERK_SECRET_KEY
.
- Name
acceptsToken?
- Type
TokenType
- Description
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.'machine_token'
- authenticates a 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'
.
Feedback
Last updated on