Boomi Data Integration API Reference (1.0.0) - Users

Toggle Pane

• Users
  • getList Users
  • getGet User
  • patchPatch User
  • getGet User Permissions
  • postUpdate User Source
  • patchPatch Active User
  • postInvite User
  • postRe Invite User
  • delDelete User From Account
  • postAttach Detach Users

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Users

List Users

Authorization scope: user:list

List users

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

query Parameters

	Email (string) or Email (null) (Email) Query parameter for filtering by email
	Name (string) or Name (null) (Name) Query parameter for filtering name in email or user name
	Array of Team Id (strings) or Team Id (null) (Team Id) Query parameter for filtering by team id
page	integer (Page) Default: 1
items_per_page	integer (Items Per Page) <= 200 Default: 20
sort_by	string (Sort By) Default: "created_at" Enum: "user_name" "created_at" "last_login" "user_email" "invited_by" "is_admin" "source" User sort properties in the UI.
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" Sorting can be either asc or desc, used in the api-service

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}/users

EU

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

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": [

  • {

    • "user_id": "5f887c764c40e5598f717676",
    • "user_email": "user@rivey.io",
    • "user_name": "John Doe",
    • "environments": {

      • "5f887c764c40e5598f717676": {

        • "role": "admin"

        }

      },
    • "is_admin": true,
    • "status": "active",
    • "created_at": "2025-10-22T09:58:03.849078",
    • "last_login": "2025-10-22T09:58:03.849078",
    • "updated_at": "2025-10-22T09:58:03.849078",
    • "groups": [

      • "5f887c764c40e5598f717676"

      ],
    • "source": "rivery",
    • "invited_by": "invite@rivey.io",
    • "is_active": true,
    • "onboarding": {

      • "know_rivery_step": {

        • "onboarding_river_types": {

          • "status": true,
          • "update_time": "2025-10-22T09:58:03.849078"

          },
        • "onboarding_rivery_introduction": {

          • "status": true,
          • "update_time": "2025-10-22T09:58:03.849078"

          }

        },
      • "data_connections_step": {

        • "onboarding_add_connection": false

        },
      • "data_pipeline_step": {

        • "onboarding_create_s2t": false,
        • "onboarding_view_activities": false

        },
      • "transform_and_orchestrate_step": null,
      • "pre_built_solutions_step": null,
      • "invite_member_step": null

      }

    }

  ]

}

Get User

Authorization scope: user:list

Get user by id

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
user_id required	string (User Id)

Responses

Response Schema: application/json

user_id required	string (User Id) The user id
user_email required	string (User Email) The email of the user
user_name required	string (User Name) The user name
environments required	object (Environments) The user environments and permission
is_admin required	boolean (Is Admin) A flag that indicates whether the flag is admin
status required	string (Status) The user status
source required	string (Source) The user source
is_super_admin required	boolean (Is Super Admin) Indicates if the user is a super admin
allow_login_password required	boolean (Allow Login Password) Indicates if the user is allowed to login with password
allow_login_google required	boolean (Allow Login Google) Indicates if the user is allowed to login with google
allow_login_sso required	boolean (Allow Login Sso) Indicates if the user is allowed to login with SSO
	Created At (string) or Created At (null) (Created At) The user creation date
	Last Login (string) or Last Login (null) (Last Login) The user's last login date
	Updated At (string) or Updated At (null) (Updated At) The user last update date
groups	Array of strings (Groups) Default: [] The user's groups
	Invited By (string) or Invited By (null) (Invited By) The user who invited this user
	Is Active (boolean) or Is Active (null) (Is Active) Default: true Indicates if the user is active
	UserOnboardingModel (object) or null

US

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

EU

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

Response samples

• 200
• 422

Content type

application/json

{

• "user_id": "5f887c764c40e5598f717676",
• "user_email": "user@rivey.io",
• "user_name": "John Doe",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "admin"

    }

  },
• "is_admin": true,
• "status": "active",
• "created_at": "2025-10-22T09:58:03.849078",
• "last_login": "2025-10-22T09:58:03.849078",
• "updated_at": "2025-10-22T09:58:03.849078",
• "groups": [

  • "5f887c764c40e5598f717676"

  ],
• "source": "rivery",
• "invited_by": "invite@rivey.io",
• "is_active": true,
• "onboarding": {

  • "know_rivery_step": {

    • "onboarding_river_types": {

      • "status": true,
      • "update_time": "2025-10-22T09:58:03.849078"

      },
    • "onboarding_rivery_introduction": {

      • "status": true,
      • "update_time": "2025-10-22T09:58:03.849078"

      }

    },
  • "data_connections_step": {

    • "onboarding_add_connection": false

    },
  • "data_pipeline_step": {

    • "onboarding_create_s2t": false,
    • "onboarding_view_activities": false

    },
  • "transform_and_orchestrate_step": null,
  • "pre_built_solutions_step": null,
  • "invite_member_step": null

  },
• "is_super_admin": false,
• "allow_login_password": true,
• "allow_login_google": true,
• "allow_login_sso": true

}

