APIs & UnifiedViews with SSO

How to use the API with SSO in place

The API endpoints remain the same, but instead of basic authentication you will need to retrieve OAuth tokens from your provider. If the API endpoint requires admin rights, then you will have to retrieve a token for a user that has an admin role in the provider.

Data migration

When you change to OIDC mode for the first time, and you want to keep your pipelines, schedules and custom DPUs, then you will need to migrate the ownership for these resources. 

The UnifiedViews Migration API

The MigrationResource REST API provides endpoints to **migrate pipelines, schedules, and DPUs** in a UnifiedViews instance.

Base Path: /migrate

Authentication: required

Authorization: all the endpoints require ADMIN_ROLE

Method: GET

Get All Pipelines

GET /migrate/pipelines/getAll - Returns a list of all pipelines available for migration

Example response

[
   {       
      "iri": "http://unifiedviews.poolparty.biz/resource/pipeline/bb768634-a5bf-4af6-a1a1-b6456b45e4ce",
      "owner": "admin",
      "name": "example-pipeline-name"
   }
]

Migrating Pipelines

Method: PUT

PUT /migrate/pipelines/migrateAll - consumes a list of PipelineDTO objects and updates the owner.

Request body:

[
  {
    "iri": "http://example.com/resources/pipeline1",
    "owner": "admin",
    "name": "My Pipeline"
  }
]

Response: a list of migrated pipelines

  [
   {
       "iri": "http://unifiedviews.poolparty.biz/resource/pipeline/bb768634-a5bf-4af6-a1a1-b6456b45e4ce",
       "owner": "http://unifiedviews.poolparty.biz/resource/user/admin",
       "name": "migrated pipeline name"
   }
]
 

Method: GET

GET /migrate/schedules/getAll - returns all schedules (admin only)

Example response

[
   {
       "iri": "http://unifiedviews.poolparty.biz/resource/schedule/bd110f7c-f077-455c-8ab2-9f14feafb8de",
       "owner": "admin",
       "pipelineName": "migrated schedule name"
   }
]

Migrating Schedules

Method: PUT

PUT /migrate/schedules/migrateAll - consumes a list of ScheduleDTO objects, updates their owners, and reassigns schedules.

Request body

    [
  {
    "iri": "http://example.com/resources/schedule1",
    "owner": "admin",
    "pipeline": "My Pipeline"
  }
]

Response - a list of migrated schedules

[
   {
       "iri": "http://unifiedviews.poolparty.biz/resource/schedule/bd110f7c-f077-455c-8ab2-9f14feafb8de",
       "owner": "http://unifiedviews.poolparty.biz/resource/user/admin",
       "pipelineName": "migrated schedule name"
   }
]

Method: GET

Get All DPUs

GET /migrate/dpus/getAll - returns a list of all DPU templates (admin only)

Example response

[
   {
       "iri": "http://unifiedviews.poolparty.biz/resource/dpuTemplate/ef75bf83-6cf4-422f-bc14-40e70972d0fe",
       "owner": "admin",
       "dpuName": "HTTP API Request Executor"
   }
]

Migrating DPUs

Method: PUT

PUT /migrate/dpus/migrateAll - consumes a list of DPUDTO objects and updates their ownership

Request body

[
  {
    "iri": "http://example.com/resources/dpu1",
    "name": "Transform CSV",
    "owner": "admin"
  }
]

Response - a list of migrated DPUs

[
   {
       "iri": "http://unifiedviews.poolparty.biz/resource/dpuTemplate/ef75bf83-6cf4-422f-bc14-40e70972d0fe",
       "owner": "http://unifiedviews.poolparty.biz/resource/user/admin",
       "dpuName": "HTTP API Request Executor"
   }
]