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

381 lines
12 KiB
Plaintext

---
id: propertymappings-all-test-create
title: "propertymappings_all_test_create"
description: "Test Property Mapping"
sidebar_label: "propertymappings_all_test_create"
hide_title: true
hide_table_of_contents: true
api: eJytVttu2zgQ/RWCT1vAtlI7cbt+2mw3WBjYbINcngrDoKWRxYYSVZJKYwj6950hpUiN1BZY9MUQybmeOTPjmusSjHBSF9uEb3hp6OxOuShLWRztXii1d2DdPjYgHPAZT8DGRpakggr3+MZuWi12HdRQqhRG5ODAWL75VHNJsl8qMCd8K/AFj6k2uXB7A7ZSDq9tnEEu+Kbm7lSSwEFrBaLgTTNrLZTCZb2BMt9XlUymVK0zIY7gBG+8ZPM6/Ev28LD9iwVxJhMonExP9O0yaUeJLdCigS+VNIBoOVNBs5txJ46U5Qg8vgvSCNGfOjlReLEuHPqgTxRSMvbQR58tRVOP89CHzxC7adQ7d6z1x+AZ4ookGGbNBKssmOhodFWyr9JlzDt/JmutqgRLvkhu4FOi1BFvEOdKKXFQ0KY6452FiQBFkkjyLdTN0DjWjvsQfl6ckT9UddLRkXeFaOtA+d8GZJEdJGgxdSPdybNNVC6jSj7iadf4KthSFzakuzw7+4WluPX0ZTpFwLso511FqHNGcLeEn8ADWyz5WKjTC962imOwNq3URFuM5JshOT/xvrF6K7ufQOo1PKDfZkmdcx5w+/ZhWzwJJRM26HcvuvqFEP8NBRgZs8ubLbsyRpsRpAk4IdUYUk/ZBCYeXmHVGhjA0zoN/iYRwSvMONN+bupQaJpPGx69ngQRjtGobudVExEtIioMmKduQlZGkaYoZfS0ijixtuP0HeEUEh0w+yWlzLmym4GeHyAMGB8fIX3bT6CrZ5GXCvqePxu2dN+pfJWK9xfp+nx+8e7tu/n5xXo5P6zSeL6Mf1+v0vVapGJN4Moi1T6SFrQ+vBmnzAJUy7Pl+eL94u2osNfikbqk0wr0YFZSkDRqKTYRe/4gUajAPAOl9B9H/eJpITVFguQCbHASbbfD9fYeTQRYCSK7iaIjjsHqsIh1Hg1MRP3XQelDhK6K6J/th6t/7648jFTdXBQD468LzLDAvtvZ9J4c9MJ3V2ZbTqpGVCqMgfLy8dctsSZWDA5epfB30y/DdugQmTOiJarV9UFYeDCqaeg6LGJiXSItDVykcCqUhRl/hNPEasYer8CTfkcHI8OUnjLw3bR/u2377Q37H1t3Epz2UhSnYYxdEh0izQ5FMxyVxHgMObx+CIHN78lGrz2aU/TfI2hc4hQt3Q9ld4ORcPPxjgh4aDd/7ucQN+IrDW789ZFqD1RYC3RXcyWKYyWOJBtsEgGJoMMNEDp81n1QVpNYYN29xL1+hAJr30Hj6EzANM1/cUh56A==
sidebar_class_name: "post 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_all_test_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/propertymappings/all/{pm_uuid}/test/"}
>
</MethodEndpoint>
Test Property Mapping
<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 Property Mapping.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Query Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"format_result","schema":{"type":"boolean"}}}
>
</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={false}
name={"user"}
required={false}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer","nullable":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"}
>
context
</strong><span
className={"openapi-schema__name"}
>
object
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","additionalProperties":{}}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"group"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true}}
>
</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={"result"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"successful"}
required={true}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"result\": \"string\",\n \"successful\": true\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
Invalid parameters
</div><div>
</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>