Patch User

Authorization scope: user:edit

Update user source

Authorizations:

HTTPBearer

path Parameters

user_id required	string (User Id)
account_id required	string (Account Id)

Request Body schema: application/json

required

	User Name (string) or User Name (null) (User Name) The user name
	Environments (object) or Environments (null) (Environments) Environment dictionary that includes roles per environment
	Is Admin (boolean) or Is Admin (null) (Is Admin) Indicate if the user admin
	Allow Login Google (boolean) or Allow Login Google (null) (Allow Login Google) Indicate if allow to the user login with google
	Allow Login Password (boolean) or Allow Login Password (null) (Allow Login Password) Indicate if allow to the user login with password

Responses

Response Schema: application/json

user_id required	string (User Id) The user id
user_email required	string (User Email) The email of the user
user_name required	string (User Name) The user name
environments required	object (Environments) The user environments and permission
is_admin required	boolean (Is Admin) A flag that indicates whether the flag is admin
status required	string (Status) The user status
source required	string (Source) The user source
is_super_admin required	boolean (Is Super Admin) Indicates if the user is a super admin
allow_login_password required	boolean (Allow Login Password) Indicates if the user is allowed to login with password
allow_login_google required	boolean (Allow Login Google) Indicates if the user is allowed to login with google
allow_login_sso required	boolean (Allow Login Sso) Indicates if the user is allowed to login with SSO
	Created At (string) or Created At (null) (Created At) The user creation date
	Last Login (string) or Last Login (null) (Last Login) The user's last login date
	Updated At (string) or Updated At (null) (Updated At) The user last update date
groups	Array of strings (Groups) Default: [] The user's groups
	Invited By (string) or Invited By (null) (Invited By) The user who invited this user
	Is Active (boolean) or Is Active (null) (Is Active) Default: true Indicates if the user is active
	UserOnboardingModel (object) or null

US

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

EU

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

Request samples

• Payload

Content type

application/json

{

• "user_name": "string",
• "environments": {

  • "6271166896834700109da341": {

    • "role": "developer"

    },
  • "6271166896834700109da342": {

    • "role": "connection_viewer"

    }

  },
• "is_admin": true,
• "allow_login_google": true,
• "allow_login_password": true

}

Response samples

• 200
• 422

Content type

application/json

{

• "user_id": "5f887c764c40e5598f717676",
• "user_email": "user@rivey.io",
• "user_name": "John Doe",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "admin"

    }

  },
• "is_admin": true,
• "status": "active",
• "created_at": "2025-10-22T09:58:03.849078",
• "last_login": "2025-10-22T09:58:03.849078",
• "updated_at": "2025-10-22T09:58:03.849078",
• "groups": [

  • "5f887c764c40e5598f717676"

  ],
• "source": "rivery",
• "invited_by": "invite@rivey.io",
• "is_active": true,
• "onboarding": {

  • "know_rivery_step": {

    • "onboarding_river_types": {

      • "status": true,
      • "update_time": "2025-10-22T09:58:03.849078"

      },
    • "onboarding_rivery_introduction": {

      • "status": true,
      • "update_time": "2025-10-22T09:58:03.849078"

      }

    },
  • "data_connections_step": {

    • "onboarding_add_connection": false

    },
  • "data_pipeline_step": {

    • "onboarding_create_s2t": false,
    • "onboarding_view_activities": false

    },
  • "transform_and_orchestrate_step": null,
  • "pre_built_solutions_step": null,
  • "invite_member_step": null

  },
• "is_super_admin": false,
• "allow_login_password": true,
• "allow_login_google": true,
• "allow_login_sso": true

}

Get User Permissions

Get user permissions

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
user_id required	string (User Id)

Responses

Response Schema: application/json

environments required

object (Environments)

US

https://api.rivery.io/v1/accounts/{account_id}/users/{user_id}/permissions

EU

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

Response samples

• 200
• 422

Content type

application/json

{

• "environments": { }

}

Update User Source

Authorization scope: user:edit

Update user source

Authorizations:

HTTPBearer

path Parameters

user_id required	string (User Id)
account_id required	string (Account Id)

Request Body schema: application/json

required

source required

string (GroupOrUserSourceEnum) Enum: "rivery" "active_directory" The desired source of the user. For example, if the user should managed by active directory then the source should be active_directory

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/users/{user_id}/source

EU

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

Request samples

• Payload

Content type

application/json

{

• "source": "active_directory"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

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

    }

  ]

}

Patch Active User

Authorization scope: user:list

Patch user active

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
user_id required	string (User Id)

Request Body schema: application/json

required

is_active required

boolean (Is Active) The user is active flag

Responses

Response Schema: application/json

