Sign in

ec90bd653983

OpenAPI 3.1.02026-08-1084330443.7 KB
Teams

Patch Team

Authorization scope: team:write

Patch team by id

patch/v1/accounts/{account_id}/teams/{team_id}

Path parameters

team_idstring required
account_idstring required

Request body

display_namestring nullable

The display name

descriptionstring nullable

Internal description

environmentsobject nullable

Dictionary of environment id and environment role

default_environmentstring nullable

Default Environment ID for this team (Optional)

is_all_environment_adminboolean nullable

Indicates if group have Admin permission for all environment

Example request

{
  "display_name": "Boomi Data Integration Core Team",
  "description": "Some description",
  "environments": {
    "5f887c764c40e5598f717676": {
      "role": "viewer"
    },
    "633ede20f1fc5500111fd7b3": {
      "role": "viewer"
    }
  },
  "default_environment": "633ede20f1fc5500111fd7b3",
  "is_all_environment_admin": true
}

Response

Successful Response

_idstring required

The user group id

account_idstring required

The account id

display_namestring required

The display name

remote_display_namestring nullable

The SCIM display name

descriptionstring nullable

Internal description

environmentsobject

Dictionary of environment id and environment role

default_environmentstring nullable

Default Environment ID for this team (Optional)

is_all_environment_adminboolean

Indicates if group have Admin permission for all environment

source'rivery' | 'active_directory'

The source group. can be locally from Rivery or imported from external provider

created_atstring date-time required

Created team datatime

Example response

{
  "_id": "633ede20f1fc5500111fd7b3",
  "account_id": "55bf7c4270fdca16cac18761",
  "display_name": "Boomi Data Integration Core Team",
  "remote_display_name": "Core Team",
  "description": "Some description",
  "environments": {
    "5f887c764c40e5598f717676": {
      "role": "viewer"
    },
    "633ede20f1fc5500111fd7b3": {
      "role": "viewer"
    }
  },
  "is_all_environment_admin": true,
  "created_at": "2026-08-10T01:50:49.761197"
}