1Password SCIM Bridge

Deploy 1Password SCIM Bridge on DigitalOcean App Platform

Learn how to deploy 1Password SCIM Bridge on DigitalOcean App Platform, so you can integrate with your identity provider.

A diagram showing the connection of identity providers to 1Password SCIM Bridge to 1Password servers.

With 1Password Business, you can automate many common administrative tasks using 1Password SCIM Bridge. It uses the System for Cross-domain Identity Management (SCIM) protocol to connect 1Password with your existing identity provider, like Google Workspace, JumpCloud, Microsoft Entra ID, Okta, OneLogin, or Rippling.

When you deploy 1Password SCIM Bridge with DigitalOcean App Platform instead of the DigitalOcean Marketplace, you can save on costs and keep management simpler without the need to create a DNS record or TLS certificate. You’ll need a DigitalOcean account with available quotas for two droplets.

Step 1: Generate credentials in 1Password

  1. Sign in to your account on 1Password.com.
  2. Select Integrations in the sidebar.
  3. Choose your identity provider from the User Provisioning section.
  4. Select Custom, then select Next.
  5. Select Save in 1Password for both the scimsession file and bearer token to save them as items in your 1Password account. Save each item in an appropriate shared vault.
  6. Select the down arrow beside the scimsession file and save it to your computer.

Step 2: Create resources in DigitalOcean

These steps were recorded in December 2023 and might have changed since. Refer to the DigitalOcean documentation  for the most up-to-date steps.

Before you begin the deployment, download the app spec template op-scim-bridge.yaml from the 1Password SCIM Bridge deployment examples repo on GitHub . Then follow these steps.

2.1: Add the 1Password SCIM Bridge app

  1. Go to the DigitalOcean Apps portal , then select Create App.
  2. Select Docker Hub from the service provider list, then enter 1password/scim in the Repository field, then select Next.
  3. Select Edit beside 1-password-scim, then select Edit beside the Name field.
  4. Enter op-scim-bridge in the Resource Name field, then select Save. Select Back at the bottom of the page.
  5. Select Edit Plan, then select Basic.
  6. From the Instance Size menu, select $5.00/mo - Basic, then select Back.
  7. Select Next on the Resources page, then select Next on the Environment page.
  8. On the Info page, select Edit in the App Info section.
  9. Enter op-scim-bridge in the Name field, then select Save.
  10. If you’d like to change the region, select Edit beside it, then select a region. Select Save.
  11. Select Next on the Info page, then scroll down on the Review page, then select Create Resources.

The deployment of 1Password SCIM Bridge will start and after a few minutes fail, which is expected because the configuration has not been defined. After you see the “deployment failed” message, continue to step 2.2.

2.2: Upload the app manifest

  1. Select the Settings tab on the app page, then scroll down, then select Edit beside App Spec.
  2. Select Upload File, then select the op-scim-bridge.yaml file you downloaded earlier.
  3. Select Replace, then wait a moment for the SCIM bridge to deploy.

Step 3: Configure and deploy your SCIM bridge

  1. After you see the “deployment went live” message at the top of the page, select op-scim-bridge from the Components list, then scroll down, then select Edit beside Environment Variables.

  2. Select the trash beside OP_SESSION to remove it. You’ll upload your own in a moment.

  3. Open a terminal window on your computer, then get the Base64 encoded contents of your scimsession file:

    • Bash:

        cat ./scimsession | base64
      
    • PowerShell:

        [Convert]::ToBase64String([IO.File]::ReadAllBytes((Join-Path $PWD.Path 'scimsession')))
      
  4. Copy the output value. You’ll need it to create the secret for the deployment.

  5. Go back to the Environment Variables section of your app’s Component Settings in DigitalOcean.

  6. Create a new environment variable and enter OP_SESSION in the Keys field, then paste the base64 value of your scimsession secret in the Values field.

  7. Select Encrypt beside the value, then select Save. The deployment will take a moment to update.

  8. After the deployment is live, use the Live App button at the top of the page to open your SCIM bridge. You can also use the URL link at the top of the page below your project name.

  9. Enter your bearer token, then select Verify.

Step 4: Connect your identity provider to the SCIM bridge

Important

If you’ve already been using 1Password Business, make sure the email addresses and group names in your 1Password account are identical to those in your identity provider.

  • If anyone is using a different email address in 1Password, ask them to change it.
  • If you have existing groups in 1Password that you want to sync with groups in your identity provider, adjust the group names in 1Password.

Because 1Password SCIM Bridge provides a SCIM 2.0-compatible web service that accepts OAuth bearer tokens for authorization, you can use it with a variety of identity providers.

Connect to the load balancer where you’ve configured the SCIM bridge (for example: https://scim.example.com) and authenticate using your OAuth bearer token.

Learn how to connect your identity provider:

Update your SCIM bridge

The latest version of 1Password SCIM Bridge is posted on the release notes website. To update your SCIM bridge:

  1. Navigate to the DigitalOcean Apps portal , then select your SCIM bridge (by default, op-scim-bridge) from the list of apps.
  2. Select op-scim-bridge in the Compute section.
  3. Select Edit in the Source section.
  4. Change the version number in the Tag field to match the latest version from the SCIM Bridge release notes page .
  5. Select Save. The SCIM bridge will redeploy with the new version.
  6. Navigate to your SCIM bridge URL and sign in with your bearer token.
  7. Check the version in the top left of the page.

Get help

Get help with the SCIM bridge, like if you lose your bearer token or session file.

To get more help or share feedback, contact 1Password Business Support or join the discussion with the 1Password Support Community.

Published: