Rivery Users API
The Users API from Rivery — 9 operation(s) for users.
The Users API from Rivery — 9 operation(s) for users.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rivery:rivery-users-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Boomi Data Integration Users API
description: '# Boomi Data Integration API documentation
Welcome to the Boomi Data Integration API Documentation.'
contact:
name: Boomi Data Integration Documentation
url: https://community.boomi.com/s/support
email: support@boomi.com
version: 1.0.0
x-logo:
url: https://rivery.io/wp-content/uploads/2021/08/logo.png
servers:
- url: https://api.rivery.io
description: US
- url: https://api.eu-west-1.rivery.io
description: EU
tags:
- name: Users
paths:
/v1/accounts/{account_id}/users:
get:
tags:
- Users
summary: List Users
description: '**Authorization scope:** `user:list`
**List users**'
operationId: list_users
security:
- HTTPBearer: []
parameters:
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
- name: email
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Query parameter for filtering by email
title: Email
description: Query parameter for filtering by email
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Query parameter for filtering name in email or user name
title: Name
description: Query parameter for filtering name in email or user name
- name: team_id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Query parameter for filtering by team id
title: Team Id
description: Query parameter for filtering by team id
- name: page
in: query
required: false
schema:
type: integer
default: 1
title: Page
- name: items_per_page
in: query
required: false
schema:
type: integer
maximum: 200
default: 20
title: Items Per Page
- name: sort_by
in: query
required: false
schema:
allOf:
- $ref: '#/components/schemas/UsersSortByEnum'
default: created_at
title: Sort By
- name: sort_order
in: query
required: false
schema:
allOf:
- $ref: '#/components/schemas/SortOrderEnum'
default: desc
title: Sort Order
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/accounts/{account_id}/users/{user_id}:
get:
tags:
- Users
summary: Get User
description: '**Authorization scope:** `user:list`
**Get user by id**'
operationId: get_user
security:
- HTTPBearer: []
parameters:
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
- name: user_id
in: path
required: true
schema:
type: string
title: User Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Users
summary: Patch User
description: '**Authorization scope:** `user:edit`
**Update user source**'
operationId: patch_user
security:
- HTTPBearer: []
parameters:
- name: user_id
in: path
required: true
schema:
type: string
title: User Id
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchUserInput'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/accounts/{account_id}/users/{user_id}/permissions:
get:
tags:
- Users
summary: Get User Permissions
description: Get user permissions
operationId: get_user_permissions
security:
- HTTPBearer: []
parameters:
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
- name: user_id
in: path
required: true
schema:
type: string
title: User Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserPermissionsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/accounts/{account_id}/users/{user_id}/source:
post:
tags:
- Users
summary: Update User Source
description: '**Authorization scope:** `user:edit`
**Update user source**'
operationId: update_user_source
security:
- HTTPBearer: []
parameters:
- name: user_id
in: path
required: true
schema:
type: string
title: User Id
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateSourceInput'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/accounts/{account_id}/users/{user_id}/active_user:
patch:
tags:
- Users
summary: Patch Active User
description: '**Authorization scope:** `user:list`
**Patch user active**'
operationId: patch_active_user
security:
- HTTPBearer: []
parameters:
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
- name: user_id
in: path
required: true
schema:
type: string
title: User Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchActiveUserInput'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/accounts/{account_id}/users/invite_user:
post:
tags:
- Users
summary: Invite User
description: '**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**'
operationId: invite_user
security:
- HTTPBearer: []
parameters:
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InviteUserInput'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/accounts/{account_id}/users/re_invite_user:
post:
tags:
- Users
summary: Re Invite User
description: '**Authorization scope:** `user:edit`
**Re Invite user**'
operationId: re_invite_user
security:
- HTTPBearer: []
parameters:
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReInviteUserInput'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/accounts/{account_id}/users/{user_id}/delete_user:
delete:
tags:
- Users
summary: Delete User From Account
description: '**Authorization scope:** `user:list`
**Delete user from specific account**'
operationId: delete_user_from_account
security:
- HTTPBearer: []
parameters:
- name: account_id
in: path
required: true
schema:
type: string
title: Account Id
- name: user_id
in: path
required: true
schema:
type: string
title: User Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/token:
post:
tags:
- Users
summary: Generate Boomi Token
description: 'Generate JWS token via Boomi JWT.
Account and user are resolved from the JWT.
If environment_id is omitted, the account''s default environment is used.'
operationId: generate_boomi_token
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GenerateBoomiTokenRequest'
title: Body
default: {}
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateTokenResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
GroupOrUserSourceEnum:
type: string
enum:
- rivery
- active_directory
title: GroupOrUserSourceEnum
description: The source group. can be locally from Rivery or imported from external provider
SortOrderEnum:
type: string
enum:
- desc
- asc
title: SortOrderEnum
description: Sorting can be either asc or desc, used in the api-service
PatchActiveUserInput:
properties:
is_active:
type: boolean
title: Is Active
description: The user is active flag
type: object
required:
- is_active
title: PatchActiveUserInput
description: Patch is_active user input
GenerateBoomiTokenRequest:
properties:
environment_id:
anyOf:
- type: string
- type: 'null'
title: Environment Id
type: object
title: GenerateBoomiTokenRequest
description: Request body for the Boomi token endpoint.
ReInviteUserInput:
properties:
user_email:
type: string
title: User Email
description: The user email
type: object
required:
- user_email
title: ReInviteUserInput
description: Re Invite user input
UserOnboardingModel:
properties:
know_rivery_step:
anyOf:
- type: object
- type: 'null'
title: Know Rivery Step
description: User finished first step
examples:
- onboarding_river_types:
status: true
update_time: '2026-09-25T12:32:48.674340'
onboarding_rivery_introduction:
status: true
update_time: '2026-09-25T12:32:48.674340'
data_connections_step:
anyOf:
- type: object
- type: 'null'
title: Data Connections Step
description: User finished second step
examples:
- onboarding_add_connection: false
data_pipeline_step:
anyOf:
- type: object
- type: 'null'
title: Data Pipeline Step
description: User finished third step
examples:
- onboarding_create_s2t: false
onboarding_view_activities: false
transform_and_orchestrate_step:
anyOf:
- type: object
- type: 'null'
title: Transform And Orchestrate Step
description: User finished fourth step
examples:
- null
pre_built_solutions_step:
anyOf:
- type: object
- type: 'null'
title: Pre Built Solutions Step
description: User finished fifth step
examples:
- null
invite_member_step:
anyOf:
- type: object
- type: 'null'
title: Invite Member Step
description: User finished sixth step
examples:
- null
type: object
title: UserOnboardingModel
description: Onboarding steps model
UsersSortByEnum:
type: string
enum:
- user_name
- created_at
- last_login
- user_email
- invited_by
- is_admin
- source
title: UsersSortByEnum
description: User sort properties in the UI.
PatchUserInput:
properties:
user_name:
anyOf:
- type: string
- type: 'null'
title: User Name
description: The user name
environments:
anyOf:
- type: object
- type: 'null'
title: Environments
description: Environment dictionary that includes roles per environment
examples:
- 6271166896834700109da341:
role: developer
6271166896834700109da342:
role: connection_viewer
is_admin:
anyOf:
- type: boolean
- type: 'null'
title: Is Admin
description: Indicate if the user admin
allow_login_google:
anyOf:
- type: boolean
- type: 'null'
title: Allow Login Google
description: Indicate if allow to the user login with google
allow_login_password:
anyOf:
- type: boolean
- type: 'null'
title: Allow Login Password
description: Indicate if allow to the user login with password
type: object
title: PatchUserInput
description: Patch user input
InviteUserInput:
properties:
user_name:
type: string
title: User Name
description: The user name
user_email:
type: string
title: User Email
description: The user email
environments:
type: object
title: Environments
description: The environments with roles per env
examples:
- 6271166896834700109da341:
role: developer
6271166896834700109da342:
role: connection_viewer
allow_login_password:
type: boolean
title: Allow Login Password
description: Indicates if the user is allowed to login with password
examples:
- true
is_admin:
anyOf:
- type: boolean
- type: 'null'
title: Is Admin
description: Indicates if the user is a admin
default: false
examples:
- false
allow_login_google:
anyOf:
- type: boolean
- type: 'null'
title: Allow Login Google
description: Indicates if the user is allowed to login with google
default: false
examples:
- true
allow_login_sso:
anyOf:
- type: boolean
- type: 'null'
title: Allow Login Sso
description: Indicates if the user is allowed to login with sso
default: false
examples:
- true
is_re_invite:
anyOf:
- type: boolean
- type: 'null'
title: Is Re Invite
description: Indicates if the invitation is a re invite
default: false
examples:
- true
type: object
required:
- user_name
- user_email
- environments
- allow_login_password
title: InviteUserInput
description: Invite user input
UserPermissionsResponse:
properties:
environments:
type: object
title: Environments
type: object
required:
- environments
title: UserPermissionsResponse
description: User permission response
GenerateTokenResponse:
properties:
token:
type: string
title: Token
type: object
required:
- token
title: GenerateTokenResponse
description: Generate token response
UserModel:
properties:
user_id:
type: string
title: User Id
description: The user id
examples:
- 5f887c764c40e5598f717676
user_email:
type: string
title: User Email
description: The email of the user
examples:
- user@rivey.io
user_name:
type: string
title: User Name
description: The user name
examples:
- John Doe
environments:
type: object
title: Environments
description: The user environments and permission
examples:
- 5f887c764c40e5598f717676:
role: admin
is_admin:
type: boolean
title: Is Admin
description: A flag that indicates whether the flag is admin
examples:
- true
is_global_operator:
type: boolean
title: Is Global Operator
description: Indicates if the user is a global operator (read-only cross-account)
default: false
examples:
- false
status:
type: string
title: Status
description: The user status
examples:
- active
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: The user creation date
examples:
- '2026-09-25T12:32:48.674340'
last_login:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Login
description: The user's last login date
examples:
- '2026-09-25T12:32:48.674340'
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: The user last update date
examples:
- '2026-09-25T12:32:48.674340'
groups:
items:
type: string
type: array
title: Groups
description: The user's groups
default: []
examples:
- - 5f887c764c40e5598f717676
source:
type: string
title: Source
description: The user source
examples:
- rivery
invited_by:
anyOf:
- type: string
- type: 'null'
title: Invited By
description: The user who invited this user
examples:
- invite@rivey.io
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
description: Indicates if the user is active
default: true
onboarding:
anyOf:
- $ref: '#/components/schemas/UserOnboardingModel'
- type: 'null'
is_super_admin:
type: boolean
title: Is Super Admin
description: Indicates if the user is a super admin
examples:
- false
is_super_admin_creator:
type: boolean
title: Is Super Admin Creator
description: Indicates if the user is a super admin creator
examples:
- false
allow_login_password:
type: boolean
title: Allow Login Password
description: Indicates if the user is allowed to login with password
examples:
- true
allow_login_google:
type: boolean
title: Allow Login Google
description: Indicates if the user is allowed to login with google
examples:
- true
allow_login_sso:
type: boolean
title: Allow Login Sso
description: Indicates if the user is allowed to login with SSO
examples:
- true
type: object
required:
- user_id
- user_email
- user_name
- environments
- is_admin
- status
- source
- is_super_admin
- is_super_admin_creator
- allow_login_password
- allow_login_google
- allow_login_sso
title: UserModel
description: User model
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
UserUpdateSourceInput:
properties:
source:
allOf:
- $ref: '#/components/schemas/GroupOrUserSourceEnum'
description: The desired source of the user. For example, if the user should managed by active directory then the source should be active_directory
examples:
- active_directory
type: object
required:
- source
title: UserUpdateSourceInput
description: User update source input
ListUsersResponse:
properties:
next_page:
anyOf:
- type: string
- type: 'null'
title: Next Page
description: The next page URL
previous_page:
anyOf:
- type: string
- type: 'null'
title: Previous Page
description: The previous page URL
page:
type: integer
title: Page
description: The page number
default: 1
current_page_size:
type: integer
title: Current Page Size
description: The current page size
total_items:
type: integer
title: Total Items
description: The total number of entities fetched
default: 0
account_id:
type: string
title: Account Id
description: The account id
items:
items:
$ref: '#/components/schemas/ListUserModel'
type: array
title: Items
type: object
required:
- current_page_size
- account_id
- items
title: ListUsersResponse
description: List users response
ListUserModel:
properties:
user_id:
type: string
title: User Id
description: The user id
examples:
- 5f887c764c40e5598f717676
user_email:
type: string
title: User Email
description: The email of the user
examples:
- user@rivey.io
user_name:
type: string
title: User Name
description: The user name
examples:
- John Doe
environments:
type: object
title: Environments
description: The user environments and permission
examples:
- 5f887c764c40e5598f717676:
role: admin
is_admin:
type: boolean
title: Is Admin
description: A flag that indicates whether the flag is admin
examples:
- true
is_global_operator:
type: boolean
title: Is Global Operator
description: Indicates if the user is a global operator (read-only cross-account)
default: false
examples:
- false
status:
type: string
title: Status
description: The user status
examples:
- active
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: The user creation date
examples:
- '2026-09-25T12:32:48.674340'
last_login:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Login
description: The user's last login date
examples:
- '2026-09-25T12:32:48.674340'
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: The user last update date
examples:
- '2026-09-25T12:32:48.674340'
groups:
items:
type: string
type: array
title: Groups
description: The user's groups
default: []
examples:
- - 5f887c764c40e5598f717676
source:
type: string
title: Source
description: The user source
examples:
- rivery
invited_by:
anyOf:
- type: string
- type: 'null'
title: Invited By
description: The user who invited this user
examples:
- invite@rivey.io
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
description: Indicates if the user is active
default: true
onboarding:
anyOf:
- $ref: '#/components/schemas/UserOnboardingModel'
- type: 'null'
type: object
required:
- user_id
- user_email
- user_name
- environments
- is_admin
- status
- source
title: ListUserModel
description: List user model
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
externalDocs:
description: Find out more about Data Integration
url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview