Skip to main content
Watch a video demonstrating SCIM in action (12 min)

​
Overview

This page describes how instance and organization admins use the System for Cross-domain Identity Management (SCIM) API to automate identity management in W&B. With the SCIM API, you can provision and deprovision users, manage team membership, and define custom roles programmatically through an identity provider or CI/CD pipeline instead of clicking through the W&B App. SCIM groups map to W&B Teams. W&B’s SCIM API is compatible with identity providers such as Okta. For SSO configuration with Okta and other identity providers, see the SSO documentation. For practical Python examples that demonstrate how to interact with the SCIM API, visit the wandb-scim repository.

​
Supported features

The SCIM API supports the following features:
  • Filtering: The API supports filtering for /Users and /Groups endpoints.
  • PATCH operations: Supports PATCH for partial resource updates.
  • ETag support: Conditional updates using ETags for conflict detection.
  • Service account authentication: Organization service accounts can access the API.
  • Service account lifecycle: Provision and deprovision team-scoped and organization-scoped service accounts. Supported on Multi-tenant Cloud and on Dedicated Cloud and Self-Managed v0.81.0+.
If you’re an admin of multiple Enterprise Multi-tenant Cloud organizations, configure the organization that receives SCIM API requests so that requests made with your API key affect the correct organization. Click your profile image, click User Settings, then check the Default API organization setting.The chosen hosting option determines the value for the [HOST-URL] placeholder used in the examples on this page.Examples use user IDs such as abc and def. Real requests and responses use hashed values for user IDs.

​
Authentication

Every SCIM request must be authenticated as an admin principal. Organization admins can authenticate with a Bearer token or HTTP Basic credentials. Either style uses the same API key string where a key applies. Choose a user identity or an organization-scoped service account after reviewing the key differences in the following section.

​
Key differences

The following list compares user credentials and service account credentials for SCIM authentication:
  • Who should use it: Users are best for interactive, one-off admin actions. Service accounts are best for automation and integrations (CI/CD, provisioning tools).
  • Credentials: Users send username and API key for Basic auth. Service accounts send only an API key (no username) for Basic auth. For Bearer auth, send only the API key in the header (no username).
  • Bearer versus Basic: Bearer uses Authorization: Bearer [API-KEY] with the key verbatim. Basic uses Authorization: Basic <base64(...)> (users encode username:API-KEY, and service accounts encode :API-KEY with a leading colon and empty username).
  • Scope and permissions: Use an API key from an instance or organization admin user, or from an organization-scoped service account. Keys from team-scoped service accounts can’t authenticate to the SCIM API. Service accounts that use SCIM are organization-scoped and headless, which supports clearer audit trails for automation.
  • Where to get credentials: Users copy their API key from User Settings. Organization-scoped service account keys are in the organization dashboard under the Service account tab.
  • Multi-tenant Cloud: If you have access to more than one Multi-tenant Cloud organization, you must set the Default API organization to ensure that SCIM API calls are routed to the intended organization.

​
Bearer token

Send the API key as a Bearer token: 
Authorization: Bearer [API-KEY]
The [API-KEY] value is the same string you’d use as the password in HTTP Basic authentication for that principal. Don’t Base64-encode the key for Bearer requests.
Bearer authentication for the SCIM API is available in W&B Multi-tenant Cloud, and in Dedicated Cloud and Self-Managed v0.79.0 and later.
The following examples use [API-KEY] as a placeholder. Replace it with a real key from an admin user or an organization-scoped service account. List users 
curl -s -S \
  -H "Authorization: Bearer [API-KEY]" \
  -H "Content-Type: application/scim+json" \
  "[HOST-URL]/scim/Users"
Create a user 
curl -s -S -X POST \
  -H "Authorization: Bearer [API-KEY]" \
  -H "Content-Type: application/scim+json" \
  "[HOST-URL]/scim/Users" \
  -d '{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "userName": "dev-user2",
    "emails": [{"primary": true, "value": "dev-user2@example.com"}]
  }'
