GitLab Projects job token scope API

openapi: 3.2.0
info:
  title: GitLab REST Projects job token scope 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: Projects job token scope
  description: 'Use this API to interact with CI/CD job token scopes.


    > [!note]

    > All requests to the CI/CD job token scope API endpoint must be authenticated.

    > The authenticated user must have the Maintainer or Owner role for the project.'
  x-displayName: Projects job token scope
  externalDocs:
    url: https://docs.gitlab.com/api/project_job_token_scopes/
paths:
  /api/v4/projects/{id}/job_token_scope:
    get:
      operationId: getApiV4ProjectsIdJobTokenScope
      summary: Retrieve the CI/CD job token access settings for a project
      description: Retrieves the CI/CD job token access settings (job token scope) of a specified project.
      tags:
      - Projects job token scope
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesProjectJobTokenScope'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '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
    patch:
      operationId: patchApiV4ProjectsIdJobTokenScope
      summary: Update the CI/CD job token access settings for a project
      description: Updates the **Authorized groups and projects** setting (job token scope) of a specified project.
      tags:
      - Projects job token scope
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchApiV4ProjectsIdJobTokenScopeRequest'
  /api/v4/projects/{id}/job_token_scope/allowlist:
    get:
      operationId: getApiV4ProjectsIdJobTokenScopeAllowlist
      summary: List all projects in a CI/CD job token allowlist
      description: Lists all projects in the CI/CD job token allowlist of a specified project.
      tags:
      - Projects job token scope
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBasicProjectDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '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
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
    post:
      operationId: postApiV4ProjectsIdJobTokenScopeAllowlist
      summary: Add a project to a CI/CD job token allowlist
      description: Adds a project to the CI/CD job token allowlist of a specified project.
      tags:
      - Projects job token scope
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesProjectScopeLink'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      parameters:
      - name: id
        required: true
        description: ID of the project.
        schema:
          type: integer
        in: path
        example: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdJobTokenScopeAllowlistRequest'
  /api/v4/projects/{id}/job_token_scope/groups_allowlist:
    get:
      operationId: getApiV4ProjectsIdJobTokenScopeGroupsAllowlist
      summary: List all groups in a CI/CD job token allowlist
      description: Lists all groups in the CI/CD job token allowlist of a specified project.
      tags:
      - Projects job token scope
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesBasicGroupDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '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
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
    post:
      operationId: postApiV4ProjectsIdJobTokenScopeGroupsAllowlist
      summary: Add a group to a CI/CD job token allowlist
      description: Adds a group to the CI/CD job token allowlist of a specified project.
      tags:
      - Projects job token scope
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGroupScopeLink'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      parameters:
      - name: id
        required: true
        description: ID of the project.
        schema:
          type: integer
        in: path
        example: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdJobTokenScopeGroupsAllowlistRequest'
  /api/v4/projects/{id}/job_token_scope/groups_allowlist/{target_group_id}:
    delete:
      operationId: deleteApiV4ProjectsIdJobTokenScopeGroupsAllowlistTargetGroupId
      summary: Delete a group from a CI/CD job token allowlist
      description: Deletes a group from the CI/CD job token allowlist of a specified project.
      tags:
      - Projects job token scope
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID of the project.
        schema:
          type: integer
        in: path
        example: 1
      - name: target_group_id
        required: true
        description: ID of the group to remove from the CI/CD job token groups allowlist.
        schema:
          type: integer
        in: path
        example: 2
  /api/v4/projects/{id}/job_token_scope/allowlist/{target_project_id}:
    delete:
      operationId: deleteApiV4ProjectsIdJobTokenScopeAllowlistTargetProjectId
      summary: Delete a project from a CI/CD job token allowlist
      description: Deletes a project from the CI/CD job token allowlist of a specified project.
      tags:
      - Projects job token scope
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID of the project.
        schema:
          type: integer
        in: path
        example: 1
      - name: target_project_id
        required: true
        description: ID of the project to remove from the CI/CD job token inbound allowlist.
        schema:
          type: integer
        in: path
        example: 2
