Skip to main content
API docs by Redocly

Beyond Identity Events API (v0)

Download OpenAPI specification:Download

The Beyond Identity Events API, is a service designed to offer comprehensive access to events data within the Beyond Identity ecosystem. This API is aimed at developers and organizations looking to retrieve detailed information about security-related events, user activities, and system interactions over a specified period.

To use the Beyond Identity Events API, an API key is required for authentication. To obtain this key, interested parties should contact the support team at https://support.beyondidentity.com. This process ensures that access is granted securely and appropriately, following verification and alignment with use case requirements.

Events

Get events by tenant, with optional case-insensitive filters.

Authorizations:
bearerAuth
query Parameters
start_time
integer <int64>

Unix epoch in milliseconds to begin events recorded time. Defaults to 0.

end_time
integer <int64>

Unix epoch in milliseconds to end events recorded time. No default.

page_size
integer <int64>

The number of events to return in a single page. The default is 100 and the maximum page_size is 1000.

ordering
required
string
Enum: "asc" "desc"

The ordering of the events (by time injected by the dataexport system, not when they occurred). No default.

cursor
string

A page contains 100 events by default, or 'page_size' events if that's set in the request. Set this to the value of 'cursor' from the last response to retrieve the next page of results.

event_type
Array of strings
Example: event_type=OIDC_INBOUND

If passed, returns only events of the given event types. Case insensitive.

actor
Array of strings
Example: actor=John Smith

If passed, returns onnly events involving principal agents with these full human names.

outcome
Array of strings
Example: outcome=SUCCESS

If passed, returns only events with the given outcomes.

emitting_service
Array of strings

If passed, returns only events produced by the given services.

correlation_id
Array of strings

If passed, returns only events with the given correlation IDs.

query_text
string
Example: query_text=add_device OR device_credential_change -windows

If passed, returns events with data matching a free-form text query of the given input.

include_not_attested
boolean
Example: include_not_attested=true

If set to true events whose data cannot be fully attested to by Beyond Identity will be included in the repsonse.

Responses

Response samples

Content type
application/json
{
  • "message": "OK",
  • "body": {
    }
}