SAML API

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

- GitLab 15.5에 도입되었습니다.

SAML 기능에 액세스하기 위한 API입니다.

그룹의 SAML 식별자 가져오기 

GET /groups/:id/saml/identities

그룹의 SAML 식별자를 가져옵니다.

지원되는 속성:

속성 유형 필수 여부 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩된 경로

성공 시 200 및 다음 응답 속성을 반환합니다:

속성 유형 설명
extern_uid 문자열 사용자의 외부 UID
user_id 문자열 사용자의 ID

예시 요청: 

curl --location --request GET "https://gitlab.example.com/api/v4/groups/33/saml/identities" --header "PRIVATE-TOKEN: <개인 토큰>"

예시 응답: 

[
    {
        "extern_uid": "yrnZW46BrtBFqM7xDzE7dddd",
        "user_id": 48
    }
]

단일 SAML 식별자 가져오기

- GitLab 16.1에서 도입되었습니다. 

GET /groups/:id/saml/:uid

지원되는 속성:

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

예시 요청: 

curl --location --request GET "https://gitlab.expamle.com/api/v4/groups/33/saml/yrnZW46BrtBFqM7xDzE7dddd" --header "PRIVATE-TOKEN: <개인 토큰>"

예시 응답: 

{
    "extern_uid": "yrnZW46BrtBFqM7xDzE7dddd",
    "user_id": 48
}

SAML 식별자의 extern_uid 필드 업데이트

SAML 식별자의 extern_uid 필드를 업데이트합니다:

SAML IdP 속성 GitLab 필드
id/externalId extern_uid 
PATCH /groups/:id/saml/:uid

지원되는 속성:

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

예시 요청: 

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

단일 SAML 식별자 삭제

- GitLab 16.5에 도입되었습니다. 

DELETE /groups/:id/saml/:uid

지원되는 속성:

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

예시 요청: 

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

예시 응답: 

{
    "message" : "204 No Content"
}