---
updatedAt: 2026-04-21T08:57:19.000Z
agentTools:
  projectIndex: https://docs.mesh.complyadvantage.com/llms.txt
---

# Update an existing user

Updates details for a given user.


You need the "Create and update users" permission to use this endpoint.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "identity_AnyUserResponse": {
        "properties": {
          "access_mode": {
            "description": "The user's current access mode.",
            "enum": [
              "UI_ONLY",
              "API_ONLY",
              "UI_AND_API"
            ],
            "example": "UI_ONLY",
            "type": "string"
          },
          "active": {
            "default": false,
            "description": "If a user is active or deactivated.",
            "example": true,
            "type": "boolean"
          },
          "client_identifier": {
            "description": "The unique identifier of the client.",
            "example": "00000000-0000-0000-0000-000000000000",
            "format": "uuid",
            "type": "string"
          },
          "created_at": {
            "description": "Date and time the user was created.",
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "description": "The unique identifier of who created the user.",
            "format": "uuid",
            "type": "string"
          },
          "deactivated_at": {
            "description": "Date and time the user was deactivated.",
            "format": "date-time",
            "type": "string"
          },
          "email": {
            "description": "Email address of the user.",
            "example": "example@mail.com",
            "type": "string"
          },
          "enforce_mfa_after": {
            "description": "Date and time of when MFA will be enforced for the user.",
            "format": "date-time",
            "type": "string"
          },
          "identifier": {
            "description": "The unique identifier of the user.",
            "example": "00000000-0000-0000-0000-000000000000",
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "description": "Full name of the user.",
            "example": "John Doe",
            "type": "string"
          },
          "updated_at": {
            "description": "Date and time the user was last updated.",
            "format": "date-time",
            "type": "string"
          },
          "updated_by": {
            "description": "The unique identifier of who last updated the user.",
            "format": "uuid",
            "type": "string"
          },
          "user_type": {
            "description": "Specifies the type of the entity.",
            "enum": [
              "AGENT",
              "HUMAN",
              "MACHINE_CREDENTIAL"
            ],
            "example": "HUMAN",
            "type": "string"
          }
        },
        "required": [
          "access_mode",
          "active",
          "client_identifier",
          "created_at",
          "created_by",
          "email",
          "identifier",
          "name",
          "updated_at",
          "updated_by",
          "user_type"
        ],
        "type": "object"
      },
      "identity_ProblemDetailErrorResponse": {
        "additionalProperties": true,
        "properties": {
          "detail": {
            "type": "string"
          },
          "identifier": {
            "format": "uuid",
            "type": "string"
          },
          "instance": {
            "format": "uri",
            "type": "string"
          },
          "status": {
            "format": "int32",
            "type": "integer"
          },
          "timestamp": {
            "format": "date-time",
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "type": {
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "timestamp"
        ],
        "type": "object"
      },
      "identity_UserPartialUpdateRequestBody": {
        "properties": {
          "access_mode": {
            "description": "Access mode for the user. Only settable to a value other than UI_ONLY if the client has legacy auth enabled. Omit to leave unchanged.",
            "enum": [
              "UI_ONLY",
              "API_ONLY",
              "UI_AND_API"
            ],
            "example": "API_ONLY",
            "type": "string"
          },
          "active": {
            "default": false,
            "description": "If the user is active or deactivated.",
            "example": true,
            "nullable": true,
            "type": "boolean"
          },
          "enforce_mfa_after": {
            "description": "Date and time of when MFA will be enforced for the user.",
            "example": "2024-06-01T00:00:00.000Z",
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "description": "Full name of the user.",
            "example": "John Doe",
            "maxLength": 50,
            "minLength": 1,
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "description": "HTTP Bearer Token Authentication",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Mesh API",
    "version": "v2.0"
  },
  "openapi": "3.0.3",
  "paths": {
    "/v2/users/{user_identifier}": {
      "patch": {
        "description": "Updates details for a given user.\n\n\nYou need the \"Create and update users\" permission to use this endpoint.",
        "operationId": "identity_v2_users_user_identifier_partialUpdateUser",
        "parameters": [
          {
            "description": "The identifier of the user that you want to update.",
            "example": "00000000-0000-0000-0000-000000000000",
            "in": "path",
            "name": "user_identifier",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/identity_UserPartialUpdateRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_AnyUserResponse"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "Invalid input"
          }
        },
        "summary": "Update an existing user",
        "tags": [
          "Users"
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "servers": [
    {
      "description": "ComplyAdvantage Mesh API",
      "url": "https://api.mesh.complyadvantage.com"
    }
  ],
  "tags": [
    {
      "name": "Users"
    }
  ]
}
```