메인 콘텐츠로 건너뛰기
SCIM 작동 시연 비디오 (12분)를 시청하세요.

​
개요

SCIM (System for Cross-domain Identity Management) API를 사용하면 인스턴스 또는 조직 관리자가 W&B 조직 내의 Users, Groups 및 커스텀 역할을 관리할 수 있습니다. SCIM 그룹은 W&B Teams에 매핑됩니다. W&B의 SCIM API는 Okta를 포함한 주요 ID 제공업체와 호환되어 사용자 프로비저닝 및 프로비저닝 해제를 자동화할 수 있습니다. Okta 및 기타 ID 제공업체와의 SSO 설정에 대해서는 SSO 문서를 참조하세요. SCIM API와 상호작용하는 방법을 보여주는 실용적인 Python 예제는 wandb-scim 저장소를 방문하세요.

​
지원 기능

  • 필터링: API는 /Users 및 /Groups 엔드포인트에 대한 필터링을 지원합니다.
  • PATCH 작업: 리소스의 부분 업데이트를 위한 PATCH를 지원합니다.
  • ETag 지원: 충돌 감지를 위해 ETag를 사용한 조건부 업데이트를 지원합니다.
  • 서비스 계정 인증: 조직 서비스 계정으로 API에 엑세스할 수 있습니다.
여러 개의 Enterprise Multi-tenant SaaS 조직의 관리자인 경우, API 키를 사용한 SCIM API 요청이 올바른 조직에 적용되도록 대상 조직을 설정해야 합니다. 프로필 이미지를 클릭한 다음 User Settings를 클릭하고 Default API organization 설정을 확인하세요.선택한 호스팅 옵션에 따라 이 페이지의 예제에 사용된 <host-url> 자리표시자 값이 결정됩니다.또한 예제에서는 abc 및 def와 같은 사용자 ID를 사용합니다. 실제 요청 및 응답에서는 사용자 ID에 대해 해시된 값을 가집니다.

​
인증

주요 차이점을 검토한 후 사용자 ID 또는 서비스 계정 중 하나를 선택하여 인증하세요.

​
주요 차이점

  • 사용 대상: 사용자는 대화형의 일회성 관리 작업에 적합하며, 서비스 계정은 자동화 및 인테그레이션 (CI/CD, 프로비저닝 툴)에 적합합니다.
  • 자격 증명: 사용자는 사용자 이름과 API 키를 전송하고, 서비스 계정은 API 키만 전송합니다 (사용자 이름 없음).
  • 권한 부여 헤더 페이로드: 사용자는 username:API-KEY를 인코딩하고, 서비스 계정은 :API-KEY (앞에 콜론 포함)를 인코딩합니다.
  • 범위 및 권한: 둘 다 관리자 권한이 필요합니다. 서비스 계정은 조직 범위이며 헤드리스(headless) 방식으로 자동화를 위한 명확한 감사 추적을 제공합니다.
  • 자격 증명 획득처: 사용자는 User Settings에서 API 키를 복사합니다. 서비스 계정 키는 조직의 Service account 탭에 있습니다.
  • Multi-tenant Cloud: 둘 이상의 Multi-tenant Cloud 조직에 액세스할 수 있는 경우, SCIM API 호출이 의도한 조직으로 라우팅되도록 Default API organization을 설정해야 합니다.

​
Users

대화형 관리 작업을 수행할 때는 개인 관리자 자격 증명을 사용하세요. HTTP Authorization 헤더를 Basic <base64(username:API-KEY)> 형식으로 구성합니다. 예를 들어, demo:p@55w0rd로 인증하는 경우: 
Authorization: Basic ZGVtbzpwQDU1dzByZA==

​
서비스 계정

자동화 또는 인테그레이션을 위해서는 조직 범위의 서비스 계정을 사용하세요. HTTP Authorization 헤더를 Basic <base64(:API-KEY)>로 구성합니다 (앞의 콜론과 비어 있는 사용자 이름에 주의하세요). 서비스 계정 API 키는 조직 대시보드의 Service account 탭에서 찾을 수 있습니다. 조직 범위 서비스 계정을 참조하세요. 예를 들어, API 키 sa-p@55w0rd로 인증하는 경우: 
Authorization: Basic OnNhLXBANTV3MHJk

​
사용자 관리

