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

YugabyteDB RBAC management API

The RBAC management API from YugabyteDB — 5 operation(s) for rbac management.

YugabyteDB RBAC 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 RBAC 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 8 operations across 5 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

8 operations 5 paths 42 schemas 1 DELETE4 GET2 POST1 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
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB RBAC 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 8

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

RBAC management 8
GET
/api/v1/customers/{cUUID}/rbac/permissions
List all the permissions available
listPermissions 2 params → 200
GET
/api/v1/customers/{cUUID}/rbac/role
List all the roles available
listRoles 2 params → 200
POST
/api/v1/customers/{cUUID}/rbac/role
Create a custom role
createRole 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/rbac/role/{rUUID}
Delete a custom role
deleteRole 3 params → 200
GET
/api/v1/customers/{cUUID}/rbac/role/{rUUID}
Get a role's information
getRole 2 params → 200
PUT
/api/v1/customers/{cUUID}/rbac/role/{rUUID}
Edit a custom role
editRole 3 params body → 200
GET
/api/v1/customers/{cUUID}/rbac/role_binding
Get all the role bindings available
getRoleBindings 2 params → 200
POST
/api/v1/customers/{cUUID}/rbac/role_binding/{userUUID}
Set the role bindings of a user
setRoleBinding 3 params body → 200

Schemas 42

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

Principal
object
4 properties 4 required
RoleBinding
object
9 properties 1 required
ResourceDefinition
object
3 properties
PermissionInfo
object
6 properties
Users
object
A user associated with a customer
12 properties 3 required
RoleResourceDefinition
object
Defines the association of Role to Resource Groups.
2 properties 1 required
Permission
object
2 properties
RoleBindingFormData
object
Role Binding form metadata
1 property 1 required
PermissionDetails
object
1 property
YBPSuccess
object
2 properties
ResourceGroup
object
1 property 1 required
Role
object
8 properties
GroupMappingInfo
object
6 properties 5 required
RoleFormData
object
Role form metadata
3 properties 3 required
Principal_2
object
4 properties 4 required
RoleBinding_2
object
9 properties 1 required
ResourceDefinition_2
object
3 properties
PermissionInfo_2
object
6 properties
Users_2
object
A user associated with a customer
12 properties 3 required
RoleResourceDefinition_2
object
Defines the association of Role to Resource Groups.
2 properties 1 required
Permission_2
object
2 properties
RoleBindingFormData_2
object
Role Binding form metadata
1 property 1 required
PermissionDetails_2
object
1 property
YBPSuccess_2
object
2 properties
ResourceGroup_2
object
1 property 1 required
Role_2
object
8 properties
GroupMappingInfo_2
object
6 properties 5 required
RoleFormData_2
object
Role form metadata
3 properties 3 required
Principal_3
object
4 properties 4 required
RoleBinding_3
object
9 properties 1 required
ResourceDefinition_3
object
3 properties
PermissionInfo_3
object
6 properties
Users_3
object
A user associated with a customer
12 properties 3 required
RoleResourceDefinition_3
object
Defines the association of Role to Resource Groups.
2 properties 1 required
Permission_3
object
2 properties
RoleBindingFormData_3
object
Role Binding form metadata
1 property 1 required
PermissionDetails_3
object
1 property
YBPSuccess_3
object
2 properties
ResourceGroup_3
object
1 property 1 required
Role_3
object
8 properties
GroupMappingInfo_3
object
6 properties 5 required
RoleFormData_3
object
Role form metadata
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-rbac-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
Where this information came from

This is an independent, third-party profile of YugabyteDB RBAC 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.