Appearance

Update Apps ​

Endpoint ​

http
PATCH /unified/sso/apps/{id}
Integrations supported
  • Torii

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
app_id
string

The unique identifier of the app the user is assigned to.

Required in
  • Torii
user_id
string

The unique identifier of the user the app is assigned to.

Required in
  • Torii

Request Body ​

Refer Writing data using Unified APIs

is_active
string

true if the user was removed from the application, false otherwise

Required in
  • Torii
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 unique identifier of the application.

Supported in
  • Torii
name
string
REQUIRED · 

The name of the application.

Supported in
  • Torii
display_name
string

The display name of the application.

Supported in
  • Torii
status
string

The status of the application. If no clear mapping is available, then the raw value is returned.

All possible enum values:
  • active
  • inactive
  • archived
  • deleted
Supported in
  • Torii
sign_on_mode
string

The sign on mode of the application.

created_at
string · date-time

The date and time the application was created.

updated_at
string · date-time

The date and time the application was last updated.

remote_data
object

Raw data returned from the remote API call.