Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Target Of Evaluation TOE

This endpoint allows a user to update the internal_ids and/or internal_name of an existing `TOE` by its identifier.

This endpoint allows a user to update the internal_ids and/or internal_name of an existing TOE by its identifier. These can be used to map a TOE in the RiskRecon system to an entity in the users system.

put/v1/toe/{toe_id}

Path parameters

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

Filter by the Toe ID.

Request body

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 request

{
  "internal_name": [
    "Riskrecon"
  ],
  "internal_id": [
    "1234"
  ]
}

Response

OK

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"
  ]
}