v1

latestOpenAPI 3.1.02026-07-121551100.4 KB

Users

Update User

patch/unified/iam/users/{id}

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

primary_email_addressstring nullable

Primary email address of the user. This is generally a work email address.

first_namestring nullable

last_namestring nullable

namestring nullable

User's name which (can be a full name or display name)

usernamestring nullable

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "primary_email_address": "han@stackone.com",
  "first_name": "Han",
  "last_name": "Solo",
  "name": "Han Solo",
  "username": "hansolo1977",
  "status": {
    "value": "enabled"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

Record updated successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}