first pass

This commit is contained in:
Tana M Berry
2024-10-22 15:10:13 -05:00
parent 63c3da169a
commit 7a6d44d0df
878 changed files with 474272 additions and 31 deletions

View File

@@ -0,0 +1,724 @@
---
id: rac-endpoints-update
title: "rac_endpoints_update"
description: "Endpoint Viewset"
sidebar_label: "rac_endpoints_update"
hide_title: true
hide_table_of_contents: true
api: eJzVWG1PGzkQ/ivWfrlWIgkEClyqk44WWiHRFtHS+8ChlXfXSdx47T3bG0ij/PebsXezzitB6rW6D6CNPZ73eWbsaaQKpqnlSl5mUS/SNI2ZzArFpTVxWWTUsmgvyphJNS+QDIguKgLylbMHwywQFFTTnFmmTdS7m0YcyQpqh7AlYQN/JXlcljyDFZMOWU6j3jSykwL3jNVcDmCnr3ROLaw4ytmy4DNye3t5Tjw54RmTlvcn+G2H3JCbs7ek1q0N3DT7p+SagV1Wl2x2vxdZOkAF0czo3hMwY9+obILapEpaYImftCgET51fOt8MCp+uqq2Sbyy1m93zmWlOBf/ONHpIo6ctZwY5eKesOiDn8orJATiudzBzh8Zgpg5IgTEbwIrftSpVAneZLHNnWVYAm7FM0c9miFYuy7DcCly4ro5f4FFgN1TG7qATBNzCBpoxm5s1iXNwWbVcc6Ba0wkw4JblZodwAzta2mGcq4yFNhkLgUi9D/PCbrPpDM5/gOO1TTl95HmZxxBaCbGCAJk1vpzTRb3uwdHJ0enh8dGJM9wvtuarp6hkk1d3gcKVA6uED6IThPG+0bTOkhufg2D9bCVj0dlpqbmduKpCWZjyI/h1P3P5awqwyKdUd3//JydxMXo6qKgkzT5JMfE2BemX5KQu8/XlsEsBuN0YjHAGC/Gp71y13TgAiuvq6M72NbmyyaDL862m1NHzAYn7Qj3s4j5ZCkETFOClLVryDriQ0rCMwDmyKII8wA9ARkaoMSrlAOUZCXKCAGTSNGUGjycTQiUpZSvgAcvAWrdr7ZXm35+n/CZlnWY1yzl+1+FsRz8eWFJADiWrwlgmX1TzPbPEJw6ZnyJGgY7UkgdGRhLMGMKfVYRl3DoXzzNtMTvQc8bwgWRZHLg+NqIcPK3JJeScllQsRA0TbM+7kUtye3Nl2juL3dR2ltpsc+I3QzJuCkEn5COc3S4poekoHVJAWvGrjN2kwn9i+JjpRBm2I/MbZkstq0QB9gunn+AeF6LUVDxfiD/3pCwY3ajrYuJ5xvA6Zu4s2cR+cWRQpS2gU8Y4Oe5c07M1bJumHrPHguvJ03qf44wKfZ0ZV8FCAfZQAh3UYLYJaqxpk3PWp6UAEOiTfZIzKo2vfazzitR4WgBMy4XbSLSCWVgjqKYCfJ21yYt3DoZ6IKrU5o/WwWuQXFoGn93X0NmVzODz8KUfdAWoFls1YjIGgyD5KvMCoxKlBKizYtVfCKfgTkQk1yVI4xriWBrywIUgCSNeECA7ABtppLSjlclmI4Bsw7Rda3FX2FjbeUI4X03e+QQWJtoedvOlkl1fY8GMFswJkZ+3ljLwp0zg/7eZW9BSpsO41Gvxavs886bkAoaU1JYAKp4Roj55gSVWzweEW8NEn2QKylgqS4Z0DB1YQt5/K439W3KZcaBEHvPL7Mu1uPcLrgeBe5q7wmjDhWFpxl1zf/AXh0UvYhSOfuh14CuMyJlvyRdaqzUXWqxNzkQWM9x/Rkr66SxbNzRjcmYwYYFYKq5DebPGEY1qXrON/jj8gf54zyTcG1Jydn25wSEZoBJfUwFbrQ1Tp2IQhLwSusVM38qHCp9yitI/zOC9PepomnbmtdCZ1q8xsw6iFNPj+uXGVW3UoQXvjA87DvXqO+hn9I03LriJzs0YWlvUjzuuWTGqETdBJ/TuTfPWcvFI80Kw5h2kQYfmvrcfomsFqh4fG+onYfEuOuzT01f946PWq5ODk9bRq+NuKznsp61u+vvxYf/4mPbpMfo4AMEG+9bCwz6I4rKvnOlVZBp/uJ5ifDy6+92j9mm7u5I9H+gILz1L1zXD0Stt192kpb7zQzZiFkVDJoT6c6DmktpcObDlKXT30JcfLr8ACx9HjInpdToDbodl0oau2QlYdJqvRKikA6Jk5+ry7cXHzxcubtg9cyoD5pBGDaSS9e+DQZGteyqs0sWyR9uB+ZpLNKNqFj5b/fvcXjQXBN+94P0Q4+VT4S6aThNq2K0WsxkuQ47hGHgHn2MKF3vXaCCtYdDBb6iLPhVmue2EGr+4qWrwJXnmc+Naw2oMlIiAYypK/AWfIzYJH0Vn99j+oT1h6oO+fvut16r1BZk0x1eAa7ZXnziD+3xht9LeBxhxfYu5klTvn1X6a4oTFv53mqpi3hfd2hQ6mByUdIC0nmU9RYSjqq/+vfojeJRZ9AUE0FF8wTEVgli7xo2t6JfZ7F8dO+fO
sidebar_class_name: "put 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={"rac_endpoints_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
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><MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3><strong
className={"openapi-schema__required"}
>
required
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"provider"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</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={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</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={"maximum_connections"}
required={false}
schemaName={"integer"}
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><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>