UPupguard
userrisk

List identity breaches

Changed on

Retrieve a list of identity breaches for your organization.

Required API key permissions: User Risk (select when creating API key in Account Settings)

get/user_risk/identity_breaches/list

Request

Query parameters

page_sizeinteger

The page size of results to return. If not supplied, default is 100.

page_tokenstring

The page_token from a previous request, use this to get the next page of results.

sort_by'title' | 'breach_date' | 'published_date'

The field to sort results by. Default is title.

sort_dir'asc' | 'desc'

The direction to sort results. Default is asc.

statusesstring[]

Filter identity breaches by status.

breach_date_minstring

Filter identity breaches that occurred after or at this date-time.

breach_date_maxstring

Filter identity breaches that occurred before or at this date-time.

published_date_minstring

Filter identity breaches published after or at this date-time.

published_date_maxstring

Filter identity breaches published before or at this date-time.

data_classesstring[]

Filter identity breaches by exposed data classes.

Response

A list of identity breaches

next_page_tokenstring

The token to be used to retrieve the next page of results. Will not be returned if there are no more results.

Example response

{
  "identity_breaches": [
    {
      "breach_date": "2023-09-24T15:30:00Z",
      "breach_type": "Company",
      "description": "Lorem ipsum dolor sit amet",
      "domain": "example.com",
      "exposed_data_types": [
        "passwords",
        "usernames"
      ],
      "id": "9b89cba1-daa9-4dc7-9ccc-ffdc8027e3ca",
      "name": "Lorem ipsum dolor sit amet",
      "published_date": "2023-09-24T15:30:00Z",
      "status": "remediated",
      "title": "Lorem ipsum dolor sit amet"
    }
  ],
  "next_page_token": "acbd18db4cc2f85cedef654fccc4a4d8"
}

Changes

  • d044bf6dc61eRevision changes
    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_dir