Files
authentik/website/docs/developer-docs/api/reference/crypto-certificatekeypairs-view-private-key-retrieve.api.mdx
2024-09-13 12:17:54 -05:00

360 lines
12 KiB
Plaintext

---
id: crypto-certificatekeypairs-view-private-key-retrieve
title: "crypto_certificatekeypairs_view_private_key_retrieve"
description: "Return certificate-key pairs private key and log access"
sidebar_label: "crypto_certificatekeypairs_view_private_key_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVUtv2zAM/iuCLtuALO7aHoacVrRBEWzdij52KYqAsZlYjSKpkpwuCPzfR9pO4jZuD1tPlim+Pn4ktZbWoYeorBllciBTv3LRjlP0UU1VChHnuHKgfBgvFT6NnVdLEo5JOvYYvcIlyp7MMKReOXZDTq4wFt6IlpPPpC8qN6LxIFgCJhPazgSkKYZAfhx4WGBEH+Tgbi0Ve3ss0K/oztAN/Wb2yWgLGUlCmuMC5GAt48rx3cRajWBkWfYaYwcx39nO3bgoVKdpICxmRjdT6xcQSVJpli+xnYjb29GZqNWFytAQxhWfY66COG1h/k4ILwlzn7x6fCyURypx9AWW9z0ZYcYgm4pLkgRMC6/iqoIORczZ95z+7lnfY3DWBAyc9OHBAX9SayIp8RGc0xyWskweAqe63gdpJw+Yxj2+zjG2E6e8Oe0PQWQQgVnx3CRR1bErYUfhPEL2y+hVA7Fsg76rrRi2iprNWvHO+Kos90rNxT9+V6C/QausMhVD763fw2asGU8V6myMfB9aLsF74DZUERdhHz+nn9oMu28gyxSHBX3Zjlfu6rFLrc7s1XocvSvxBr1Kxcnl6JWCZBhB6Q5Qb6F9xnvtoMV8E/QNmCSiJZBbXkgzjNVeoDEeyKQelqRjPSXrZrjL5OWiSnje0S83W6Xwmn2BU8nyKJFla/SuuXA18tYAbjHmMbrN8qj2DYJHXyWszNRWmg3KnXlPcuQa2+HB4XH/a//LHhMXMOcdsrGq+RRBLZxG3h9MOKQV4cQsMyJz1Np+m9ltpL6yzAt1A9KeqNq5XnsXoxtyUcNmCGGQJDMV82LST+0iablIdqeJtpOEQpnkx+h0+PN6WMF0NsQFmJbzmhLRQYlgIp7t+9dejFZD/8fj0ZAU8U9MnKbMuRoV6nXTQNttSwXdz5ekg90L8bKLSMRdnFMB2NF6PYGAt16XJYvrR4q7K1MBJpqbfwo6YE+y7bNnawm6wKrR7/nHK9bvtn21Sh+vmhn7JP7xReqs1mbXmVU7zw2GTXHKe1LNad1T73Pa9e0J8eBiy25vMzHe7WCfD7kpud/aD3g9UL3Ngb135kTlrzRu7BwNUbBJMfI/J1iWfwHdjRYO
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_view_private_key_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/crypto/certificatekeypairs/{kp_uuid}/view_private_key/"}
>
</MethodEndpoint>
Return certificate-key pairs private key and log access
<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><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":"download","schema":{"type":"boolean"}}}
>
</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={"data"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"data\": \"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>