A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.gitlab.com/api/custom_attributes/ below:

Custom Attributes API | GitLab Docs

Help us learn about your current experience with the documentation.

Take the survey

.

Custom Attributes API

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

Custom attributes are currently available on users, groups, and projects, which is referred to as “resource” in this documentation.

List custom attributes

Get all custom attributes on a resource.

GET /users/:id/custom_attributes
GET /groups/:id/custom_attributes
GET /projects/:id/custom_attributes
Attribute Type Required Description id integer yes The ID of a resource 
curl --request GET \
   --header "PRIVATE-TOKEN: <your_access_token>" \
   --url "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 resource.

GET /users/:id/custom_attributes/:key
GET /groups/:id/custom_attributes/:key
GET /projects/:id/custom_attributes/:key
Attribute Type Required Description id integer yes The ID of a resource key string yes The key of the custom attribute 
curl --request GET \
   --header "PRIVATE-TOKEN: <your_access_token>" \
   --url "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 resource. The attribute is updated if it already exists, or newly created otherwise.

PUT /users/:id/custom_attributes/:key
PUT /groups/:id/custom_attributes/:key
PUT /projects/:id/custom_attributes/:key
Attribute Type Required Description id integer yes The ID of a resource key string yes The key of the custom attribute value string yes The value of the custom attribute 
curl --request PUT \
   --header "PRIVATE-TOKEN: <your_access_token>" \
   --data "value=Greenland" \
   --url "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 resource.

DELETE /users/:id/custom_attributes/:key
DELETE /groups/:id/custom_attributes/:key
DELETE /projects/:id/custom_attributes/:key
Attribute Type Required Description id integer yes The ID of a resource key string yes The key of the custom attribute 
curl --request DELETE \
   --header "PRIVATE-TOKEN: <your_access_token>" \
   --url "https://gitlab.example.com/api/v4/users/42/custom_attributes/location"

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4