How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yugabytedb

YugabyteDB Authentication API

Authentication operations on YBA

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, {protocol}://{host_port}/api/v2.

3 operations 2 paths 4 schemas 1 DELETE1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
YugabyteDB Anywhere Support
License
Polyform Free Trial License 1.0.0
Resource Areas
1

Authentication & Security 1

YugabyteDB Authentication API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

Paths & Operations 3

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

Authentication 3

Authentication operations on YBA

GET
/customers/{cUUID}/auth/group-mappings
List Group Mappings
listMappings 1 param → 200400500
PUT
/customers/{cUUID}/auth/group-mappings
Create Group Mappings
updateGroupMappings 1 param body → 200400500
DELETE
/customers/{cUUID}/auth/group-mappings/{gUUID}
Delete Group Mappings
deleteGroupMappings 2 params → 200400404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AuthGroupToRolesMapping (5 properties), ResourceDefinition (3 properties), RoleResourceDefinition (2 properties), ResourceGroup (1 property). Each schema is shown below with its type and property counts.

RoleResourceDefinition
object
Defines the association of Role to Resource Groups. Part of AuthGroupToRolesMapping.
2 properties 1 required
ResourceDefinition
object
Resource definition containing the resource type and resource set.
3 properties 2 required
ResourceGroup
object
Resource group definition for the role. Only applicable for custom roles.
1 property 1 required
AuthGroupToRolesMapping
object
AuthGroupToRolesMapping Group mapping properties. This is used to map LDAP and OIDC group to YBA roles.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-authentication-api-openapi.yml Raw ↑
#Authentication
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-authentication-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
Yugabytedb
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabytedb-authentication-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-authentication-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of YugabyteDB Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.