GitLab Resource subscriptions API

openapi: 3.2.0
info:
  title: GitLab REST Resource subscriptions 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: Resource subscriptions
  description: 'Use this API to subscribe to and unsubscribe from issues,

    merge requests, and

    labels in projects and groups.


    All API calls to non-public information require authentication.'
  x-displayName: Resource subscriptions
paths:
  /api/v4/projects/{id}/merge_requests/{subscribable_id}/subscribe:
    post:
      operationId: postApiV4ProjectsIdMergeRequestsSubscribableIdSubscribe
      summary: Subscribe to a merge request
      description: Subscribes the currently authenticated user to a specified merge request. They will receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMergeRequest'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/merge_requests/{subscribable_id}/unsubscribe:
    post:
      operationId: postApiV4ProjectsIdMergeRequestsSubscribableIdUnsubscribe
      summary: Unsubscribe to a merge request
      description: Unsubscribes the currently authenticated user from a specified merge request. They will no longer receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMergeRequest'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/issues/{subscribable_id}/subscribe:
    post:
      operationId: postApiV4ProjectsIdIssuesSubscribableIdSubscribe
      summary: Subscribe to an issue
      description: Subscribes the currently authenticated user to a specified issue. They will receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesIssue'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/issues/{subscribable_id}/unsubscribe:
    post:
      operationId: postApiV4ProjectsIdIssuesSubscribableIdUnsubscribe
      summary: Unsubscribe to an issue
      description: Unsubscribes the currently authenticated user from a specified issue. They will no longer receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesIssue'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/labels/{subscribable_id}/subscribe:
    post:
      operationId: postApiV4ProjectsIdLabelsSubscribableIdSubscribe
      summary: Subscribe to a project label
      description: Subscribes the currently authenticated user to a specified project label. They will receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesProjectLabel'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/labels/{subscribable_id}/unsubscribe:
    post:
      operationId: postApiV4ProjectsIdLabelsSubscribableIdUnsubscribe
      summary: Unsubscribe to a project label
      description: Unsubscribes the currently authenticated user from a specified project label. They will no longer receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesProjectLabel'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
  /api/v4/groups/{id}/labels/{subscribable_id}/subscribe:
    post:
      operationId: postApiV4GroupsIdLabelsSubscribableIdSubscribe
      summary: Subscribe to a group label
      description: Subscribes the currently authenticated user to a specified group label. They will receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGroupLabel'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
  /api/v4/groups/{id}/labels/{subscribable_id}/unsubscribe:
    post:
      operationId: postApiV4GroupsIdLabelsSubscribableIdUnsubscribe
      summary: Unsubscribe to a group label
      description: Unsubscribes the currently authenticated user from a specified group label. They will no longer receive notifications on changes to this item.
      tags:
      - Resource subscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGroupLabel'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: subscribable_id
        required: true
        description: Internal ID of the issue or merge request, or ID or title of the label.
        schema:
          type: string
        in: path
