Admin ConsoleLogin with SSO

SAML 2.0 Configuration

Step 1: Set an SSO identifier

Users who authenticate their identity using SSO will be required to enter an SSO identifier that indicates the organization (and therefore, the SSO integration) to authenticate against. To set a unique SSO Identifier:

  1. Log in to your web vault and open your organization.

  2. Open the Settings tab, select Single sign-on, and enter a unique SSO Identifier for your organization:

    Enter an identifier
    Enter an identifier
  3. Save your changes before exiting this page.

Tipp

You will need to share this value with users once the configuration is ready to be used.

Step 2: Enable login with SSO

Once you have your SSO identifier, you can proceed to enabling and configuring your integration. To enable login with SSO:

  1. From the organization vault, navigate to the Settings tab and select Single sign-on from the left-hand menu:

    SAML 2.0 configuration
    SAML 2.0 configuration

  2. On the Single sign-on screen, check the Allow SSO authentication checkbox.

  3. From the Type dropdown menu, select the SAML 2.0 option. If you intend to use OIDC instead, switch over to the OIDC Configuration Guide.

    You can turn off the Set a unique SP entity ID option at this stage if you wish. Doing so will remove your organization ID from your SP entity ID value, however in almost all cases it is recommended to leave this option on.

Tipp

There are alternative Member decryption options. Learn how to get started using SSO with trusted devices or Key Connector.

Step 3: Configuration

From this point on, implementation will vary provider-to-provider. Jump to one of our specific implementation guides for help completing the configuration process:

Provider

Guide

AD FS

AD FS Implementation Guide

Auth0

Auth0 Implementation Guide

AWS

AWS Implementation Guide

Azure

Azure Implementation Guide

Duo

Duo Implementation Guide

Google

Google Implementation Guide

JumpCloud

JumpCloud Implementation Guide

Keycloak

Keycloak Implementation Guide

Okta

Okta Implementation Guide

OneLogin

OneLogin Implementation Guide

PingFederate

PingFederate Implementation Guide

Configuration reference materials

The following sections will define fields available during single sign-on configuration, agnostic of which IdP you are integration with. Fields that must be configured will be marked (required).

Tipp

Unless you are comfortable with SAML 2.0, we recommend using one of the above implementation guides instead of the following generic material.

The single sign-on screen separates configuration into two sections:

  • SAML Service Provider Configuration will determine the format of SAML requests.

  • SAML Identity Provider Configuration will determine the format to expect for SAML responses.

Service Provider Configuration

Field

Description

SP Entity ID

(Automatically generated) The Bitwarden endpoint for authentication requests.

This automatically-generated value can be copied from the organization's SettingsSingle sign-on screen and will vary based on your setup.

SAML 2.0 Metadata URL

(Automatically generated) Metadata URL for the Bitwarden endpoint.

This automatically-generated value can be copied from the organization's SettingsSingle sign-on screen and will vary based on your setup.

Assertion Consumer Service (ACS) URL

(Automatically generated) Location where the SAML assertion is sent from the IdP.

This automatically-generated value can be copied from the organization's SettingsSingle sign-on screen and will vary based on your setup.

Name ID Format

Format Bitwarden will request of the SAML assertion. Must be cast as a string. Options include:
-Unspecified (default)
-Email address
-X.509 Subject name
-Windows Domain Qualified Name
-Kerberos Principal Name
-Entity identifier
-Persistent
-Transient

Outbound Signing Algorithm

The algorithm Bitwarden will use to sign SAML requests. Options include:
- http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 (default)
- http://www.w3.org/2000/09/xmldsig#rsa-sha1
- http://www.w3.org/2000/09/xmldsig#rsa-sha384
- http://www.w3.org/2000/09/xmldsig#rsa-sha512

Signing Behavior

Whether/when SAML requests will be signed. Options include:
-If IdP wants authn requests signed (default)
-Always
-Never

Minimum Incoming Signing Algorithm

Minimum strength of the algorithm that Bitwarden will accept in SAML responses.

Expect signed assertations

Check this checkbox if Bitwarden should expect responses from the IdP to be signed.

Validate certificates

Check this box when using trusted and valid certificates from your IdP through a trusted CA. Self-signed certificates may fail unless proper trust chains are configured within the Bitwarden login with SSO docker image.

Identity Provider Configuration

Field

Description

Entity ID

(Required) Address or URL of your identity server or the IdP Entity ID. This field is case sensitive and must match the IdP value exactly.

Binding Type

Method used by the IdP to respond to Bitwarden SAML requests. Options include:
-Redirect (recommended)
-HTTP POST

Single Sign On Service URL

(Required if Entity ID is not a URL) SSO URL issued by your IdP.

Single log out service URL

Login with SSO currently does not support SLO. This option is planned for future use, however we strongly recommend pre-configuring this field.

X509 Public Certificate

(Required) The X.509 Base-64 encoded certificate body. Do not include the

-----BEGIN CERTIFICATE-----

and

-----END CERTIFICATE-----

lines or portions of the CER/PEM formatted certificate.

The certificate value is case sensitive, extra spaces, carriage returns, and other extraneous characters inside this field will cause certificate validation failure. Copy only the certificate data into this field.

Outbound Signing Algorithm

The algorithm your IdP will use to sign SAML responses/assertions. Options include:
- http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 (default)
- http://www.w3.org/2000/09/xmldsig#rsa-sha1
- http://www.w3.org/2000/09/xmldsig#rsa-sha384
- http://www.w3.org/2000/09/xmldsig#rsa-sha512

Allow outbound logout requests

Login with SSO currently does not support SLO. This option is planned for future use, however we strongly recommend pre-configuring this field.

Sign authentication requests

Check this checkbox if your IdP should expect SAML requests from Bitwarden to be signed.

Hinweis

When completing the X509 certificate, take note of the expiration date. Certificates will have to be renewed in order to prevent any disruptions in service to SSO end users. If a certificate has expired, Admin and Owner accounts will always be able to log in with email address and master password.

SAML attributes & claims

An email address is required for account provisioning, which can be passed as any of the attributes or claims in the following table.

A unique user identifier is also highly recommended. If absent, email will be used in its place to link the user.

Attributes/claims are listed in order of preference for matching, including fallbacks where applicable:

Value

Claim/Attribute

Fallback claim/attribute

Unique ID

NameID (when not transient)
urn:oid:0.9.2342.19200300.100.1.1
Sub
UID
UPN
EPPN

Email

Email
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
urn:oid:0.9.2342.19200300.100.1.3
Mail
EmailAddress

Preferred_Username
Urn:oid:0.9.2342.19200300.100.1.1
UID

Name

Name
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name
urn:oid:2.16.840.1.113730.3.1.241
urn:oid:2.5.4.3
DisplayName
CN

First Name + “ “ + Last Name (see below)

First Name

urn:oid:2.5.4.42
GivenName
FirstName
FN
FName
Nickname

Last Name

urn:oid:2.5.4.4
SN
Surname
LastName

Make a suggestion to this page

Kontaktieren Sie unser Team vom Kundendienst

For technical, billing, product, and Family/Premium questions.

Name*
E-Mail-Adresse Ihres Bitwarden-Kontos*
Bestätigen Sie die E-Mail-Adresse des Kontos*
Produkt*
Bist du selbst gehostet?*
Betreff*
Nachricht...*

Cloud-Status

Status überprüfen

© 2024 Bitwarden, Inc.NutzungsbedingungenDatenschutzerklärungSitemap
Diese Website ist auf Deutsch verfügbar.
Go to EnglishStay Here