Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Users

Update a user

patch/projects/{projectId}/customers/{customerId}/users/{userId}

Path parameters

projectIdstring required
Example:consoleproject

Unique identifier of your project in the Corti API Console.

To find it, open your project at console.corti.app, go to Settings, and copy the value from the Project ID field.

customerIdstring required
Example:contosohospital

The unique identifier for a Customer

userIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The ID of the user

Request body

firstNamestring

User's first name

lastNamestring

User's last name

enabledboolean

Flag indicating if the user account is active

passwordstring

New password for the user

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "enabled": true,
  "password": "My$ecureP@ssw0rd123!"
}

Response

User updated successfully

idstring uuid

Unique identifier for the user

emailstring email required

User's email address

firstNamestring required

User's first name

lastNamestring required

User's last name

emailVerifiedboolean

Flag indicating whether the user's email address has been verified

enabledboolean required

Flag indicating if the user account is active

createdAtstring date-time

Timestamp when the user was created

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "emailVerified": true,
  "enabled": true,
  "createdAt": "2023-10-01T12:00:00Z"
}