SCIM 사용자 리소스는 W&B Users에 매핑됩니다. 다음 엔드포인트를 사용하여 조직의 사용자를 관리하세요.

​
사용자 조회

조직 내 특정 사용자의 정보를 검색합니다.
이 작업은 서비스 계정을 검색하지 않습니다.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: GET

​
파라미터

파라미터타입필수 여부설명
idstring예사용자의 고유 ID

​
예시

GET /scim/Users/abc

​
사용자 목록 조회

조직 내 모든 사용자 목록을 검색합니다.
이 작업은 서비스 계정을 검색하지 않습니다.

​
사용자 필터링

/Users 엔드포인트는 사용자 이름 또는 이메일로 사용자 필터링을 지원합니다:
  • userName eq "value" - 사용자 이름으로 필터링
  • emails.value eq "value" - 이메일 주소로 필터링
예시
GET /scim/Users?filter=userName eq "john.doe"
GET /scim/Users?filter=emails.value eq "john@example.com"

​
엔드포인트

  • URL: <host-url>/scim/Users
  • 메소드: GET

​
예시

GET /scim/Users

​
사용자 생성

조직에 새 사용자를 생성합니다.

​
엔드포인트

  • URL: <host-url>/scim/Users
  • 메소드: POST

​
파라미터

파라미터타입필수 여부설명
emailsarray예이메일 오브젝트 배열. 기본 이메일이 포함되어야 함
userNamestring예새 사용자의 사용자 이름

​
예시

POST /scim/Users

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

​
응답

(Status 201)

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

​
사용자 삭제

관리자 엑세스 유지인스턴스 또는 조직에는 항상 최소 한 명 이상의 관리자 사용자가 존재해야 합니다. 그렇지 않으면 아무도 조직의 W&B 계정을 설정하거나 유지 관리할 수 없습니다. 조직에서 SCIM 또는 다른 자동화된 프로세스를 사용하여 사용자의 프로비저닝을 해제하는 경우, 실수로 인스턴스 또는 조직의 마지막 남은 관리자가 제거될 수 있습니다.운영 절차 개발에 대한 도움이 필요하거나 관리자 엑세스를 복구하려면 지원팀에 문의하세요.
조직에서 사용자를 완전히 삭제합니다.
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 서비스 계정은 W&B Team 설정에서 삭제하세요.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: DELETE

​
파라미터

파라미터타입필수 여부설명
idstring예삭제할 사용자의 고유 ID

​
예시

DELETE /scim/Users/abc
사용자를 일시적으로 비활성화하려면 PATCH 엔드포인트를 사용하는 사용자 비활성화 API를 참조하세요.

​
사용자 이메일 업데이트

사용자의 기본 이메일 주소를 업데이트합니다. 사용자 계정이 조직에 의해 관리되지 않는 Multi-tenant Cloud에서는 지원되지 않습니다.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예사용자의 고유 ID
opstring예replace
pathstring예emails
valuearray예새 이메일 오브젝트가 포함된 배열

​
예시

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
                }
            ]
        }
    ]
}

​
사용자 표시 이름 업데이트

사용자의 표시 이름을 업데이트합니다. 사용자 계정이 조직에 의해 관리되지 않는 Multi-tenant Cloud에서는 지원되지 않습니다.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예사용자의 고유 ID
opstring예replace
pathstring예displayName
valuestring예새 표시 이름

​
예시

PATCH /scim/Users/abc

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

​
사용자 비활성화

조직에서 사용자를 비활성화합니다. 실제 결과는 배포 유형에 따라 다릅니다:
  • Dedicated Cloud / Self-Managed: 사용자의 active 필드를 false로 설정합니다. 비활성화된 사용자의 조직 엑세스를 복구하려면 사용자 활성화를 참조하세요.
  • Multi-tenant Cloud: 조직에서 사용자를 제거합니다. 사용자의 엑세스를 복구하려면 조직에 다시 추가해야 합니다. 사용자 생성을 참조하세요. Multi-tenant Cloud에서는 사용자의 계정이 조직에 의해 관리되지 않습니다.
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 서비스 계정 비활성화는 지원되지 않습니다. 팀 서비스 계정은 W&B Team 설정에서 관리하세요.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예비활성화할 사용자의 고유 ID
opstring예replace
valueobject예{"active": false}가 포함된 오브젝트

