Files
authentik/website/docs/developer-docs/api/reference/rac-endpoints-retrieve.api.mdx
2024-09-13 12:17:54 -05:00

616 lines
27 KiB
Plaintext

---
id: rac-endpoints-retrieve
title: "rac_endpoints_retrieve"
description: "Endpoint Viewset"
sidebar_label: "rac_endpoints_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJzFWG1v2zYQ/iuEvqwFUitNgrVwMWBZkxYG+hKkTfchCwRKOtusKVIlKSeu4f++O1KS5dc4QId9CEJLx7t77v00j3QJhjuh1SCP+pHhWQIqL7VQziYGnBEwhegoysFmRpREiGSXNQn7JuDegkOCkhtegANjo/7tPBJEVnI3xlcKX9CvtEiqSuT4xGZjKHjUn0duVtI7i4LUCN8MtSm4wyeecrEu+Jzd3AwuWCBnIgflxHBGZzcWll2fv2WNbj3kZuBHJQwgMmcqWNwdRY6PSEECGuFPC1llhJt5nXnlxsRwgr/uiNiALbWyYEnTk+Nj+pdp5ZCIjrwspci88eLvlvSbbyLT6XfI3G4LfgEjuBQ/wZARDbnDiSCxnDxuIVKS55+VnAWMiFA4SReu0oI1RgweWOe18AKnaEXTeYlKwQifdN4mCMIDlvLz0JtqPzh0w1V99WB8jdjdgAYXe6E03gsOSYZS3x9iPlVJyVMSEKStInmHXFhlIWd4j62KYPf4A+MOGLdWZ4I7JOvEBMOA5FkGlq6nM8YVq9SLDg98jKxNr9FeG/HzacrvUtZr1rBss6NxZ6/2LblilhSoMpLYjjxuDJ8he+GgsAdkKbLLdIGpUifGOvmqmu/BsRA4rL3FrEYduWP3wCYKYYzxz2kGuXDexG2krUYHWc5aMVKQJx3TJ1ZWo8c1GWDMGcXlitcowI6CGYViN9cfbO9gsduDc6OILW/8ZlkubCn5jH3Cu/slpTybZGOuFMj/C+wuFf4T4FMwqbZwIPNrcJVRdaAg+5Xbj3BPSlkZLp8uJNx7VBY2Rp4UOkerPQmMaHzm77Jd7LEDuzqF8ZeuXKmtS6gvH5zTiy1ssdUphEn+hYdSmNnjel/QBFAIBdZnsNRYezjDDmop2iS3zvbYBQx5JbEIDNkxK4ArG3Kf8rwmtYEWC6YT0r9IjcZJw1BRzSTaOu+xZ+98GeqjqMrYP168fIOSKwd4PHmDnV2rHI+nz8MYIVG1xOkJqAQBYfDV8DqgUq0lqrOB6m8qp2hOqki+S7ClaZhnadm9kJKlwIIgrOxY2NhSSs9XyeU8crungOyraYfm4qFlY2vn6ZbzzeCte/BqoB1RN19L2e05drfs6J05IQrz1loEYpNyOtM+MUFVhZ/c8pI4q4zmSDv2/NZish2B6uuXdBXZjVHbraG/mkC/uDWSgb39uiisQ3tnYSQqSrcPxTne/4jXGxSSVyobJ5XZWq/2zzN/VULikJK5CotKYERVnz2jFGvmAyacBTlkucY0VtqxMZ9iB1YY998r6/5RQuUCKYlHuyw831r3+IMoqiJZpovdOvLVdFH/5OXZq7PXp7+fvcKHQoWHL9qnrzeSqLVt7d0V87SR6mOzDabO2Ls243ZisxnQ0YUbWwh54eyXrgPfcETOQ0u+NEZvzsqKclOAzBOg908IyTCd5duGZgrOHCcsFMvlVVfeYmmIpWpBs532OP2F9ngPCveGjJ1fDXYYJMeqJLZkwF603dCpGXRcXgvdAzO08rGmVXlUr7244vajGPfJuM2FeN7suouYqhSYabMX+6yNYl6KeHoa+6rX7KBfyDYBXGcTbWGMnSub1dk3K+CG6ibqJNRQe8oayPK6L8E2qH9yfHLWe917uWHsj3xCO8LadmNFUUo/mJFPeWiU6DwyejQGKfWfI91K6gnta5PIsBl669db/8fBV2QRYBME24/jkXDjKu1hk4k7LOLlKZU6jVGUij8M3l5++nLpYVKzKbjqMEerLysQ2/W5ohOV275c1PZ18OBiHEiFIiB1dQ3uDZ8LjqJWFJ77nc8ZFESht9xG83nKLdwYuVjQ4x8V0Nx0i8cpx03YV2aMA5wM6IyBNOTSrtfprsbPruugfc6e+PVjK7CmaCgqGVMuK/qFxwnMut9oFnfUL7Ge07cB1De8Psd1tnSdixs5TgHdpsj7y6/1gNEdskLcHjWHzueEVaXQkp7iKw1YaM1GRz9wkYKLxb/G6ZRR
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={"rac_endpoints_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/rac/endpoints/{pbm_uuid}/"}
>
</MethodEndpoint>
Endpoint Viewset
<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":"pbm_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this RAC Endpoint.","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"}}
>
<SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Pbm uuid"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"provider"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
provider_obj
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<div
style={{"marginTop":".5rem","marginBottom":".5rem"}}
>
RACProvider Serializer
</div><SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"ID (integer)"}
qualifierMessage={undefined}
schema={{"type":"integer","readOnly":true,"title":"ID"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authentication_flow"}
required={false}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow used for authentication when the associated application is accessed by an un-authenticated user."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"authorization_flow"}
required={true}
schemaName={"uuid"}
qualifierMessage={undefined}
schema={{"type":"string","format":"uuid","description":"Flow used when authorizing this provider."}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"property_mappings"}
required={false}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"component"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_application_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_application_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_backchannel_application_slug"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"assigned_backchannel_application_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"verbose_name_plural"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"meta_model_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Return internal model name","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"settings"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"outpost_set"}
required={true}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","readOnly":true,"items":{"type":"string"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"connection_expiry"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"delete_token_on_disconnect"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"When set to true, connection tokens will be deleted upon disconnect."}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"protocol"}
required={true}
schemaName={"ProtocolEnum (string)"}
qualifierMessage={"**Possible values:** [`rdp`, `vnc`, `ssh`]"}
schema={{"enum":["rdp","vnc","ssh"],"type":"string","title":"ProtocolEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"host"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"settings"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"property_mappings"}
required={false}
schemaName={"uuid[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"auth_mode"}
required={true}
schemaName={"AuthModeEnum (string)"}
qualifierMessage={"**Possible values:** [`static`, `prompt`]"}
schema={{"enum":["static","prompt"],"type":"string","title":"AuthModeEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"launch_url"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","nullable":true,"description":"Build actual launch URL (the provider itself does not have one, just\nindividual endpoints)","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"maximum_connections"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"provider\": 0,\n \"provider_obj\": {\n \"pk\": 0,\n \"name\": \"string\",\n \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"authorization_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"string\",\n \"assigned_application_slug\": \"string\",\n \"assigned_application_name\": \"string\",\n \"assigned_backchannel_application_slug\": \"string\",\n \"assigned_backchannel_application_name\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"settings\": {},\n \"outpost_set\": [\n \"string\"\n ],\n \"connection_expiry\": \"string\",\n \"delete_token_on_disconnect\": true\n },\n \"protocol\": \"rdp\",\n \"host\": \"string\",\n \"settings\": {},\n \"property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"auth_mode\": \"static\",\n \"launch_url\": \"string\",\n \"maximum_connections\": 0\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>