Create a user import upload URL.

POST

/api/admin/jobs/users/import/upload-url

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/jobs/users/import/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filename": "users.csv", "content_type": "text/csv", "size_bytes": 4096, "checksum_sha256": "9d6f965ac832e40a5c8a5d7aa7a4b1e0e67f..." }'

Creates a short-lived Admin API upload target for a CSV import artifact and returns the upload id, R2 key, HTTP method, and expiration timestamp. The upload itself is completed with PUT.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

filename

required

string

content_type

required

string

Allowed values: text/csv application/csv application/vnd.ms-excel

size_bytes

required

integer

>= 1 <= 10485760

checksum_sha256

string

key

additional properties

Example

{
  "filename": "users.csv",
  "content_type": "text/csv",
  "size_bytes": 4096,
  "checksum_sha256": "9d6f965ac832e40a5c8a5d7aa7a4b1e0e67f..."
}

Responses

200

User import upload URL response.

Media type application/json

object

upload_url

required

string

upload_method

required

string

Allowed values: PUT

file_key

required

string

r2_key

required

string

expires_at

required

string format: date-time

upload_id

required

string

key

additional properties

Example

{
  "upload_method": "PUT"
}

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

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