Files
authentik/website/docs/developer-docs/api/reference/crypto-certificatekeypairs-view-certificate-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-certificate-retrieve
title: "crypto_certificatekeypairs_view_certificate_retrieve"
description: "Return certificate-key pairs certificate and log access"
sidebar_label: "crypto_certificatekeypairs_view_certificate_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVd9P2zAQ/lciv2yTugYVHqY+DUGFqo0NwdgLqqprcm1MXdvYTllV5X/fXZJSQwMPG09x7vd33/m8FcaigyCNHudiKDK3scFMM3RBzmUGAZe4sSCdn64lPsaKqcPgJK5R9ESOPnPSchgKco2hdDqJbD9TlKQOE0sT0HmizCKBLEPvKY4FBysM6LwY3m2F5GgPJboN6TRp6Dc3j1oZyEniswJXIIZbETaWdTNjFIIWVdVrnS2EYu+7tNOylJ2unrDoBWnmxq0gkKS2rF5iO01ub8fnSWOeyBw1odnwORTSJ2cR5m+E+Yow9ymqw4dSOqQWB1diNemJAAsG2XZckMRjVjoZNjV0KEPBsZf0N2F7h94a7dFz0YOjI/5kRgcy4iNYqzgtVZneey51ewjSzO4xCwd8XWCIC6e6uewPPskhALPieEiCbHLXwo7GOYT8p1abFmIVg75rvBi2DIrdonznrKqqg1Zz80/eFehvUDKvXZORc8YdYNNGT+cSVT5F1vsoJDgHPIYy4Mof4ufyM5NjtwbyXHJaUFdxvmrfj31pTWWv9uP4XYnX6GSWnF6NX2lIjgGk6gD1FtpnvDcBIubbpG/AJBEtgcLwQlpgqPcCXeOhSJvLknasp3TbXu4qfbmoUr7v6Na7rVI6xbHAynR9nIoquno33LgGeXQBnzAWIdjd8qj3DYJDVxcs9dzUli3KvXtPcOYG2+BocNL/0h8cMHEJS94hO6+Gz8TLlVXI+4MJh6wmnJhlRkSBSpmvC/OUqS8N80LTgLQn6nFu1t7l+BeFaGAzBD9M04UMRTnrZ2aVRiHS/WmmzCylVDr9Pj4b/bgZ1TCt8WEFOgreUJJ0UJIwEc/2/WsvRjTQ//F4tCQF/BNSq6hy7kaNetsO0NO2pYYe1kvS4f6FeDlFJOIpLqgBHGi7nYHHW6eqisXNI8XTlUsPM8XDPwflsSco/PNnaw2qxHrQJ/zjJNt3+77apY/X7R37lPzji9TZrd2u05u4zh2GXXOqCZkWtO5p9rnsRntKPNgQ+R1sJsb7dLEvRjyUPG/xA95cqN7uwNE7a6L21xa/zBI1UbArMfA/F1hVfwGmcRYM
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_certificate_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/crypto/certificatekeypairs/{kp_uuid}/view_certificate/"}
>
</MethodEndpoint>
Return certificate-key pairs certificate 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>