Breaches
Team sonar

List compromised employees for a breach

Lists all employees affected by a specific breach, ordered by their compromise date in descending order (most recent first). The breach notification and acknowledgement dates, and breached email accounts are provided.

Scopes required:

  • breaches:read
get/v1/breaches/{breach_id}/compromised-employees

Request

  • Base URL: https://public-api.tryriot.com
  • URL: https://public-api.tryriot.com/v1/breaches/{breach_id}/compromised-employees
  • Auth: API key in header x-api-key

Path parameters

breach_idstring uuid required

ID of the breach for which to retrieve compromised employees

Query parameters

cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

limitinteger

Maximum number of items to return. Maximum value is 100.

workspace_idstring uuid required

ID of the workspace for which to retrieve employees

warnedboolean

Filters employees based on whether they have received a notification about the breach. When true, only employees who have been warned will be included. When false, only employees who have not been warned will be included.

acknowledgedboolean

Filters employees based on whether they have acknowledged the breach. When true, only employees who have acknowledged the breach will be included. When false, only employees who have not acknowledged the breach will be included.

Headers

x-item-limitinteger

Maximum number of items to return. Maximum value is 100.

x-next-cursorstring

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

Response

Compromised employees list for a breach

Example response

{
  "data": [
    {
      "breached_accounts": [
        {
          "email": "john.doe@example.com"
        }
      ],
      "employee": {
        "name": "John Doe",
        "primary_email_address": "john.doe@tryriot.com"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.