Manage Users

This guide covers listing, inviting, updating, and deleting users.

List users

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Filter parameters

Parameter	Type	Description
text	string	Free-text search
email	string	Filter by email
organization	UUID	Filter by organization
status	string	INVITED, ACTIVE, or DELETED
origin	string	MANUAL, INVITED, LDAP, SAML, OIDC, or MANAGED
role	string	USER, GLOBAL_ADMIN, ADMIN, BILLING_CONTACT, or NO_ACCESS

Example — list active admin users:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users?status=ACTIVE&role=GLOBAL_ADMIN" \
  -H "Authorization: Bearer <your-token>"

Invite a user

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/invite" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newuser@example.com",
    "role": "USER",
    "organization": "<org-id>"
  }'

Get a user

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/<user-id>" \
  -H "Authorization: Bearer <your-token>"

Get the current user

Retrieve the currently authenticated user's profile:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/current" \
  -H "Authorization: Bearer <your-token>"

Update a user

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/<user-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "jdoe",
    "displayName": "Jane Doe",
    "email": "jane@example.com",
    "role": "ADMIN"
  }'

Update the current user

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/current" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Jane Doe",
    "firstName": "Jane",
    "lastName": "Doe"
  }'

Delete a user

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/<user-id>" \
  -H "Authorization: Bearer <your-token>"

Set or change a user's password

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/<user-id>/password" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "newSecurePassword123!"
  }'

User image

# Upload
curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/<user-id>/image" \
  -H "Authorization: Bearer <your-token>" \
  -F "file=@avatar.png"

# Download
curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/<user-id>/image" \
  -H "Authorization: Bearer <your-token>" --output avatar.png

# Delete
curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/users/<user-id>/image" \
  -H "Authorization: Bearer <your-token>"