mirror of
https://github.com/goauthentik/authentik
synced 2026-04-27 09:57:31 +02:00
6ed5cb5249
* website/integrations: rename "Create with Provider" to "New Application" The application list page now uses a split-button labeled "New Application" instead of the old "Create with Provider" dropdown. Update all 113 integration guides to match. * website/docs: update flow, stage, and policy button labels - "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons - "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit - "Create and bind stage" → "New Stage" / "Bind Existing Stage" - "Create" (binding submit) → "Create Stage Binding" * website/docs: update provider button labels - "Create" → "New Provider" for trigger buttons - "Create with Provider" → "New Application" in RAC docs - "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt" for related entity creation * website/docs: update directory button labels - "Create" → "New Source" for federation/social login pages - "Create" → "New Role", submit → "Create Role" - "Create" → "New Invitation" - Policy binding submit → "Create Policy Binding" * website/docs: update endpoint device and system management button labels - "Create" → "New Endpoint Connector", "New Enrollment Token", "New Device Access Group", "New Flow" - Submit → "Create Device Access Group" - "Create" → "New Notification Rule", "New Notification Transport" - Binding submit → "Create Policy Binding" * Reorganize policy documentation * website/docs: address policy docs review feedback * post-rebase * website/docs: Reorganize policy documentation -- Revisions (#21601) * apply suggestions * Fix escaped. * Fix whitespace. * Update button label. * Fix phrasing. * Fix phrasing. * Clean up stragglers. * Format. --------- Co-authored-by: Dominic R <dominic@sdko.org>
91 lines
4.5 KiB
Markdown
91 lines
4.5 KiB
Markdown
---
|
|
title: Integrate with Vaultwarden
|
|
sidebar_label: Vaultwarden
|
|
support_level: community
|
|
---
|
|
|
|
## What is Vaultwarden
|
|
|
|
> Vaultwarden is an alternative server implementation of the Bitwarden Client API, written in Rust and compatible with official Bitwarden clients, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
|
|
>
|
|
> -- https://github.com/dani-garcia/vaultwarden
|
|
|
|
## Preparation
|
|
|
|
The following placeholders are used in this guide:
|
|
|
|
- `vaultwarden.company` is the FQDN of the Vaultwarden installation.
|
|
- `authentik.company` is the FQDN of the authentik installation.
|
|
|
|
:::info
|
|
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.
|
|
:::
|
|
|
|
## authentik configuration
|
|
|
|
To support the integration of Vaultwarden with authentik, you need to create an application/provider pair in authentik.
|
|
|
|
### Create custom scope mapping
|
|
|
|
Vaultwarden either requires the email scope to return a true value for whether the email address is verified, or no value at all. As of [authentik 2025.10](https://docs.goauthentik.io/releases/2025.10/#default-oauth-scope-mappings) the default behavior is to return `email_verified: False`, so a custom scope mapping is required for Vaultwarden to allow authentication.
|
|
|
|
1. Log in to authentik as an administrator and open the authentik Admin interface.
|
|
2. Navigate to **Customization** > **Property Mappings** and click **Create**.
|
|
- **Select type**: select **Scope Mapping**.
|
|
- **Configure the Scope Mapping**: Provide a descriptive name (e.g. `Vaultwarden Email Scope`), and an optional description.
|
|
- **Scope name**: `email`
|
|
- **Expression**:
|
|
|
|
```python showLineNumbers
|
|
return {
|
|
"email": request.user.email,
|
|
"email_verified": True
|
|
}
|
|
```
|
|
|
|
3. Click **Finish** to save the property mapping.
|
|
|
|
### Create an application and provider in authentik
|
|
|
|
1. Log in to authentik as an administrator and open the authentik Admin interface.
|
|
2. Navigate to **Applications** > **Applications** and click **New Application** to open the application wizard.
|
|
- **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
|
|
- **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type.
|
|
- **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
|
|
- Note the **Client ID**, **Client Secret**, and **slug** values because they will be required later.
|
|
- Set a `Strict` redirect URI to `https://vaultwarden.company/identity/connect/oidc-signin`.
|
|
- Select any available signing key.
|
|
- Under **Advanced protocol settings**:
|
|
- Set **Access token validity** to more than 5 minutes.
|
|
- Ensure the `offline_access` scope mapping is available by adding `authentik default OAuth Mapping: OpenID 'offline_access'` to the selected scopes.
|
|
- Remove the `authentik default OAuth Mapping: OpenID 'email'` scope, and add the custom scope mapping you created above.
|
|
- **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/bindings-overview/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page.
|
|
|
|
3. Click **Submit** to save the new application and provider.
|
|
|
|
## Vaultwarden configuration
|
|
|
|
To configure Vaultwarden to use authentik, add the following environment variables to your Vaultwarden deployment:
|
|
|
|
```yaml
|
|
SSO_ENABLED=true
|
|
SSO_AUTHORITY=https://authentik.company/application/o/<application_slug>/
|
|
SSO_CLIENT_ID=<client_id>
|
|
SSO_CLIENT_SECRET=<client_secret>
|
|
SSO_SCOPES=email profile offline_access
|
|
SSO_ALLOW_UNKNOWN_EMAIL_VERIFICATION=false
|
|
SSO_CLIENT_CACHE_EXPIRATION=0
|
|
SSO_ONLY=false # Set to true to disable email+master password login and require SSO
|
|
SSO_SIGNUPS_MATCH_EMAIL=true # Match first SSO login to existing account by email
|
|
```
|
|
|
|
Then restart Vaultwarden to apply the changes.
|
|
|
|
## Resources
|
|
|
|
- [Vaultwarden Wiki - SSO using OpenID Connect](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-SSO-support-using-OpenId-Connect)
|
|
|
|
## Configuration verification
|
|
|
|
To verify the integration of authentik with Vaultwarden, log out of Vaultwarden, then on the login page enter a verified email and click **Use single sign-on**.
|