Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Portfolio

This endpoint adds and updates subscription licenses for a TOE.

This request sets the list of subscription licenses that determine whether a TOE appears in your portfolio, and for which risk dimensions. The currently available Risk Dimensions are CYBER and PRIVACY. The available license types are AVISOR, DISCOVER, and SNAPSHOT. A cyber license of ADVISOR or DISCOVER is a prerequisite of any privacy license. SNAPSHOT licenses are not available for the privacy risk dimension at this time.

post/v1/toes/{toe_id}/subscriptions

Path parameters

toe_idstring required
Example:5976423a-ee35-11e3-8569-14109ff1a304

Filter by the Toe ID.

Request body

Example request

{
  "licenses": [
    {
      "name": "ADVISOR",
      "riskDimension": "CYBER"
    }
  ]
}

Response

ChangeSubscription list of affected subscriptions and success message.

messagestring required

Success message or info about modified subscriptions

Example response

{
  "message": "portfolio subscription for toe_id: 7db00def-832f-43bd-83a2-6eefb8638491 adjusted successfully",
  "events": [
    {
      "customerId": "5976423a-ee35-11e3-8569-14109ff1a304",
      "toeId": "5976423a-ee35-11e3-8569-14109ff1a304",
      "newLicense": "ADVISOR",
      "oldLicense": "ADVISOR",
      "riskDimension": "CYBER",
      "subscriptionAdjustedOn": "2021-10-01T22:18:57+00:00"
    }
  ]
}