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",
  "body": "string",
  "created": "2024-07-29T15:51:28.071Z",
  "event": {
    "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": {}
  },
  "seen": true
}

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

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/events/notifications/:uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"event\": {\n    \"user\": {},\n    \"action\": \"login\",\n    \"app\": \"string\",\n    \"context\": {},\n    \"client_ip\": \"string\",\n    \"expires\": \"2024-07-29T15:51:28.071Z\",\n    \"brand\": {}\n  },\n  \"seen\": true\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

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-07-29T15:51:28.071Z",
    "brand": {}
  },
  "seen": true
}