Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB LDAP Role management API

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

YugabyteDB LDAP Role management API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include LDAP Role management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB LDAP Role management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

LDAP Role management 1
POST
/api/v1/customers/{cUUID}/universes/{univUUID}/ldap_roles_sync
YugabyteDB Anywhere Perform an LDAP Users Sync on the Universe
syncLdapUniverse 3 params body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are LdapUnivSyncFormData_2 (18 properties), LdapUnivSyncFormData (18 properties), YBPTask_2 (2 properties), YBPTask (2 properties). Each schema is shown below with its type and property counts.

LdapUnivSyncFormData
object
Config to sync universe roles with ldap users
18 properties 4 required
YBPTask
object
2 properties
LdapUnivSyncFormData_2
object
Config to sync universe roles with ldap users
18 properties 4 required
YBPTask_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-ldap-role-management-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API