Skip to main content
PATCH
/
unified
/
iam
/
users
/
{id}
Update User
curl --request PATCH \
  --url https://api.stackone.com/unified/iam/users/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "primary_email_address": "han@stackone.com",
  "first_name": "Han",
  "last_name": "Solo",
  "name": "Han Solo",
  "username": "hansolo1977",
  "is_bot_user": true,
  "status": {
    "value": "enabled",
    "source_value": "<string>"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'
{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stackone.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

​
Prefer
string

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

Example:

"heartbeat"

Path Parameters

​
id
string
required

Body

application/json
​
primary_email_address
string | null

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

Example:

"han@stackone.com"

​
first_name
string | null
Example:

"Han"

​
last_name
string | null
Example:

"Solo"

​
name
string | null

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

Example:

"Han Solo"

​
username
string | null
Example:

"hansolo1977"

​
is_bot_user

Indicates if the user is a bot or service user

Example:

true

​
status
object
​
passthrough
object

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

Record updated successfully.

​
statusCode
number
required
Example:

200

​
message
string
required
Example:

"Record updated successfully."

​
timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"