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 Personas API

A `Persona` is to represent job function a user does. OpenMetadata uses Persona to define customizable experience in the UI.

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

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

This API exposes 13 operations across 8 paths, and defines 24 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.

13 operations 8 paths 24 schemas 3 DELETE6 GET2 PATCH1 POST1 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 Personas API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 13

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

Personas 13

A Persona is to represent job function a user does. OpenMetadata uses Persona to define customizable experience in the UI.

GET
/v1/personas
List personas
listPersonas 4 params → 200
PUT
/v1/personas
Update Persona
createOrUpdatePersona body → 200400
POST
/v1/personas
Create a Persona
createPersona body → 200400
GET
/v1/personas/name/{name}
Get a Persona by name
getPersonaByFQN 3 params → 200404
DELETE
/v1/personas/name/{name}
Delete a Persona by name
deletePersonaByName 1 param → 200404
GET
/v1/personas/{id}
Get a persona by id
getPersonaByID 4 params → 200404
DELETE
/v1/personas/{id}
Delete a Persona by id
deletePersona 1 param → 200404
PATCH
/v1/personas/{id}
Update a Persona
patchPersona_1 1 param body → default
DELETE
/v1/personas/async/{id}
Asynchronously delete a Persona by id
deletePersonaAsync 1 param → 200404
GET
/v1/personas/{id}/versions/{version}
Get a version of the Persona
getSpecificPersonaVersion 2 params → 200404
GET
/v1/personas/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_57 5 params → 200
GET
/v1/personas/{id}/versions
List Persona versions
listAllPersonaVersion 1 param → 200
PATCH
/v1/personas/name/{fqn}
Update a Persona using name.
patchPersona 1 param body → default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Persona (34 properties), TagLabel (13 properties), CreatePersona (12 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
Persona
object
34 properties 2 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
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
JsonPatch
object
CreatePersona
object
12 properties 1 required
ChangeDescription
object
5 properties
UsageStats
object
2 properties 1 required
Style
object
3 properties
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
PersonaList
object
5 properties 1 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-personas-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 Personas 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.