​
예시

PATCH /scim/Users/abc

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

​
응답

(Status 200)

{
    "active": false,
    "displayName": "Dev User 1",
    "emails": {
        "Value": "dev-user1@example.com",
        "Display": "",
        "Type": "",
        "Primary": true
    },
    "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"
}

​
사용자 활성화

조직에서 이전에 비활성화된 사용자를 다시 활성화합니다.
  • 사용자 활성화는 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 서비스 계정에 대해서는 활성화가 지원되지 않습니다. 서비스 계정은 W&B Team 설정에서 관리하세요.
  • 사용자 활성화는 Multi-tenant Cloud에서 지원되지 않습니다. 사용자의 엑세스를 복구하려면 조직에 다시 추가해야 합니다. 사용자 생성을 참조하세요. Multi-tenant Cloud에서는 사용자의 계정이 조직에 의해 관리되지 않습니다. 사용자를 활성화하려고 시도하면 HTTP 400 오류가 발생합니다: 
    {
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:Error"
    ],
    "detail": "User reactivation operations are not supported in SaaS Cloud",
    "status": "400"
}

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예활성화할 사용자의 고유 ID
opstring예replace
valueobject예{"active": true}가 포함된 오브젝트

​
예시

PATCH /scim/Users/abc

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

​
조직 역할 할당

사용자에게 조직 수준의 역할을 할당합니다.
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 커스텀 역할은 서비스 계정에 대해 지원되지 않습니다.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예사용자의 고유 ID
opstring예replace
pathstring예organizationRole
valuestring예역할 이름 (admin 또는 member)
조직 범위의 viewer 역할은 더 이상 지원되지 않으며 UI에서 할당할 수 없습니다. SCIM을 사용하여 사용자에게 viewer 역할을 할당하는 경우:
  • 조직에서 member 역할이 할당됩니다.
  • full 시트 대신 Models viewer 시트가 할당됩니다. 이를 통해 Models에 대한 읽기 전용 엑세스와 Registry에 대한 전체 엑세스가 가능합니다. 사용 가능한 Models 시트가 없으면 Seat limit reached 오류가 로그에 기록되고 Models 엑세스 권한 없이 멤버가 추가됩니다. 이는 나중에 시트가 생기면 업데이트할 수 있습니다.
  • full 시트 대신 Weave viewer 시트가 할당됩니다. 이를 통해 Weave에 대한 읽기 전용 엑세스가 가능합니다. 사용 가능한 Weave 시트가 없으면 Seat limit reached 오류가 로그에 기록되고 Weave 엑세스 권한 없이 멤버가 추가됩니다.
  • 조직 수준에서 볼 수 있는 registries에 대해 Registry viewer 역할이 할당됩니다.

​
예시

PATCH /scim/Users/abc

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

​
팀 역할 할당

사용자에게 팀 수준의 역할을 할당합니다.
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 커스텀 역할은 서비스 계정에 대해 지원되지 않습니다.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예사용자의 고유 ID
opstring예replace
pathstring예teamRoles
valuearray예teamName과 roleName이 포함된 오브젝트 배열

​
예시

PATCH /scim/Users/abc

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

​
Registry에 추가

할당된 registry 수준의 역할과 함께 사용자를 registry에 추가합니다.
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 커스텀 역할은 서비스 계정에 대해 지원되지 않습니다.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예사용자의 고유 ID
opstring예add
pathstring예registryRoles
valuearray예registryName과 roleName이 포함된 오브젝트 배열

​
예시

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"
                }
            ]
        }
    ]
}

​
Registry에서 제거

Registry에서 사용자를 제거합니다.
  • 제거 작업은 RFC 7644 SCIM 프로토콜 사양을 따릅니다. 특정 registry에서 사용자를 제거하려면 "registryRoles[registryName eq \"{registry_name}\"]" 필터 구문을 사용하고, 모든 registries에서 사용자를 제거하려면 "registryRoles"를 사용하세요.
  • 이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. Registry에서 서비스 계정을 제거하려면 W&B Team 설정에서 수행하세요.

​
엔드포인트

  • URL: <host-url>/scim/Users/{id}
  • 메소드: PATCH

​
파라미터

파라미터타입필수 여부설명
idstring예사용자의 고유 ID
opstring예remove
pathstring예"registryRoles[registryName eq \"{registry_name}\"]" 또는 "registryRoles"

