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 LDAPOIDC Role management API

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

YugabyteDB LDAPOIDC 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 LDAPOIDC 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 5 operations across 3 paths, and defines 10 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.

5 operations 3 paths 10 schemas 1 DELETE2 GET2 PUT

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 LDAPOIDC 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 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

LDAPOIDC Role management 5
GET
/api/v1/customers/{cUUID}/ldap_mappingsdeprecated
YugabyteDB Anywhere List LDAP Mappings
listLdapDnToYbaRoles 1 param → 200
PUT
/api/v1/customers/{cUUID}/ldap_mappingsdeprecated
YugabyteDB Anywhere Set LDAP Mappings
setLdapDnToYbaRoles 2 params body → default
GET
/api/v1/customers/{cUUID}/oidc_mappingsdeprecated
YugabyteDB Anywhere List OIDC Group Mappings
listOidcGroupToYbaRoles 1 param → 200
PUT
/api/v1/customers/{cUUID}/oidc_mappingsdeprecated
YugabyteDB Anywhere Set OIDC Mappings
mapOidcGroupToYbaRoles 2 params body → default
DELETE
/api/v1/customers/{cUUID}/oidc_mappings/{groupName}deprecated
YugabyteDB Anywhere Delete a OIDC Group Mapping
deleteOidcGroupMapping 3 params → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are LdapDnYbaRoleDataPair_2 (2 properties), YBPSuccess (2 properties), OidcGroupToYbaRolesPair (2 properties), YBPSuccess_2 (2 properties). Each schema is shown below with its type and property counts.

LdapDnYbaRoleDataPair
object
2 properties 2 required
LdapDnToYbaRoleData
object
A list of LDAP DN, YBA role pairs
1 property
OidcGroupToYbaRolesData
object
1 property
OidcGroupToYbaRolesPair
object
2 properties 2 required
YBPSuccess
object
2 properties
LdapDnYbaRoleDataPair_2
object
2 properties 2 required
LdapDnToYbaRoleData_2
object
A list of LDAP DN, YBA role pairs
1 property
OidcGroupToYbaRolesData_2
object
1 property
OidcGroupToYbaRolesPair_2
object
2 properties 2 required
YBPSuccess_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-ldapoidc-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