GitLab Access requests API

openapi: 3.2.0
info:
  title: GitLab REST Access requests 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: Access requests
  description: Use this API to interact with access requests for groups and projects.
  x-displayName: Access requests
  externalDocs:
    url: https://docs.gitlab.com/api/access_requests/
paths:
  /api/v4/groups/{id}/access_requests:
    get:
      operationId: getApiV4GroupsIdAccessRequests
      summary: List all access requests for a group
      description: Lists all access requests for a specified group that are viewable by the authenticated user.
      tags:
      - Access requests
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAccessRequester'
        '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: 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: postApiV4GroupsIdAccessRequests
      summary: Request access to a group
      description: Requests access to a specified group for the authenticated user.
      tags:
      - Access requests
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAccessRequester'
              example:
                id: 1
                username: raymond_smith
                name: Raymond Smith
                state: active
                requested_at: '2012-10-22T14:13:35Z'
        '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
  /api/v4/groups/{id}/access_requests/{user_id}/approve:
    put:
      operationId: putApiV4GroupsIdAccessRequestsUserIdApprove
      summary: Approve an access request
      description: Approves an access request for a specified user in a group.
      tags:
      - Access requests
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMember'
              example:
                id: 1
                username: raymond_smith
                name: Raymond Smith
                state: active
                created_at: '2012-10-22T14:13:35Z'
                access_level: '20'
        '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: user_id
        required: true
        description: ID of the user requesting access.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdAccessRequestsUserIdApproveRequest'
  /api/v4/groups/{id}/access_requests/{user_id}:
    delete:
      operationId: deleteApiV4GroupsIdAccessRequestsUserId
      summary: Deny an access request
      description: Denies an access request for a specified user in a group.
      tags:
      - Access requests
      responses:
        '204':
          description: Resource deleted
        '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: user_id
        required: true
        description: ID of the user requesting access.
        schema:
          type: integer
        in: path
  /api/v4/projects/{id}/access_requests:
    get:
      operationId: getApiV4ProjectsIdAccessRequests
      summary: List all access requests for a project
      description: Lists all access requests for a specified project that are viewable by the authenticated user.
      tags:
      - Access requests
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAccessRequester'
        '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: 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: postApiV4ProjectsIdAccessRequests
      summary: Request access to a project
      description: Requests access to a specified project for the authenticated user.
      tags:
      - Access requests
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAccessRequester'
              example:
                id: 1
                username: raymond_smith
                name: Raymond Smith
                state: active
                requested_at: '2012-10-22T14:13:35Z'
        '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
  /api/v4/projects/{id}/access_requests/{user_id}/approve:
    put:
      operationId: putApiV4ProjectsIdAccessRequestsUserIdApprove
      summary: Approve an access request
      description: Approves an access request for a specified user in a project.
      tags:
      - Access requests
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMember'
              example:
                id: 1
                username: raymond_smith
                name: Raymond Smith
                state: active
                created_at: '2012-10-22T14:13:35Z'
                access_level: '20'
        '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: user_id
        required: true
        description: ID of the user requesting access.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdAccessRequestsUserIdApproveRequest'
  /api/v4/projects/{id}/access_requests/{user_id}:
    delete:
      operationId: deleteApiV4ProjectsIdAccessRequestsUserId
      summary: Deny an access request
      description: Denies an access request for a specified user in a project.
      tags:
      - Access requests
      responses:
        '204':
          description: Resource deleted
        '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: user_id
        required: true
        description: ID of the user requesting access.
        schema:
          type: integer
        in: path
