Skip to main content

Documentation Index

Fetch the complete documentation index at: https://wb-21fd5541-docs-2661.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

This guide is for administrators of W&B Dedicated Cloud or Self-Managed instances who want to enable single sign-on (SSO) using an OpenID Connect (OIDC) compatible identity provider. By the end, you’ve configured your identity provider, connected it to W&B so that users can sign in through your organization’s existing identity system, and you can manage user identities and group memberships through providers like Okta, Keycloak, Auth0, Google, and Entra.

OpenID Connect

W&B supports the following OIDC authentication flows for integrating with external Identity Providers (IdPs):
  • Implicit flow with form post.
  • Authorization code flow with Proof Key for Code Exchange (PKCE).
These flows authenticate users and provide W&B with the identity information (in the form of ID tokens) needed to manage access control. The ID token is a JWT that contains the user’s identity information, such as their name, username, email, and group memberships. W&B uses this token to authenticate the user and map them to appropriate roles or groups in the system. In the context of W&B, access tokens authorize requests to APIs on behalf of the user, but because W&B’s primary concern is user authentication and identity, it only requires the ID token. You can use environment variables to configure IAM options for your Dedicated Cloud or Self-Managed instance. To assist with configuring Identity Providers for Dedicated Cloud or Self-Managed deployments, follow these guidelines. If you’re using W&B Multi-tenant Cloud, reach out to support@wandb.com for assistance.

Configure your IdP

The following sections describe how to configure your identity provider (IdP) for OIDC. Complete the configuration steps for your IdP first. You use the resulting Client ID, Issuer URL, and (optionally) Client Secret when you set up SSO in W&B in the next section. Select the tab for your IdP for details.
Follow this procedure to set up AWS Cognito as your IdP. At the end, you have a Client ID and OIDC issuer URL to use when you configure W&B.
  1. Sign in to your AWS account and navigate to the AWS Cognito App.
    AWS Cognito setup
  2. Provide an allowed callback URL to configure the application in your IdP. Add http(s)://[YOUR-W-AND-B-HOST]/oidc/callback as the callback URL. Replace [YOUR-W-AND-B-HOST] with your W&B host path.
  3. If your IdP supports universal logout, set the Logout URL to http(s)://[YOUR-W-AND-B-HOST]. Replace [YOUR-W-AND-B-HOST] with your W&B host path. For example, if your application runs at https://wandb.mycompany.com, replace [YOUR-W-AND-B-HOST] with wandb.mycompany.com. The following image demonstrates how to provide allowed callback and sign-out URLs in AWS Cognito.
    Host configuration
    wandb/local uses the implicit grant with the form_post response type by default. You can also configure wandb/local to perform an authorization_code grant that uses the PKCE Code Exchange flow.
  4. Select one or more OAuth grant types to configure how AWS Cognito delivers tokens to your app.
  5. W&B requires specific OpenID Connect (OIDC) scopes. Select the following from AWS Cognito App:
    • openid
    • profile
    • email
    For example, your AWS Cognito App UI should look similar to the following image:
    Required fields
    Select the Auth Method in the settings page or set the OIDC_AUTH_METHOD environment variable to specify which grant wandb/local uses. You must set the Auth Method to pkce.
  6. You need a Client ID and the URL of your OIDC issuer. The OpenID discovery document must be available at $OIDC_ISSUER/.well-known/openid-configuration. For example, you can generate your issuer URL by appending your User Pool ID to the Cognito IdP URL from the App Integration tab within the User Pools section:
    AWS Cognito issuer URL
    Don’t use the Cognito domain for the IdP URL. Cognito provides its discovery document at https://cognito-idp.$REGION.amazonaws.com/$USER_POOL_ID.
Next, Set up SSO in W&B.

Set up SSO in W&B

After you finish configuring your IdP, complete the following steps in W&B to connect the IdP and enable SSO for your instance. To set up SSO, you must have administrator privileges and the following information:
  • OIDC Client ID.
  • OIDC Auth method (implicit or pkce).
  • OIDC Issuer URL.
  • OIDC Client Secret (optional, depends on how you’ve set up your IdP).
If your IdP requires an OIDC Client Secret, specify it by passing the environment variables GORILLA_OIDC_SECRET:
  • In the W&B App, go to System Console > Settings > Advanced > User Spec and add GORILLA_OIDC_SECRET to the extraENV section as shown in the following example.
  • In Helm, configure values.global.extraEnv as shown in the following example.
    values:
    global:
        extraEnv:
        GORILLA_OIDC_SECRET="[YOUR-SECRET]"
    
If you can’t sign in to your instance after configuring SSO, you can restart the instance with the LOCAL_RESTORE=true environment variable set. This outputs a temporary password to the containers logs and disables SSO. After you resolve any issues with SSO, you must remove that environment variable to enable SSO again.
Use this tab if you deploy W&B with the W&B Kubernetes Operator. The System Console is the successor to the System Settings page. It’s available with the W&B Kubernetes Operator based deployment.
  1. Refer to Access the W&B Management Console.
  2. Navigate to Settings, then Authentication. Select OIDC in the Type dropdown.
    System Console OIDC configuration
  3. Enter the values.
  4. Click Save.
  5. Sign out and then sign back in, this time using the IdP sign-in screen.

Find your customer namespace

Before you can configure team-level BYOB with CoreWeave storage on W&B Dedicated Cloud or Self-Managed, you must obtain your organization’s Customer Namespace. You can view and copy it from the bottom of the Authentication tab.For detailed instructions on configuring CoreWeave storage with your Customer Namespace, see CoreWeave requirements for Dedicated Cloud or Self-Managed.
If you can’t sign in to your instance after configuring SSO, you can restart the instance with the LOCAL_RESTORE=true environment variable set. This outputs a temporary password to the containers logs and disables SSO. After you resolve any issues with SSO, you must remove that environment variable to enable SSO again.

Security Assertion Markup Language (SAML)

W&B doesn’t support SAML.