google-cloud-run

Deploy 1Password SCIM Bridge on Google Cloud Run

Learn how to deploy 1Password SCIM Bridge on Cloud Run using the Cloud Shell in Google Cloud.

This guide can be used to deploy 1Password SCIM Bridge as an ingress container for a single replica Cloud Run service with the required Redis cache deployed as a sidecar container. Credentials are stored in Secret Manager and mounted as volumes attached to the SCIM bridge container.

The included Cloud Run service YAML manifests are suitable for use in a production environment without modification, but are intentionally minimal for simplicity, to allow any identity provider to connect to its public endpoint, and to facilitate its use as a base for a customized deployment.

Before you begin

Complete the necessary preparation steps to deploy 1Password SCIM Bridge. You'll also need a Google Cloud account with permissions to create a project, set up billing, and enable Google Cloud APIs to create and manage secrets in Secret Manager.

Note

If you don't have a Google Cloud account, you can sign up for a free trial with starting credit: https://console.cloud.google.com/freetrial

Step 1: Set up Google Cloud

1. Sign in to the Google Cloud console and activate Cloud Shell: https://console.cloud.google.com?cloudshell=true

2. Create a project to organize the Google Cloud resources for your 1Password SCIM Bridge deployment, and set it as the default project for your Cloud Shell environment:

   gcloud projects create --name "1Password SCIM Bridge" --set-as-default

   Use the suggested project ID.

Tip

If you have already created a project for your SCIM bridge, set its ID as the default project for this Cloud Shell session. For example:

gcloud config set project op-scim-bridge-1234

3. Enable the Secret Manager and Cloud Run APIs for your project:

   gcloud services enable secretmanager.googleapis.com run.googleapis.com

4. Set the default region for Cloud Run:

   gcloud config set run/region us-central1

Note

All region-bound resources created in the following steps will be created in the specified region. You may replace us-central1 in the above commmand with your preferred region.

Step 2: Create a secret for your scimsession credentials

The Cloud Run service for the SCIM bridge will be configured to mount volume using a secret from Secret Manager. Follow these steps to upload your scimsession credentials file to the Cloud Shell, create a secret, and store the file contents as its first secret version:

1. Click ⋮ (More) > Upload in the Cloud Shell terminal menu bar.

2. Click Choose Files. Select the scimsession file that you saved to your computer.

3. Use the suggested destination directory. Click Upload. If you saved it elsewhere or used a different file name, make a note of the full path to the file.

4. Create a secret with the contents of this file as its first secret version:

   gcloud secrets create scimsession --data-file=$HOME/scimsession

Tip

If the file was not saved using the above suggested values, replace $HOME/scimsession with the actual path to the file. For example:

gcloud secrets create scimsession --data-file=/example/path/to/scimsession.file

5. Enable Cloud Run to access the secret using the Compute Engine default service account for the project:

   gcloud secrets add-iam-policy-binding scimsession --member=serviceAccount:$(
     gcloud iam service-accounts list --filter="$(
       gcloud projects describe $(gcloud config get-value project) --format='value(projectNumber)'
     )-compute@developer.gserviceaccount.com" --format="value(email)"
   ) --role=roles/secretmanager.secretAccessor

Step 3: Deploy your SCIM bridge

Stream the op-scim-bridge.yaml Cloud Run service YAML from this repository, use it to deploy 1Password SCIM Bridge inline, and enable public ingress for your SCIM bridge so that you and your identity provider can connect to its public endpoint:

curl --silent --show-error \
  https://raw.githubusercontent.com/1Password/scim-examples/main/beta/google-cloud-run/op-scim-bridge.yaml |
  gcloud run services replace - &&
  gcloud run services add-iam-policy-binding op-scim-bridge --member=allUsers --role=roles/run.invoker &&
  gcloud run services describe op-scim-bridge --format="value(status.url)"

The final line of the above chained command should output a URL for the HTTPS endpoint provided by Cloud Run. This is your SCIM bridge URL.

