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 User management API

The User management API from YugabyteDB — 6 operation(s) for user management.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 9 operations across 6 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

9 operations 6 paths 15 schemas 1 DELETE3 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

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

  • apiKeyAuth — API token passed as header

Paths & Operations 9

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

User Management 9
PUT
/api/v1/customers/{cUUID}/reset_password
Reset the user's password
resetUserPassword 2 params body → 200
GET
/api/v1/customers/{cUUID}/users
List all users
listUsers 2 params → 200
POST
/api/v1/customers/{cUUID}/users
Create a user
createUser 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/users/{uUUID}
Delete a user
deleteUser 3 params → 200
GET
/api/v1/customers/{cUUID}/users/{uUUID}
Get a user's details
getUserDetails 2 params → 200
PUT
/api/v1/customers/{cUUID}/users/{uUUID}deprecated
Change a user's role
updateUserRole 4 params → 200
PUT
/api/v1/customers/{cUUID}/users/{uUUID}/change_passworddeprecated
Change password - deprecated
changePassword 3 params body → default
GET
/api/v1/customers/{cUUID}/users/{uUUID}/oidc_auth_token
Retrieve OIDC auth token
retrieveOIDCAuthToken 3 params → 200
PUT
/api/v1/customers/{cUUID}/users/{uUUID}/update_profile
Update a user's profile
UpdateUserProfile 3 params body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Users (12 properties), UserWithFeatures (12 properties), UserWithFeatures_2 (10 properties), Users_2 (10 properties). Each schema is shown below with its type and property counts.

RoleResourceDefinition
object
Defines the association of Role to Resource Groups.
2 properties 1 required
UserRegistrationData
object
User registration data. The API and UI use this to validate form data.
7 properties 1 required
UserOIDCAuthToken
object
1 property
ResourceDefinition
object
3 properties
ResourceGroup
object
1 property 1 required
UserProfileData
object
User profile data. The API and UI use this to validate form data.
4 properties 1 required
UserWithFeatures
object
A user with set of features, associated with a customer
12 properties 3 required
Users
object
A user associated with a customer
12 properties 3 required
YBPSuccess
object
2 properties
UserPasswordChangeFormData
object
User registration data. The API and UI use this to validate form data.
2 properties
UserRegistrationData_2
object
User registration data. The API and UI use this to validate form data.
6 properties 2 required
UserProfileData_2
object
User profile data. The API and UI use this to validate form data.
4 properties 1 required
UserWithFeatures_2
object
A user with set of features, associated with a customer
10 properties 1 required
Users_2
object
A user associated with a customer
10 properties 1 required
YBPSuccess_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-user-management-api-openapi.yml Raw ↑
#User Management
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-user-management-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-user-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-user-management-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 User management 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.