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.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 42

PUT /v1/users/changePassword Change Password For User #
POST /v1/users/checkEmailVerified Check if a mail is verified #
PUT /v1/users/registrationConfirmation Confirm User Email #
GET /v1/users/security/token Get personal access token to User #
PUT /v1/users/security/token Provide access token to User #
GET /v1/users List users #
PUT /v1/users Update user #
POST /v1/users Create a user #
GET /v1/users/name/{name} Get a user by name #
DELETE /v1/users/name/{name} Delete a user #
GET /v1/users/{id} Get a user #
DELETE /v1/users/{id} Delete a user #
PATCH /v1/users/{id} Update a user #
DELETE /v1/users/async/{id} Asynchronously delete a user #
GET /v1/users/export Export users in a team in CSV format #
GET /v1/users/exportAsync Export users in a team in CSV format #
GET /v1/users/generateRandomPwd Generate a random password #
PUT /v1/users/generateToken/{id} Generate JWT Token for a Bot User #
POST /v1/users/generateToken Generate JWT Token for a User #
GET /v1/users/auth-mechanism/{id} Get Authentication Mechanism for a Bot User #
GET /v1/users/loggedInUser/groupTeams Get group type of teams for current logged in user #
GET /v1/users/loggedInUser Get current logged in user #
GET /v1/users/token/{id} Get JWT Token for a Bot User #
GET /v1/users/documentation/csv Get CSV documentation for user import/export #
GET /v1/users/{id}/versions/{version} Get a version of the user #
PUT /v1/users/import Import from CSV to create, and update teams #
PUT /v1/users/importAsync Import from CSV to create, and update teams asynchronously #
GET /v1/users/history List all entity versions within a time range #
GET /v1/users/online List online users #
GET /v1/users/{id}/assets List assets owned by this user or their teams #
GET /v1/users/name/{name}/assets List assets owned by this user or their teams by name #
GET /v1/users/{id}/versions List user versions #
POST /v1/users/login Login User with email (plain-text) and Password (encoded in base 64) #
POST /v1/users/logout Logout a User(Only called for saml and basic Auth) #
POST /v1/users/refresh Provide access token to User with refresh token #
POST /v1/users/signup Register User #
PUT /v1/users/resendRegistrationToken Resend Registration Token #
POST /v1/users/password/reset Reset Password For User #
PUT /v1/users/restore Restore a soft deleted User #
PUT /v1/users/security/token/revoke Revoke personal access token to User #
PUT /v1/users/revokeToken Revoke JWT Token for a Bot User #

Documentation

📖
Documentation
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
📖
Authentication
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-users-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openmetadata-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openmetadata-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenMetadata Users API
  description: Common types and API definition for OpenMetadata
  contact:
    name: OpenMetadata
    url: https://open-metadata.org
    email: openmetadata-dev@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '1.13'
servers:
- url: /api
  description: Current Host
- url: http://localhost:8585/api
  description: Endpoint URL
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-users-api-openapi.yml