Files
authentik/website/docs/developer-docs/api/reference/events-notifications-update.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

633 lines
25 KiB
Plaintext

---
id: events-notifications-update
title: "events_notifications_update"
description: "Notification Viewset"
sidebar_label: "events_notifications_update"
hide_title: true
hide_table_of_contents: true
api: eJztV1tv2zYU/iuGnlbAsZK0RTs/NeuMIUAvQRL3YYUh0NKxzZoiNV6ceIb++84hJUu2ZWdbM+ylD3FI6vBcv/OR3ESqAM0sV/I6i4YRrEBak0hl+Yynft0krsiYhagfZWBSzQtaRdlPLaHeFw4PBiwKFUyzHCxoEw2/biJOogWzC/wk8QPOnOMZzky6gJxFw01k1wWtG6u5nOOXmdI5s7VkuW/4qjceX//aC+I9nqHLfLamsV1w02v7NUBtGv5wXAOGZ7WDctKPLJuTc1W00STIgLG/qGxNDqVKWvxEQ1YUolIWfzNkf3PouZp+g9SeztAdaM4E/xM0JUlT3i0HQ1q8H0+rG5HYKT3O4OJwgwljadiDuqXLKVah5liKfvifzBgXkIWpcmSK9iYPmvtCG2cKnnLlTFJlxhfWmAelsyTU2UCqwSYrLHwz08oGqHC54tYHnqBmssScXSiNfietlNJO5XQKieBy6eV4jhFhosNmY5m2HesgM786E+ohgUdIXaWuUKh73b2UQlEvhbytkxydQeTsfDRrYyFPLDPLHT276wfy7SUE0IzPna6c1VpRtXKVgUgwUSyEFOahvZo5/kGYI8i4wHRLXyAvlrAVrrGpoCSnzliVJwTg/Ray3AqoMXPl0WCokzDcro7LufwAco5dOrwo+wH/jzZgKRUcdSS8c6N0Injjm+tAETwW2HrmZJNTWGeWIzXghqlmMiO7Zbtxv9aADgFM9uK7rTBaEg5BtqxNlRLAZETq6i3trtzuLEu/OXXYAWtPXIRXYpYlzial5whTYBZDNJfn5/8DURTLp+mSHGXZZynWdU3qwMcVmxrkmxAmei3E55mPtyYK4v6U0PXAtAwGmEAXTqHsrtI4Ih0hV20XqK4Vs+5rOBCsu+PvIaZDwXOR6fflOqivz68fxPyDmP8NMX8HFT9LK/0n7N041qcm2yfzJ1i8rdaTyp66Fr1Nujk/8ly/ywZk9NWzUvoXpJUsEPqoQtkuv0jE34yDyAIK21lmWjMKDHs+78h+6WGRQfcXlmWczDJx07bXOgAb14JnR/Px8hnz8RtIrErau7q5PpKQDCx20JEmOBZtGw6VglbZK6MnwsQlfKwsFD1+ChfYlC4vURweB/HOUyjeEKOXsUeZXtVvHKcF7WAFj1cvY38A1leJO0pPiK91odhGsrC2qJ9CHunANGjvFiX4tnmWjB5ZXgjYeS4cHivb08TTSdOux1ikkdj2Ol5tLl+dnb85u/z5/uL18PXF8PLt4PzNxe/Rbn+HHq2YgsuZ8mFViW9i7UeUpuAcaR68HVwegOMjW9Lzrd5VXYQMp4gHlfsYog8+9yCJFiCEejdXW0sDrggqCFDAS5rvsPDc/Hh9Tyzta0T5NsM4nnO7cNNBqvK4pSJuRlOhpjGakvGH6/ejT3cjX5NCGZsz2VIeUNLbQUmv+8HcaqVjb+cKFVSquBBo3V8etG+KgMvto7Uf7djE+bC6klADLNBREt5spszAWIuypGVEk6bbLQ5XDG8+/rRAAGfc0BhLO2PCwAnHf7qtGu5F7x8+wztjqwlPEt2tmHA0w+ES1tvn/wTlFng0EdbR1/DpffDo7J4UNFsPGKrs1zuuUroFnJSdtMjgZkyoqa+tuSegSDO6UtGv91IVIfco4Nc2kWBy7ticZINKz8iOKtecZqHH+/WAgurMAxbPS9yrJUgsYJ0WS3PKS1n+BeAPNvU=
sidebar_class_name: "put api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"events_notifications_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
path={"/events/notifications/{uuid}/"}
>
</MethodEndpoint>
Notification Viewset
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"path","name":"uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Notification.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
event
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
Event Serializer
</div><SchemaItem
collapsible={false}
name={"user"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"action"}
required={true}
schemaName={"EventActions (string)"}
qualifierMessage={"**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_`]"}
schema={{"enum":["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_"],"type":"string","title":"EventActions"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"app"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"context"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_ip"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","nullable":true,"minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"expires"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"brand"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"seen"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"severity"}
required={true}
schemaName={"SeverityEnum (string)"}
qualifierMessage={"**Possible values:** [`notice`, `warning`, `alert`]"}
schema={{"enum":["notice","warning","alert"],"type":"string","title":"SeverityEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"body"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"created"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
event
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
Event Serializer
</div><SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Event uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"user"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"action"}
required={true}
schemaName={"EventActions (string)"}
qualifierMessage={"**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_`]"}
schema={{"enum":["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_"],"type":"string","title":"EventActions"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"app"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"context"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_ip"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","nullable":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"created"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"expires"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"brand"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"seen"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"severity\": \"notice\",\n \"body\": \"string\",\n \"created\": \"2024-07-29T15:51:28.071Z\",\n \"event\": {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"user\": {},\n \"action\": \"login\",\n \"app\": \"string\",\n \"context\": {},\n \"client_ip\": \"string\",\n \"created\": \"2024-07-29T15:51:28.071Z\",\n \"expires\": \"2024-07-29T15:51:28.071Z\",\n \"brand\": {}\n },\n \"seen\": true\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"non_field_errors"}
required={false}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"non_field_errors\": [\n \"string\"\n ],\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"403"}
value={"403"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"detail"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"detail\": \"string\",\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>