Boomi Data Integration API Reference (1.0.0) - Teams

Toggle Pane

• Teams
  • getList Teams
  • postCreate Team
  • getGet Team
  • delDelete Team
  • putUpdate Team
  • patchPatch Team

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Teams

List Teams

Authorization scope: team:list

Get all user teams

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

query Parameters

page	integer (Page) Default: 1
items_per_page	integer (Items Per Page) <= 200 Default: 20
	Display Name (string) or Display Name (null) (Display Name) Examples: display_name=Marketing team The internal display name of the team
	Source (string) or Source (null) (Source) Examples: source=rivery The team source local (rivery) or external (Active Directory)
	Remote Display Name (string) or Remote Display Name (null) (Remote Display Name) Examples: remote_display_name=Core team The remote display name of the team
sort_by	string (Sort By) Default: "display_name" Enum: "display_name" "created_at" "source" "is_all_environment_admin" "default_environment" Sorted the results by attributes
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" Sorting can be either asc or desc, used in the api-service
	Array of Team Id (strings) or Team Id (null) (Team Id) Examples: team_id=65ce173412f5e196b2b9b163 List of team ids

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/teams

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/teams

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "items": [

  • {

    • "_id": "633ede20f1fc5500111fd7b3",
    • "account_id": "55bf7c4270fdca16cac18761",
    • "display_name": "Rivery Core Team",
    • "remote_display_name": "Core Team",
    • "description": "Some description",
    • "environments": {

      • "5f887c764c40e5598f717676": {

        • "role": "viewer"

        },
      • "633ede20f1fc5500111fd7b3": {

        • "role": "viewer"

        }

      },
    • "default_environment": true,
    • "is_all_environment_admin": true,
    • "source": "rivery",
    • "created_at": "2025-10-01T19:34:09.191724"

    }

  ]

}

Create Team

Authorization scope: team:write

Create user team

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Request Body schema: application/json

required

display_name required	string (Display Name) The display name in rivery
	Description (string) or Description (null) (Description) Internal description
environments	object (Environments) Default: {} Dictionary of environment id and environment role
	Default Environment (string) or Default Environment (null) (Default Environment) Default Environment ID for this team (Optional)
is_all_environment_admin	boolean (Is All Environment Admin) Default: false Indicates if group have Admin permission for all environment

Responses

Response Schema: application/json

_id required	string ( Id) The user group id
account_id required	string (Account Id) The account id
display_name required	string (Display Name) The display name in rivery
created_at required	string <date-time> (Created At) Created team datatime
	Remote Display Name (string) or Remote Display Name (null) (Remote Display Name) The SCIM display name
	Description (string) or Description (null) (Description) Internal description
environments	object (Environments) Default: {} Dictionary of environment id and environment role
	Default Environment (string) or Default Environment (null) (Default Environment) Default Environment ID for this team (Optional)
is_all_environment_admin	boolean (Is All Environment Admin) Default: false Indicates if group have Admin permission for all environment
source	string (GroupOrUserSourceEnum) Default: "rivery" Enum: "rivery" "active_directory" Source if this group locally of rivery or imported from external such as Active Directory

US

https://api.rivery.io/v1/accounts/{account_id}/teams

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/teams

Request samples

• Payload

Content type

application/json

{

• "display_name": "Rivery Core Team",
• "description": "Some description",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "viewer"

    },
  • "633ede20f1fc5500111fd7b3": {

    • "role": "viewer"

    }

  },
• "default_environment": "633ede20f1fc5500111fd7b3",
• "is_all_environment_admin": true

}

Response samples

• 200
• 422

Content type

application/json

{

• "_id": "633ede20f1fc5500111fd7b3",
• "account_id": "55bf7c4270fdca16cac18761",
• "display_name": "Rivery Core Team",
• "remote_display_name": "Core Team",
• "description": "Some description",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "viewer"

    },
  • "633ede20f1fc5500111fd7b3": {

    • "role": "viewer"

    }

  },
• "default_environment": true,
• "is_all_environment_admin": true,
• "source": "rivery",
• "created_at": "2025-10-01T19:34:09.191724"

}

Get Team

Authorization scope: team:list

Get user team by id

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
team_id required	string (Team Id)

Responses

Response Schema: application/json

_id required	string ( Id) The user group id
account_id required	string (Account Id) The account id
display_name required	string (Display Name) The display name in rivery
created_at required	string <date-time> (Created At) Created team datatime
	Remote Display Name (string) or Remote Display Name (null) (Remote Display Name) The SCIM display name
	Description (string) or Description (null) (Description) Internal description
environments	object (Environments) Default: {} Dictionary of environment id and environment role
	Default Environment (string) or Default Environment (null) (Default Environment) Default Environment ID for this team (Optional)
is_all_environment_admin	boolean (Is All Environment Admin) Default: false Indicates if group have Admin permission for all environment
source	string (GroupOrUserSourceEnum) Default: "rivery" Enum: "rivery" "active_directory" Source if this group locally of rivery or imported from external such as Active Directory

US

https://api.rivery.io/v1/accounts/{account_id}/teams/{team_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/teams/{team_id}

Response samples

• 200
• 422

Content type

application/json

