gitlab-org--gitlab-foss/doc/api/custom_attributes.md

Custom Attributes API

Every API call to custom attributes must be authenticated as administrator.

List custom attributes

Get all custom attributes on a user.

GET /users/:id/custom_attributes

Attribute	Type	Required	Description
id	integer	yes	The ID of a user

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/42/custom_attributes

Example response:

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

Single custom attribute

Get a single custom attribute on a user.

GET /users/:id/custom_attributes/:key

Attribute	Type	Required	Description
id	integer	yes	The ID of a user
key	string	yes	The key of the custom attribute

curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/42/custom_attributes/location

Example response:

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

Set custom attribute

Set a custom attribute on a user. The attribute will be updated if it already exists, or newly created otherwise.

PUT /users/:id/custom_attributes/:key

Attribute	Type	Required	Description
id	integer	yes	The ID of a user
key	string	yes	The key of the custom attribute
value	string	yes	The value of the custom attribute

curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "value=Greenland" https://gitlab.example.com/api/v4/users/42/custom_attributes/location

Example response:

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

Delete custom attribute

Delete a custom attribute on a user.

DELETE /users/:id/custom_attributes/:key

Attribute	Type	Required	Description
id	integer	yes	The ID of a user
key	string	yes	The key of the custom attribute

curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/42/custom_attributes/location