Files
authentik/website/docs/developer-docs/api/reference/crypto-certificatekeypairs-used-by-list.api.mdx
2024-09-13 12:17:54 -05:00

384 lines
14 KiB
Plaintext

---
id: crypto-certificatekeypairs-used-by-list
title: "crypto_certificatekeypairs_used_by_list"
description: "Get a list of all objects that use this object"
sidebar_label: "crypto_certificatekeypairs_used_by_list"
hide_title: true
hide_table_of_contents: true
api: eJytVd9v0zAQ/lesPIFUmjH2gPrEgGqqYGhijBc0RU5ybUyd2LMvE1GU/507J23DmiJAPOXiH+fvu/v8uY2MBSdRmWqVR4soc41Fk2TgUK1VJhG20FipnE9qD3mSNolWHqNZlIPPnLK8k/ZdAQopeEqYtZBaC5N+hwy9wEKioL0UKD+M0nYrnSwBwflo8a2NFCexEguaqmiC/rY2qWuV04DPCihltGgjbCxPeXSq2tDM2rhSIo2Eld1TVJfi7m71XvTLhcqhIlYNxwHMuwPLFx+gETfEc05ZHTzUygHVA10N3f0sQrlhnEN5IhrxkNVOYRPQyxoLzr2lv3te78BbU3nwDPr87Iw/mamQFnEordV8LKGMv3uG2h6TlM7JhtAohNKPxvclfMp1qvoO1uCgynrOIB5qcAryUR8cCwBVD5WAHZeZylqaHHTSN2Zi2m4nh0+ul1kPuo2gqstQWOkzmQMBGqKklBWz94BJVWs9hDmsZa2RO/BUC6hQ88Ad6fRtcxmOWHL6rhu39Nvu9Flg+wu3AXIgdP80I+XpjhTGbC7+rb8n+vhVapWHrWLpnHFHPapMlawV6DwBnvd/IJld5QlsRmynZ2SeKz5W6pvxed2hDgdoPbKT9Xj1H+txBRVJNhOXN6sTBckBpdKTQjvNdiyIIcGo48Ohv6HJlwKwMGyaG+gdjdxrEcW9R8QTFhq3g6d18WCmcZC1e9zZYO00p5BWxY+v4qgbGc0t12u4pQe72VMrEO3OKvk/BenABZyqWpuwciB32D6L+OSe0vnZ+cX89fzlUQOu5ZbdY7erb6PwqrQa2C25z3Slwm0uQyOiArQ2bzZmf9JcGW4HiQDIFYOKe5O/Xn2hFD1tpuAXcbxRWNTpPDNlPEoRH6JUmzSmo6r44+rd8tPtMtC0xiOZxih53wkx0Ql+kHKRNmLqMRtJ9+/ftaEdCD8wtpowMu/Arx0Usn9FqHTHyGh0cXj5BplQxOosiCHvb9tUerhzuut4mD2d3yEKH6VTMuUuk5hy5Tkmha6l9vAbls8+D7fhufjHJ3OS9s6VgpE/Sl3zH4XEdfS+d/e0tADyfBdg97OXWQYWR/uOPIQvx/4KXi1ZRyyR0Z0Y7sBsF3D2SUxU0LDii9lCRUXdQUT+Z4Bd9xMxoSsV
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={"crypto_certificatekeypairs_used_by_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/crypto/certificatekeypairs/{kp_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":"kp_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Certificate-Key Pair.","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>