{

• "_id": "633ede20f1fc5500111fd7b3",
• "account_id": "55bf7c4270fdca16cac18761",
• "display_name": "Rivery Core Team",
• "remote_display_name": "Core Team",
• "description": "Some description",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "viewer"

    },
  • "633ede20f1fc5500111fd7b3": {

    • "role": "viewer"

    }

  },
• "default_environment": true,
• "is_all_environment_admin": true,
• "source": "rivery",
• "created_at": "2025-10-01T19:34:09.191724"

}

Delete Team

Authorization scope: team:write

Delete user team

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
team_id required	string (Team Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/teams/{team_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/teams/{team_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Update Team

Authorization scope: team:write

Update team

Authorizations:

HTTPBearer

path Parameters

team_id required	string (Team Id)
account_id required	string (Account Id)

Request Body schema: application/json

required

display_name	string (Display Name) The display name in rivery
description	string (Description) Internal description
default_environment	string (Default Environment) Default Environment ID for this team (Optional)
environments	object (Environments) Dictionary of environment id and environment role
	Is All Environment Admin (boolean) or Is All Environment Admin (null) (Is All Environment Admin) Default: false Indicates if group have Admin permission for all environment

Responses

Response Schema: application/json

_id required	string ( Id) The user group id
account_id required	string (Account Id) The account id
display_name required	string (Display Name) The display name in rivery
created_at required	string <date-time> (Created At) Created team datatime
	Remote Display Name (string) or Remote Display Name (null) (Remote Display Name) The SCIM display name
	Description (string) or Description (null) (Description) Internal description
environments	object (Environments) Default: {} Dictionary of environment id and environment role
	Default Environment (string) or Default Environment (null) (Default Environment) Default Environment ID for this team (Optional)
is_all_environment_admin	boolean (Is All Environment Admin) Default: false Indicates if group have Admin permission for all environment
source	string (GroupOrUserSourceEnum) Default: "rivery" Enum: "rivery" "active_directory" Source if this group locally of rivery or imported from external such as Active Directory

US

https://api.rivery.io/v1/accounts/{account_id}/teams/{team_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/teams/{team_id}

Request samples

• Payload

Content type

application/json

{

• "display_name": "Rivery Core Team",
• "description": "Some description",
• "default_environment": "633ede20f1fc5500111fd7b3",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "viewer"

    },
  • "633ede20f1fc5500111fd7b3": {

    • "role": "viewer"

    }

  },
• "is_all_environment_admin": true

}

Response samples

• 200
• 422

Content type

application/json

{

• "_id": "633ede20f1fc5500111fd7b3",
• "account_id": "55bf7c4270fdca16cac18761",
• "display_name": "Rivery Core Team",
• "remote_display_name": "Core Team",
• "description": "Some description",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "viewer"

    },
  • "633ede20f1fc5500111fd7b3": {

    • "role": "viewer"

    }

  },
• "default_environment": true,
• "is_all_environment_admin": true,
• "source": "rivery",
• "created_at": "2025-10-01T19:34:09.191724"

}

Patch Team

Authorization scope: team:write

Patch team by id

Authorizations:

HTTPBearer

path Parameters

team_id required	string (Team Id)
account_id required	string (Account Id)

Request Body schema: application/json

required

	Display Name (string) or Display Name (null) (Display Name) The display name in rivery
	Description (string) or Description (null) (Description) Internal description
	Environments (object) or Environments (null) (Environments) Dictionary of environment id and environment role
	Default Environment (string) or Default Environment (null) (Default Environment) Default Environment ID for this team (Optional)
	Is All Environment Admin (boolean) or Is All Environment Admin (null) (Is All Environment Admin) Indicates if group have Admin permission for all environment

Responses

Response Schema: application/json

_id required	string ( Id) The user group id
account_id required	string (Account Id) The account id
display_name required	string (Display Name) The display name in rivery
created_at required	string <date-time> (Created At) Created team datatime
	Remote Display Name (string) or Remote Display Name (null) (Remote Display Name) The SCIM display name
	Description (string) or Description (null) (Description) Internal description
environments	object (Environments) Default: {} Dictionary of environment id and environment role
	Default Environment (string) or Default Environment (null) (Default Environment) Default Environment ID for this team (Optional)
is_all_environment_admin	boolean (Is All Environment Admin) Default: false Indicates if group have Admin permission for all environment
source	string (GroupOrUserSourceEnum) Default: "rivery" Enum: "rivery" "active_directory" Source if this group locally of rivery or imported from external such as Active Directory

US

https://api.rivery.io/v1/accounts/{account_id}/teams/{team_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/teams/{team_id}

Request samples

• Payload

Content type

application/json

{

• "display_name": "Rivery Core Team",
• "description": "Some description",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "viewer"

    },
  • "633ede20f1fc5500111fd7b3": {

    • "role": "viewer"

    }

  },
• "default_environment": "633ede20f1fc5500111fd7b3",
• "is_all_environment_admin": true

}

Response samples

• 200
• 422

Content type

application/json

{

• "_id": "633ede20f1fc5500111fd7b3",
• "account_id": "55bf7c4270fdca16cac18761",
• "display_name": "Rivery Core Team",
• "remote_display_name": "Core Team",
• "description": "Some description",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "viewer"

    },
  • "633ede20f1fc5500111fd7b3": {

    • "role": "viewer"

    }

  },
• "default_environment": true,
• "is_all_environment_admin": true,
• "source": "rivery",
• "created_at": "2025-10-01T19:34:09.191724"

}