UPupguard
userrisk

List identity breach users

Changed on

Retrieve a list of users involved in a specific identity breach.

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

get/user_risk/identity_breaches/users/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'id' | 'email' | 'name' | 'risk_rating'

The field to sort results by. Default is id.

sort_dir'asc' | 'desc'

The direction to sort results. Default is asc.

idstring required

The unique identifier of the identity breach.

Response

A list of users involved in the identity breach

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

{
  "next_page_token": "acbd18db4cc2f85cedef654fccc4a4d8",
  "users": [
    {
      "email": "john.doe@example.com",
      "id": "e7cfc445-30a6-416c-8a12-0a988f042d08",
      "name": "John Doe",
      "risk_rating": 750,
      "role": "developer",
      "status": "current",
      "team": "product"
    }
  ]
}

Changes

  • d044bf6dc61eRevision changes
    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_dir