For more information, see Create user.

​
Users

Use your personal admin credentials when you perform interactive admin tasks. Construct the HTTP Authorization header as Basic <base64(username:API-KEY)>. For example, authorize as demo:p@55w0rd: 
Authorization: Basic ZGVtbzpwQDU1dzByZA==

​
Service accounts

Use an organization-scoped service account for automation or integrations. Construct the HTTP Authorization header as Basic <base64(:API-KEY)> (note the leading colon and empty username). Find service account API keys in the organization dashboard under the Service account tab. Refer to Organization-scoped service accounts. For example, authorize with API key sa-p@55w0rd: 
Authorization: Basic OnNhLXBANTV3MHJk

​
User management

The SCIM user resource maps to W&B users and service accounts. Use the endpoints in this section to provision, update, and remove users and service accounts in your organization, for example, when you onboard new employees, rotate service credentials, or remove access for departing users. For service account concepts and UI workflows, see Use service accounts to automate workflows.
Breaking change for integrations that parse SCIM User JSON
  • In Dedicated Cloud and Self-Managed v0.80.1+, and in Multi-tenant Cloud deployments after April 30, 2026, responses from /scim/Users (including GET user, GET users, and PATCH responses that return a User) serialize emails as a JSON array of objects using lowercase field names (value, primary, and optional type or display), matching SCIM 2.0.
  • Deployments on older releases return emails as a single JSON object with PascalCase keys (Value, Primary, and similar).
If your code reads emails from SCIM responses, treat emails as an array and read the primary entry (or the first element).Request bodies for creating or updating users already used the array form and are unchanged. The list-users filter emails.value eq "..." is also unchanged.

​
Get user

Retrieves information for a specific user or service account in your organization by user ID, or for a user by email address. Service account responses include accountType (SERVICE for team-scoped service accounts, ORG_SERVICE for organization-scoped service accounts). Service accounts don’t include emails.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: GET

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user

​
Example

GET /scim/Users/abc

​
List users

Retrieves a list of all users and service accounts in your organization. Each resource includes accountType (USER, SERVICE, or ORG_SERVICE).

​
Filter users

The /Users endpoint supports filtering users by username or email:
  • userName eq "value": Filter by username.
  • emails.value eq "value": Filter by email address.
Example
GET /scim/Users?filter=userName eq "john.doe"
GET /scim/Users?filter=emails.value eq "john@example.com"

​
Endpoint

  • URL: [HOST-URL]/scim/Users
  • Method: GET

​
Example

GET /scim/Users

​
Create user

Creates a new user in your organization.

​
Endpoint

  • URL: [HOST-URL]/scim/Users
  • Method: POST

​
Parameters

ParameterTypeRequiredDescription
emailsarrayYesArray of email objects. Must include a primary email
userNamestringYesThe username for the new user
modelsSeatstringNoModels seat level. One of full, viewer, or none. Defaults to full.
weaveRolestringNoWeave role level. One of full, viewer, or none. Defaults to full.

​
Example

POST /scim/Users

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "emails": [
        {
            "primary": true,
            "value": "dev-user2@example.com"
        }
    ],
    "userName": "dev-user2",
    "modelsSeat": "full",
    "weaveRole": "full"
}

​
Response

(Status 201)

{
    "active": true,
    "displayName": "Dev User 2",
    "emails": [
        {
            "primary": true,
            "value": "dev-user2@example.com"
        }
    ],
    "id": "def",
    "meta": {
        "resourceType": "User",
        "created": "2023-10-01T00:00:00Z",
        "location": "Users/def"
    },
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "modelsSeat": "full",
    "weaveRole": "full",
    "userName": "dev-user2"
}

​
Provision service account

