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 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 28 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.

8 operations 5 paths 28 schemas 1 DELETE4 GET2 POST1 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 RBAC 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 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
YugabyteDB Anywhere List All the Permissions Available
listPermissions 2 params → 200
GET
/api/v1/customers/{cUUID}/rbac/role
YugabyteDB Anywhere List All the Roles Available
listRoles 2 params → 200
POST
/api/v1/customers/{cUUID}/rbac/role
YugabyteDB Anywhere Create a Custom Role
createRole 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/rbac/role/{rUUID}
YugabyteDB Anywhere Delete a Custom Role
deleteRole 3 params → 200
GET
/api/v1/customers/{cUUID}/rbac/role/{rUUID}
YugabyteDB Anywhere Get a Role's Information
getRole 2 params → 200
PUT
/api/v1/customers/{cUUID}/rbac/role/{rUUID}
YugabyteDB Anywhere Edit a Custom Role
editRole 3 params body → 200
GET
/api/v1/customers/{cUUID}/rbac/role_binding
YugabyteDB Anywhere Get All the Role Bindings Available
getRoleBindings 2 params → 200
POST
/api/v1/customers/{cUUID}/rbac/role_binding/{userUUID}
YugabyteDB Anywhere Set the Role Bindings of a User
setRoleBinding 3 params body → 200

Schemas 28

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

Permission
object
2 properties
GroupMappingInfo
object
6 properties 5 required
Principal
object
4 properties 4 required
Role
object
8 properties
PermissionDetails
object
1 property
PermissionInfo
object
6 properties
RoleBindingFormData
object
Role Binding form metadata
1 property 1 required
RoleFormData
object
Role form metadata
3 properties 3 required
YBPSuccess
object
2 properties
ResourceGroup
object
1 property 1 required
RoleResourceDefinition
object
Defines the association of Role to Resource Groups.
2 properties 1 required
ResourceDefinition
object
3 properties
RoleBinding
object
9 properties 1 required
Users
object
A user associated with a customer
12 properties 3 required
Permission_2
object
2 properties
GroupMappingInfo_2
object
6 properties 5 required
Principal_2
object
4 properties 4 required
Role_2
object
8 properties
PermissionDetails_2
object
1 property
PermissionInfo_2
object
6 properties
RoleBindingFormData_2
object
Role Binding form metadata
1 property 1 required
RoleFormData_2
object
Role form metadata
3 properties 3 required
YBPSuccess_2
object
2 properties
ResourceGroup_2
object
1 property 1 required
RoleResourceDefinition_2
object
Defines the association of Role to Resource Groups.
2 properties 1 required
ResourceDefinition_2
object
3 properties
RoleBinding_2
object
9 properties 1 required
Users_2
object
A user associated with a customer
12 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