Skip to main content
API docs by Redocly

Beyond Identity API (v0)

Download OpenAPI specification:Download

Beyond Identity API

Users

Recover User

Authorizations:
bearerAuth
Request Body schema: application/json
external_id
required
string

This is the identifier which corresponds to the user in your database.

binding_token_delivery_method
required
string

Delivery method of the binding token. Can only be 'email'

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "binding_token_delivery_method": "string"
}

Response samples

Content type
application/json
{
  • "internal_id": "string",
  • "external_id": "string",
  • "email": "string",
  • "user_name": "string",
  • "display_name": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_modified": "2019-08-24T14:15:22Z",
  • "status": "USER_STATUS_UNSET"
}

Create User

Authorizations:
bearerAuth
Request Body schema: application/json
external_id
required
string

This is the identifier which corresponds to the user in your database.

email
required
string

This is the email address for the user. An email will be sent to the user to enable them to enrol in Beyond Identity.

user_name
required
string

Internal field to identify the user. When signing in, this will be returned as the subject field of the ID token.

display_name
required
string

Internal field to identify the user's name.

binding_token_delivery_method
required
string

Delivery method of the binding token. Can only be 'email'

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "email": "string",
  • "user_name": "string",
  • "display_name": "string",
  • "binding_token_delivery_method": "string"
}

Response samples

Content type
application/json
{
  • "internal_id": "string",
  • "external_id": "string",
  • "email": "string",
  • "user_name": "string",
  • "display_name": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_modified": "2019-08-24T14:15:22Z",
  • "status": "USER_STATUS_UNSET"
}

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": {
    }
}