components:
  schemas:
    APIEntitiesMemberRole:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 2
        group_id:
          type: integer
          format: int64
          example: 2
        name:
          type: string
          example: Custom guest
        description:
          type: string
          example: Guest user who can also read_code
        base_access_level:
          type: integer
          enum:
          - 5
          - 10
          - 15
          - 20
          - 25
          - 30
          - 40
          example: 40
        apply_security_scan_profiles:
          type: boolean
          default: false
        admin_merge_request:
          type: boolean
          default: false
        archive_project:
          type: boolean
          default: false
        admin_ai_catalog_item_consumer:
          type: boolean
          default: false
        create_security_scan_profiles:
          type: boolean
          default: false
        destroy_package:
          type: boolean
          default: false
        remove_project:
          type: boolean
          default: false
        delete_security_scan_profiles:
          type: boolean
          default: false
        remove_group:
          type: boolean
          default: false
        manage_security_policy_link:
          type: boolean
          default: false
        admin_ai_catalog_item:
          type: boolean
          default: false
        admin_compliance_framework:
          type: boolean
          default: false
        admin_cicd_variables:
          type: boolean
          default: false
        manage_deploy_tokens:
          type: boolean
          default: false
        manage_group_access_tokens:
          type: boolean
          default: false
        admin_group_member:
          type: boolean
          default: false
        admin_integrations:
          type: boolean
          default: false
        manage_merge_request_settings:
          type: boolean
          default: false
        manage_project_access_tokens:
          type: boolean
          default: false
        admin_protected_branch:
          type: boolean
          default: false
        admin_protected_environments:
          type: boolean
          default: false
        admin_push_rules:
          type: boolean
          default: false
        admin_runners:
          type: boolean
          default: false
        admin_security_attributes:
          type: boolean
          default: false
        admin_terraform_state:
          type: boolean
          default: false
        admin_vulnerability:
          type: boolean
          default: false
        admin_web_hook:
          type: boolean
          default: false
        read_agent_artifacts:
          type: boolean
          default: false
        read_compliance_dashboard:
          type: boolean
          default: false
        read_security_scan_profiles:
          type: boolean
          default: false
        read_virtual_registry:
          type: boolean
          default: false
        update_sec_ai_workflow_settings:
          type: boolean
          default: false
        update_security_scan_profiles:
          type: boolean
          default: false
        read_admin_cicd:
          type: boolean
          default: false
        read_crm_contact:
          type: boolean
          default: false
        read_dependency:
          type: boolean
          default: false
        read_admin_groups:
          type: boolean
          default: false
        read_admin_projects:
          type: boolean
          default: false
        read_code:
          type: boolean
          default: false
        read_runners:
          type: boolean
          default: false
        read_security_attribute:
          type: boolean
          default: false
        read_admin_subscription:
          type: boolean
          default: false
        read_admin_monitoring:
          type: boolean
          default: false
        read_admin_users:
          type: boolean
          default: false
        read_vulnerability:
          type: boolean
          default: false
    APIEntitiesMember:
      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
        access_level:
          type: string
        created_at:
          type: string
        created_by:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        expires_at:
          type: string
        two_factor_enabled:
          type: boolean
        group_saml_identity:
          $ref: '#/components/schemas/APIEntitiesIdentity'
        group_scim_identity:
          $ref: '#/components/schemas/APIEntitiesScimIdentity'
        email:
          type: string
        is_using_seat:
          type: string
        override:
          type: string
        membership_state:
          type: string
        member_role:
          $ref: '#/components/schemas/APIEntitiesMemberRole'
    APIEntitiesIdentity:
      type: object
      properties:
        provider:
          type: string
        extern_uid:
          type: string
        saml_provider_id:
          type: string
    putApiV4ProjectsIdAccessRequestsUserIdApproveRequest:
      type: object
      properties:
        access_level:
          type: integer
          description: Access level to grant to the approved user. For a list of values, see [roles](https://docs.gitlab.com/user/permissions/#default-roles).
          default: 30
    putApiV4GroupsIdAccessRequestsUserIdApproveRequest:
      type: object
      properties:
        access_level:
          type: integer
          description: Access level to grant to the approved user. For a list of values, see [roles](https://docs.gitlab.com/user/permissions/#default-roles).
          default: 30
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    APIEntitiesAccessRequester:
      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
        requested_at:
          type: string
    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
    APIEntitiesScimIdentity:
      type: object
      properties:
        extern_uid:
          type: string
        group_id:
          type: string
        active:
          type: string
  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