Skip to main content

providers/authentik

Built-in Authentik integration.

default()​

default<P>(options): OAuthConfig< P >

Add Authentik login to your page.

Setup​

Callback URL​

https://example.com/api/auth/callback/authentik

Configuration​

import Auth from "@auth/core"
import Authentik from "@auth/core/providers/authentik"

const request = new Request(origin)
const response = await Auth(request, {
  providers: [Authentik({ clientId: AUTHENTIK_CLIENT_ID, clientSecret: AUTHENTIK_CLIENT_SECRET, issuer: AUTHENTIK_ISSUER })],
})
note

issuer should include the slug without a trailing slash – e.g., https://my-authentik-domain.com/application/o/My_Slug

Resources​

Notes​

By default, Auth.js assumes that the Authentik provider is based on the Open ID Connect specification.

tip

The Authentik 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.

Type parameters​

▪ P extends AuthentikProfile

Parameters​

▪ options: OAuthUserConfig< P >

Returns​

OAuthConfig< P >