Step 4: Test your SCIM bridge

Use your SCIM bridge URL to test the connection and view status information. For example:

curl --silent --show-error --request GET --header "Accept: application/json" \
  --header "Authorization: Bearer mF_9.B5f-4.1JqM" \
  https://op-scim-bridge-example-uc.a.run.app/health

Replace mF_9.B5f-4.1JqM with your bearer token and https://op-scim-bridge-example-uc.a.run.app with your SCIM bridge URL.

Example JSON response:

{
  "build": "209031",
  "version": "2.9.3",
  "reports": [
    {
      "source": "ConfirmationWatcher",
      "time": "2024-04-25T14:06:09Z",
      "expires": "2024-04-25T14:16:09Z",
      "state": "healthy"
    },
    {
      "source": "RedisCache",
      "time": "2024-04-25T14:06:09Z",
      "expires": "2024-04-25T14:16:09Z",
      "state": "healthy"
    },
    {
      "source": "SCIMServer",
      "time": "2024-04-25T14:06:56Z",
      "expires": "2024-04-25T14:16:56Z",
      "state": "healthy"
    },
    {
      "source": "StartProvisionWatcher",
      "time": "2024-04-25T14:06:09Z",
      "expires": "2024-04-25T14:16:09Z",
      "state": "healthy"
    }
  ],
  "retrievedAt": "2024-04-25T14:06:56Z"
}

Similar information is presented graphically by accessing your SCIM bridge URL in a web browser. Sign in with your bearer token to view status information and download container log files.

Step 5: Connect your identity provider

Important

If Google Workspace is your identity provider, additional steps are required: connect your 1Password SCIM Bridge to Google Workspace.

To finish setting up automated user provisioning, connect your identity provider to your SCIM bridge.

Update your SCIM bridge

Important

If Google Workspace is your identity provider, alternate steps are required: update your SCIM bridge when Google Workspace is your IdP

1. Sign in to the Google Cloud console and activate Cloud Shell: https://console.cloud.google.com?cloudshell=true

2. Redeploy your SCIM bridge using the latest version of the Cloud Run services YAML from this directory in our repository:

   curl --silent --show-error \
     https://raw.githubusercontent.com/1Password/scim-examples/main/beta/google-cloud-run/op-scim-bridge.yaml |
     gcloud run services replace -

Tip

Check for 1Password SCIM Bridge updates on the SCIM bridge releases notes website.

3. Test your SCIM bridge deployment using your bearer token.

The new version number that you updated to should appear in the health check, the container logs for 1Password SCIM Bridge, and the top left-hand side of the page if signing in to the SCIM bridge at its URL in a web browser. After you sign in to your SCIM bridge, the Automated User Provisioning page in your 1Password account will also update with the latest access time and SCIM bridge version.

Rotate credentials

To use regenerated credentials in your SCIM bridge deployment, pause provisioning in your identity provider, then update the value of the scimsession credentials:

1. Sign in to the Google Cloud console, select the project for your SCIM bridge deployment, and go to the Cloud Run page.
2. Click on your 1Password SCIM bridge Cloud Run deployment.
3. Select the Revisions tab. Choose the latest deployed revision.
4. Select the Volumes tab in the revision details pane and click the name of the secret associated with the credentials volume (scimsession).
5. Add a secret version with the new SCIM bridge credentials to the secret:
   1. Click ➕ New Version.
   2. Click Browse in the "Upload file" field.
   3. Open the new scimsession file downloaded from 1Password in the file selector. The "Secret value" field displays the file contents that will be used for the new version.
   4. Select Disable all past versions.
   5. Click Add New Version.
6. Return to the Cloud Run page, click the name of the Cloud Run service for your SCIM bridge deployment, and click the URL at the top to access your SCIM bridge in a new browser tab. Sign in using the new bearer token associated with the regenerated scimsession credentials file to verify the change.
7. Update your identity provider configuration with your new bearer token and resume provisioning.