PATCH /v1/users/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Users

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
user = Users.retrieve("77655e6e-ad33-49da-bbca-db4ba4d4e2cd")
user.description = "Senior data analyst in the Sales team"
user.displayName = "Aaron M. Johnson"
updated = Users.update(user)

print(f"Updated to version {updated.version}")

import static org.openmetadata.sdk.fluent.Users.*;

// Retrieve, modify, and update
var user = Users.retrieve("77655e6e-ad33-49da-bbca-db4ba4d4e2cd");
user.setDescription("Senior data analyst in the Sales team");
var updated = Users.update(user);

# Update by ID
curl -X PATCH "{base_url}/api/v1/users/77655e6e-ad33-49da-bbca-db4ba4d4e2cd" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Senior data analyst in the Sales team"},
    {"op": "replace", "path": "/displayName", "value": "Aaron M. Johnson"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/users/name/aaron_johnson0" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Senior data analyst in the Sales team"}
  ]'

{
  "id": "77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
  "name": "aaron_johnson0",
  "fullyQualifiedName": "aaron_johnson0",
  "displayName": "Aaron M. Johnson",
  "description": "Senior data analyst in the Sales team",
  "version": 0.2,
  "updatedAt": 1769982624214,
  "updatedBy": "admin",
  "email": "aaron_johnson0@gmail.com",
  "href": "http://localhost:8585/api/v1/users/77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
  "isBot": false,
  "isAdmin": false,
  "allowImpersonation": false,
  "teams": [
    {
      "id": "7a2b921b-f623-4eb5-9736-649788ad842c",
      "type": "team",
      "name": "Sales",
      "fullyQualifiedName": "Sales",
      "displayName": "Sales",
      "deleted": false
    }
  ],
  "personas": [],
  "deleted": false,
  "roles": [
    {
      "id": "761c2bb2-0b77-4bc5-9af9-cf89536d6a12",
      "type": "role",
      "name": "DataSteward",
      "fullyQualifiedName": "DataSteward",
      "displayName": "Data Steward",
      "deleted": false
    }
  ],
  "domains": []
}

PATCH

users

{id}

PATCH /v1/users/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Users

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
user = Users.retrieve("77655e6e-ad33-49da-bbca-db4ba4d4e2cd")
user.description = "Senior data analyst in the Sales team"
user.displayName = "Aaron M. Johnson"
updated = Users.update(user)

print(f"Updated to version {updated.version}")

import static org.openmetadata.sdk.fluent.Users.*;

// Retrieve, modify, and update
var user = Users.retrieve("77655e6e-ad33-49da-bbca-db4ba4d4e2cd");
user.setDescription("Senior data analyst in the Sales team");
var updated = Users.update(user);

# Update by ID
curl -X PATCH "{base_url}/api/v1/users/77655e6e-ad33-49da-bbca-db4ba4d4e2cd" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Senior data analyst in the Sales team"},
    {"op": "replace", "path": "/displayName", "value": "Aaron M. Johnson"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/users/name/aaron_johnson0" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Senior data analyst in the Sales team"}
  ]'

{
  "id": "77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
  "name": "aaron_johnson0",
  "fullyQualifiedName": "aaron_johnson0",
  "displayName": "Aaron M. Johnson",
  "description": "Senior data analyst in the Sales team",
  "version": 0.2,
  "updatedAt": 1769982624214,
  "updatedBy": "admin",
  "email": "aaron_johnson0@gmail.com",
  "href": "http://localhost:8585/api/v1/users/77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
  "isBot": false,
  "isAdmin": false,
  "allowImpersonation": false,
  "teams": [
    {
      "id": "7a2b921b-f623-4eb5-9736-649788ad842c",
      "type": "team",
      "name": "Sales",
      "fullyQualifiedName": "Sales",
      "displayName": "Sales",
      "deleted": false
    }
  ],
  "personas": [],
  "deleted": false,
  "roles": [
    {
      "id": "761c2bb2-0b77-4bc5-9af9-cf89536d6a12",
      "type": "role",
      "name": "DataSteward",
      "fullyQualifiedName": "DataSteward",
      "displayName": "Data Steward",
      "deleted": false
    }
  ],
  "domains": []
}

Update a User

Update a user’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Permissions

Starting in OpenMetadata 2.0.3, updating another user’s profile requires EditAll on that user. A request without the required permission returns 403 Forbidden. Adding a user to a closed team (isJoinable: false) requires an administrator. OpenMetadata 2.0.3 also enforces this for create-or-update (PUT /v1/users) requests. Keeping an existing closed-team membership in a PUT request does not count as adding a new membership. Other authorization requirements still apply.

Update by ID

string

required

UUID of the user to update.

Update by Name

Use PATCH /v1/users/name/{fqn} to update by fully qualified name.

string

required

Fully qualified name of the user (e.g., aaron_johnson0).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

string

Updated display name.

string

Updated description in Markdown format.

string

Updated email address.

boolean

Updated admin status.

array

Updated list of team references.

Show properties

string

UUID of the team.

string

Type of entity (always team).

array

Updated list of role references.

Show properties

string

UUID of the role.

string

Type of entity (always role).

string

Updated domain FQN.

object

Updated profile information.

PATCH /v1/users/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Users

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
user = Users.retrieve("77655e6e-ad33-49da-bbca-db4ba4d4e2cd")
user.description = "Senior data analyst in the Sales team"
user.displayName = "Aaron M. Johnson"
updated = Users.update(user)

print(f"Updated to version {updated.version}")

import static org.openmetadata.sdk.fluent.Users.*;

// Retrieve, modify, and update
var user = Users.retrieve("77655e6e-ad33-49da-bbca-db4ba4d4e2cd");
user.setDescription("Senior data analyst in the Sales team");
var updated = Users.update(user);

# Update by ID
curl -X PATCH "{base_url}/api/v1/users/77655e6e-ad33-49da-bbca-db4ba4d4e2cd" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Senior data analyst in the Sales team"},
    {"op": "replace", "path": "/displayName", "value": "Aaron M. Johnson"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/users/name/aaron_johnson0" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Senior data analyst in the Sales team"}
  ]'

{
  "id": "77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
  "name": "aaron_johnson0",
  "fullyQualifiedName": "aaron_johnson0",
  "displayName": "Aaron M. Johnson",
  "description": "Senior data analyst in the Sales team",
  "version": 0.2,
  "updatedAt": 1769982624214,
  "updatedBy": "admin",
  "email": "aaron_johnson0@gmail.com",
  "href": "http://localhost:8585/api/v1/users/77655e6e-ad33-49da-bbca-db4ba4d4e2cd",
  "isBot": false,
  "isAdmin": false,
  "allowImpersonation": false,
  "teams": [
    {
      "id": "7a2b921b-f623-4eb5-9736-649788ad842c",
      "type": "team",
      "name": "Sales",
      "fullyQualifiedName": "Sales",
      "displayName": "Sales",
      "deleted": false
    }
  ],
  "personas": [],
  "deleted": false,
  "roles": [
    {
      "id": "761c2bb2-0b77-4bc5-9af9-cf89536d6a12",
      "type": "role",
      "name": "DataSteward",
      "fullyQualifiedName": "DataSteward",
      "displayName": "Data Steward",
      "deleted": false
    }
  ],
  "domains": []
}

Returns

Returns the updated user object with the new version number.

Response

string

Unique identifier for the user (UUID format).

string

Username.

string

Fully qualified name (same as name for users).

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid JSON patch or malformed request
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this user
`404`	`NOT_FOUND`	User with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a User

Update a User

Permissions

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling

​Update a User

​Permissions

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update a User

Permissions

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling