Skip to content

Create a user migration run

Request

Starts a migration run for the requested uploaded files.

Security
AdminAccessToken
Bodyapplication/jsonrequired
modestringrequired

Controls the execution type. "live" provisions users, "dry_run" only parses and validates the files

Enum:"live""dry_run"
app_idstringrequired

The target application the migrated users will be provisioned in

filesArray of strings

Names of previously uploaded files to process. Defaults to all uploaded files if omitted.

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/migration/users/runs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "mode": "live",
    "app_id": "string",
    "files": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {
    "run_id": "string",
    "status": "running",
    "total_files": 0
  }
}