user_id required	string (User Id) The user id
user_email required	string (User Email) The email of the user
user_name required	string (User Name) The user name
environments required	object (Environments) The user environments and permission
is_admin required	boolean (Is Admin) A flag that indicates whether the flag is admin
status required	string (Status) The user status
source required	string (Source) The user source
is_super_admin required	boolean (Is Super Admin) Indicates if the user is a super admin
allow_login_password required	boolean (Allow Login Password) Indicates if the user is allowed to login with password
allow_login_google required	boolean (Allow Login Google) Indicates if the user is allowed to login with google
allow_login_sso required	boolean (Allow Login Sso) Indicates if the user is allowed to login with SSO
	Created At (string) or Created At (null) (Created At) The user creation date
	Last Login (string) or Last Login (null) (Last Login) The user's last login date
	Updated At (string) or Updated At (null) (Updated At) The user last update date
groups	Array of strings (Groups) Default: [] The user's groups
	Invited By (string) or Invited By (null) (Invited By) The user who invited this user
	Is Active (boolean) or Is Active (null) (Is Active) Default: true Indicates if the user is active
	UserOnboardingModel (object) or null

US

https://api.rivery.io/v1/accounts/{account_id}/users/{user_id}/active_user

EU

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

Request samples

• Payload

Content type

application/json

{

• "is_active": true

}

Response samples

• 200
• 422

Content type

application/json

{

• "user_id": "5f887c764c40e5598f717676",
• "user_email": "user@rivey.io",
• "user_name": "John Doe",
• "environments": {

  • "5f887c764c40e5598f717676": {

    • "role": "admin"

    }

  },
• "is_admin": true,
• "status": "active",
• "created_at": "2025-10-22T09:58:03.849078",
• "last_login": "2025-10-22T09:58:03.849078",
• "updated_at": "2025-10-22T09:58:03.849078",
• "groups": [

  • "5f887c764c40e5598f717676"

  ],
• "source": "rivery",
• "invited_by": "invite@rivey.io",
• "is_active": true,
• "onboarding": {

  • "know_rivery_step": {

    • "onboarding_river_types": {

      • "status": true,
      • "update_time": "2025-10-22T09:58:03.849078"

      },
    • "onboarding_rivery_introduction": {

      • "status": true,
      • "update_time": "2025-10-22T09:58:03.849078"

      }

    },
  • "data_connections_step": {

    • "onboarding_add_connection": false

    },
  • "data_pipeline_step": {

    • "onboarding_create_s2t": false,
    • "onboarding_view_activities": false

    },
  • "transform_and_orchestrate_step": null,
  • "pre_built_solutions_step": null,
  • "invite_member_step": null

  },
• "is_super_admin": false,
• "allow_login_password": true,
• "allow_login_google": true,
• "allow_login_sso": true

}

Invite User

Authorization scope: user:edit

Invite new user 1. Create new user with temp password 2. Send email with redirect url that includes the password inside the token

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Request Body schema: application/json

required

user_name required	string (User Name) The user name
user_email required	string (User Email) The user email
environments required	object (Environments) The environments with roles per env
allow_login_password required	boolean (Allow Login Password) Indicates if the user is allowed to login with password
	Is Admin (boolean) or Is Admin (null) (Is Admin) Default: false Indicates if the user is a admin
	Allow Login Google (boolean) or Allow Login Google (null) (Allow Login Google) Default: false Indicates if the user is allowed to login with google
	Allow Login Sso (boolean) or Allow Login Sso (null) (Allow Login Sso) Default: false Indicates if the user is allowed to login with sso
	Is Re Invite (boolean) or Is Re Invite (null) (Is Re Invite) Default: false Indicates if the invitation is a re invite

Responses

US

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

EU

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

Request samples

• Payload

Content type

application/json

{

• "user_name": "string",
• "user_email": "string",
• "environments": {

  • "6271166896834700109da341": {

    • "role": "developer"

    },
  • "6271166896834700109da342": {

    • "role": "connection_viewer"

    }

  },
• "allow_login_password": true,
• "is_admin": false,
• "allow_login_google": true,
• "allow_login_sso": true,
• "is_re_invite": true

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

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

    }

  ]

}

Re Invite User

Authorization scope: user:edit

Re Invite user

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Request Body schema: application/json

required

user_email required

string (User Email) The user email

Responses

US

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

EU

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

Request samples

• Payload

Content type

application/json

{

• "user_email": "string"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

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

    }

  ]

}

Delete User From Account

Authorization scope: user:list

Delete user from specific account

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
user_id required	string (User Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/users/{user_id}/delete_user

EU

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

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

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

    }

  ]

}

Attach Detach Users

Authorization scope: user:edit

Attach or detach users from a team

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Request Body schema: application/json

required

operation required	string (AttachDetachUserToTeamEnum) Enum: "attach" "detach" Operation if to detach or attache user to a team
team_id required	string (Team Id) The team id
user_ids required	Array of strings (User Ids) List of user ids

Responses

US

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

EU

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

Request samples

• Payload

Content type

application/json

{

• "operation": "attach",
• "team_id": "string",
• "user_ids": [

  • "65ce173412f5e196b2b9b163",
  • "65ce173a80f82dbf5b625756"

  ]

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

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

    }

  ]

}