YugabyteDB

YugabyteDB LDAP Role management API

The LDAP Role management API from YugabyteDB — 1 operation(s) for ldap role management.

Documentation GitHub OpenAPI

Operations 1

POST /api/v1/customers/{cUUID}/universes/{univUUID}/ldap_roles_sync Perform an LDAP users sync on the universe #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yugabytedb-ldap-role-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yugabytedb LDAP Role management API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged LDAP Role management across 3 of this provider''s published API definitions: openapi_2.yaml, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-users-rbac.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: LDAP Role management
paths:
  /api/v1/customers/{cUUID}/universes/{univUUID}/ldap_roles_sync:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: syncLdapUniverse
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: univUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LdapUnivSyncFormData'
        description: config to sync universe roles with ldap users
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Perform an LDAP users sync on the universe
      tags:
      - LDAP Role management
      x-codegen-request-body-name: syncLdapUniverse
    servers:
    - url: /
components:
  schemas:
    YBPTask:
      example:
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        resourceUUID:
          description: UUID of the resource being modified by the task
          format: uuid
          readOnly: true
          type: string
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
      type: object
    LdapUnivSyncFormData:
      description: Config to sync universe roles with ldap users
      example:
        ldapServer: ldapServer
        createGroups: true
        ldapSearchFilter: (objectclass=person)
        useLdapTls: true
        ldapUserfield: cn, sAMAccountName
        dbuserPassword: dbuserPassword
        excludeUsers:
        - excludeUsers
        - excludeUsers
        targetApi: ysql
        ldapPort: 0
        ldapBasedn: dc=example,dc=org
        ldapGroupMemberOfAttribute: ldapGroupMemberOfAttribute
        groupsToSync:
        - groupsToSync
        - groupsToSync
        ldapBindDn: cn=user,dc=example,dc=com
        useLdapSsl: true
        ldapTlsProtocol: TLSv1
        dbUser: dbUser
        ldapBindPassword: ldapBindPassword
        ldapGroupfield: cn
      properties:
        createGroups:
          description: Allow the API to create the LDAP groups as DB superusers
          type: boolean
        dbUser:
          description: 'Database user to connect: yugabyte for ysql, cassandra for ycql'
          type: string
        dbuserPassword:
          type: string
        excludeUsers:
          description: List of users to exclude while revoking and dropping
          items:
            type: string
          type: array
        groupsToSync:
          description: LDAP groups to sync. In case user belongs to multiple groups & we don't want to sync all of them to DB
          items:
            type: string
          type: array
        ldapBasedn:
          description: Dn of the search starting point.
          example: dc=example,dc=org
          type: string
        ldapBindDn:
          description: Dn of the user authenticating to LDAP.
          example: cn=user,dc=example,dc=com
          type: string
        ldapBindPassword:
          description: Password of the user authenticating to LDAP.
          type: string
        ldapGroupMemberOfAttribute:
          description: LDAP group dn attribute to which the user belongs
          type: string
        ldapGroupfield:
          description: LDAP field to get the group information
          example: cn
          type: string
        ldapPort:
          description: 'Port of the ldap server : 389 or 636(tls)'
          format: int32
          type: integer
        ldapSearchFilter:
          description: LDAP search filter to get the user entries
          example: (objectclass=person)
          type: string
        ldapServer:
          description: IP address of the LDAP server
          type: string
        ldapTlsProtocol:
          description: 'TLS versions for LDAPS : TLSv1, TLSv1_1, TLSv1_2'
          enum:
          - TLSv1
          - TLSv1_1
          - TLSv1_2
          type: string
        ldapUserfield:
          description: Dn/Attribute field to get the user's name from
          example: cn, sAMAccountName
          type: string
        targetApi:
          enum:
          - ysql
          - ycql
          type: string
        useLdapSsl:
          description: Use LDAP SSL
          type: boolean
        useLdapTls:
          description: Use LDAP TLS
          type: boolean
      required:
      - dbuserPassword
      - ldapGroupfield
      - ldapUserfield
      - targetApi
      type: object
    YBPTask_2:
      example:
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        resourceUUID:
          description: UUID of the resource being modified by the task
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    LdapUnivSyncFormData_2:
      description: Config to sync universe roles with ldap users
      example:
        ldapServer: ldapServer
        createGroups: true
        ldapSearchFilter: (objectclass=person)
        useLdapTls: true
        ldapUserfield: cn, sAMAccountName
        dbuserPassword: dbuserPassword
        excludeUsers:
        - excludeUsers
        - excludeUsers
        targetApi: ysql
        ldapPort: 0
        ldapBasedn: dc=example,dc=org
        ldapGroupMemberOfAttribute: ldapGroupMemberOfAttribute
        groupsToSync:
        - groupsToSync
        - groupsToSync
        ldapBindDn: cn=user,dc=example,dc=com
        useLdapSsl: true
        ldapTlsProtocol: TLSv1
        dbUser: dbUser
        ldapBindPassword: ldapBindPassword
        ldapGroupfield: cn
      properties:
        createGroups:
          description: Allow the API to create the LDAP groups as DB superusers
          type: boolean
          example: true
        dbUser:
          description: 'Database user to connect: yugabyte for ysql, cassandra for ycql'
          type: string
          example: example-dbUser
        dbuserPassword:
          type: string
          example: REDACTED
        excludeUsers:
          description: List of users to exclude while revoking and dropping
          items:
            type: string
          type: array
          example:
          - example-excludeUsers
        groupsToSync:
          description: LDAP groups to sync. In case user belongs to multiple groups & we don't want to sync all of them to DB
          items:
            type: string
          type: array
          example:
          - example-groupsToSync
        ldapBasedn:
          description: Dn of the search starting point.
          example: dc=example,dc=org
          type: string
        ldapBindDn:
          description: Dn of the user authenticating to LDAP.
          example: cn=user,dc=example,dc=com
          type: string
        ldapBindPassword:
          description: Password of the user authenticating to LDAP.
          type: string
          example: REDACTED
        ldapGroupMemberOfAttribute:
          description: LDAP group dn attribute to which the user belongs
          type: string
          example: example-ldapGroupMemberOfAttribute
        ldapGroupfield:
          description: LDAP field to get the group information
          example: cn
          type: string
        ldapPort:
          description: 'Port of the ldap server : 389 or 636(tls)'
          format: int32
          type: integer
          example: 5433
        ldapSearchFilter:
          description: LDAP search filter to get the user entries
          example: (objectclass=person)
          type: string
        ldapServer:
          description: IP address of the LDAP server
          type: string
          example: example-ldapServer
        ldapTlsProtocol:
          description: 'TLS versions for LDAPS : TLSv1, TLSv1_1, TLSv1_2'
          enum:
          - TLSv1
          - TLSv1_1
          - TLSv1_2
          type: string
          example: TLSv1
        ldapUserfield:
          description: Dn/Attribute field to get the user's name from
          example: cn, sAMAccountName
          type: string
        targetApi:
          enum:
          - ysql
          - ycql
          type: string
          example: ysql
        useLdapSsl:
          description: Use LDAP SSL
          type: boolean
          example: true
        useLdapTls:
          description: Use LDAP TLS
          type: boolean
          example: true
      required:
      - dbuserPassword
      - ldapGroupfield
      - ldapUserfield
      - targetApi
      type: object
    YBPTask_3:
      example:
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        resourceUUID:
          description: UUID of the resource being modified by the task
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    LdapUnivSyncFormData_3:
      description: Config to sync universe roles with ldap users
      example:
        ldapServer: ldapServer
        createGroups: true
        ldapSearchFilter: (objectclass=person)
        useLdapTls: true
        ldapUserfield: cn, sAMAccountName
        dbuserPassword: dbuserPassword
        excludeUsers:
        - excludeUsers
        - excludeUsers
        targetApi: ysql
        ldapPort: 0
        ldapBasedn: dc=example,dc=org
        ldapGroupMemberOfAttribute: ldapGroupMemberOfAttribute
        groupsToSync:
        - groupsToSync
        - groupsToSync
        ldapBindDn: cn=user,dc=example,dc=com
        useLdapSsl: true
        ldapTlsProtocol: TLSv1
        dbUser: dbUser
        ldapBindPassword: ldapBindPassword
        ldapGroupfield: cn
      properties:
        createGroups:
          description: Allow the API to create the LDAP groups as DB superusers
          type: boolean
          example: true
        dbUser:
          description: 'Database user to connect: yugabyte for ysql, cassandra for ycql'
          type: string
          example: example-dbUser
        dbuserPassword:
          type: string
          example: REDACTED
        excludeUsers:
          description: List of users to exclude while revoking and dropping
          items:
            type: string
          type: array
          example:
          - example-excludeUsers
        groupsToSync:
          description: LDAP groups to sync. In case user belongs to multiple groups & we don't want to sync all of them to DB
          items:
            type: string
          type: array
          example:
          - example-groupsToSync
        ldapBasedn:
          description: Dn of the search starting point.
          example: dc=example,dc=org
          type: string
        ldapBindDn:
          description: Dn of the user authenticating to LDAP.
          example: cn=user,dc=example,dc=com
          type: string
        ldapBindPassword:
          description: Password of the user authenticating to LDAP.
          type: string
          example: REDACTED
        ldapGroupMemberOfAttribute:
          description: LDAP group dn attribute to which the user belongs
          type: string
          example: example-ldapGroupMemberOfAttribute
        ldapGroupfield:
          description: LDAP field to get the group information
          example: cn
          type: string
        ldapPort:
          description: 'Port of the ldap server : 389 or 636(tls)'
          format: int32
          type: integer
          example: 5433
        ldapSearchFilter:
          description: LDAP search filter to get the user entries
          example: (objectclass=person)
          type: string
        ldapServer:
          description: IP address of the LDAP server
          type: string
          example: example-ldapServer
        ldapTlsProtocol:
          description: 'TLS versions for LDAPS : TLSv1, TLSv1_1, TLSv1_2'
          enum:
          - TLSv1
          - TLSv1_1
          - TLSv1_2
          type: string
          example: TLSv1
        ldapUserfield:
          description: Dn/Attribute field to get the user's name from
          example: cn, sAMAccountName
          type: string
        targetApi:
          enum:
          - ysql
          - ycql
          type: string
          example: ysql
        useLdapSsl:
          description: Use LDAP SSL
          type: boolean
          example: true
        useLdapTls:
          description: Use LDAP TLS
          type: boolean
          example: true
      required:
      - dbuserPassword
      - ldapGroupfield
      - ldapUserfield
      - targetApi
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-refined-from:
- openapi_2.yaml
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v1-users-rbac.yaml