Appearance

Update Users ​

Endpoint ​

http
PATCH /unified/mdm/users/{id}
Integrations supported
  • Jamf

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

name
string
REQUIRED · 

The user's name

Supported in
  • Jamf
emails
object[]

The emails of the user

Supported in
  • Jamf
email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The user's unique identifier

name
string
REQUIRED · 

The user's name

first_name
string

The user's first name

last_name
string

The user's last name

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

organization
object

The organization/account the device belongs to

id
string

The unique identifier for an organization

name
string

The name of the organization

is_active
boolean

Whether the user is active or not

avatar
string

The URL of the user's avatar

created_at
string · date-time

The date and time the user was created

updated_at
string · date-time

The date and time the user was last updated

remote_data
object

Raw data returned from the remote API call.