Product documentation
MigrationSource
The MigrationSource resource.
MigrationSource
The MigrationSource resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/migration-sources | Migration Source Get | tenant:migration.read |
PUT | /api/v1/migration-sources | Migration Source Put | tenant:migration.write |
DELETE | /api/v1/migration-sources | Migration Source Delete | tenant:migration.write |
POST | /api/v1/migration-sources/import | Migration Source Start Import | tenant:migration.write |
GET | /api/v1/migration-sources/import/jobs/latest | Migration Source Get Latest Import Job | tenant:migration.read |
GET | /api/v1/migration-sources/import/jobs/{id} | Migration Source Get Import Job | tenant:migration.read |
Operation details
GET /api/v1/migration-sources
Migration Source Get
- Operation ID:
migrationSourceGet - Required scopes:
tenant:migration.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
PUT /api/v1/migration-sources
Migration Source Put
- Operation ID:
migrationSourcePut - Required scopes:
tenant:migration.write
Request body (required): application/json → PutMigrationSourceRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/migration-sources
Migration Source Delete
- Operation ID:
migrationSourceDelete - Required scopes:
tenant:migration.write
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/migration-sources/import
Migration Source Start Import
- Operation ID:
migrationSourceStartImport - Required scopes:
tenant:migration.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
dryRun | query | no | boolean | When true, validate the configured migration source and return a synchronous validation report (reachability, a mapped-profile sample, and any errors) WITHOUT writing anything — no user is created, no import job is enqueued. Defaults to false (start the real eager import, returning 202 + the job resource). |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/migration-sources/import/jobs/latest
Migration Source Get Latest Import Job
- Operation ID:
migrationSourceGetLatestImportJob - Required scopes:
tenant:migration.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/migration-sources/import/jobs/{id}
Migration Source Get Import Job
- Operation ID:
migrationSourceGetImportJob - Required scopes:
tenant:migration.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |