APIAnalytics

List tool access identities

Identities ranked by regulated or write-capable reach. Calls without a user email are left out.

GET
/analytics/tool-access/identities

Identities ranked by regulated or write-capable reach. Calls without a user email are left out.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.

Required permission

view_user_analytics

Query Parameters

offset?integer

Number of items to skip before returning results.

Formatint32
Range0 <= value
Default0
limit?integer

Maximum number of items to return per page.

Formatint32
Range0 <= value <= 256
Default10
start_time*string

Start of the time range to report on, inclusive.

Formatdate-time
end_time*string

End of the time range to report on, exclusive.

Formatdate-time
sort?string

Ranking: regulated (default) or writes.

Value in"regulated""writes"
user_email?string

Restrict to one identity.

exclude_local?boolean

Leave out client built-in (local) calls.

Response Body

The request has succeeded.

application/json
  1. response

Identities ranked by tool reach.

items*array<>

The items in this page.

meta*

Paging information for a list response.

curl -X GET "https://example.com/analytics/tool-access/identities?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z"
{  "items": [    {      "user_email": "string",      "user_id": null,      "calls": 0,      "sessions": 0,      "systems": 0,      "regulated_systems": 0,      "confidential_systems": 0,      "internal_systems": 0,      "operational_systems": 0,      "unclassified_systems": 0,      "write_systems": 0,      "sensitive_calls": 0,      "write_calls": 0,      "top_severity": "unclassified",      "has_write_chain": true    }  ],  "meta": {    "total": 0,    "offset": 0,    "limit": 0  }}