assessment

Create Assessment

Create a new assessment.

post/api/v1/assessment/

Request

The document declares no server URL.
Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Request body

namestring required

descriptionstring required

assessment_type'PurpleTeam' | 'RedTeam'

Possible assessment types

Example request

{
  "assessment_type": "PurpleTeam",
  "description": "Atomic based Purple Team engagement",
  "name": "Purple Team Assessment Example"
}

Response

Successful Response

namestring required

descriptionstring required

assessment_type'PurpleTeam' | 'RedTeam'

Possible assessment types

idstring uuid required

default_evaluation_templatesobject[] required

Example response

{
  "assessment_type": "PurpleTeam",
  "default_evaluation_templates": [
    {
      "evaluation_template_id": "00000000-0000-0000-0000-000000000000",
      "position": 0
    }
  ],
  "description": "Atomic based Purple Team engagement",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Purple Team Assessment Example"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.