Skip to content
Authrim

Create a bulk user update job.

POST
/api/admin/jobs/users/bulk-update
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/jobs/users/bulk-update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "fields": [ "status" ], "filter": { "lifecycle_state": "active" }, "values": { "status": "suspended" }, "dry_run": true, "result_delivery": "auto" }'

Queues a users/bulk-update job after validating fields, values, optional filter, dry-run mode, batch size, and result delivery. The response includes affected user count and estimated completion. Each field sets the account status, so one field per job; each account takes it as the job’s transition, versioned when the job is created, so a status change made after that is never overwritten (such accounts count as failed).

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json

User_type=end_user filters include both guest and registered humans. Use registration_state=guest or registration_state=registered to narrow the filter. Registration state is read-only and cannot be included in update fields.

object
fields
required

The one status field to set (each sets the account status).

Array<string>
>= 1 items <= 1 items
Allowed values: status lifecycle_state is_active
filter
object
registration_state

Registration state based on the committed guest lifecycle phase.

string
Allowed values: guest registered
user_type

End_user includes both guest and registered humans.

string
Allowed values: end_user admin m2m
key
additional properties
values
required
object
key
additional properties
dry_run
boolean
batch_size
integer
>= 1 <= 1000
result_delivery
string
Allowed values: auto inline artifact
key
additional properties
Example 
{
  "fields": [
    "status"
  ],
  "filter": {
    "lifecycle_state": "active"
  },
  "values": {
    "status": "suspended"
  },
  "dry_run": true,
  "result_delivery": "auto"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Bulk user update job accepted response.

Media type application/json
object
job_id
required
string
status
required
string
Allowed values: pending
job_type
required
string
created_at
required
string format: date-time
estimated_completion
required
string format: date-time
affected_users
required
integer
dry_run
required
boolean
Example 
{
  "status": "pending"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}