GitLab Enterprise users API

openapi: 3.2.0
info:
  title: GitLab REST Enterprise users 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: Enterprise users
  description: 'Use this API to manage the enterprise users of a

    top-level group, including disabling two-factor authentication for them.


    These endpoints work only for top-level groups, and require the Owner role for that group. The users

    themselves do not have to be members of the group.'
  x-displayName: Enterprise users
  externalDocs:
    url: https://docs.gitlab.com/api/group_enterprise_users/
paths:
  /api/v4/groups/{id}/enterprise_users:
    get:
      operationId: getApiV4GroupsIdEnterpriseUsers
      summary: List all enterprise users
      description: Lists all enterprise users for a specified top-level group. Use the `page` and `per_page` pagination parameters to filter the results.
      tags:
      - Enterprise users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesUserPublic'
        '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
      - name: username
        required: false
        description: Return a user with the given username.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: search
        required: false
        description: Return users with a matching name, email, or username. Use partial values to increase results.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: active
        required: false
        description: If `true`, returns only active users.
        schema:
          type: boolean
          default: false
        in: query
      - name: blocked
        required: false
        description: If `true`, returns only blocked users.
        schema:
          type: boolean
          default: false
        in: query
      - name: created_after
        required: false
        description: Return users created on or after the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
      - name: created_before
        required: false
        description: Return users created on or before the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
      - name: two_factor
        required: false
        description: Filter users by two-factor authentication (2FA). Filter values are `enabled` or `disabled`. By default it returns all users.
        schema:
          type:
          - string
          - 'null'
        in: query
      - 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
      x-gitlab-tier: premium
  /api/v4/groups/{id}/enterprise_users/{user_id}:
    get:
      operationId: getApiV4GroupsIdEnterpriseUsersUserId
      summary: Retrieve an enterprise user
      description: Retrieves a specified enterprise user.
      tags:
      - Enterprise users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesUserPublic'
        '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
      - name: user_id
        required: true
        description: ID of the user.
        schema:
          type: integer
        in: path
      x-gitlab-tier: premium
    patch:
      operationId: patchApiV4GroupsIdEnterpriseUsersUserId
      summary: Update an enterprise user
      description: Updates a specified enterprise user.
      tags:
      - Enterprise users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesUserPublic'
        '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
      - name: user_id
        required: true
        description: ID of the user.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchApiV4GroupsIdEnterpriseUsersUserIdRequest'
      x-gitlab-tier: premium
    delete:
      operationId: deleteApiV4GroupsIdEnterpriseUsersUserId
      summary: Delete an enterprise user
      description: Deletes a specified enterprise user.
      tags:
      - Enterprise users
      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:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: user_id
        required: true
        description: ID of the user.
        schema:
          type: integer
        in: path
      - name: hard_delete
        required: false
        description: If `true`, deletes the user, their associated contributions, and any groups owned solely by the user. If `false`, deletes the user and moves their contributions to a [ghost user](https://docs.gitlab.com/user/profile/account/delete_account/#associated-records).
        schema:
          type: boolean
          default: false
        in: query
      x-gitlab-tier: premium
  /api/v4/groups/{id}/enterprise_users/{user_id}/disable_two_factor:
    patch:
      operationId: patchApiV4GroupsIdEnterpriseUsersUserIdDisableTwoFactor
      summary: Disable two-factor authentication for an enterprise user
      description: Disables two-factor authentication (2FA) for a specified enterprise user.
      tags:
      - Enterprise users
      responses:
        '204':
          description: No Content
        '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
      - name: user_id
        required: true
        description: ID of the user.
        schema:
          type: integer
        in: path
      x-gitlab-tier: premium
components:
  schemas:
    APIEntitiesUserPublic:
      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
        created_at:
          type: string
        bio:
          type: string
        location:
          type: string
        linkedin:
          type: string
        twitter:
          type: string
        discord:
          type: string
        website_url:
          type: string
        github:
          type: string
        job_title:
          type: string
        pronouns:
          type: string
        organization:
          type: string
        bot:
          type: boolean
        work_information:
          type: string
        followers:
          type: string
        following:
          type: string
        is_followed:
          type: string
        local_time:
          type: string
        last_sign_in_at:
          type: string
          format: date-time
          example: '2015-09-03T07:24:01.670Z'
        confirmed_at:
          type: string
          format: date-time
          example: '2015-09-03T07:24:01.670Z'
        last_activity_on:
          type: string
          format: date-time
          example: '2015-09-03T07:24:01.670Z'
        email:
          type: string
          example: john@example.com
        theme_id:
          type: integer
          example: 2
        color_scheme_id:
          type: integer
          example: 1
        projects_limit:
          type: integer
          example: 10
        current_sign_in_at:
          type: string
          format: date-time
          example: '2015-09-03T07:24:01.670Z'
        identities:
          $ref: '#/components/schemas/APIEntitiesIdentity'
        can_create_group:
          type: boolean
          example: true
        can_create_project:
          type: boolean
          example: true
        two_factor_enabled:
          type: boolean
          example: true
        external:
          type: boolean
        private_profile:
          type: boolean
          example: false
        commit_email:
          type: string
        preferred_language:
          type: string
          example: en
        shared_runners_minutes_limit:
          type: string
        extra_shared_runners_minutes_limit:
          type: string
        scim_identities:
          $ref: '#/components/schemas/APIEntitiesScimIdentity'
    APIEntitiesIdentity:
      type: object
      properties:
        provider:
          type: string
        extern_uid:
          type: string
        saml_provider_id:
          type: string
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    patchApiV4GroupsIdEnterpriseUsersUserIdRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the user account.
        email:
          type:
          - string
          - 'null'
          description: Email address of the user account. Must be from a verified [group domain](https://docs.gitlab.com/user/enterprise_user/#manage-group-domains).
        projects_limit:
          type:
          - integer
          - 'null'
          minimum: 0
          description: Maximum number of projects the user can create.
        can_create_group:
          type:
          - boolean
          - 'null'
          description: If `true`, the user can create groups.
    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