Okta SAML
This article contains Okta-specific help for configuring Login with SSO via SAML 2.0. For help configuring login with SSO for another IdP, refer to SAML 2.0 Configuration.
Configuration involves working simultaneously within the Bitwarden web app and the Okta Admin Portal. As you proceed, we recommend having both readily available and completing steps in the order they are documented.
tip
Already an SSO expert? Skip the instructions in this article and download screenshots of sample configurations to compare against your own.
Open SSO in the web app
Log in to the Bitwarden web app and open the Admin Console using the product switcher:
Open your organization's Settings → Single sign-on screen:
If you haven't already, create a unique SSO identifier for your organization and select SAML from the the Type dropdown. Keep this screen open for easy reference.
You can uncheck Set a unique SP entity ID. If you do, this will remove your organization ID from your SP entity ID value. We recommend leaving this setting checked in almost all cases.
tip
There are alternative Member decryption options. Learn how to get started using SSO with trusted devices or Key Connector.
Create an Okta application
Next, create a new Okta application:
From the Okta Admin Portal, go to Applications → Applications.
Select Create App Integration.
Select SAML 2.0:
Create new app for SAML 2.0 Select Next, which will open the app's general settings.
Enter a unique, Bitwarden-specific name in App name.
Select Next.
Configure SAML
This will open the Configure SAML page. Configure the following fields:
Field | Description |
|---|---|
Single sign on URL | Set this field to the pre-generated Assertion Consumer Service (ACS) URL. This automatically-generated value can be copied from the organization's Settings → Single sign-on screen and will vary based on your setup. |
Audience URI (SP Entity ID) | Set this field to the pre-generated SP Entity ID. This automatically-generated value can be copied from the organization's Settings → Single sign-on screen and will vary based on your setup. |
Name ID format | Select the SAML NameID format to use in SAML assertions. By default, Unspecified. |
Application username | Select the Okta attribute users will use to login to Bitwarden, typically Email. |
Advanced settings
Next, select Show Advanced Settings:
Set up these fields:
Field | Description |
|---|---|
Response | Whether the SAML response is signed by Okta. |
Assertion Signature | Whether the SAML assertion is signed by Okta. |
Signature Algorithm | The signing algorithm used to sign the response and/or assertion, depending on which is set to Signed. By default, |
Digest Algorithm | The digest algorithm used to sign the response and/or assertion, depending on which is set to Signed. This field must match the selected Signature Algorithm. |
Once configured, select Next and then Finish.
Attribute statements
To define attribute statements in your new Bitwarden app:
Go to the Sign On tab.
Within the Attribute statements section, select Show legacy configuration.
Select Edit:
Create attribute statements By default, one line will appear below to build an attribute statement. Select Add Another twice so you can build these three SP → IdP attribute mappings. Then select Save:
Name | Name format | Value |
|---|---|---|
Unspecified | user.email | |
firstname | Unspecified | user.firstName |
lastname | Unspecified | user.lastName |
Get IdP values
While still on the Sign On tab, select View Setup Instructions on the right:
Leave this page open for next steps, or copy the Identity Provider Single Sign-On URL and Identity Provider issuer and download the X.509 Certificate:
Assignments
Return to your Bitwarden app configuration in Okta and go to Assignments. Select Assign:
You can assign access to the application on a user-by-user basis using the Assign to People option or in-bulk using the Assign to Groups option.
Back to the web app
At this point, you've configured everything needed within the Okta Admin Portal. Open the Bitwarden web app and go to Settings → Single sign-on to complete your SSO setup.
SAML service provider configuration
The first section is SAML service provider configuration and determine the format of SAML requests. Configure the following fields according to the choices selected in the Okta Admin Portal during app creation:
Field | Description |
|---|---|
Name ID format | Set this to whatever the Name ID format specified in Okta, otherwise leave Unspecified. |
Outbound signing algorithm | The algorithm Bitwarden will use to sign SAML requests. |
Signing behavior | Whether/when SAML requests will be signed. |
Minimum incoming signing algorithm | Set this to the Signature Algorithm specified in Okta. |
Expect signed assertions | Check this box if you set the Assertion Signature field to Signed in Okta. |
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 configure within the Bitwarden login with SSO docker image. |
When you're done with the service provider configuration, select Save.
SAML identity provider configuration
The second section on this page is SAML identity provider configuration and determines the format to expect for SAML responses. Refer back to the Okta Admin Portal to retrieve some of these values:
Field | Description |
|---|---|
Entity ID | Enter your Identity Provider Issuer, retrieved from the Okta Sign On Settings screen by selecting the View Setup Instructions button. This field is case sensitive. |
Binding type | Set to Redirect. Okta currently does not support HTTP POST. |
Single sign-on service URL | Enter your Identity Provider Single Sign-On URL, retrieved from the Okta Sign On Settings screen. |
Single log-out service URL | Login with SSO currently does not support SLO. |
X509 public certificate | Paste the downloaded certificate, removing
and |
Outbound signing algorithm | Select the Signature Algorithm selected during Okta app configuration. If you didn't change the Signature Algorithm, leave the default ( |
Allow outbound logout requests | Login with SSO currently does not support SLO. |
Sign authentication requests | Whether Okta expects SAML requests to be signed. |
note
When completing the X509 certificate, take note of the expiration date. Certificates will need to be renewed to prevent any disruptions in service to SSO end-users. If a certificate expires, Admin and Owner accounts can still log in with their email address and master password.
When you're done with the identity provider configuration, select Save.
tip
You can require users to log in with SSO by activating the single sign-on authentication policy.
Test the configuration
Once your configuration is complete, test it. Go to https://vault.bitwarden.com, enter your email address, and select Use single sign-on:
Enter the configured organization identifier and select Continue. If your implementation is successfully configured, you will be redirected to the Okta login screen:
After you authenticate with your Okta credentials, enter your Bitwarden master password to decrypt your vault!
tip
Bitwarden does not support unsolicited responses, so initiating login from your IdP will result in an error. The SSO login flow must be initiated from Bitwarden. Okta administrators can create an Okta Bookmark App that will link directly to the Bitwarden web vault login page.
As an admin, navigate to the Applications drop down located on the main navigation bar and select Applications.
Click Browse App Catalog.
Search for Bookmark App and click Add Integration.
Add the following settings to the application:
Give the application a name such as Bitwarden Login.
In the URL field, provide the URL to your Bitwarden client such as
https://vault.bitwarden.com/#/loginoryour-self-hostedURL.com.
Select Done and return to the applications dashboard and edit the newly created app.
Assign people and groups to the application. You may also assign a logo to the application for end user recognition. The Bitwarden logo can be obtained here.
Once this process has been completed, assigned people and groups will have a Bitwarden bookmark application on their Okta dashboard that will link them directly to the Bitwarden web vault login page.