1
0
mirror of https://github.com/bitwarden/help synced 2025-12-31 23:53:20 +00:00
Files
help/_articles/login-with-sso/oidc-azure.md
fred_the_tech_writer 82ecf7def2 KC (#805)
* initial draft

* codeblock e.g.'s

* initial draft of f4e end-user doc

* first round of feedback

* feedback round 2

* feedback round 3

* update screenshots

* safari/macos import guide sketch

* adios, friendly name

* cli note

* fix typo

* finish import from macos/safari

* feedback round 4

* more feedback

* updated diagrams

* fix typo

* linked custom fields & more release note items

* new auto-fill unlock behavior for context menu & keyboard!

* release notes - autofill unlock

* new events

* fixes to 'using sso'

* updated KC screenshot & test step

* KC URL

* send extension & release notes

* hide ios extension

* updates to sso faqs

* SEO desc's & tags

* Key Connector > Impact on Unlock > Add a note for online dependency

* clarify "account is lost"

* add some references to CME

* final edits

* f4e

* quick edit to RN
2021-12-08 07:53:03 -05:00

5.9 KiB

layout, title, categories, featured, popular, hidden, tags, order, description
layout title categories featured popular hidden tags order description
article Azure OIDC Implementation
login-with-sso
false false true
sso
oidc
azure
This article contains instructions for configuring Bitwarden Login with SSO for Azure OIDC implementations.

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

Configuration involves working simultaneously within the Bitwarden Web Vault and the Azure Portal. As you proceed, we recommend having both readily available and completing steps in the order they're documented.

Open SSO in the Web Vault

If you're coming straight from OIDC Configuration, you should already have an Organization ID created. If you don't refer to that article to create an Organization ID for SSO.

Navigate to your Organization's ManageSingle Sign-On screen:

{% image sso/sso-oidc1.png OIDC Configuration %}

You don't need to edit anything on this screen yet, but keep it open for easy reference.

{% callout success %} If you're 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. {% endcallout %}

Create an App Registration

In the Azure Portal, navigate to App registrations and select the New registration button:

{% image sso/cheatsheets/oidc-azure/azure-newapp.png Create App Registration %}

On the Register an application screen, give your app a Bitwarden-specific name and specify which accounts should be able to use the application. This selection will determine which users can use Bitwarden Login with SSO.

Register a Redirect URI

Select Authentication from the navigation and select the Add a platform button:

{% image sso/cheatsheets/oidc-azure/azure-redirecturis.png Register a Redirect URI %}

Select the Web option on the Configure platforms screen and enter your Callback Path in the Redirect URIs input.

{% callout info %} Callback Path 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. {% endcallout %}

Create a Client Secret

Select Certificates & secrets from the navigation, and select the New client secret button:

{% image sso/cheatsheets/oidc-azure/azure-newcert.png Create Client Secret %}

Give the certificate a Bitwarden-specific name, and choose an expiration timeframe.

Back to the Web Vault

At this point, you've configured everything you need within the context of the Azure Portal. Jump back over to the Bitwarden Web Vault to configure the following fields:

Field Description
Authority Enter https://login.microsoft.com/<TENANT_ID>/v2.0, where TENANT_ID is the Directory (tenant) ID value retrieved from the App registration's Overview screen.
Client ID Enter the App registration's Application (client) ID, which can be retrieved from the Overview screen.
Client Secret Enter the Secret Value of the created Client Secret.
Metadata Address For Azure implementations as documented, you can leave this field blank.
OIDC Redirect Behavior Select either Form POST or Redirect GET.
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're done configuring these fields, Save your work.

Test the Configuration

Once your configuration is complete, test it by navigating to https://vault.bitwarden.com{:target="_blank"} and selecting the Enterprise Single Sign-On button:

{% image sso/sso-button-lg.png Enterprise Single Sign-On button %}

Enter the configured Organization Identifier and select Log In. If your implementation is successfully configured, you'll be redirected to the Microsoft login screen:

{% image sso/cheatsheets/saml-azure/az-login.png Azure login screen %}

After you authenticate with your Azure credentials, enter your Bitwarden Master Password to decrypt your Vault!