Creates a team-scoped or organization-scoped service account in your organization. Use this endpoint to create headless identities for automation, CI/CD, or integrations that shouldn’t be tied to a human user. Omit accountType to create a regular user instead. See Create user.
Available in Dedicated Cloud and Self-Managed v0.81.0+ and in Multi-tenant Cloud.
  • Set userName to the service account name. The API uses userName for the account’s display name. The displayName field in the request body is ignored.
  • emails aren’t required for service accounts.
  • modelsSeat and weaveRole aren’t supported on create and return 400 Bad Request if present.
  • Service accounts can’t be updated with PATCH or PUT, can’t be deactivated, and can’t be assigned organization, team, or registry roles through SCIM. Create API keys in the W&B App after provisioning.

​
Endpoint

  • URL: [HOST-URL]/scim/Users
  • Method: POST

​
Parameters

ParameterTypeRequiredDescription
userNamestringYesUnique name for the service account.
accountTypestringYesSERVICE for a team-scoped service account, or ORG_SERVICE for an organization-scoped service account.
urn:ietf:params:scim:schemas:extension:teams:2.0:UserobjectYesTeams extension object.
defaultTeamstringYesSub-field of the teams extension. Name of an existing W&B Team. The service account is created as a member of this team. For team-scoped service accounts, this is the only team they join. Organization-scoped service accounts are also added automatically to teams created later through SCIM.
teamsarrayNoMulti-tenant Cloud only. Team names to add the account to. Include the same team as defaultTeam when you use this field.

​
Example

POST /scim/Users

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:teams:2.0:User"
    ],
    "userName": "sa-deploy-bot",
    "accountType": "SERVICE",
    "urn:ietf:params:scim:schemas:extension:teams:2.0:User": {
        "defaultTeam": "ml-platform"
    }
}

​
Response

(Status 201)

{
    "accountType": "SERVICE",
    "active": true,
    "displayName": "sa-deploy-bot",
    "id": "xyz",
    "meta": {
        "resourceType": "User",
        "created": "2023-10-01T00:00:00Z",
        "location": "Users/xyz"
    },
    "organizationRole": "member",
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:wandb:2.0:User"
    ],
    "teamRoles": [
        {
            "teamName": "ml-platform",
            "roleName": "member"
        }
    ],
    "urn:ietf:params:scim:schemas:extension:wandb:2.0:User": {
        "organizationRole": "member"
    },
    "userName": "sa-deploy-bot"
}
For an organization-scoped service account, accountType is ORG_SERVICE. In Self-Managed deployments, organizationRole is service or org_service instead of member, matching the account type. If the response returns one of the following errors, check the request for these common problems:
  • 409 Conflict: The request includes duplicate userName keys for the same service account.
  • 400 Bad Request: The request is missing defaultTeam or sets it to an invalid value.

​
Deprovision service account

Permanently deletes a service account and its organization membership. Use this endpoint when a service account is no longer needed (for example, after you retire an automation pipeline). This is a hard delete, and the account can’t be reactivated through SCIM.
Available in Dedicated Cloud and Self-Managed v0.81.0+ and in Multi-tenant Cloud. Use the service account’s SCIM user id from the provision response or from Get user. Deprovisioning doesn’t delete API keys that were already issued. Revoke keys separately in the W&B App if needed.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: DELETE

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the service account.

​
Example

DELETE /scim/Users/xyz

​
Delete user

Maintain admin accessEnsure that at least one admin user always exists in your instance or organization. Otherwise, no user can configure or maintain your organization’s W&B account. If an organization uses SCIM or another automated process to deprovision users from W&B, a deprovisioning operation could inadvertently remove the last remaining admin from the instance or organization.For assistance with developing operational procedures, or to restore admin access, contact support.
Fully deletes a user from your organization. To delete a service account, see Deprovision service account.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: DELETE

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user to delete

​
Example

DELETE /scim/Users/abc
To temporarily deactivate the user, refer to the Deactivate user API, which uses the PATCH endpoint.

​
Update user email

