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

Cockroach Labs RoleManagement API

Manage role-based access control, including assigning and removing roles for users across organization, folder, and cluster scopes.

Cockroach Labs RoleManagement API is one of 26 APIs that Cockroach Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Role Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 2024-09-16.

Requests are made against a single base URL, https://cockroachlabs.cloud.

6 operations 4 paths 6 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-09-16
Base URL
https://cockroachlabs.cloud
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Cockroach Labs RoleManagement API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Generate a token in the CockroachDB Cloud Console under Organization Settings API Access.

Paths & Operations 6

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

RoleManagement 6

Manage role-based access control, including assigning and removing roles for users across organization, folder, and cluster scopes.

GET
/api/v1/roles
List role grants
ListRoleGrants 4 params → 200401
GET
/api/v1/roles/{user_id}
Get all roles for a user
GetAllRolesForUser 1 param → 200401404
PUT
/api/v1/roles/{user_id}
Set roles for a user
SetRolesForUser 1 param body → 200400401
POST
/api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}
Add user to role
AddUserToRole 4 params → 200401404
DELETE
/api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}
Remove user from role
RemoveUserFromRole 4 params → 200401404
GET
/api/v1/users/persons-by-email
Get person users by email
GetPersonUsersByEmail 1 param → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PaginationResponse (3 properties), Error (3 properties), ListRoleGrantsResponse (2 properties), GetAllRolesForUserResponse (1 property). Each schema is shown below with its type and property counts.

GetPersonUsersByEmailResponse
object
Person user accounts matching the queried email address.
1 property
Error
object
Standard error response returned by the API.
3 properties
PaginationResponse
object
Pagination metadata included in list responses.
3 properties
SetRolesForUserRequest
object
Request body for setting all roles for a user.
1 property 1 required
ListRoleGrantsResponse
object
Paginated list of role grants in the organization.
2 properties
GetAllRolesForUserResponse
object
All role grants assigned to a specific user.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cockroach-labs-rolemanagement-api-openapi.yml Raw ↑

Other APIs Cockroach Labs publishes across the network.

Cockroach Labs APIKeys API
Cockroach Labs AuditLogs API
Cockroach Labs Auth API
Cockroach Labs BackupRestore API
Cockroach Labs Billing API
Cockroach Labs Clusters API
Cockroach Labs CMEK API
Cockroach Labs Databases API
Cockroach Labs EgressRules API
Cockroach Labs Folders API
Cockroach Labs Health API
Cockroach Labs IPAllowlists API
Where this information came from

This is an independent, third-party profile of Cockroach Labs RoleManagement 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.