SCIM API

Tier: 프리미엄, 얼티밋 Offering: GitLab.com

GitLab SCIM API는 그룹 내 SCIM 식별자를 관리하고 /groups/:groups_id/scim/identities 및 /groups/:groups_id/scim/:uid 엔드포인트를 제공합니다. 기본 URL은 <http|https>://<GitLab 호스트>/api/v4입니다.

이 API를 사용하려면 그룹 SSO가 그룹에 대해 활성화되어 있어야 합니다. 이 API는 SCIM for Group SSO가 활성화된 경우에만 사용됩니다. 이는 SCIM 식별자의 생성에 선행되는 작업입니다.

이 API는 내부 그룹 SCIM API 및 인스턴스 SCIM API와 다릅니다.

  • 이 API:
    • RFC7644 프로토콜을 구현하지 않습니다.
    • 그룹 내에서 SCIM 식별자를 가져오고, 확인하고, 업데이트하며 삭제합니다.
  • 내부 그룹 및 인스턴스 SCIM API:
    • SCIM 공급자 통합을 위한 시스템 사용용입니다.
    • RFC7644 프로토콜을 구현합니다.
    • 그룹 또는 인스턴스에 대해 SCIM으로 공급된 사용자 목록을 가져옵니다.
    • 그룹 또는 인스턴스에 대해 SCIM으로 공급된 사용자를 생성, 삭제 및 업데이트합니다.

그룹의 SCIM 식별자 가져오기 

GET /groups/:id/scim/identities

지원되는 속성:

속성 유형 필수 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩된 경로

성공할 경우, 200 및 다음과 같은 응답 속성을 반환합니다:

속성 유형 설명
extern_uid string 사용자의 외부 UID
user_id integer 사용자의 ID
active boolean 식별자의 상태

응답 예시: 

[
    {
        "extern_uid": "be20d8dcc028677c931e04f387",
        "user_id": 48,
        "active": true
    }
]

요청 예시: 

curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/identities" \
--header "PRIVATE-TOKEN: <PRIVATE-TOKEN>"

단일 SCIM 식별자 가져오기 

GET /groups/:id/scim/:uid

지원되는 속성:

속성 유형 필수 설명
id integer 예 그룹의 ID 또는 URL 인코딩된 경로
uid string 예 사용자의 외부 UID

요청 예시: 

curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/scim/be20d8dcc028677c931e04f387" --header "PRIVATE-TOKEN: <PRIVATE TOKEN>"

응답 예시: 

{
    "extern_uid": "be20d8dcc028677c931e04f387",
    "user_id": 48,
    "active": true
}

SCIM 식별자의 extern_uid 필드 업데이트하기

업데이트할 수 있는 필드:

SCIM/IdP 필드 GitLab 필드
id/externalId extern_uid 
PATCH /groups/:groups_id/scim/:uid

매개변수:

속성 유형 필수 설명
id integer/string 예 그룹의 ID 또는 URL 인코딩된 경로
uid string 예 사용자의 외부 UID

예시 요청: 

curl --location --request PATCH "https://gitlab.example.com/api/v4/groups/33/scim/be20d8dcc028677c931e04f387" \
--header "PRIVATE-TOKEN: <PRIVATE TOKEN>" \
--form "extern_uid=yrnZW46BrtBFqM7xDzE7dddd"

단일 SCIM 식별자 삭제하기 

DELETE /groups/:id/scim/:uid

지원되는 속성:

속성 유형 필수 설명
id integer 예 그룹의 ID 또는 URL 인코딩된 경로
uid string 예 사용자의 외부 UID

예시 요청: 

curl --location --request DELETE "https://gitlab.example.com/api/v4/groups/33/scim/yrnZW46BrtBFqM7xDzE7dddd" --header "PRIVATE-TOKEN: <your_access_token>"

응답 예시: 

{
    "message" : "204 No Content"
}