Skip to main content
POST
/
redTeams
/
runs:run
{
  "id": "<string>",
  "displayName": "<string>",
  "numTurns": 123,
  "attackStrategies": [
    "easy"
  ],
  "simulationOnly": false,
  "riskCategories": [
    "HateUnfairness"
  ],
  "applicationScenario": "<string>",
  "tags": {},
  "properties": {},
  "status": "<string>",
  "target": {
    "type": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
api-version
string
required

The API version to use for this operation.

Minimum length: 1

Body

application/json

Redteam to be run

Red team details.

​
target
object
required
​
displayName
string

Name of the red-team run.

​
numTurns
integer

Number of simulation rounds.

​
attackStrategies
enum<string>[]

List of attack strategies or nested lists of attack strategies.

​
simulationOnly
boolean
default:false

Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.

​
riskCategories
enum<string>[]

List of risk categories to generate attack objectives for.

​
applicationScenario
string

Application scenario for the red team operation, to generate scenario specific attacks.

​
tags
object

Red team's tags. Unlike properties, tags are fully mutable.

​
properties
object

Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

Response

The request has succeeded and a new resource has been created as a result.

Red team details.

​
id
string
required

Identifier of the red team run.

​
target
object
required
​
displayName
string

Name of the red-team run.

​
numTurns
integer

Number of simulation rounds.

​
attackStrategies
enum<string>[]

List of attack strategies or nested lists of attack strategies.

​
simulationOnly
boolean
default:false

Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result.

​
riskCategories
enum<string>[]

List of risk categories to generate attack objectives for.

​
applicationScenario
string

Application scenario for the red team operation, to generate scenario specific attacks.

​
tags
object

Red team's tags. Unlike properties, tags are fully mutable.

​
properties
object

Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

​
status
string

Status of the red-team. It is set by service and is read-only.