Okta OIDC Implementation

This article contains Okta-specific help for configuring login with SSO via OpenID Connect (OIDC). For help configuring login with SSO for another OIDC IdP, or for configuring Okta via SAML 2.0, see OIDC Configuration or Okta SAML Implementation.

Configuration involves working simultaneously within the Bitwarden web vault and the Okta Admin Portal. As you proceed, we recommend having both readily available and completing steps in the order they are documented.

Open SSO in the web vault

Navigate to your organization's SettingsSingle Sign-On screen:

OIDC Configuration
OIDC Configuration

If you haven't already, create a unique SSO Identifier for your organization. Otherwise, you don't need to edit anything on this screen yet, but keep it open for easy reference.

Tipp

If you are self-hosting Bitwarden, you can use alternative Member Decryption Options. This feature is disabled by default, so continue with Master Password decryption for now and learn how to get started using Key Connector once your configuration is complete and successfully working.

Create an Okta app

In the Okta Admin Portal, select ApplicationsApplications from the navigation. On the Applications screen, select the Create App Integration button. For Sign-on method, select OIDC - OpenID Connect. For Application type, select Web Application:

Create App Integration
Create App Integration

On the New Web App Integration screen, configure the following fields:

Field Description
App integration name Give the app a Bitwarden-specific name.
Grant type Enable the following grant types:

- Client acting on behalf of itself → Client Credentials
- Client acting on behalf of a user → Authorization Code
Sign-in redirect URIs Set this field to your Callback Path, which can be retrieved from the Bitwarden SSO Configuration screen.

For cloud-hosted customers, this is always https://sso.bitwarden.com/oidc-signin. For self-hosted instances, this is determined by your configured server URL, for example https://your.domain.com/sso/oidc-signin.
Sign-out redirect URIs Set this field to your Signed Out Callback Path, which can be retrieved from the Bitwarden SSO Configuration screen.
Assignments Use this field to designate whether all or only select groups will be able to use Bitwarden Login with SSO.

Once configured, select the Next button.

Get client credentials

On the Application screen, copy the Client ID and Client secret for the newly created Okta app:

App Client Credentials
App Client Credentials

You will need to use both values during a later step.

Get authorization server information

Select SecurityAPI from the navigation. From the Authorization Servers list, select the server you would like to use for this implementation. On the Settings tab for the server, copy the Issuer and Metadata URI values:

Okta Authorization Server Settings
Okta Authorization Server Settings

You will need to use both values during the next step.

Back to the web vault

At this point, you have configured everything you need within the context of the Okta Admin Portal. Return to the Bitwarden web vault to configure the following fields:

Field Description
Authority Enter the retrieved Issuer URI for your Authorization Server.
Client ID Enter the retrieved Client ID for your Okta app.
Client Secret Enter the retrieved Client secret for your Okta app.
Metadata Address Enter the retrieved Metadata URI for your Authorization Server.
OIDC Redirect Behavior Select Redirect GET. Okta currently does not support Form POST.
Get Claims From User Info Endpoint Enable this option if you receive URL too long errors (HTTP 414), truncated URLS, and/or failures during SSO.
Additional/Custom Scopes Define custom scopes to be added to the request (comma-delimited).
Additional/Custom User ID Claim Types Define custom claim type keys for user identification (comma-delimited). When defined, custom claim types are searched for before falling back on standard types.
Additional/Custom Email Claim Types Define custom claim type keys for users' email addresses (comma-delimited). When defined, custom claim types are searched for before falling back on standard types.
Additional/Custom Name Claim Types Define custom claim type keys for users' full names or display names (comma-delimited). When defined, custom claim types are searched for before falling back on standard types.
Requested Authentication Context Class Reference values Define Authentication Context Class Reference identifiers (acr_values) (space-delimited). List acr_values in preference-order.
Expected "acr" Claim Value in Response Define the acr Claim Value for Bitwarden to expect and validate in the response.

When you are done configuring these fields, Save your work.

Tipp

You can require users to log in with SSO by activating the single sign-on authentication policy. Please note, this will require activating the single organization policy as well. Learn more.

Test the configuration

Once your configuration is complete, test it by navigating to https://vault.bitwarden.com, entering your email address, selecting Continue, and selecting the Enterprise Single-On button:

Enterprise single sign on and master password
Enterprise single sign on and master password

Enter the configured organization identifier and select Log In. If your implementation is successfully configured, you'll be redirected to the Okta login screen:

Log in with Okta
Log in with Okta

After you authenticate with your Okta credentials, enter your Bitwarden master password to decrypt your vault!


Sprache
© 2022 Bitwarden, Inc.
NutzungsbedingungenDatenschutzerklärungSitemap