SCIM API
Offering: GitLab.com, GitLab Dedicated
이 API를 사용하여 그룹의 SCIM ID를 관리합니다. 이 API는 SCIM 토큰이 필요한 내부 그룹 SCIM API 및 내부 인스턴스 SCIM API와 다릅니다. 성공하면 200과 다음 응답 속성을 반환합니다: SCIM ID의 extern_uid 필드를 업데이트합니다.
히스토리
- GitLab 15.5에서 도입됨.
이 API를 사용하여 그룹의 SCIM ID를 관리합니다.
필수 요건:
- 그룹 SSO를 활성화해야 합니다.
- 그룹 SSO용 SCIM을 활성화해야 합니다.
- 올바른 범위를 가진 개인 액세스 토큰 또는 그룹 액세스 토큰으로 인증해야 합니다.
이 API는 SCIM 토큰이 필요한 내부 그룹 SCIM API 및 내부 인스턴스 SCIM API와 다릅니다.
- 이 API는:
- RFC7644 프로토콜을 구현하지 않습니다.
- 그룹 내 SCIM ID를 가져오고, 확인하고, 업데이트하고, 삭제합니다.
- 내부 그룹 및 인스턴스 SCIM API는:
- SCIM 공급자 통합을 위한 시스템 용도입니다.
- RFC7644 프로토콜을 구현합니다.
- 그룹 또는 인스턴스에 대해 SCIM으로 프로비저닝된 사용자 목록을 가져옵니다.
- 그룹 또는 인스턴스에 대해 SCIM으로 프로비저닝된 사용자를 생성, 삭제, 업데이트합니다.
그룹의 SCIM ID 가져오기#
히스토리
- GitLab 15.5에서 도입됨.
그룹의 SCIM ID를 가져옵니다.
GET /groups/:id/scim/identities
지원되는 속성:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | Yes | 그룹의 ID 또는 URL 인코딩된 경로 |
성공하면 200과 다음 응답 속성을 반환합니다:
| 속성 | 유형 | 설명 |
|---|---|---|
extern_uid |
문자열 | 사용자의 외부 UID |
user_id |
정수 | 사용자의 ID |
active |
불리언 | ID의 상태 |
예시 응답:
[
{
"extern_uid": "be20d8dcc028677c931e04f387",
"user_id": 48,
"active": true
}
]
예시 요청:
curl --location --request GET \
--url "https://gitlab.example.com/api/v4/groups/33/scim/identities" \
--header "PRIVATE-TOKEN: "
단일 SCIM ID 가져오기#
히스토리
- GitLab 16.1에서 도입됨.
단일 SCIM ID를 가져옵니다.
GET /groups/:id/scim/:uid
지원되는 속성:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
uid |
문자열 | yes | 사용자의 외부 UID. |
예시 요청:
curl --location --request GET \
--url "https://gitlab.example.com/api/v4/groups/33/scim/be20d8dcc028677c931e04f387" \
--header "PRIVATE-TOKEN: "
예시 응답:
{
"extern_uid": "be20d8dcc028677c931e04f387",
"user_id": 48,
"active": true
}
SCIM ID의 extern_uid 필드 업데이트#
히스토리
- GitLab 15.5에서 도입됨.
SCIM ID의 extern_uid 필드를 업데이트합니다.
업데이트할 수 있는 필드:
| SCIM/IdP 필드 | GitLab 필드 |
|---|---|
id/externalId |
extern_uid |
PATCH /groups/:groups_id/scim/:uid
파라미터:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 그룹의 ID 또는 URL 인코딩된 경로 |
uid |
문자열 | yes | 사용자의 외부 UID. |
예시 요청:
curl --location --request PATCH \
--url "https://gitlab.example.com/api/v4/groups/33/scim/be20d8dcc028677c931e04f387" \
--header "PRIVATE-TOKEN: " \
--form "extern_uid=yrnZW46BrtBFqM7xDzE7dddd"
단일 SCIM ID 삭제#
히스토리
- GitLab 16.5에서 도입됨.
단일 SCIM ID를 삭제합니다.
DELETE /groups/:id/scim/:uid
지원되는 속성:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 | yes | 그룹의 ID 또는 URL 인코딩된 경로. |
uid |
문자열 | yes | 사용자의 외부 UID. |
예시 요청:
curl --location --request DELETE \
--url "https://gitlab.example.com/api/v4/groups/33/scim/yrnZW46BrtBFqM7xDzE7dddd" \
--header "PRIVATE-TOKEN: <your_access_token>"
예시 응답:
{
"message" : "204 No Content"
}
