Bulk user operation

POST

/api/v1/users/bulk

curl --request POST \
  --url http://localhost:3000/api/v1/users/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "userIds": [ "uuid1", "uuid2" ], "action": "enable", "roleId": "example", "organizationId": "example", "reason": "example" }'

• Development
• Production

Performs a bulk operation on multiple users. Supported actions: enable, disable, delete, reset_password, assign_role. Requires Super Admin privileges.

Authorizations

• api-key
• bearer

Parameters

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Request Body^required

Media typeapplication/json

object

userIds

required

User IDs to apply the action to

Array<string>

Example

[
  "uuid1",
  "uuid2"
]

action

required

Action to perform

string

Allowed values: enable disable delete reset_password assign_role

roleId

Role ID for assign_role action

string

organizationId

Organization ID for assign_role action

string

reason

Reason for the operation

string

Responses

200

Bulk operation completed

Media typeapplication/json

object

processed

required

Total number of users processed

number

successful

required

Number of successful operations

number

failed

required

Number of failed operations

number

errors

Failed user IDs with error messages

object

key

additional properties

string

outcomes

Per-user outcome (FM-862). Populated for reset_password, where an undelivered reset is NOT counted as successful and carries emailSent=false.

Array<object>

object

userId

required

Target user ID

string

success

required

Whether the operation fully succeeded for this user

boolean

emailSent

For reset_password: whether the reset email was actually delivered. False means the target was NOT counted as successful.

boolean

error

Failure reason when success is false

string

Example^generated

{
  "processed": 1,
  "successful": 1,
  "failed": 1,
  "errors": {
    "additionalProperty": "example"
  },
  "outcomes": [
    {
      "userId": "example",
      "success": true,
      "emailSent": true,
      "error": "example"
    }
  ]
}

400

Invalid input data

401

Unauthorized

403

Forbidden - Super Admin required