Skip to content

Product documentation

MigrationSource

The MigrationSource resource.

MigrationSource

The MigrationSource resource.

Base URL: https://api.stg.thoryn.org

Operations

MethodPathSummaryScopes
GET/api/v1/migration-sourcesMigration Source Gettenant:migration.read
PUT/api/v1/migration-sourcesMigration Source Puttenant:migration.write
DELETE/api/v1/migration-sourcesMigration Source Deletetenant:migration.write
POST/api/v1/migration-sources/importMigration Source Start Importtenant:migration.write
GET/api/v1/migration-sources/import/jobs/latestMigration Source Get Latest Import Jobtenant:migration.read
GET/api/v1/migration-sources/import/jobs/{id}Migration Source Get Import Jobtenant:migration.read

Operation details

GET /api/v1/migration-sources

Migration Source Get

  • Operation ID: migrationSourceGet
  • Required scopes: tenant:migration.read

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonPutMigrationSourceRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
dryRunquerynobooleanWhen 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:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)