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

OpenMetadata Roles API

A `Role` is a collection of `Policies` that provides access control. A user or a team can be assigned one or multiple roles that provide privileges to a user and members of a team to perform the job function.

OpenMetadata Roles API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 15 operations across 10 paths, and defines 25 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

15 operations 10 paths 25 schemas 3 DELETE7 GET2 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Roles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 15

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

Roles 15

A Role is a collection of Policies that provides access control. A user or a team can be assigned one or multiple roles that provide privileges to a user and members of a team to…

GET
/v1/roles
List roles
listRoles 6 params → 200
PUT
/v1/roles
Update role
createOrUpdateRole body → 200400
POST
/v1/roles
Create a role
createRole body → 200400
GET
/v1/roles/name/{name}
Get a role by name
getRoleByFQN 3 params → 200404
DELETE
/v1/roles/name/{name}
Delete a role
deleteRoleByName 2 params → 200404
GET
/v1/roles/{id}
Get a role by id
getRoleByID 4 params → 200404
DELETE
/v1/roles/{id}
Delete a role
deleteRole 2 params → 200404
PATCH
/v1/roles/{id}
Update a role
patchRole_1 1 param body → default
DELETE
/v1/roles/async/{id}
Asynchronously delete a role
deleteRoleAsync 2 params → 200404
GET
/v1/roles/{id}/versions/{version}
Get a version of the role
getSpecificRoleVersion 2 params → 200404
GET
/v1/roles/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_58 5 params → 200
GET
/v1/roles/{id}/versions
List role versions
listAllRoleVersion 1 param → 200
PATCH
/v1/roles/name/{fqn}
Update a role using name.
patchRole 1 param body → default
PUT
/v1/roles/restore
Restore a soft deleted role
restore_45 body → 200
GET
/v1/roles/search
Search roles
searchRoles 5 params → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Role (37 properties), TagLabel (13 properties), CreateRole (11 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
CreateRole
object
11 properties 2 required
JsonPatch
object
ChangeDescription
object
5 properties
Role
object
37 properties 2 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
RoleList
object
5 properties 1 required
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-roles-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

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