Files
authentik/website/docs/developer-docs/api/reference/crypto-certificatekeypairs-view-private-key-retrieve.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

359 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: eJytVd9P2zAQ/lcsv2yTugYVHqY+DUGFqo0NwdgLqqprcm1MXdvYTllV5X/fXZLSQAMPG09xzvfru+/uvJXWoYeorBlncihTv3HRTlP0Uc1VChGXuHGgfJiuFT5OnVdrEk5JOvUYvcI1yp7MMKReOXZDTq4xFt6IlpPPpC8qN6LxIFgCJhPaLgSkKYZAfhx4WGFEH+TwbisVe3so0G/oztAN/Wb20WgLGUlCmuMK5HAr48bx3cxajWBkWfYaYwcx39su3bQoVKdpICxmQTdz61cQSVJpli+xnYrb2/G5qNWFytAQxg2fY66COGth/kYIrwhzn7x6fCiURypx9AWWk56MsGCQTcUlSQKmhVdxU0GHIubse0l/E9b3GJw1AQMnPTg64k9qTSQlPoJzmsNSlsl94FS3hyDt7B7TeMDXBcZ24pQ3p/0hiAwiMCuemySqOnYl7CicR8h+Gr1pIJZt0He1FcNWUbNZK945X5XlQam5+CfvCvQ3aJVVpmLkvfUH2Iw107lCnU2R70PLJXgP3IYq4ioc4uf0U5th9w1kmeKwoK/a8cp9Pfap1Zm9Wo/jdyXeoFepOL0av1KQDCMo3QHqLbTPeK8dtJhvgr4Bk0S0BHLLC2mBsdoLNMZDmdTDknSsp2TbDHeZvFxUCc87+vVuqxResy9wKlkfJ7Jsjd4NF65G3hrAJ4x5jG63PKp9g+DRVwkrM7eVZoNyb96THLnGNjganPS/9AcHTFzCknfIzqrmUwS1chp5fzDhkFaEE7PMiMxRa/t1YZ8i9ZVlXqgbkPZE1c712rsc/yIXNWyGEIZJslAxL2b91K6Slotkf5ppO0solEm+j89GP25GFUxnQ1yBaTmvKREdlAgm4tm+f+3FaDX0fzweDUkR/8TEacqcq1Gh3jYN9LRtqaCH+ZJ0uH8hXnYRibiLcyoAO9puZxDw1uuyZHH9SHF3ZSrATHPzz0EH7Em2ffZsrUEXWDX6hH+8Yv1u21er9PG6mbFP4h9fpM5q7Xad2bTz3GHYFaeckGpO6556n9Oub0+JBxdbdgebifE+DfbFiJuS+639gNcD1dsd2HtnTlT+SuOXXaIhCnYpRv7nBMvyL+DyFg8=
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={"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>