events_events_create

POST 
/api/v3//events/events/

Event Read-Only Viewset

Request

application/json

Body

required

user
action EventActions (string)required

Possible values: [login, login_failed, logout, user_write, suspicious_request, password_set, secret_view, secret_rotate, invitation_used, authorize_application, source_linked, impersonation_started, impersonation_ended, flow_execution, policy_execution, policy_exception, property_mapping_exception, system_task_execution, system_task_exception, system_exception, configuration_error, model_created, model_updated, model_deleted, email_sent, update_available, custom_]

app stringrequired

Possible values: non-empty

context
client_ip stringnullable

Possible values: non-empty

expires date-time
brand

Responses

201

application/json

Schema

Schema

pk uuidrequired
user
action EventActions (string)required

Possible values: [login, login_failed, logout, user_write, suspicious_request, password_set, secret_view, secret_rotate, invitation_used, authorize_application, source_linked, impersonation_started, impersonation_ended, flow_execution, policy_execution, policy_exception, property_mapping_exception, system_task_execution, system_task_exception, system_exception, configuration_error, model_created, model_updated, model_deleted, email_sent, update_available, custom_]

app stringrequired
context
client_ip stringnullable
created date-timerequired
expires date-time
brand

Example (from schema)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user": {},
  "action": "login",
  "app": "string",
  "context": {},
  "client_ip": "string",
  "created": "2024-07-29T15:51:28.071Z",
  "expires": "2024-07-29T15:51:28.071Z",
  "brand": {}
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/events/events/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "user": {},
  "action": "login",
  "app": "string",
  "context": {},
  "client_ip": "string",
  "expires": "2024-07-29T15:51:28.071Z",
  "brand": {}
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Body required

{
  "user": {},
  "action": "login",
  "app": "string",
  "context": {},
  "client_ip": "string",
  "expires": "2024-07-29T15:51:28.071Z",
  "brand": {}
}