Skip to content

Remove Groups

Endpoint

http
POST /unified/user-directory/groups/remove
Integrations supported
  • Okta

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
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

group_id
string

The unique identifier for the group

Required in
  • Okta
user_id
string

The unique identifier for the user

Required in
  • Okta
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.

name
string

Name of the group.

description
string

Description of the group.

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
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.