Updates a user’s primary email address. Not supported for Multi-tenant Cloud, where a user’s account isn’t managed by the organization.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesreplace
pathstringYesemails
valuearrayYesArray with new email object

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "emails",
            "value": [
                {
                    "value": "newemail@example.com",
                    "primary": true
                }
            ]
        }
    ]
}

​
Update user display name

Updates a user’s display name. Not supported for Multi-tenant Cloud, where a user’s account isn’t managed by the organization.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesreplace
pathstringYesdisplayName
valuestringYesNew display name

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "displayName",
            "value": "John Doe"
        }
    ]
}

​
Deactivate user

Deactivates a user in your organization. The result differs by deployment type:
  • Dedicated Cloud / Self-Managed: Sets the user’s active field to false. To restore a deactivated user’s access to your organization, see Reactivate user.
  • Multi-tenant Cloud: Removes the user from the organization. To restore the user’s access, re-add them to your organization. See Create user. In Multi-tenant Cloud, a user’s account isn’t managed by the organization.
This operation works for users only, not service accounts. Deactivating a service account isn’t supported. Manage team service accounts in the settings for the W&B Team.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user to deactivate
opstringYesreplace
valueobjectYesObject with {"active": false}

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "value": {"active": false}
        }
    ]
}

​
Response

(Status 200)

{
    "active": false,
    "displayName": "Dev User 1",
    "emails": [
        {
            "primary": true,
            "value": "dev-user1@example.com"
        }
    ],
    "id": "abc",
    "meta": {
        "resourceType": "User",
        "created": "2023-10-01T00:00:00Z",
        "lastModified": "2023-10-01T00:00:00Z",
        "location": "Users/abc"
    },
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "userName": "dev-user1"
}

​
Reactivate user

Reactivates a previously deactivated user in your organization.
  • User reactivation works for users only, not service accounts. Reactivation isn’t supported for service accounts. Manage service accounts in the settings for the W&B Team.
  • User reactivation isn’t supported in Multi-tenant Cloud. To restore the user’s access, re-add them to your organization. See Create user. In Multi-tenant Cloud, a user’s account isn’t managed by the organization. An attempt to reactivate a user results in an HTTP 400 error. The detail field in the response body is returned verbatim from the API and may still use legacy product wording: 
    {
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "detail": "User reactivation operations are not supported in SaaS Cloud",
    "status": "400"
}

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user to reactivate
opstringYesreplace
valueobjectYesObject with {"active": true}

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "value": {"active": true}
        }
    ]
}

​
Assign organization role

Assigns an organization-level role to a user.
This operation works for users only, not service accounts. Custom roles aren’t supported for service accounts.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesreplace
pathstringYesorganizationRole
valuestringYesRole name (admin or member)
The organization-scoped viewer role is deprecated and can no longer be assigned in the UI. If you use SCIM to assign the viewer role to a user:
  • They’re assigned the member role in the organization.
  • Their modelsSeat is set to viewer instead of full. This allows view-only access to Models and full access to Registry. If no Models seats are available, a Seat limit reached error is returned. This can be updated later if a seat is available.
  • Their weaveRole is set to viewer instead of full. This allows view-only access to Weave.
  • All of their existing team and project roles are set to viewer.
  • They’re assigned the Registry viewer role in registries that are visible at the organization level.
Assigning the member or admin organization role doesn’t change the user’s modelsSeat or weaveRole.

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "organizationRole",
            "value": "admin"
        }
    ]
}

​
Update Models seat

Updates a user’s Models seat.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesreplace
pathstringYesmodelsSeat
valuestringYesSeat level (full, viewer, or none)

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "modelsSeat",
            "value": "full"
        }
    ]
}

​
Update Weave role

Updates a user’s Weave role.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesreplace
pathstringYesweaveRole
valuestringYesRole level (full, viewer, or none)

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "weaveRole",
            "value": "full"
        }
    ]
}

​
Assign team role

