GitLab Custom attributes API

openapi: 3.2.0
info:
  title: GitLab REST Custom attributes API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Custom Attributes
  description: 'Use this API to manage the custom attributes set on users, groups, and projects.


    These endpoints require administrator access to the instance.'
  x-displayName: Custom attributes
  externalDocs:
    url: https://docs.gitlab.com/api/custom_attributes/
paths:
  /api/v4/users/{id}/custom_attributes:
    get:
      operationId: getApiV4UsersIdCustomAttributes
      summary: List all custom attributes for a user
      description: Lists all custom attributes for a specified user.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the user.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
  /api/v4/users/{id}/custom_attributes/{key}:
    get:
      operationId: getApiV4UsersIdCustomAttributesKey
      summary: Retrieve a custom attribute for a user
      description: Retrieves a specified custom attribute for a user.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the user.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
    put:
      operationId: putApiV4UsersIdCustomAttributesKey
      summary: Creates or updates a custom attribute for a user
      description: Creates or updates a custom attribute for a specified user. If the attribute already exists, it is updated, otherwise a new attribute is created.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the user.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4UsersIdCustomAttributesKeyRequest'
    delete:
      operationId: deleteApiV4UsersIdCustomAttributesKey
      summary: Delete a custom attribute for a user
      description: Deletes a specified custom attribute for a user.
      tags:
      - Custom Attributes
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the user.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
  /api/v4/projects/{id}/custom_attributes:
    get:
      operationId: getApiV4ProjectsIdCustomAttributes
      summary: List all custom attributes for a project
      description: Lists all custom attributes for a specified project.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
  /api/v4/projects/{id}/custom_attributes/{key}:
    get:
      operationId: getApiV4ProjectsIdCustomAttributesKey
      summary: Retrieve a custom attribute for a project
      description: Retrieves a specified custom attribute for a project.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
    put:
      operationId: putApiV4ProjectsIdCustomAttributesKey
      summary: Creates or updates a custom attribute for a project
      description: Creates or updates a custom attribute for a specified project. If the attribute already exists, it is updated, otherwise a new attribute is created.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdCustomAttributesKeyRequest'
    delete:
      operationId: deleteApiV4ProjectsIdCustomAttributesKey
      summary: Delete a custom attribute for a project
      description: Deletes a specified custom attribute for a project.
      tags:
      - Custom Attributes
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
  /api/v4/groups/{id}/custom_attributes:
    get:
      operationId: getApiV4GroupsIdCustomAttributes
      summary: List all custom attributes for a group
      description: Lists all custom attributes for a specified group.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
  /api/v4/groups/{id}/custom_attributes/{key}:
    get:
      operationId: getApiV4GroupsIdCustomAttributesKey
      summary: Retrieve a custom attribute for a group
      description: Retrieves a specified custom attribute for a group.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
    put:
      operationId: putApiV4GroupsIdCustomAttributesKey
      summary: Creates or updates a custom attribute for a group
      description: Creates or updates a custom attribute for a specified group. If the attribute already exists, it is updated, otherwise a new attribute is created.
      tags:
      - Custom Attributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdCustomAttributesKeyRequest'
    delete:
      operationId: deleteApiV4GroupsIdCustomAttributesKey
      summary: Delete a custom attribute for a group
      description: Deletes a specified custom attribute for a group.
      tags:
      - Custom Attributes
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: key
        required: true
        description: Key of the custom attribute.
        schema:
          type: string
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
components:
  schemas:
    putApiV4ProjectsIdCustomAttributesKeyRequest:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
          description: Value of the custom attribute.
      required:
      - value
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    putApiV4GroupsIdCustomAttributesKeyRequest:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
          description: Value of the custom attribute.
      required:
      - value
    putApiV4UsersIdCustomAttributesKeyRequest:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
          description: Value of the custom attribute.
      required:
      - value
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header