Appearance

Update Groups ​

Endpoint ​

http
PATCH /unified/user-directory/groups/{id}
Integrations supported
  • Files.com

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

Name of the group.

Supported in
  • Files.com
description
string

Description of the group.

Supported in
  • Files.com
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 · 

Unique identifier for the group.

Supported in
  • Files.com
name
string

Name of the group.

Supported in
  • Files.com
description
string

Description of the group.

Supported in
  • Files.com
organization
string

Unique identifier for the organization the group belongs to.

group_type
string

Type of the group.

All possible enum values:
  • team
  • department
  • group
Supported in
  • Files.com
created_at
string · date-time

Date and time when the group was created.

updated_at
string · date-time

Date and time when the group was last updated.

remote_data
object

Raw data returned from the remote API call.