Assigns a team-level role to a user.
This operation works for users only, not service accounts. Custom roles aren’t supported for service accounts.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesreplace
pathstringYesteamRoles
valuearrayYesArray of objects with teamName and roleName

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "teamRoles",
            "value": [
                {
                    "roleName": "admin",
                    "teamName": "team1"
                }
            ]
        }
    ]
}

​
Add to Registry

Adds a user to a registry with an assigned registry-level role.
This operation works for users only, not service accounts. Custom roles aren’t supported for service accounts.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesadd
pathstringYesregistryRoles
valuearrayYesArray of objects with registryName and roleName

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "registryRoles",
            "value": [
                {
                    "roleName": "admin",
                    "registryName": "hello-registry"
                }
            ]
        }
    ]
}

​
Remove from Registry

Removes a user from a registry.
  • The remove operations follow RFC 7644 SCIM protocol specifications. Use the filter syntax "registryRoles[registryName eq \"{registry_name}\"]" to remove a user from a specific registry, or "registryRoles" to remove the user from all registries.
  • This operation works for users only, not service accounts. Remove service accounts from a registry in the settings for the W&B Team.

​
Endpoint

  • URL: [HOST-URL]/scim/Users/{id}
  • Method: PATCH

​
Parameters

ParameterTypeRequiredDescription
idstringYesThe unique ID of the user
opstringYesremove
pathstringYes"registryRoles[registryName eq \"{registry_name}\"]" or "registryRoles"

​
Example

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "registryRoles[registryName eq \"goodbye-registry\"]"
        }
    ]
}

PATCH /scim/Users/abc

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "registryRoles"
        }
    ]
}

​
Group resource

The SCIM group resource maps to a W&B Team. Use the endpoints in this section to create teams, manage team membership, and (optionally) configure team-level storage from your identity provider or automation. When you create a SCIM group in your IAM, it creates and maps to a W&B Team, and other SCIM group operations act on the team. To configure custom storage during team creation, include storageBucket in the request.

​
Service accounts

When you create a W&B Team using SCIM, all organization-level service accounts are automatically added to the team, to maintain the service account’s access to team resources.

​
Filter groups

The /Groups endpoint supports filtering to search for specific teams.

​
Supported filters

The /Groups endpoint supports the following filter:
  • displayName eq "value": Filter by team display name.

​
Example

GET /scim/Groups?filter=displayName eq "engineering-team"

​
Get team

Retrieve team information by providing the team’s unique ID.

​
Endpoint

  • URL: [HOST-URL]/scim/Groups/{id}
  • Method: GET

​
Example

GET /scim/Groups/ghi

​
List teams

Retrieve a list of teams.

​
Endpoint

  • URL: [HOST-URL]/scim/Groups
  • Method: GET

​
Example

GET /scim/Groups

​
Create team

Creates a new team resource.

​
Endpoint

  • URL: [HOST-URL]/scim/Groups
  • Method: POST

​
Supported fields

FieldTypeRequired
displayNameStringYes
membersMulti-Valued ArrayYes (value sub-field is required and maps to a user ID)
storageBucketObjectNo
You can configure team-level Bring your own bucket (BYOB) during team creation by including a storageBucket object. If omitted, the team uses default or instance-level storage. Provision the bucket (policy, CORS, credentials) and determine the storage address format per provider using the BYOB guide. The storageBucket object has the following sub-fields:
  • Required: name (bucket name), provider (one of COREWEAVE, AWS, AZURE, GCP, or MINIO). The value is case-sensitive. Use uppercase as shown.
  • Optional: path (path prefix within the bucket), kmsKeyId (KMS key for encryption, for example for AWS), awsExternalId (AWS cross-account access), azureTenantId (Azure tenant ID), azureClientId (Azure managed identity client ID).
W&B validates that the bucket exists and is reachable before creating the team. If validation fails, the SCIM request fails and the team isn’t created. An invalid provider value returns 400 Bad Request with a SCIM error that lists the allowed values.

