Update Users
/unified/user-directory/users/{id}
Path Parameters
The ID of the resource.
23423523Query Parameters
Refer Specifying query parameters in Truto APIs
4 supported4 required2 notes
The ID of the organization to update the user in
The unique identifier for the organization
2 supported1 required
1 supported
2 supported2 required
The unique identifier of a user
1 supported1 required
The groups of the user
1 supported1 required
The unique identifier for a group
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount).debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
The unique identifier for a user
42 supported
1 supported
The avatar of the user
14 supported
The date and time the user was created
29 supported
1 supported
1 supported
1 supported
The emails of the user
39 supported1 required
The email address
Whether the email address is primary
The type of email address
The first name of the user
25 supported
1 supported1 required
The groups of the user
15 supported
The unique identifier for a group
The name of the group
The unique identifier of the organization to which the group belongs
The languages preferred by the user
11 supported
The last name of the user
25 supported
Whether the user is a licensed user.
1 supported
The licenses of the user or the products the user has access to
15 supported
The unique identifier for a license
The date and time the user was last active for the license
The name of the license
The unique identifier of the organization to which the license belongs
Display name for the Stripe SCIM user. Stripe does not support email/userName updates.
39 supported1 required
Org unit path, e.g. /Sales
1 supported
The organizations of the user
4 supported
The unique identifier for an organization
The name of the organization
1 supported
The phones of the user
17 supported
The phone number
The type of phone number
phonemobile
The extension of the phone number
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.
The roles of the user
33 supported3 required
The name of the role
admingroup_admin
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
The unique identifier for a role
admingroup_admin
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.
lifecycle status of the user
activeinactivedeletedinvitedactiveinactiveactiveinactivedeletedactiveactiveinactiveactiveinactiveactiveinactiveactiveinactiveactiveinactivedeleted+ 9 more
33 supported1 required
activeinactiveactiveinactivedeletedactiveactiveinactiveactiveinactiveactiveinactivedeletedThe timezone of the user
11 supported
The title of the user
10 supported
The URLs of the user
1 supported
The type of URL
The URL
The type of user
2 supported
The username of the user
17 supported2 required
The workspaces of the user
3 supported
The unique identifier for a workspace
The name of the workspaces
Response Body
The unique identifier for a user
42 supported
The date and time the user was activated
2 supported
The avatar of the user
14 supported
The bio of the user. Usually a short description set by the user about them.
3 supported
The date and time the user was created
29 supported
The emails of the user
38 supported
The email address
Whether the email address is primary
The type of email address
The external identifier for a user. This is set when the SCIM API is being used.
3 supported
The first name of the user
25 supported
The groups of the user
15 supported
The unique identifier for a group
The name of the group
The unique identifier of the organization to which the group belongs
The identifiers of the user.
2 supported
Whether the user has 2FA enabled
5 supported
Whether the user's email has been verified
5 supported
The languages preferred by the user
11 supported
The date and time the user was last active
8 supported
The date and time the user was last logged in
16 supported
The last name of the user
25 supported
The licenses of the user or the products the user has access to
15 supported
The unique identifier for a license
The date and time the user was last active for the license
The name of the license
The unique identifier of the organization to which the license belongs
The name of the user
39 supported
The organizations of the user
4 supported
The unique identifier for an organization
The name of the organization
The phones of the user
17 supported
The extension of the phone number
The phone number
The type of phone number
Raw data returned from the remote API call.
The roles of the user
31 supported
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
The unique identifier for a role
The name of the role
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.
The status of the user. If no clear mapping is available, then the raw value is returned.
activeinactivedeletedinvited
33 supported
The date and time the user's status was last changed
The timezone of the user
11 supported
The title of the user
10 supported
The date and time the user was last updated
19 supported
The URLs of the user
1 supported
The type of URL
The URL
The type of user
2 supported
The username of the user
17 supported
The workspaces of the user
3 supported
The unique identifier for a workspace
The name of the workspaces
truto unified user-directory users '<resource_id>' \
-m update \
-a '<integrated_account_id>' \
-b '{
"name": "your_name",
"password": "your_password",
"group": 0,
"roles": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"username": "your_username",
"emails": [],
"workspaces": [],
"status": "active",
"phones": [],
"title": "your_title",
"groups": [],
"timezone": "your_timezone",
"avatar": "your_avatar",
"languages": [],
"org_unit_path": "your_org_unit_path",
"user_type": "your_user_type",
"licensed_sheet_creator": true,
"organizations": [],
"created_at": "your_created_at",
"licenses": [],
"id": "your_id",
"urls": [],
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.update(
'user-directory',
'users',
'<resource_id>',
{
"name": "your_name",
"password": "your_password",
"group": 0,
"roles": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"username": "your_username",
"emails": [],
"workspaces": [],
"status": "active",
"phones": [],
"title": "your_title",
"groups": [],
"timezone": "your_timezone",
"avatar": "your_avatar",
"languages": [],
"org_unit_path": "your_org_unit_path",
"user_type": "your_user_type",
"licensed_sheet_creator": true,
"organizations": [],
"created_at": "your_created_at",
"licenses": [],
"id": "your_id",
"urls": [],
"remote_data": {}
},
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
result = await truto_api.unified_api.update(
"user-directory",
"users",
"<resource_id>",
{
"name": "your_name",
"password": "your_password",
"group": 0,
"roles": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"username": "your_username",
"emails": [],
"workspaces": [],
"status": "active",
"phones": [],
"title": "your_title",
"groups": [],
"timezone": "your_timezone",
"avatar": "your_avatar",
"languages": [],
"org_unit_path": "your_org_unit_path",
"user_type": "your_user_type",
"licensed_sheet_creator": True,
"organizations": [],
"created_at": "your_created_at",
"licenses": [],
"id": "your_id",
"urls": [],
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X PATCH 'https://api.truto.one/unified/user-directory/users/{id}?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "your_name",
"password": "your_password",
"group": 0,
"roles": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"username": "your_username",
"emails": [],
"workspaces": [],
"status": "active",
"phones": [],
"title": "your_title",
"groups": [],
"timezone": "your_timezone",
"avatar": "your_avatar",
"languages": [],
"org_unit_path": "your_org_unit_path",
"user_type": "your_user_type",
"licensed_sheet_creator": true,
"organizations": [],
"created_at": "your_created_at",
"licenses": [],
"id": "your_id",
"urls": [],
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"name": "your_name",
"password": "your_password",
"group": 0,
"roles": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"username": "your_username",
"emails": [],
"workspaces": [],
"status": "active",
"phones": [],
"title": "your_title",
"groups": [],
"timezone": "your_timezone",
"avatar": "your_avatar",
"languages": [],
"org_unit_path": "your_org_unit_path",
"user_type": "your_user_type",
"licensed_sheet_creator": true,
"organizations": [],
"created_at": "your_created_at",
"licenses": [],
"id": "your_id",
"urls": [],
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/user-directory/users/{id}?integrated_account_id=${integratedAccountId}`, {
method: 'PATCH',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
body: JSON.stringify(body),
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/user-directory/users/{id}"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"name": "your_name",
"password": "your_password",
"group": 0,
"roles": [],
"first_name": "your_first_name",
"last_name": "your_last_name",
"username": "your_username",
"emails": [],
"workspaces": [],
"status": "active",
"phones": [],
"title": "your_title",
"groups": [],
"timezone": "your_timezone",
"avatar": "your_avatar",
"languages": [],
"org_unit_path": "your_org_unit_path",
"user_type": "your_user_type",
"licensed_sheet_creator": True,
"organizations": [],
"created_at": "your_created_at",
"licenses": [],
"id": "your_id",
"urls": [],
"remote_data": {}
}
response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())