​
예시

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 리소스

IAM에서 SCIM 그룹을 생성하면 W&B Team이 생성되어 매핑되며, 기타 SCIM 그룹 작업은 해당 팀에 대해 수행됩니다.

​
서비스 계정

SCIM을 사용하여 W&B Team을 생성하면, 팀 리소스에 대한 서비스 계정의 엑세스를 유지하기 위해 모든 조직 수준의 서비스 계정이 자동으로 팀에 추가됩니다.

​
그룹 필터링

/Groups 엔드포인트는 특정 팀을 검색하기 위한 필터링을 지원합니다:

​
지원되는 필터

  • displayName eq "value" - 팀 표시 이름으로 필터링

​
예시

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

​
팀 조회

팀의 고유 ID를 제공하여 팀 정보를 검색합니다.

​
엔드포인트

  • URL: <host-url>/scim/Groups/{id}
  • 메소드: GET

​
예시

GET /scim/Groups/ghi

​
팀 목록 조회

팀 목록을 검색합니다.

​
엔드포인트

  • URL: <host-url>/scim/Groups
  • 메소드: GET

​
예시

GET /scim/Groups

​
팀 생성

  • 엔드포인트: <host-url>/scim/Groups
  • 메소드: POST
  • 설명: 새로운 팀 리소스를 생성합니다.
  • 지원 필드:
필드타입필수 여부
displayNameString예
members다중값 배열예 (value 서브 필드는 필수이며 사용자 ID에 매핑됨)

​
예시

dev-user2를 멤버로 하는 wandb-support라는 이름의 팀을 생성합니다. 
POST /scim/Groups

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

​
팀 업데이트

  • 엔드포인트: <host-url>/scim/Groups/{id}
  • 메소드: PATCH
  • 설명: 기존 팀의 멤버십 목록을 업데이트합니다.
  • 지원 작업: 멤버 add, 멤버 remove, 멤버 replace
  • 제거 작업은 RFC 7644 SCIM 프로토콜 사양을 따릅니다. 특정 사용자를 제거하려면 members[value eq "{user_id}"] 필터 구문을 사용하고, 팀의 모든 사용자를 제거하려면 members를 사용하세요. 사용자 식별: 멤버 작업에서 {user_id}는 다음 중 하나일 수 있습니다:
  • 이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 팀의 서비스 계정은 W&B Team 설정에서 업데이트하세요.
요청 시 {team_id}는 실제 팀 ID로, {user_id}는 실제 사용자 ID 또는 이메일 주소로 바꾸세요.

​
팀 멤버 교체

팀의 모든 멤버를 새 목록으로 교체합니다.
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 서비스 계정은 W&B Team 설정에서 관리하세요.
  • 엔드포인트: <host-url>/scim/Groups/{id}
  • 메소드: 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}"
        }
    ]
}
팀에 사용자 추가 acme-devs에 dev-user2 추가:
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 서비스 계정은 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}"
                }
            ]
        }
    ]
}
팀에서 특정 사용자 제거 acme-devs에서 dev-user2 제거:
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 서비스 계정은 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}\"]"
        }
    ]
}
팀에서 모든 사용자 제거 acme-devs에서 모든 사용자 제거:
이 작업은 사용자에게만 적용되며 서비스 계정에는 적용되지 않습니다. 서비스 계정은 W&B Team 설정에서 관리하세요.
PATCH /scim/Groups/{team_id}

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

​
팀 삭제

  • 팀 삭제는 현재 SCIM API에서 지원되지 않습니다. 팀과 연결된 추가 데이터가 있기 때문입니다. 모든 것을 삭제하려면 앱에서 팀을 삭제하세요.

​
역할 리소스

SCIM 역할 리소스는 W&B 커스텀 역할에 매핑됩니다. 앞서 언급했듯이 /Roles 엔드포인트는 공식 SCIM 스키마의 일부는 아니지만, W&B는 조직의 커스텀 역할을 자동화된 방식으로 관리할 수 있도록 /Roles 엔드포인트를 추가했습니다.

​
커스텀 역할 조회

역할의 고유 ID를 제공하여 커스텀 역할에 대한 정보를 검색합니다.

​
엔드포인트

  • URL: <host-url>/scim/Roles/{id}
  • 메소드: GET

