---
title: "Update User Data"
method: PATCH
path: "/Users/{userId}"
tags: ["Users"]
---

# Update User Data

`PATCH /Users/{userId}`

Documentation on updating a User via SCIM. 

**OAuth Scope required:** `scim.users.updateUsers`

## Path parameters

- `userId` string, required

## Query parameters

- `excludedAttributes` string

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- object
  - `schemas` string[], required
  - `Operations` object[]
    - `op` string, required — Must be "add", "remove", or "replace"
    - `path` string, required — The path of the attribute that you wish to change (e.g., emails, name.givenName, name.familyName)
    - `value` string — The value you wish to use for "add" or "replace" operations. The "remove" operation does not take the "value" parameter.

## Response `200`

200 OK

- UserResponseObject
  - `schemas` string[], required
  - `userName` string — The email address of the user (e.g., jdoe@acme.com).
  - `name` object — The first name and last name of the user.
    - `givenName` string — The first name of the user.
    - `familyName` string — The last name of the user.
  - `title` string — The user's legal title.
  - `id` string, required — The user's unique identifier.
  - `emails` object[] — A list of emails associated with the user. The email with type work and primary flag is typically copied from the main email stored in the userName property.
    - `value` string — The email address value.
    - `type` string — The type of email this is. Canonical values include 'work', 'home', and 'other'.
    - `primary` boolean — Whether this is the user's primary email address.
  - `active` boolean — Whether this user is currently active. Ironclad users do not have the concept of active vs. inactive, and a SCIM User with active set to `false` will be removed from the company. On subsequent reads, inactive users would be not found.
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` object — Enterprise User attributes
    - `department` string — Which department the user is a part of.
  - `urn:ietf:params:scim:schemas:extension:ironclad:2.0:User` object — Ironclad User attributes
    - `departmentHead` string, email — The email address (username) of the user's department head.
    - `provider` 'local' | 'magicLink' | 'saml' | 'google' — The user's authentication method.
    - `allowProviderConversion` boolean — Whether the user is allowed to convert from `local` to `google` provider.
  - `meta` object — Metadata for the user.
    - `resourceType` 'User' — Type of the SCIM resource. In this case: 'User'.
    - `created` string — When the User was created.
    - `lastModified` string — When the User was last modified.
    - `location` string, url — The URI of the User resource being returned.

## Other responses

- `400` — 400 Bad Request
- `403` — 403 Forbidden
- `404` — 404 Not Found
- `500` — 500 Internal Server Error

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)