OneLogin SCIM Integration

System of cross-domain identity management (SCIM) can be used to automatically provision and de-provision members and groups in your Bitwarden organization.

note

SCIM Integrations are available for Enterprise organizations. Teams organizations, or customers not using a SCIM-compatible identity provider, may consider using Directory Connector as an alternative means of provisioning.

This article will help you configure a SCIM integration with OneLogin. Configuration involves working simultaneously with the Bitwarden web vault and OneLogin Admin Portal. As you proceed, we recommend having both readily available and completing steps in the order they are documented.

Enable SCIM

note

Are you self-hosting Bitwarden? If so, complete these steps to enable SCIM for your server before proceeding.

To start your SCIM integration, open your organization's Manage SCIM Provisioning page:

SCIM Provisioning
SCIM Provisioning

Select the Enable SCIM checkbox and take note of your SCIM URL and SCIM API Key. You will need to use both values in a later step.

Create a OneLogin app

In the OneLogin Portal, navigate to the the Applications screen and select the Add App button:

Add an Application
Add an Application

In the search bar, type SCIM and select the SCIM Provisioner with SAML (SCIM v2 Enterprise) app:

SCIM Provisioner App
SCIM Provisioner App

Give your application a Bitwarden-specific Display Name and select the Save button.

Configuration

Select Configuration from the left-hand navigation and configure the following information, some of which you will need to retrieve from the Single Sign-On and SCIM Provisioning screens in Bitwarden.

SCIM App Configuration
SCIM App Configuration

Application details

OneLogin will require you to fill in the SAML Audience URL and SAML Consumer URL fields even if you aren't going to use single sign-on. Learn what to enter in these fields.

API connection

Enter the following values in the API Connection section:

Application setting Description
SCIM base URL Set this field to the SCIM URL (learn more).
SCIM bearer token Set this field to the SCIM API key (learn more).

Select Save once you have configured these fields.

Access

Select Access from the left-hand navigation. In the Roles section, assign application access to all the roles you would like provision in Bitwarden. Each role is treated as a group in your Bitwarden organization, and users assigned to any role will be included in each group including if they are assigned multiple roles.

Parameters

Select Parameters from the left-hand navigation. Select Groups from the table, enable the Include in User Provisioning checkbox, and select the Save button:

Include Groups in User Provisioning
Include Groups in User Provisioning

Rules

Create a rule to map OneLogin Roles to Bitwarden groups:

  1. Select Rules from the left-hand navigation.

  2. Select the Add Rule button to open the New mapping dialog:

    Role/Group Mapping
    Role/Group Mapping

  3. Give the rule a Name like Create Groups from Rules.

  4. Leave Conditions blank.

  5. In the Actions section:

    1. Select Set Groups in <application_name> from the first dropdown.

    2. Select the Map from OneLogin option.

    3. Select role from the "For each" dropdown.

    4. Enter .* in the "with value that matches" field to map all roles to groups, or enter a specific role name.

  6. Select the Save button to finish creating the rule.

Test connection

Select Configuration from the left-hand navigation, and select the Enable button under API Status:

Test API Connection
Test API Connection

This test will not start provisioning, but will make a GET request to Bitwarden and display Enabled if the application gets a response from Bitwarden successfully.

Enable provisioning

Select Provisioning from the left-hand navigation:

Provisioning Settings
Provisioning Settings

On this screen:

  1. Select the Enable Provisioning checkbox.

  2. In the When users are deleted in OneLogin... dropdown, select Delete.

  3. In the When user accounts are suspended in OneLogin... dropdown, select Suspend.

When you aqre done, select Save to trigger provisioning.

Finish user onboarding

Now that your users have been provisioned, they will receive invitations to join the organization. Instruct your users to accept the invitation and, once they have, confirm them to the organization.

note

The Invite → Accept → Confirm workflow facilitates the decryption key handshake that allows users to securely access organization vault data.

Appendix

User attributes

Both Bitwarden and OneLogin's SCIM Provisioner with SAML (SCIM v2 Enterprise) application use standard SCIM v2 attribute names. Bitwarden will use the following attributes:

  • active

  • emailsª or userName

  • displayName

  • externalId

ª - Because SCIM allows users to have multiple email addresses expressed as an array of objects, Bitwarden will use the value of the object which contains "primary": true.


言語
© 2022 Bitwarden, Inc.
利用規約プライバシーポリシーサイトマップ