patch https://{application_vanity_domain}/api/v1/users/
Patches the specified user.
Required Permissions
Below is the list of required permissions needed to interact with this API. For each permission the allowed permission boundaries are also specified.
| Permission | Boundary | Description |
|---|---|---|
| user:update | Application | The subject can update all users under the application that the subject belongs to. |
| Tenant | The subject can update all users associated to the tenant that the subject belongs to. | |
| Tenant Inclusion List | The subject can update all users associated to tenants specified in the tenant inclusion list. | |
| Tenant Exclusion List | The subject can update all users associated to tenants that belong to the subject's application but are not included in the tenant exclusion list. | |
| Self | A user subject can update itself. |
Field-Level Permissions
In addition to the aforementioned permissions, the following permissions are conditionally required depending on the fields being updated. The permission boundaries that apply to the user:update permission also apply to the field level permissions.
| Permission | Description |
|---|---|
| user:manage-email | Required if the email or emailVerified fields are modified. |
| user:manage-external-id | Required if the externalId field is modified. |
| user:manage-restricted-metadata | Required if the restrictedMetadata field is modified. |
| user:manage-status | required if the status field is modified. |