components:
  schemas:
    APIEntitiesMilestone:
      type: object
      properties:
        id:
          type: integer
          format: int64
        iid:
          type: integer
          format: int64
        project_id:
          type: integer
          format: int64
        group_id:
          type: string
        title:
          type: string
        description:
          type: string
        state:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        due_date:
          type: string
        start_date:
          type: string
        expired:
          type: boolean
        web_url:
          type: string
    APIEntitiesProjectLabel:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: bug
        description:
          type: string
          example: Bug reported by user
        text_color:
          type: string
          example: '#FFFFFF'
        description_html:
          type: string
          example: <p>Bug reported by user</p>
        color:
          type: string
          example: '#FF0000'
        archived:
          type: boolean
          example: false
        open_issues_count:
          type: integer
          example: 1
        closed_issues_count:
          type: integer
          example: 0
        open_merge_requests_count:
          type: integer
          example: 1
        subscribed:
          type: boolean
          example: false
        priority:
          type: integer
          example: 10
        is_project_label:
          type: boolean
    APIEntitiesIssuableTimeStats:
      type: object
      properties:
        time_estimate:
          type: integer
          example: 12600
        total_time_spent:
          type: integer
          example: 3600
        human_time_estimate:
          type: string
          example: 3h 30m
        human_total_time_spent:
          type: string
          example: 1h
    APIEntitiesMergeRequestAuthor:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        username:
          type: string
          example: admin
        public_email:
          type: string
          example: john@example.com
        name:
          type: string
          example: Administrator
        state:
          type: string
          example: active
        locked:
          type: boolean
        avatar_url:
          type: string
          example: https://gravatar.com/avatar/1
        avatar_path:
          type: string
          example: /user/avatar/28/The-Big-Lebowski-400-400.png
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        web_url:
          type: string
          example: https://gitlab.example.com/root
        bot:
          type: boolean
          example: false
    APIEntitiesGroupLabel:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: bug
        description:
          type: string
          example: Bug reported by user
        text_color:
          type: string
          example: '#FFFFFF'
        description_html:
          type: string
          example: <p>Bug reported by user</p>
        color:
          type: string
          example: '#FF0000'
        archived:
          type: boolean
          example: false
        open_issues_count:
          type: integer
          example: 1
        closed_issues_count:
          type: integer
          example: 0
        open_merge_requests_count:
          type: integer
          example: 1
        subscribed:
          type: boolean
          example: false
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    APIEntitiesTaskCompletionStatus:
      type: object
      properties:
        count:
          type: integer
          example: 5
        completed_count:
          type: integer
          example: 3
    APIEntitiesIteration:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 1
        sequence:
          type: integer
          example: 1
        group_id:
          type: integer
          format: int64
          example: 1
        title:
          type: string
          example: Iteration I
        description:
          type: string
          example: Iteration description
        state:
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        updated_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        start_date:
          type: string
          format: date
          example: '2022-01-01'
        due_date:
          type: string
          format: date
          example: '2022-01-31'
        web_url:
          type: string
          example: https://gitlab.example.com/groups/gitlab-org/-/iterations/1
    APIEntitiesIssuableReferences:
      type: object
      properties:
        short:
          type: string
          example: '&6'
        relative:
          type: string
          example: '&6'
        full:
          type: string
          example: test&6
    APIEntitiesIssue:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 84
        iid:
          type: integer
          example: 14
        project_id:
          type: integer
          format: int64
          example: 4
        title:
          type: string
          example: Impedit et ut et dolores vero provident ullam est
        description:
          type: string
          example: Repellendus impedit et vel velit dignissimos.
        state:
          type: string
          example: closed
        created_at:
          type: string
          format: date-time
          example: '2022-08-17T12:46:35.053Z'
        updated_at:
          type: string
          format: date-time
          example: '2022-11-14T17:22:01.470Z'
        closed_at:
          type: string
          format: date-time
          example: '2022-11-15T08:30:55.232Z'
        closed_by:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        labels:
          type: array
          example:
          - bug
          items:
            type: string
        milestone:
          $ref: '#/components/schemas/APIEntitiesMilestone'
        assignees:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        author:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        type:
          type: string
          description: The type of the issue.
          enum:
          - ISSUE
          - INCIDENT
          - TEST_CASE
          - REQUIREMENT
          - TASK
          - TICKET
          example: ISSUE
        assignee:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        user_notes_count:
          type: integer
        merge_requests_count:
          type: integer
        upvotes:
          type: integer
        downvotes:
          type: integer
        start_date:
          type: string
          format: date
          example: '2022-11-18'
        due_date:
          type: string
          format: date
          example: '2022-11-20'
        confidential:
          type: boolean
        discussion_locked:
          type: boolean
        issue_type:
          type: string
          example: issue
        web_url:
          type: string
          example: http://example.com/example/example/issues/14
        time_stats:
          $ref: '#/components/schemas/APIEntitiesIssuableTimeStats'
        task_completion_status:
          $ref: '#/components/schemas/APIEntitiesTaskCompletionStatus'
        weight:
          type: integer
          example: 5
        blocking_issues_count:
          type: integer
          example: 2
        has_tasks:
          type: boolean
          example: true
        task_status:
          type: string
          example: 2 of 4 tasks completed
        _links:
          type: object
          properties:
            self:
              type: string
              example: http://example.com/api/v4/projects/1/issues/2
            notes:
              type: string
              example: http://example.com/api/v4/projects/1/issues/2/notes
            award_emoji:
              type: string
              example: http://example.com/api/v4/projects/1/issues/2/award_emoji
            project:
              type: string
              example: http://example.com/api/v4/projects/1
            closed_as_duplicate_of:
              type: string
              example: http://example.com/api/v4/projects/1/issues/75
        references:
          $ref: '#/components/schemas/APIEntitiesIssuableReferences'
        severity:
          type: string
          description: The severity of the issue.
          enum:
          - UNKNOWN
          - LOW
          - MEDIUM
          - HIGH
          - CRITICAL
        subscribed:
          type: boolean
          example: false
        moved_to_id:
          type: integer
          format: int64
          example: 1
        imported:
          type: boolean
          example: false
        imported_from:
          type: string
          example: github
        service_desk_reply_to:
          type: string
          example: user@example.com
        epic_iid:
          type: string
        epic:
          $ref: '#/components/schemas/EpicBaseEntity'
        iteration:
          $ref: '#/components/schemas/APIEntitiesIteration'
        health_status:
          type: string
    APIEntitiesDiffRefs:
      type: object
      properties:
        base_sha:
          type: string
          example: b83d6e391c22777fca1ed3012fce84f633d7fed0
        head_sha:
          type: string
          example: b83d6e391c22777fca1ed3012fce84f633d7fed0
        start_sha:
          type: string
          example: b83d6e391c22777fca1ed3012fce84f633d7fed0
    APIEntitiesCiPipelineBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 2
        project_id:
          type: integer
          format: int64
          example: 3
        sha:
          type: string
          example: 0ec9e58fdfca6cdd6652c083c9edb53abc0bad52
        ref:
          type: string
          example: feature-branch
        status:
          type: string
          example: success
        source:
          type: string
          example: push
        created_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        updated_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        web_url:
          type: string
          example: https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61
    EpicBaseEntity:
      type: object
      properties:
        id:
          type: string
        iid:
          type: string
        title:
          type: string
        url:
          type: string
        group_id:
          type: string
        human_readable_end_date:
          type: string
        human_readable_timestamp:
          type: string
    APIEntitiesMergeRequest:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 84
        iid:
          type: integer
          example: 14
        project_id:
          type: integer
          format: int64
          example: 4
        title:
          type: string
          example: Impedit et ut et dolores vero provident ullam est
        description:
          type: string
          example: Repellendus impedit et vel velit dignissimos.
        state:
          type: string
          example: closed
        created_at:
          type: string
          format: date-time
          example: '2022-08-17T12:46:35.053Z'
        updated_at:
          type: string
          format: date-time
          example: '2022-11-14T17:22:01.470Z'
        merged_by:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        merge_user:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        merged_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        closed_by:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        closed_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        title_html:
          type: string
        description_html:
          type: string
        target_branch:
          type: string
        source_branch:
          type: string
        user_notes_count:
          type: integer
        upvotes:
          type: integer
        downvotes:
          type: integer
        author:
          $ref: '#/components/schemas/APIEntitiesMergeRequestAuthor'
        assignees:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        assignee:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        reviewers:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        source_project_id:
          type: integer
          format: int64
        target_project_id:
          type: integer
          format: int64
        labels:
          type: array
          items:
            type: string
        draft:
          type: boolean
        imported:
          type: boolean
        imported_from:
          type: string
          example: bitbucket
        work_in_progress:
          type: boolean
        milestone:
          $ref: '#/components/schemas/APIEntitiesMilestone'
        merge_when_pipeline_succeeds:
          type: boolean
        merge_status:
          type: string
          example: unchecked
        detailed_merge_status:
          type: string
          example: mergeable
        merge_after:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        sha:
          type: string
          example: 1234abcd
        merge_commit_sha:
          type: string
          example: 1234abcd
        squash_commit_sha:
          type: string
          example: 1234abcd
        discussion_locked:
          type: boolean
        should_remove_source_branch:
          type: boolean
        force_remove_source_branch:
          type: boolean
        prepared_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        allow_collaboration:
          type: boolean
        allow_maintainer_to_push:
          type: boolean
        reference:
          type: string
          example: '!1'
        references:
          $ref: '#/components/schemas/APIEntitiesIssuableReferences'
        web_url:
          type: string
          example: https://gitlab.example.com/my-group/my-project/-/merge_requests/1
        time_stats:
          $ref: '#/components/schemas/APIEntitiesIssuableTimeStats'
        squash:
          type: boolean
        squash_on_merge:
          type: boolean
        task_completion_status:
          $ref: '#/components/schemas/APIEntitiesTaskCompletionStatus'
        has_conflicts:
          type: boolean
        blocking_discussions_resolved:
          type: boolean
        approvals_before_merge:
          type: integer
          example: 2
        subscribed:
          type: boolean
        changes_count:
          type: string
          example: '1'
        latest_build_started_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        latest_build_finished_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        first_deployed_to_production_at:
          type: string
          format: date-time
          example: '2022-01-31T15:10:45.080Z'
        pipeline:
          $ref: '#/components/schemas/APIEntitiesCiPipelineBasic'
        head_pipeline:
          $ref: '#/components/schemas/APIEntitiesCiPipeline'
        diff_refs:
          $ref: '#/components/schemas/APIEntitiesDiffRefs'
        merge_error:
          type: string
          example: Merge error
        rebase_in_progress:
          type: boolean
        diverged_commits_count:
          type: integer
          example: 0
        first_contribution:
          type: boolean
        user:
          type: object
          properties:
            can_merge:
              type: boolean
    APIEntitiesCiPipeline:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 2
        project_id:
          type: integer
          format: int64
          example: 3
        sha:
          type: string
          example: 0ec9e58fdfca6cdd6652c083c9edb53abc0bad52
        ref:
          type: string
          example: feature-branch
        status:
          type: string
          example: success
        source:
          type: string
          example: push
        created_at:
          type: string
          format: date-time
          example: '2015-12-24T15:51:21.880Z'
        updated_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:31.198Z'
        web_url:
          type: string
          example: https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61
        before_sha:
          type: string
          example: a91957a858320c0e17f3a0eca7cfacbff50ea29a
        tag:
          type: boolean
          example: false
        yaml_errors:
          type: string
          example: 'widgets:build: needs ''widgets:test'''
        user:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        started_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:30.733Z'
        finished_at:
          type: string
          format: date-time
          example: '2015-12-24T17:54:31.198Z'
        committed_at:
          type: string
          format: date-time
          example: '2015-12-24T15:51:21.880Z'
        duration:
          type: integer
          description: Time spent running in seconds
          example: 127
        queued_duration:
          type: integer
          description: Time spent enqueued in seconds
          example: 63
        coverage:
          type: number
          format: float
          example: 98.29
        detailed_status:
          $ref: '#/components/schemas/DetailedStatusEntity'
        archived:
          type: boolean
          example: false
    APIEntitiesUserBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        username:
          type: string
          example: admin
        public_email:
          type: string
          example: john@example.com
        name:
          type: string
          example: Administrator
        state:
          type: string
          example: active
        locked:
          type: boolean
        avatar_url:
          type: string
          example: https://gravatar.com/avatar/1
        avatar_path:
          type: string
          example: /user/avatar/28/The-Big-Lebowski-400-400.png
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        web_url:
          type: string
          example: https://gitlab.example.com/root
    DetailedStatusEntity:
      type: object
      properties:
        icon:
          type: string
          example: status_success
        text:
          type: string
          example: passed
        label:
          type: string
          example: passed
        group:
          type: string
          example: success
        tooltip:
          type: string
          example: passed
        has_details:
          type: boolean
          example: true
        details_path:
          type: string
          example: /test-group/test-project/-/pipelines/287
        illustration:
          type: object
          example:
            image: illustrations/empty-state/empty-job-not-triggered-md.svg
            size: ''
            title: This job has not been triggered yet
            content: This job depends on upstream jobs that need to succeed in order for this job to be triggered
        favicon:
          type: string
          example: /assets/ci_favicons/favicon_status_success.png
        action:
          type: object
          properties:
            icon:
              type: string
              example: cancel
            title:
              type: string
              example: Cancel
            path:
              type: string
              example: /namespace1/project1/-/jobs/2/cancel
            method:
              type: string
              example: post
            button_title:
              type: string
              example: Cancel this job
            confirmation_message:
              type: string
              example: Are you sure?
  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