{
  "opencollection": "1.0.0",
  "info": {
    "name": "Riot Team simulation API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-api-key",
      "value": "{{x-api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Team simulation",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List attack login domains",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/attack_login_domains",
            "headers": [
              {
                "name": "x-item-limit",
                "value": ""
              },
              {
                "name": "x-next-cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Returns the attack login domains assigned to a workspace, sorted by name. These domains are randomly selected as the link for each attack.\n\n\n**Scopes required:**\n- simulation:read"
        },
        {
          "info": {
            "name": "List breaches",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/breaches",
            "headers": [
              {
                "name": "x-item-limit",
                "value": ""
              },
              {
                "name": "x-next-cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Lists all breaches for a workspace with their affected employees count and status.\n\n**Scopes required:**\n- breaches:read"
        },
        {
          "info": {
            "name": "Get breaches statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/breaches/statistics",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "breached_after",
                "value": "",
                "type": "query"
              },
              {
                "name": "breached_before",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves statistics about breaches for a given workspace, including impacted employees count, acknowledged employees count, and warned employees count.\n\n**Scopes required:**\n- breaches:read"
        },
        {
          "info": {
            "name": "List compromised employees for a breach",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/breaches/:breach_id/compromised-employees",
            "headers": [
              {
                "name": "x-item-limit",
                "value": ""
              },
              {
                "name": "x-next-cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "breach_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "warned",
                "value": "",
                "type": "query"
              },
              {
                "name": "acknowledged",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Lists all employees affected by a specific breach, ordered by their compromise date in descending order (most recent first).\nThe breach notification and acknowledgement dates, and breached email accounts are provided.\n\n\n**Scopes required:**\n- breaches:read"
        },
        {
          "info": {
            "name": "List campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/campaigns",
            "headers": [
              {
                "name": "x-item-limit",
                "value": ""
              },
              {
                "name": "x-next-cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_after",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Lists the campaigns for a workspace with its cycles, sorted by their creation date in descending order (most recent entries first).\nA campaign cycle forms a group of attacks sent at a period of time. Periods of two cycles can't overlap.\nRecurring campaigns usually have multiple cycles, whereas one-off campaigns usually have only one.\n\n\n**Scopes required:**\n- simulation:read"
        },
        {
          "info": {
            "name": "Get campaigns statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/campaigns/statistics",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "campaign_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "campaign_cycle_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_after",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves statistics about campaigns in a workspace including attack events counts.\nDescription of the events can be found at https://docs.tryriot.com/api-reference/simulation/list-attacks#response-type\n\n\n**Scopes required:**\n- simulation:read"
        },
        {
          "info": {
            "name": "List attacks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/campaigns/:campaign_id/attacks",
            "headers": [
              {
                "name": "x-item-limit",
                "value": ""
              },
              {
                "name": "x-next-cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "campaign_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "campaign_cycle_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_after",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query"
              },
              {
                "name": "is_tricked",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a list of attacks of a campaign with associated events, sorted by their creation date in descending order (most recent entries first).\n\n**Scopes required:**\n- simulation:read"
        },
        {
          "info": {
            "name": "List domains",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.tryriot.com/v1/domains",
            "headers": [
              {
                "name": "x-item-limit",
                "value": ""
              },
              {
                "name": "x-next-cursor",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves the domains sorted by name in ascending order.\n\n**Scopes required:**\n- workspace:read"
        }
      ]
    }
  ],
  "bundled": true
}