Accounts API v2

All API URLs should be prefixed with

https://<your-server-ip>:8443/openapi/api/rest/v2/accounts

Preface

The following post detail how to interact with the SkyFormation cloud apps connector accounts using APIs.

A SkyFormation account represent a specific instance of a cloud app connector on-boarded to the SkyFormation application. For example a SkyFormation account might be a cloud app connector to an organization’s Salesforce account for the US sales team.

Authentication

See guide

Objects used with these APIs 

AccountConfiguration

{
 "id": "account-id",
 "tenant": {
   "id": "tenant-id",
   "name": "tenant-name"
 },
 "name": "acc-name",
 "application": "type0 e.g. Office 365",
 "status": "STOPPED|RUNNING",
 "authn-data": {
   "type": "type0 e.g. oauth2",
   "fields": [{
     "name": "field-name",
     "value": "field-value"
   },
   // more fields ...
   ],
   "supplementary-authn-data": {
     "type0": {
       "identifier": {
         "type": "GROUP",
         "name": "type0"
       },
      "authn-data": {
        "type": "type1",
        "fields": [{
          "name": "field-name",
          "value": "field-value"
        },
       // more fields ...
       ]
      }
    },
    // more types ...
   }
  }
}

Create an account

Refer to required authentication fields to detailed list of what each application type requires for authentication

POST /
Body:
AccountConfiguration w/o id.
Response:
200,
AccountConfiguration w/ id.

Modify an account

Refer to required authentication fields to detailed list of what each application type requires for authentication

PUT /{account-id}
Body:
AccountConfiguration
Response:
200,
AccountConfiguration