​
Examples

These examples show how to create a team without custom storage and with BYOB storage on a specific provider. Select a tab for the desired storage configuration to see an example request, and select the Response tab for an example response. 
POST /scim/Groups

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
    "displayName": "wandb-support",
    "members": [
        {
            "value": "def"
        }
    ]
}

​
Update team

Updates an existing team’s membership list.

​
Endpoint

  • URL: [HOST-URL]/scim/Groups/{id}
  • Method: PATCH
  • Supported operations: add member, remove member, replace members.
  • The remove operations follow RFC 7644 SCIM protocol specifications. Use the filter syntax members[value eq "{user_id}"] to remove a specific user, or members to remove all users from the team. User identification: The {user_id} in member operations can be either of the following:
  • These operations work for users only, not service accounts. Update a team’s service accounts in the settings for the W&B Team.
Replace {team_id} with the actual team ID and {user_id} with the actual user ID or email address in your requests.

​
Replace team members

Replaces all members of a team with a new list.
This operation works for users only, not service accounts. Manage service accounts in the settings for the W&B Team.

​
Endpoint

  • URL: [HOST-URL]/scim/Groups/{id}
  • Method: PUT
PUT /scim/Groups/{team_id}

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
    "displayName": "acme-devs",
    "members": [
        {
            "value": "{user_id_1}"
        },
        {
            "value": "{user_id_2}"
        }
    ]
}

​
Add a user to a team

Adds dev-user2 to acme-devs:
This operation works for users only, not service accounts. Manage service accounts in the settings for the W&B Team.
PATCH /scim/Groups/{team_id}

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "add",
            "path": "members",
            "value": [
                {
                    "value": "{user_id}"
                }
            ]
        }
    ]
}

​
Remove a specific user from a team

Removes dev-user2 from acme-devs:
This operation works for users only, not service accounts. Manage service accounts in the settings for the W&B Team.
PATCH /scim/Groups/{team_id}

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "remove",
            "path": "members[value eq \"{user_id}\"]"
        }
    ]
}

​
Remove all users from a team

Removes all users from acme-devs:
This operation works for users only, not service accounts. Manage service accounts in the settings for the W&B Team.
PATCH /scim/Groups/{team_id}

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "remove",
            "path": "members"
        }
    ]
}

​
Delete team

The SCIM API doesn’t support deleting teams because additional data is linked to teams. Delete teams from the W&B App to confirm you want everything deleted.

​
Role resource

The SCIM role resource maps to W&B custom roles. Use the endpoints in this section to create and maintain custom roles programmatically (for example, to keep role definitions in sync with your access policies). The /Roles endpoints aren’t part of the official SCIM schema. W&B adds /Roles endpoints to support automated management of custom roles in W&B organizations.

​
Get custom role

Retrieve information for a custom role by providing the role’s unique ID.

​
Endpoint

  • URL: [HOST-URL]/scim/Roles/{id}
  • Method: GET

​
Example

GET /scim/Roles/abc

​
List custom roles

Retrieve information for all custom roles in the W&B organization.

​
Endpoint

  • URL: [HOST-URL]/scim/Roles
  • Method: GET

​
Example

GET /scim/Roles

​
Create custom role

Creates a new custom role in the W&B organization.

​
Endpoint

  • URL: [HOST-URL]/scim/Roles
  • Method: POST

​
Supported fields

FieldTypeRequired
nameStringName of the custom role
descriptionStringDescription of the custom role
permissionsObject arrayArray of permission objects where each object includes a name string field that has value of the form w&bobject:operation. For example, a permission object for delete operation on W&B runs would have name as run:delete.
inheritedFromStringThe predefined role that the custom role inherits from. It can be either member or viewer.

​
Example

POST /scim/Roles

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Role"],
    "name": "Sample custom role",
    "description": "A sample custom role for example",
    "permissions": [
        {
            "name": "project:update"
        }
    ],
    "inheritedFrom": "member"
}

