eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-26 17:45:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

first pass

Browse Source
This commit is contained in:
Tana M Berry
2024-10-22 15:10:13 -05:00
parent 63c3da169a
commit 7a6d44d0df
878 changed files with 474272 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

383
website/docs/developer-docs/api/reference/events-rules-used-by-list.api.mdx Normal file
View File

@@ -0,0 +1,383 @@
---
id: events-rules-used-by-list
title: "events_rules_used_by_list"
description: "Get a list of all objects that use this object"
sidebar_label: "events_rules_used_by_list"
hide_title: true
hide_table_of_contents: true
api: eJytVduO0zAQ/RUrTyBVzarLA+oTC1SrSoBWe+EFrSInmTbeOnGwJxVVlH9nxnHa0AsCxFPGt/E5MyfHbWRqsBKVqZZ5NI9gCxW6xDYaXNI4yJN0l2jlMJpEObjMqpr30s5bQCEFLwmzElJrYdIXyNAJLCQKOkuBcmGWjtfSyhIQrIvm39pIcZJaYkFLFS3wKC2TplE5zbisgFJG8zbCXc1rDq2q1rSyMraUSDN+Z3cM60Y8PS0/in67UDnRUasdxx7NF0NDlXnC4p5YTimlhe+NskD80TbQPU8ilGtGGcoR0YyDrLEKdx67bLDgxBsaPfN+C642lQPHiGdXV/zJTIW0iUNZ1zpcGr84xtmeMpTWyh2hUQilG83vC3hM9FztLazAQpX1hEF8b8AqyEddsNxwVD1UAnZaY6ppaXLQSd+WM8v15uz0xf0y60G3EVRNyYXNpMtkDgQoREkpK2bvAJOq0TqEOaxko5E7cCwEVKh54olU+n53469YcPquG7f023D7xLP9hVuA7Ak9H2ekPN2JvJjNm3/r74U+fpVa5b0eF9Yae9KjylTJSoHOE+B19weSGSpPYDNie35F5rnia6W+G9/XHepwgNYju1iP6/9Yj1uoSLKZuLlbXihIDiiVPiu0y2zHgggJRh0Pl/6GJv8UgIVhk1xD72fkXfMo7j0i9pYZt4OHdXFwz9gr2W4H32us5lOyVvH2Oo66kbc8cInCj3lwmD2bArEerJHHKUgL1kNT1cr4nYHP4fgk4pt7FrOr2Zvp2+nspOaf5YYNYzgV7NGpsu4NkltLf5H/gUtf+6gArc27tdnfNFWGO0B9BzJCL9ze1T8vHylFT5spuHkcrxUWTTrNTBmPUsSHKNUmjemqKv60/LD48rDwNGvjkHxilLwvvvDF5zcnF+lOnHuvRvr8+6crNADhB8a1JlTM1DNqgwz2TwUpjbHQdz56zoIWKGLVFUSDj7RtKh08Wd11PM1eze8LhVtplUy5laSYXDmOSXkrqR38htir+6Dy1+Jf3sGzNAer8e68lbrhEYUb2I2f7O6Z9hZATm496H75JsugxtHBE2dg/e9/rNsFS4VVMJJ9kPlkCDj7WVBUTr/j0WygopIOGJHHDLDrfgJLjRPe
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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"events_rules_used_by_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/events/rules/{pbm_uuid}/used_by/"}
>
</MethodEndpoint>
Get a list of all objects that use this object
<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":"pbm_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Notification Rule.","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"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"app"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"model_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"action"}
required={true}
schemaName={"UsedByActionEnum (string)"}
qualifierMessage={"**Possible values:** [`cascade`, `cascade_many`, `set_null`, `set_default`]"}
schema={{"enum":["cascade","cascade_many","set_null","set_default"],"type":"string","title":"UsedByActionEnum"}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"[\n {\n \"app\": \"string\",\n \"model_name\": \"string\",\n \"pk\": \"string\",\n \"name\": \"string\",\n \"action\": \"cascade\"\n }\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>