providers/clerk
Built-in sign in with Clerk integration.
ClerkProfile
See
Properties
email: "string";email_verified
email_verified: boolean;family_name
family_name: "string";given_name
given_name: "string";instance_id
instance_id: "string";name
name: "string";object
object: "string";picture
picture: "string";private_metadata?
optional private_metadata: any;public_metadata?
optional public_metadata: any;unsafe_metadata?
optional unsafe_metadata: any;user_id
user_id: "string";username
username: "string";default()
default(config): OAuthConfig<ClerkProfile>Add Clerk login to your page.
Setup
Callback URL
https://example.com/api/auth/callback/clerk
Configuration
import { Auth } from "@auth/core"
import Clerk from "@auth/core/providers/clerk"
const request = new Request(origin)
const response = await Auth(request, {
providers: [
Clerk({ clientId: CLERK_CLIENT_ID, clientSecret: CLERK_CLIENT_SECRET, baseUrl: CLERK_BASE_URL }),
],
})Resources
Notes
By default, Auth.js assumes that the Clerk provider is based on the OAuth 2 specification.
💡
The Clerk provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.
Disclaimer If you think you found a bug in the default configuration, you can open an issue.
Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.
Parameters
| Parameter | Type |
|---|---|
config | OAuthUserConfig<ClerkProfile> & { baseUrl: string; } |