components:
  schemas:
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    APIEntitiesGroupScopeLink:
      type: object
      properties:
        source_project_id:
          type: integer
          format: int64
        target_group_id:
          type: integer
          format: int64
    patchApiV4ProjectsIdJobTokenScopeRequest:
      type: object
      properties:
        enabled:
          type:
          - boolean
          - 'null'
          description: Indicates CI/CD job tokens generated in other projects have restricted access to this project.
      required:
      - enabled
    APIEntitiesNamespaceBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 2
        name:
          type: string
          example: project
        path:
          type: string
          example: my_project
        kind:
          type: string
          example: project
        full_path:
          type: string
          example: group/my_project
        parent_id:
          type: integer
          format: int64
          example: 1
        avatar_url:
          type: string
          example: https://example.com/avatar/12345
        web_url:
          type: string
          example: https://example.com/group/my_project
    APIEntitiesBasicGroupDetails:
      type: object
      properties:
        id:
          type: integer
          format: int64
        web_url:
          type: string
          example: http://gitlab.example.com/groups/diaspora
        name:
          type: string
          example: Diaspora
    postApiV4ProjectsIdJobTokenScopeAllowlistRequest:
      type: object
      properties:
        target_project_id:
          type:
          - integer
          - 'null'
          description: ID of the project to add to the CI/CD job token inbound allowlist.
          example: 2
      required:
      - target_project_id
    APIEntitiesBasicProjectDetails:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        description:
          type: string
          example: desc
        name:
          type: string
          example: project1
        name_with_namespace:
          type: string
          example: John Doe / project1
        path:
          type: string
          example: project1
        path_with_namespace:
          type: string
          example: namespace1/project1
        created_at:
          type: string
          format: date-time
          example: '2020-05-07T04:27:17.016Z'
        default_branch:
          type: string
          example: main
        tag_list:
          type: array
          example:
          - tag
          items:
            type: string
        topics:
          type: array
          example:
          - topic
          items:
            type: string
        ssh_url_to_repo:
          type: string
          example: git@gitlab.example.com:gitlab/gitlab.git
        http_url_to_repo:
          type: string
          example: https://gitlab.example.com/gitlab/gitlab.git
        web_url:
          type: string
          example: https://gitlab.example.com/gitlab/gitlab
        readme_url:
          type: string
          example: https://gitlab.example.com/gitlab/gitlab/blob/master/README.md
        forks_count:
          type: integer
          example: 1
        license_url:
          type: string
          example: https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE
        license:
          $ref: '#/components/schemas/APIEntitiesLicenseBasic'
        avatar_url:
          type: string
          example: http://example.com/uploads/project/avatar/3/uploads/avatar.png
        star_count:
          type: integer
          example: 1
        last_activity_at:
          type: string
          format: date-time
          example: '2013-09-30T13:46:02Z'
        visibility:
          type: string
          example: public
        namespace:
          $ref: '#/components/schemas/APIEntitiesNamespaceBasic'
        custom_attributes:
          $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        repository_storage:
          type: string
          example: default
    postApiV4ProjectsIdJobTokenScopeGroupsAllowlistRequest:
      type: object
      properties:
        target_group_id:
          type:
          - integer
          - 'null'
          description: ID of the group to add to the CI/CD job token groups allowlist.
          example: 2
      required:
      - target_group_id
    APIEntitiesLicenseBasic:
      type: object
      properties:
        key:
          type: string
          example: gpl-3.0
        name:
          type: string
          example: GNU General Public License v3.0
        nickname:
          type: string
          example: GNU GPLv3
        html_url:
          type: string
          example: http://choosealicense.com/licenses/gpl-3.0
        source_url:
          type: string
    APIEntitiesProjectScopeLink:
      type: object
      properties:
        source_project_id:
          type: integer
          format: int64
        target_project_id:
          type: integer
          format: int64
    APIEntitiesProjectJobTokenScope:
      type: object
      properties:
        inbound_enabled:
          type: boolean
        outbound_enabled:
          type: boolean
  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