YugabyteDB

YugabyteDB LDAPOIDC Role management API

The LDAPOIDC Role management API from YugabyteDB — 3 operation(s) for ldapoidc role management.

Documentation GitHub OpenAPI

Operations 5

GET /api/v1/customers/{cUUID}/ldap_mappings List LDAP Mappings #

PUT /api/v1/customers/{cUUID}/ldap_mappings Set LDAP Mappings #

GET /api/v1/customers/{cUUID}/oidc_mappings List OIDC Group Mappings #

PUT /api/v1/customers/{cUUID}/oidc_mappings Set OIDC Mappings #

DELETE /api/v1/customers/{cUUID}/oidc_mappings/{groupName} Delete a OIDC group mapping #

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-ldapoidc-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 LDAPOIDC 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 LDAPOIDC 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: LDAPOIDC Role management
paths:
  /api/v1/customers/{cUUID}/ldap_mappings:
    get:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.0.0.</b> Please use the v2 /auth/group-mappings GET endpoint instead. Note that this API will not return the custom roles assigned to groups via the new /api/v2/customers/{cUUID}/auth/group-mappings API.
      operationId: listLdapDnToYbaRoles
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LdapDnToYbaRoleData'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List LDAP Mappings
      tags:
      - LDAPOIDC Role management
    put:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.0.0.</b> Please use the v2 /auth/group-mappings PUT endpoint instead
      operationId: setLdapDnToYbaRoles
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LdapDnToYbaRoleData'
        description: New LDAP Mappings to be set
        required: true
      responses:
        default:
          content: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set LDAP Mappings
      tags:
      - LDAPOIDC Role management
      x-codegen-request-body-name: ldapMappings
    servers:
    - url: /
  /api/v1/customers/{cUUID}/oidc_mappings:
    get:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.0.0.</b> Please use the v2 /auth/group-mappings GET endpoint instead. Note that this API will not return the custom roles assigned to groups via the new /api/v2/customers/{cUUID}/auth/group-mappings API.
      operationId: listOidcGroupToYbaRoles
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcGroupToYbaRolesData'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List OIDC Group Mappings
      tags:
      - LDAPOIDC Role management
    put:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.0.0.</b> Please use the v2 /auth/group-mappings PUT endpoint instead
      operationId: mapOidcGroupToYbaRoles
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcGroupToYbaRolesData'
        description: New OIDC Mappings to be set
        required: true
      responses:
        default:
          content: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set OIDC Mappings
      tags:
      - LDAPOIDC Role management
      x-codegen-request-body-name: oidcMappings
    servers:
    - url: /
  /api/v1/customers/{cUUID}/oidc_mappings/{groupName}:
    delete:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.0.0.</b> Please use the v2 /auth/group-mappings/{groupUUID} DELETE endpoint instead
      operationId: deleteOidcGroupMapping
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: groupName
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete a OIDC group mapping
      tags:
      - LDAPOIDC Role management
    servers:
    - url: /
