Create a user import job.

POST

/api/admin/jobs/users/import

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/jobs/users/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "file_key": "imports/default/018f3f7c/users.csv", "size_bytes": 4096, "content_type": "text/csv", "checksum_sha256": "9d6f965ac832e40a5c8a5d7aa7a4b1e0e67f...", "options": { "skip_header": true, "on_duplicate": "skip", "validate_only": false } }'

Queues a users/import job for an already uploaded CSV artifact. The handler verifies tenant ownership, content type, size, checksum, and import options before creating the pending job.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

file_key

string

r2_key

string

size_bytes

integer

>= 1

content_type

string

checksum_sha256

string

options

object

skip_header

boolean

default: true

on_duplicate

string

default: skip

Allowed values: update skip error

validate_only

boolean

key

additional properties

key

additional properties

Example

{
  "file_key": "imports/default/018f3f7c/users.csv",
  "size_bytes": 4096,
  "content_type": "text/csv",
  "checksum_sha256": "9d6f965ac832e40a5c8a5d7aa7a4b1e0e67f...",
  "options": {
    "skip_header": true,
    "on_duplicate": "skip",
    "validate_only": false
  }
}

Responses

202

User import 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

key

additional properties

Example

{
  "status": "pending"
}

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

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

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"
}

404

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

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

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"
}