WorkOS

user_management.users.update

Updates properties of a user. The omitted properties will be left unchanged.

Remote workos

Other tools also called user_management.users.update? See providers with this name

Input Schema


            {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique ID of the user."
    },
    "email": {
      "type": "string",
      "description": "The email address of the user."
    },
    "locale": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's preferred locale."
    },
    "metadata": {
      "type": [
        "object",
        "null"
      ],
      "description": "Object containing metadata key/value pairs associated with the user."
    },
    "password": {
      "type": "string",
      "description": "The password to set for the user."
    },
    "last_name": {
      "type": "string",
      "description": "The last name of the user."
    },
    "first_name": {
      "type": "string",
      "description": "The first name of the user."
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The external ID of the user."
    },
    "password_hash": {
      "type": "string",
      "description": "The hashed password to set for the user. Mutually exclusive with `password`."
    },
    "email_verified": {
      "type": "boolean",
      "description": "Whether the user's email has been verified."
    },
    "password_hash_type": {
      "enum": [
        "bcrypt",
        "firebase-scrypt",
        "ssha",
        "scrypt",
        "pbkdf2",
        "argon2"
      ],
      "type": "string",
      "description": "The algorithm originally used to hash the password, used when providing a `password_hash`."
    }
  }
}
          

Provider

WorkOS →