Files
authentik/website/docs/developer-docs/api/reference/propertymappings-notification-retrieve.api.mdx
2024-09-13 12:17:54 -05:00

354 lines
12 KiB
Plaintext

---
id: propertymappings-notification-retrieve
title: "propertymappings_notification_retrieve"
description: "NotificationWebhookMapping Viewset"
sidebar_label: "propertymappings_notification_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVclu2zAQ/RWBpxYwrDTJofCpRmsEBpo0aJYeAsOgpLHFmCIZknLjCvr3zmiJCS9pA+QkUsNZ3pvhY8W0Acu90GqasREzlvZ+U3BjhFq6udJeLETanJhb8FbAGtiAZeBSKwz9Rrer4NQvSHKtV5dthOhewG8HHl0Mt7wAD9ax0UPFBDka7nM0KTTQrpiXpcjwh0tzKDgbVcxvDJkcZlZLtCy0LbjHP83JereScXR3N/0WtccjkYHCyja09rlwUVdc1FU3xIAWnkphAdF7W0I9GzDPl1TiHhkMbQ7S0gq/aSDw0ueUYIW7GXlacEYrB44qPz05oU+qlcdDtMQ4smMpfnRUb7WPVCePkPq3UHwDVnAp/oAlltuiRVuDWf2bQyqbZz+U3LQUIAHCS3K4LqKe5bZDu6HQAM8GUTvRotkx1yG9D+HZLuKAKpxtMx5HicH2mk35z9+V5XvkMWtco4m1ep9QhddgIUBmcyC7C0Jya/kGHYSHwh0mI9XZIRbRwrNMUFour8N89ZaabWltZUf5OHtHPi5A4XCl0fh6eoSQDDwX8uBoHEcbDkUXIBiCLukrMPEXKkmuSbKWnbigkIxYvHtn41DA4qpTmDomjQG77sWotJK8uRHx+ixmdXDTb4iqFmtw319Q5d6bXrBonwC3YJsShVro5mSHa+s+YJS5RXN6cno+/Dz8tMf9JV/R7e69WgiRE4WRQMJFLeZp02LsJfWA5SCl/rLUL5mGQlMnsP+AstQMcCu1l9NbDNHCJghuFMdL4fMyGaa6iIMQ8XaVSJ3EmErF36dfJ1c3kwam0c4XXAXBd5sQhU2Ijr0iwdD+34PSdcDDs4+NxLIIagOp6ubhgIaj8ASxcTvavjo0hDmiIceqSriDOyvrmn4/lWBJ9HG55ii3CXUUBycTjtY4iAsuHbwC6cPPbug/Rm9/pA5C7XVHkeqsuSxph8sVbILHtJ7h0RwVHqeSKm6t4zQF4wO/PZWgO/ByyS4mNC40CcHod6M+6BcU/WBNyGVz4lavQCGffYme9lRgXf8FDxX7Sw==
sidebar_class_name: "get 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 Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"propertymappings_notification_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/propertymappings/notification/{pm_uuid}/"}
>
</MethodEndpoint>
NotificationWebhookMapping 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":"pm_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Webhook Mapping.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><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":"Pm uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"expression"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"expression\": \"string\"\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>