GitLab LDAP API

openapi: 3.2.0
info:
  title: GitLab REST LDAP 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: LDAP
  description: 'Use this API to search the LDAP groups available to an instance, and to

    manage group memberships with LDAP

    by managing a group''s LDAP links and triggering an LDAP synchronization.'
  x-displayName: LDAP
  externalDocs:
    url: https://docs.gitlab.com/api/group_ldap_links/
paths:
  /api/v4/groups/{id}/ldap_group_links:
    get:
      operationId: getApiV4GroupsIdLdapGroupLinks
      summary: List all LDAP group links
      description: Lists all LDAP group links.
      tags:
      - LDAP
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesLdapGroupLink'
        '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
      x-gitlab-tier: premium
    post:
      operationId: postApiV4GroupsIdLdapGroupLinks
      summary: Add an LDAP group link with CN or filter
      description: Adds an LDAP group link using a CN or filter.Adding a group link by filter is only supported in the Premium tier and above.
      tags:
      - LDAP
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesLdapGroupLink'
        '400':
          description: Validation error
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      parameters:
      - 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/postApiV4GroupsIdLdapGroupLinksRequest'
      x-gitlab-tier: premium
    delete:
      operationId: deleteApiV4GroupsIdLdapGroupLinks
      summary: Delete an LDAP group link with CN or filter
      description: Deletes an LDAP group link using a CN or filter.Deleting by filter is only supported in the Premium tier and above.
      tags:
      - LDAP
      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: cn
        required: false
        description: CN of an LDAP group. Exactly one of `cn`, `filter` must be provided.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: filter
        required: false
        description: LDAP filter for the group. Exactly one of `cn`, `filter` must be provided.
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: provider
        required: true
        description: Name of the provider for the LDAP group link.
        schema:
          type:
          - string
          - 'null'
        in: query
      x-gitlab-tier: premium
  /api/v4/groups/{id}/ldap_group_links/{cn}:
    delete:
      operationId: deleteApiV4GroupsIdLdapGroupLinksCn
      summary: Delete LDAP group link
      description: Deletes an LDAP group link. Deprecated. Scheduled for removal in a future release.
      tags:
      - LDAP
      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: cn
        required: true
        description: CN of an LDAP group.
        schema:
          type: string
        in: path
      x-gitlab-tier: premium
  /api/v4/groups/{id}/ldap_group_links/{provider}/{cn}:
    delete:
      operationId: deleteApiV4GroupsIdLdapGroupLinksProviderCn
      summary: Delete LDAP group link
      description: Deletes an LDAP group link for a specific LDAP provider.Deprecated. Scheduled for removal in a future release.
      tags:
      - LDAP
      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: cn
        required: true
        description: CN of an LDAP group.
        schema:
          type: string
        in: path
      - name: provider
        required: true
        description: Name of the provider for the LDAP group link.
        schema:
          type: string
        in: path
      x-gitlab-tier: premium
  /api/v4/ldap/groups:
    get:
      operationId: getApiV4LdapGroups
      summary: List all LDAP groups
      description: Lists all LDAP groups on the GitLab instance. Limited to 20 results.
      tags:
      - LDAP
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesLdapGroup'
        '400':
          description: Bad Request
      parameters:
      - name: search
        required: false
        description: Search for a specific LDAP group.
        schema:
          type: string
          default: ''
        in: query
  /api/v4/ldap/{provider}/groups:
    get:
      operationId: getApiV4LdapProviderGroups
      summary: List all LDAP groups by provider
      description: Lists all LDAP groups for the specified provider. Limited to 20 results.
      tags:
      - LDAP
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesLdapGroup'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: provider
        required: true
        description: Name of the LDAP provider.
        schema:
          type: string
        in: path
      - name: search
        required: false
        description: Search for a specific LDAP group.
        schema:
          type: string
          default: ''
        in: query
  /api/v4/groups/{id}/ldap_sync:
    post:
      operationId: postApiV4GroupsIdLdapSync
      summary: Sync a group with LDAP
      description: Syncs a specified group with its linked LDAP group. You must be an administrator or have the Owner role for the group.
      tags:
      - LDAP
      responses:
        '201':
          description: Created
        '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
      x-gitlab-tier: premium
components:
  schemas:
    postApiV4GroupsIdLdapGroupLinksRequest:
      type: object
      properties:
        cn:
          type:
          - string
          - 'null'
          description: CN of an LDAP group. Exactly one of `cn`, `filter` must be provided.
        filter:
          type:
          - string
          - 'null'
          description: LDAP filter for the group. Exactly one of `cn`, `filter` must be provided.
        group_access:
          type: integer
          enum:
          - 5
          - 10
          - 15
          - 20
          - 25
          - 30
          - 40
          - 50
          description: Default access level for members of the LDAP group.
        provider:
          type:
          - string
          - 'null'
          description: Name of the provider for the LDAP group link.
        member_role_id:
          type:
          - integer
          - 'null'
          description: ID of the member role for members of the LDAP group. Ultimate only.
      required:
      - group_access
      - provider
    APIEntitiesLdapGroupLink:
      type: object
      properties:
        cn:
          type: string
          example: ldap-group-1
        group_access:
          type: integer
          example: 10
        provider:
          type: string
          example: ldapmain
        filter:
          type: string
          example: id >= 500
        member_role_id:
          type: integer
          format: int64
          example: 12
    APIEntitiesLdapGroup:
      type: object
      properties:
        cn:
          type: string
          example: ldap-group-1
  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