​
Update custom role

The following sections describe how to add or remove permissions on an existing custom role.

​
Add permissions to role

Adds permissions to an existing custom role.
Endpoint
  • URL: [HOST-URL]/scim/Roles/{id}
  • Method: PATCH
PATCH /scim/Roles/{role_id}

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "add",
            "path": "permissions",
            "value": [
                {
                    "name": "project:delete"
                },
                {
                    "name": "run:stop"
                }
            ]
        }
    ]
}

​
Remove a permission from a role

Removes permissions from an existing custom role.
Endpoint
  • URL: [HOST-URL]/scim/Roles/{id}
  • Method: PATCH
PATCH /scim/Roles/{role_id}

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "remove",
            "path": "permissions",
            "value": [
                {
                    "name": "project:update"
                }
            ]
        }
    ]
}

​
Replace custom role

Replaces an entire custom role definition.

​
Endpoint

  • URL: [HOST-URL]/scim/Roles/{id}
  • Method: PUT
PUT /scim/Roles/{role_id}

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Role"],
    "name": "Updated custom role",
    "description": "Updated description for the custom role",
    "permissions": [
        {
            "name": "project:read"
        },
        {
            "name": "run:read"
        },
        {
            "name": "artifact:read"
        }
    ],
    "inheritedFrom": "viewer"
}

​
Delete custom role

Delete a custom role in the W&B organization. Use this operation with caution. The predefined role that the custom role inherited from is reassigned to all users who held the custom role before the deletion.

​
Endpoint

  • URL: [HOST-URL]/scim/Roles/{id}
  • Method: DELETE

​
Example

DELETE /scim/Roles/abc

​
Advanced features

The following sections describe optional capabilities (ETag-based concurrency control and standard error responses) that help SCIM integrations behave safely in production.

​
ETag support

The SCIM API supports ETags for conditional updates to prevent concurrent modification conflicts. This matters when multiple admins or automated systems update the same resource, because it ensures that one update doesn’t silently overwrite another. ETags are returned in the ETag response header and the meta.version field.

​
ETags

To use ETags, follow these steps:
  1. Get current ETag: When you GET a resource, note the ETag header in the response.
  2. Conditional update: Include the ETag in the If-Match header when updating.

​
Example

# Get user and note ETag
GET /scim/Users/abc
# Response includes: ETag: W/"xyz123"

# Update with ETag
PATCH /scim/Users/abc
If-Match: W/"xyz123"

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "replace",
            "path": "organizationRole",
            "value": "admin"
        }
    ]
}
A 412 Precondition Failed error response indicates that the resource has been modified since you retrieved it.

​
Error handling

The SCIM API returns standard SCIM error responses:
Status CodeDescription
200Success
201Created
204No Content (successful deletion)
400Bad Request: invalid parameters or request body
401Unauthorized: authentication failed
403Forbidden: insufficient permissions
404Not Found: resource doesn’t exist
409Conflict: resource already exists
412Precondition Failed: ETag mismatch
500Internal Server Error

​
Implementation differences per deployment type

W&B maintains two separate SCIM API implementations, and the features differ between them. Review the following table before you integrate with SCIM to confirm that the operations you rely on are available on your deployment type.
FeatureMulti-tenant CloudDedicated Cloud and Self-Managed
Update user email-✓
Update user display name-✓
User deactivation✓✓
User reactivation-✓
Multiple emails per user✓-
Set modelsSeat on create/update✓✓
Set weaveRole on create/update✓✓

​
Limitations

Keep the following constraints in mind when you design SCIM integrations:
  • Maximum results: 9,999 items per request.
  • Dedicated Cloud and Self-Managed: Only support one email per user.
  • Team deletion: Not supported through SCIM (use the W&B web interface).
  • User reactivation: Not supported in Multi-tenant Cloud environments.
  • Seat limits: Operations may fail if organization seat limits are reached.