​
예시

GET /scim/Roles/abc

​
커스텀 역할 목록 조회

W&B 조직 내의 모든 커스텀 역할 정보를 검색합니다.

​
엔드포인트

  • URL: <host-url>/scim/Roles
  • 메소드: GET

​
예시

GET /scim/Roles

​
커스텀 역할 생성

  • 엔드포인트: <host-url>/scim/Roles
  • 메소드: POST
  • 설명: W&B 조직에 새로운 커스텀 역할을 생성합니다.
  • 지원 필드:
필드타입필수 여부
nameString커스텀 역할의 이름
descriptionString커스텀 역할에 대한 설명
permissionsObject arrayw&bobject:operation 형식의 name 문자열 필드를 가진 권한 오브젝트 배열. 예를 들어, W&B runs에 대한 삭제 작업 권한은 name이 run:delete가 됩니다.
inheritedFromString커스텀 역할이 상속받을 사전 정의된 역할. member 또는 viewer가 될 수 있습니다.

​
예시

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"
}

​
커스텀 역할 업데이트

​
역할에 권한 추가

  • 엔드포인트: <host-url>/scim/Roles/{id}
  • 메소드: 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"
                }
            ]
        }
    ]
}

​
역할에서 권한 제거

  • 엔드포인트: <host-url>/scim/Roles/{id}
  • 메소드: 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"
                }
            ]
        }
    ]
}

​
커스텀 역할 교체

  • 엔드포인트: <host-url>/scim/Roles/{id}
  • 메소드: 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"
}

​
커스텀 역할 삭제

W&B 조직의 커스텀 역할을 삭제합니다. 주의해서 사용하세요. 삭제 작업 후에는 해당 커스텀 역할을 할당받았던 모든 사용자에게 해당 커스텀 역할이 상속받았던 사전 정의된 역할이 할당됩니다.

​
엔드포인트

  • URL: <host-url>/scim/Roles/{id}
  • 메소드: DELETE

​
예시

DELETE /scim/Roles/abc

​
고급 기능

​
ETag 지원

SCIM API는 동시 수정 충돌을 방지하기 위한 조건부 업데이트용 ETag를 지원합니다. ETag는 ETag 응답 헤더와 meta.version 필드에 반환됩니다.

​
ETag 사용법

ETag를 사용하려면:
  1. 현재 ETag 획득: 리소스를 GET할 때 응답의 ETag 헤더를 기록합니다.
  2. 조건부 업데이트: 업데이트할 때 If-Match 헤더에 ETag를 포함합니다.

​
예시

# 사용자를 조회하고 ETag를 확인합니다.
GET /scim/Users/abc
# 응답 예시: ETag: W/"xyz123"

# 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"
        }
    ]
}
412 Precondition Failed 오류 응답은 조회한 이후에 리소스가 수정되었음을 나타냅니다.

​
오류 처리

SCIM API는 표준 SCIM 오류 응답을 반환합니다:
상태 코드설명
200성공
201생성됨
204내용 없음 (성공적으로 삭제됨)
400잘못된 요청 - 파라미터 또는 요청 본문이 유효하지 않음
401인증되지 않음 - 인증 실패
403금지됨 - 권한 부족
404찾을 수 없음 - 리소스가 존재하지 않음
409충돌 - 리소스가 이미 존재함
412전제 조건 실패 - ETag 불일치
500내부 서버 오류

​
배포 유형별 구현 차이점

W&B는 두 가지 별도의 SCIM API 구현을 유지 관리하며, 기능 차이는 다음과 같습니다:
기능Dedicated CloudSelf-Managed
사용자 이메일 업데이트-✓
사용자 표시 이름 업데이트-✓
사용자 비활성화✓✓
사용자 활성화-✓
사용자당 여러 이메일✓-

​
제한 사항

  • 최대 결과: 요청당 9999개 항목.
  • 싱글 테넌트 환경: 사용자당 하나의 이메일만 지원합니다.
  • 팀 삭제: SCIM을 통해 지원되지 않습니다 (W&B 웹 인터페이스를 사용하세요).
  • 사용자 활성화: Multi-tenant Cloud 환경에서는 지원되지 않습니다.
  • 시트 제한: 조직의 시트 제한에 도달하면 작업이 실패할 수 있습니다.