events_notifications_partial_update

PATCH 
/api/v3//events/notifications/:uuid/

Notification Viewset

Request

Path Parameters

uuid uuidrequired

A UUID string identifying this Notification.

application/json

Body

event

object

Event Serializer

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
seen boolean

Responses

200

application/json

Schema

Schema

pk uuidrequired
severity SeverityEnum (string)required

Possible values: [notice, warning, alert]

body stringrequired
created date-timerequired

event

object

Event Serializer

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
seen boolean

Example (from schema)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "severity": "notice",
  "body": "string",
  "created": "2024-09-27T14:26:18.164Z",
  "event": {
    "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user": {},
    "action": "login",
    "app": "string",
    "context": {},
    "client_ip": "string",
    "created": "2024-09-27T14:26:18.164Z",
    "expires": "2024-09-27T14:26:18.164Z",
    "brand": {}
  },
  "seen": true
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

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 -X PATCH '/api/v3/events/notifications/:uuid/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "event": {
    "user": {},
    "action": "login",
    "app": "string",
    "context": {},
    "client_ip": "string",
    "expires": "2024-09-27T14:26:17.887Z",
    "brand": {}
  },
  "seen": true
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

uuid — pathrequired

Body

{
  "event": {
    "user": {},
    "action": "login",
    "app": "string",
    "context": {},
    "client_ip": "string",
    "expires": "2024-09-27T14:26:17.887Z",
    "brand": {}
  },
  "seen": true
}