Files
authentik/website/docs/developer-docs/api/reference/events-notifications-partial-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-partial-update
title: "events_notifications_partial_update"
description: "Notification Viewset"
sidebar_label: "events_notifications_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJztWFlz2zYQ/isaPrUzsmg7ySTVU1xX03omh8dHHpLRcCByJSICARaHbEXD/95dgBSp023jTl/yYJsAFos9vv2A9SpSJWhmuZJXWTSMYAHSmkQqy6c89fMmKZm2nInElRmzEPWjDEyqeUmruOdDR7j3icODAYtCuIsVYEGbaPhlFXESLZnNcUniAo6c4xmOTJpDwaLhKrLLkuaN1VzOcGWqdMFsI1ltH3zRu7+/+q0XxHs8Q9P5dEnfNuem17VrgNo0/Om4BnTTagfVuB9ZNiPjaq+jcZABY39V2ZIMSpW0uESfrCxFrSz+auj81a7lavIVUns8QregMZj8G2gKkqb4Ww6GtHg7nlY3IrFjepzByeEKA8bSsAd1S1eQr0LNMBX98DeZMi4gC0Pl6Cjamzxo7hNtnCl5ypUzSR0Zn1hjHpTOkpBnA6kGmyww8e1IKxugwuWCW+94gprpJOZsrjTanXRCSjuV0ykkgsu5l+MFeoSBDpuNRRDumQeZ+dmpUA8JPELqanWlQt3L/VMplM1UiNsyKdAYRM7GolkaC0VimZlv6Nmc35HvTiGApnzmdG2s1oqyVagMRIKBYsGlMA7l1Y7xB8IYQcYFhlv6BHmxhC1wjk0EBTl1xqoiIQBvl5DlVkCDmQuPBkOVhO7uq7iCy3cgZ1ilw7OqH/D/aAOWUsFRR8L3bpROBGt8ce0ogscSS88cLXJy68RypAbcMNFMZnRu1S3cLw2ggwPjLf9uaoxWhEOQndMmSglgMiJ1zZZrZrF+s25xrhVUldeROiyEpecvgi0RzBxH48pThSkxmMGp89PT/4EvyvnTrEmGsuyjFMsmNY3/9zWpGqSd4CZaLcTHqfe34Qu6ClIC2QPTMhzABJpwDGy3tcYR6Qix6ppA6a0JdlvDjmBTJH8POHsUPBenfl+sg/rmGvvBzz/4+d/w83cw8rOU0n9C4q1hfSqybU5/gsy7aj2pbKnr0FtHc5dgI8/1m2xAh758Vkr/hLSSBUIf1Sjb5BeJ+JtyEFlAYTfKTGtGjmHNF3uiX3lYZLB/hWUZp2OZuO6e17kHW9OCZQfj8eIZ4/E7SMxK2ru4vjoQkAwsVtCBIjjkbRcOtYJO2utDj7iJU9iz5CoLzUqaez6lV0wUhy4h3uiN4hVxehV7nOlF0+w4LWgHK3m8eBH7K7B5TNxSgIKHnSfF2pfc2rLpiTzWgWnQ3jAK8U3bn4weWVEK2Ogbdi+W9X3iCaUt2EM80kqsqx0fN+cvT05fn5z/cnf2avjqbHj+ZnD6+uxztFnhoUprruByqrxbdehbX/sRhSkYR5oHbwbnO/B4z+bUxzW76qeQ4eTxoDYfXfTOFx4mUQ5CqLcztT5pwBWBBSEK+EzzNRb6zvdXd8TTPkcUbzOM4xm3uZsMUlXEHRVx+zURahLjUTJ+d3U5+nA78jkplbEFkx3lASW9DZT06g66t7+D7hTVoWa6RgelLC4FWuGfEdqXR8DnuovtRxtn43hYP06oFHI0mIRXqwkzcK9FVdE0okrTOxc/FwzfQP7eQCBn3NA3pnjKhIEjhv90U5fez71/2Jfv9a2hPknEt2DC0Qg/57Bc/z9gjHI5XlKEebQ1LF0Gi07uSEG7dYerqn6z4yKl98BR2XGHFq4v7i7/iNonbOHJKNKMnlf029upyhB9FPBzq0gwOXNsRrJBqWdnR7lrb7ZQ7f3mg9zaGwlMn5e4U3OQmMImMJbGFJmq+gunZkE1
sidebar_class_name: "patch 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_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
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>