components:
  schemas:
    OidcGroupToYbaRolesData:
      example:
        oidcGroupToYbaRolesPairs:
        - groupName: groupName
          roles:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - groupName: groupName
          roles:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        oidcGroupToYbaRolesPairs:
          description: ' list of pairs of groupName and roles'
          items:
            $ref: '#/components/schemas/OidcGroupToYbaRolesPair'
          type: array
      type: object
    LdapDnToYbaRoleData:
      description: A list of LDAP DN, YBA role pairs
      example:
        ldapDnToYbaRolePairs:
        - ybaRole: ConnectOnly
          distinguishedName: distinguishedName
        - ybaRole: ConnectOnly
          distinguishedName: distinguishedName
      properties:
        ldapDnToYbaRolePairs:
          description: ' list of pairs of distinguishedName and ybaRole'
          items:
            $ref: '#/components/schemas/LdapDnYbaRoleDataPair'
          type: array
      type: object
    YBPSuccess:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
      type: object
    LdapDnYbaRoleDataPair:
      example:
        ybaRole: ConnectOnly
        distinguishedName: distinguishedName
      properties:
        distinguishedName:
          type: string
        ybaRole:
          enum:
          - ConnectOnly
          - ReadOnly
          - BackupAdmin
          - Admin
          - SuperAdmin
          type: string
      required:
      - distinguishedName
      - ybaRole
      type: object
    OidcGroupToYbaRolesPair:
      example:
        groupName: groupName
        roles:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        groupName:
          type: string
        roles:
          items:
            format: uuid
            type: string
          type: array
      required:
      - groupName
      - roles
      type: object
    OidcGroupToYbaRolesData_2:
      example:
        oidcGroupToYbaRolesPairs:
        - groupName: groupName
          roles:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - groupName: groupName
          roles:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        oidcGroupToYbaRolesPairs:
          description: ' list of pairs of groupName and roles'
          items:
            $ref: '#/components/schemas/OidcGroupToYbaRolesPair_2'
          type: array
          example:
          - groupName: groupName
            roles:
            - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    LdapDnToYbaRoleData_2:
      description: A list of LDAP DN, YBA role pairs
      example:
        ldapDnToYbaRolePairs:
        - ybaRole: ConnectOnly
          distinguishedName: distinguishedName
        - ybaRole: ConnectOnly
          distinguishedName: distinguishedName
      properties:
        ldapDnToYbaRolePairs:
          description: ' list of pairs of distinguishedName and ybaRole'
          items:
            $ref: '#/components/schemas/LdapDnYbaRoleDataPair_2'
          type: array
          example:
          - ybaRole: ConnectOnly
            distinguishedName: distinguishedName
      type: object
    YBPSuccess_2:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    LdapDnYbaRoleDataPair_2:
      example:
        ybaRole: ConnectOnly
        distinguishedName: distinguishedName
      properties:
        distinguishedName:
          type: string
          example: example-distinguishedName
        ybaRole:
          enum:
          - ConnectOnly
          - ReadOnly
          - BackupAdmin
          - Admin
          - SuperAdmin
          type: string
          example: ConnectOnly
      required:
      - distinguishedName
      - ybaRole
      type: object
    OidcGroupToYbaRolesPair_2:
      example:
        groupName: groupName
        roles:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        groupName:
          type: string
          example: example-groupName
        roles:
          items:
            format: uuid
            type: string
          type: array
          example:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      required:
      - groupName
      - roles
      type: object
    OidcGroupToYbaRolesData_3:
      example:
        oidcGroupToYbaRolesPairs:
        - groupName: groupName
          roles:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - groupName: groupName
          roles:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        oidcGroupToYbaRolesPairs:
          description: ' list of pairs of groupName and roles'
          items:
            $ref: '#/components/schemas/OidcGroupToYbaRolesPair_3'
          type: array
          example:
          - groupName: groupName
            roles:
            - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    LdapDnToYbaRoleData_3:
      description: A list of LDAP DN, YBA role pairs
      example:
        ldapDnToYbaRolePairs:
        - ybaRole: ConnectOnly
          distinguishedName: distinguishedName
        - ybaRole: ConnectOnly
          distinguishedName: distinguishedName
      properties:
        ldapDnToYbaRolePairs:
          description: ' list of pairs of distinguishedName and ybaRole'
          items:
            $ref: '#/components/schemas/LdapDnYbaRoleDataPair_3'
          type: array
          example:
          - ybaRole: ConnectOnly
            distinguishedName: distinguishedName
      type: object
    YBPSuccess_3:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    LdapDnYbaRoleDataPair_3:
      example:
        ybaRole: ConnectOnly
        distinguishedName: distinguishedName
      properties:
        distinguishedName:
          type: string
          example: example-distinguishedName
        ybaRole:
          enum:
          - ConnectOnly
          - ReadOnly
          - BackupAdmin
          - Admin
          - SuperAdmin
          type: string
          example: ConnectOnly
      required:
      - distinguishedName
      - ybaRole
      type: object
    OidcGroupToYbaRolesPair_3:
      example:
        groupName: groupName
        roles:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        groupName:
          type: string
          example: example-groupName
        roles:
          items:
            format: uuid
            type: string
          type: array
          example:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      required:
      - groupName
      - roles
      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