HUhuntress
Identities

List Identities

Shows Identities associated with your account.

get/v1/identities

Request

  • Base URL
    https://api.huntress.io
  • URL
    https://api.huntress.io/v1/identities
  • Auth
    basic (a scheme the document does not define)

Query parameters

limitinteger

Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500.

page_tokenstring

Token used to request the next page in paginated results. Defaults to 'null'

sort_field'id' | 'created_at' | 'updated_at'

Field to sort by. Defaults to 'id'.

sort_direction'asc' | 'desc'

Sort direction. Defaults to 'desc'.

organization_idinteger

Filter by organization ID within Huntress account.

tenant_type'microsoft_365' | 'google_workspace'

Filter by identity provider type.

billableboolean

Filter by billable status.

enabledboolean

Filter by enabled status.

externalboolean

Filter by external/guest status.

risk_level'none' | 'low' | 'medium' | 'high'

Filter by risk level.

mfa_enabledboolean

Filter by MFA enabled status.

escalation_idinteger

Filter by an escalation ID within Huntress account.

Response

List Identities

Example response

{
  "identities": [
    {
      "id": 12345678,
      "account": {
        "id": 1,
        "name": "Your Account Name"
      },
      "organization": {
        "id": 1,
        "name": "Your Organization Name"
      },
      "tenant": {
        "id": 123,
        "type": "google_workspace"
      },
      "username": "user@example.com",
      "email": "user@example.com",
      "enabled": true,
      "billable": true,
      "enabled_products": [
        "itdr",
        "ispm"
      ],
      "mfa_enabled": true,
      "risk_level": "none",
      "risk_state": "none",
      "risk_detail": "none",
      "risk_last_updated_at": "2022-03-01T20:05:10Z",
      "password_last_changed_at": "2022-03-01T20:05:10Z",
      "created_at": "2022-03-01T20:05:10Z",
      "updated_at": "2022-03-01T20:05:10Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 8 revisions of this API.