v1

latestOpenAPI 3.1.12026-07-242899061.7 MB

Target Of Evaluation TOE

This endpoint adds an existing TOE to the users portfolio.

This endpoint adds an existing TOE to the users portfolio. The toe_id and other information can be obtained from the /v1/toes/by_domains response.

post/v1/toe/{toe_id}

Path parameters

toe_idstring required

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

Filter by the Toe ID.

Request body

risk_relationship_slugsstring[]

Risk relationship slugs which are returned from /v1/portfolio/risk_relationships_folders. This is optional.

subscription_level1 | 2 required

The SubscriptionLevelConfig. 1 (Discover) or 2 (Advisor). This defaults to 2.

privacy_subscription_level2

The SubscriptionLevelConfig for privacy. Only 2 (Advisor) is available and this is only available if your customer has privacy enabled.

internal_namesstring[] nullable

The user defined names for the TOE.

internal_idsstring[] nullable

The user defined identifiers for the TOE. These can be used to query the TOE.

assessment_frequency'one_time' | 'continuous' required

Scan frequency. This must be either one_time or continuous. The default is continuous.

Example request

{
  "risk_relationship_slugs": [
    "ownenterprise_critical"
  ],
  "subscription_level": 2,
  "privacy_subscription_level": 2,
  "internal_names": [
    "Riskrecon"
  ],
  "internal_ids": [
    "1234"
  ],
  "assessment_frequency": "continuous"
}

Response

toe_short_namestring

The Company or entity name.

toe_idstring uuid

The unique identifier for the Target Of Evaluation (TOE).

internal_namestring[] nullable

The user defined names for the TOE.

internal_idstring[] nullable

The user defined identifiers for the TOE. These can be used to query the TOE.

Example response

{
  "toe_short_name": "Riskrecon",
  "toe_id": "5976423a-ee35-11e3-8569-14109ff1a304",
  "internal_name": [
    "Riskrecon"
  ],
  "internal_id": [
    "1234"
  ]
}