사용자 정의 속성 API

Tier: Free, Premium, Ultimate Offering: Self-Managed, GitLab Dedicated

모든 사용자 정의 속성에 대한 API 호출은 관리자로 인증되어야 합니다.

현재 사용자 정의 속성은 사용자, 그룹, 프로젝트에서 사용할 수 있으며, 이를 문서에서 “리소스”로 참조합니다.

사용자 정의 속성 목록

리소스의 모든 사용자 정의 속성을 가져옵니다. 

GET /users/:id/custom_attributes
GET /groups/:id/custom_attributes
GET /projects/:id/custom_attributes
속성 유형 필수 설명
id 정수 예 리소스의 ID 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/custom_attributes"

응답 예시: 

[
   {
      "key": "location",
      "value": "Antarctica"
   },
   {
      "key": "role",
      "value": "Developer"
   }
]

단일 사용자 정의 속성

리소스에서 단일 사용자 정의 속성을 가져옵니다. 

GET /users/:id/custom_attributes/:key
GET /groups/:id/custom_attributes/:key
GET /projects/:id/custom_attributes/:key
속성 유형 필수 설명
id 정수 예 리소스의 ID
key 문자열 예 사용자 정의 속성의 키 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/custom_attributes/location"

응답 예시: 

{
   "key": "location",
   "value": "Antarctica"
}

사용자 정의 속성 설정

리소스에 사용자 정의 속성을 설정합니다. 해당 속성이 이미 존재하는 경우 업데이트되며, 그렇지 않은 경우 새로 생성됩니다. 

PUT /users/:id/custom_attributes/:key
PUT /groups/:id/custom_attributes/:key
PUT /projects/:id/custom_attributes/:key
속성 유형 필수 설명
id 정수 예 리소스의 ID
key 문자열 예 사용자 정의 속성의 키
value 문자열 예 사용자 정의 속성의 값 
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     --data "value=Greenland" "https://gitlab.example.com/api/v4/users/42/custom_attributes/location"

응답 예시: 

{
   "key": "location",
   "value": "Greenland"
}

사용자 정의 속성 삭제

리소스에서 사용자 정의 속성을 삭제합니다. 

DELETE /users/:id/custom_attributes/:key
DELETE /groups/:id/custom_attributes/:key
DELETE /projects/:id/custom_attributes/:key
속성 유형 필수 설명
id 정수 예 리소스의 ID
key 문자열 예 사용자 정의 속성의 키 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/custom_attributes/location"