Files
authentik/website/docs/developer-docs/api/reference/propertymappings-provider-microsoft-entra-used-by-list.api.mdx
2024-09-13 12:17:54 -05:00

384 lines
14 KiB
Plaintext

---
id: propertymappings-provider-microsoft-entra-used-by-list
title: "propertymappings_provider_microsoft_entra_used_by_list"
description: "Get a list of all objects that use this object"
sidebar_label: "propertymappings_provider_microsoft_entra_used_by_list"
hide_title: true
hide_table_of_contents: true
api: eJytVk2P2zYQ/SuETi1gWNtNDoVP3TTGwkC3WDTZXoKFQEkjizFFKuTIqCDov3eGkmzFloM2yMkjfszMe/M44y6yNTiJyppdHm2i2vE3tpWsa2X2PqGFo8rBJZXKnPW2wAQMOpk0HvIkbROtPEarKAefOVWzI3LzCCik4C1hCyG1Fjb9DBl6gaVEQXfJUH5cpeu1dLICBOejzacuUuyklljSlqEN/qqSplE5LfishEpGmy7CtuYtj45ypZ3CukoirYST/WVWD+LlZfdeDMcFoTKoipbtkMzThFBsGaF4HqGLp4GMNUVw8KVRDogqdA30r6sI5Z5zvmIuoj0PWeMUtgGTbLDkiAf6euWbDnxtjQfPUO7v7vgnswbpEJvkR6sslCb+7BlAdw1dOidbykshVH62fiL2koGlmjgowIHJBiZAfGnAKchn1RmwqSFVSuyafCK7sjnoZCjXwnZ9WFy+eV5mQ9JdBKapmOJM+kzmQAmNVlJJw+g9YGIarUczh0I2GrkClwpBhZoXXki979qHEGLL7vt+XtxPU/RVQPsVtjHlAOj10iP56a90x2jefl99b9Txb6lVHq6KrXPWXdXIWJMUCnSeAO/7/yCZiXlKNiO0yzsyzxWHlfp5Hq8/83BObcjsJh9vfiAfj2BIspl4eN7dICQHlEovCu022rkgRgezio9BvwGTHwVgabmz7mHoc9TTNlF82S3iqc/GF3027sbG18djx42Dyt1x6pWN0+xR1io+vomjftZ3PjB946M9d58T0hKxnvopf6cgHbiQtjKFDSdHrOfrq4gjDwjv7+7frn9d/3JVjyd54GYy3RqqKryqag3cRrns9MLC465CXaIStLa/7e0p0lpZrg5pAqhJBlEPk+Bp95FcDLAZgt/E8V5h2aTrzFbxzEV8tlJt05hCmfiP3e/bPz9sA8zaeqQeMnN+WRgxFUacCiNCYXiI5SJtxdIAnAn7/8/CsToI/2Bca0qZaQhwu1E/C9Mm6D0kyt3qaw3RyuY8PkcZkcViLokBdth1qfTw4nTf8zKPAB5bZB6lUzJlFZDYcuXZJkEXUnv4Buyf/hofz8/iB8zdRU6mhhZmwFHqhr/IPEA7+8PQv9LREiRTwxCG3Ycsgxpn967aDz+k0+t93LLmWE6z9zO+l9VksPfFnIjccOKjPYAhgqcUkb85wb7/F/CuUgs=
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_provider_microsoft_entra_used_by_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/propertymappings/provider/microsoft_entra/{pm_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":"pm_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Microsoft Entra Provider 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"}}
>
<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>