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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenMetadata

OpenMetadata Users API

A `User` represents a user of OpenMetadata. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more data assets. A user can also follow zero or more data assets.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 42 operations across 36 paths, and defines 49 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.

42 operations 36 paths 49 schemas 3 DELETE18 GET1 PATCH9 POST11 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
Contact
OpenMetadata
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 42

Across 36 paths, the API surfaces 42 operations — 3 DELETE, 18 GET, 1 PATCH, 9 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 42

A User represents a user of OpenMetadata. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more d…

PUT
/v1/users/changePassword
Change Password For User
changeUserPassword body → 200400
POST
/v1/users/checkEmailVerified
Check if a mail is verified
checkEmailIsVerified body → 200400
PUT
/v1/users/registrationConfirmation
Confirm User Email
confirmUserEmail 1 param → 200400
GET
/v1/users/security/token
Get personal access token to User
getPersonalAccessToken 1 param → 200400
PUT
/v1/users/security/token
Provide access token to User
createPersonalAccessToken body → 200400
GET
/v1/users
List users
listUsers 8 params → 200
PUT
/v1/users
Update user
createOrUpdateUser body → 200400
POST
/v1/users
Create a user
createUser body → 200400
GET
/v1/users/name/{name}
Get a user by name
getUserByFQN 3 params → 200404
DELETE
/v1/users/name/{name}
Delete a user
deleteUserByName 2 params → 200404
GET
/v1/users/{id}
Get a user
getUserByID 3 params → 200404
DELETE
/v1/users/{id}
Delete a user
deleteUser 2 params → 200404
PATCH
/v1/users/{id}
Update a user
patchUser 1 param body → default
DELETE
/v1/users/async/{id}
Asynchronously delete a user
deleteUserAsync 2 params → 200404
GET
/v1/users/export
Export users in a team in CSV format
exportUsers 1 param → 200
GET
/v1/users/exportAsync
Export users in a team in CSV format
exportUsers_1 1 param → 200
GET
/v1/users/generateRandomPwd
Generate a random password
generateRandomPwd → 200
POST
/v1/users/generatePasswordResetLink
Generate Password Reset Link
generatePasswordResetLink body → 200400
PUT
/v1/users/generateToken/{id}
Generate JWT Token for a Bot User
generateJWTTokenForBotUser 1 param body → 200400
POST
/v1/users/generateToken
Generate JWT Token for a User
generateJWTTokenForUser body → 200400403
GET
/v1/users/auth-mechanism/{id}
Get Authentication Mechanism for a Bot User
getAuthenticationMechanismBotUser 1 param → 200400
GET
/v1/users/loggedInUser/groupTeams
Get group type of teams for current logged in user
getCurrentLoggedInUserGroupTeams → 200404
GET
/v1/users/loggedInUser
Get current logged in user
getCurrentLoggedInUser 1 param → 200404
GET
/v1/users/token/{id}
Get JWT Token for a Bot User
getJWTTokenForBotUser 1 param → 200400
GET
/v1/users/documentation/csv
Get CSV documentation for user import/export
getCsvDocumentation_2 → default
GET
/v1/users/{id}/versions/{version}
Get a version of the user
getSpecificUserVersion 2 params → 200404
PUT
/v1/users/import
Import from CSV to create, and update teams.
importTeams_1 2 params body → 200
PUT
/v1/users/importAsync
Import from CSV to create, and update teams asynchronously.
importTeamsAsync_1 2 params body → 200
GET
/v1/users/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_60 5 params → 200
GET
/v1/users/online
List online users
listOnlineUsers 5 params → 200403
GET
/v1/users/{id}/assets
List assets owned by this user or their teams
listUserAssets 3 params → 200404
GET
/v1/users/name/{name}/assets
List assets owned by this user or their teams by name
listUserAssetsByName 3 params → 200404
GET
/v1/users/{id}/versions
List user versions
listAllUserVersion 1 param → 200
POST
/v1/users/login
Login User with email (plain-text) and Password (encoded in base 64)
loginUserWithPwd body → 200400
POST
/v1/users/logout
Logout a User(Only called for saml and basic Auth)
logoutUser body → 200400
POST
/v1/users/refresh
Provide access token to User with refresh token
refreshToken body → 200400
POST
/v1/users/signup
Register User
registerUser body → 200400
PUT
/v1/users/resendRegistrationToken
Resend Registration Token
resendRegistrationToken 1 param → 200400
POST
/v1/users/password/reset
Reset Password For User
resetUserPassword body → 200400
PUT
/v1/users/restore
Restore a soft deleted User.
restore_47 body → 200
PUT
/v1/users/security/token/revoke
Revoke personal access token to User
revokePersonalAccessToken 2 params body → 200400
PUT
/v1/users/revokeToken
Revoke JWT Token for a Bot User
revokeJWTTokenForBotUser body → 200400

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are User (52 properties), CreateUser (26 properties), TagLabel (13 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
GenerateTokenRequest
object
2 properties 1 required
AuthenticationMechanism
object
2 properties
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
PersonalAccessToken
object
6 properties 3 required
FieldChange
object
3 properties
CoverImage
object
2 properties
Profile
object
2 properties
RestoreEntity
object
1 property 1 required
RevokeTokenRequest
object
1 property 1 required
Webhook
object
9 properties
LifeCycle
object
3 properties
CreatePersonalToken
object
2 properties 2 required
LandingPageSettings
object
2 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
RevokePersonalTokenRequest
object
1 property
Paging
object
5 properties 1 required
ChangePasswordRequest
object
5 properties 2 required
JsonPatch
object
LoginRequest
object
2 properties 2 required
ChangeDescription
object
5 properties
UserList
object
5 properties 1 required
PersonaPreferences
object
3 properties 2 required
PersonalAccessTokenList
object
5 properties 1 required
CSVExportResponse
object
2 properties
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
ImageList
object
7 properties
CsvImportResult
object
7 properties
EmailRequest
object
1 property 1 required
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
User
object
52 properties 3 required
TagLabelMetadata
object
2 properties
LogoutRequest
object
4 properties 1 required
JwtResponse
object
4 properties
JWTAuthMechanism
object
3 properties 1 required
TokenRefreshRequest
object
1 property 1 required
EntityError
object
2 properties
CreateUser
object
26 properties 2 required
SubscriptionConfig
object
4 properties
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required
PasswordResetRequest
object
4 properties 1 required
RegistrationRequest
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-users-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
AE Profile APIs.io
OpenMetadata AI Applications API
AE Profile APIs.io
OpenMetadata AI Governance Policies API
AE Profile APIs.io
OpenMetadata API Collections API
AE Profile APIs.io
OpenMetadata API Endpoint API
AE Profile APIs.io
OpenMetadata API Services API
AE Profile APIs.io
OpenMetadata Apps API
AE Profile APIs.io
OpenMetadata Audit Logs API
AE Profile APIs.io
OpenMetadata Bots API
AE Profile APIs.io
OpenMetadata ChangeSummary API
AE Profile APIs.io
OpenMetadata Charts API
AE Profile APIs.io
OpenMetadata Classifications API
AE Profile APIs.io
#User
← Back to O APIs
API Details
ID
openmetadata:openmetadata-users-api
Base URL
https://{your-host}/api/v1
Docs
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
Provider
OpenMetadata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openmetadata-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openmetadata-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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