Files
authentik/website/docs/developer-docs/api/reference/providers-rac-list.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

655 lines
28 KiB
Plaintext

---
id: providers-rac-list
title: "providers_rac_list"
description: "RACProvider Viewset"
sidebar_label: "providers_rac_list"
hide_title: true
hide_table_of_contents: true
api: eJzFWN1v2zYQ/1cIvWwDXDtL+zCkGLCgSYsAbRf0aw9FINDS2WJNkypJJXEN/++7I2WLiiTHzjbsIbEk8u5+98k7rhNdguFOaHWVJ2dJafStyMHY1PAslcK6ZJTkYDMjStqEWz6cv7qud7EvAu4s0J6SG74Eh5TJ2dd1Imjn9wrMCtcUruArL0spMi8rTYVVlZS4aLMCljw5WyduVdK2qdYSuEo2m1E/H/pBBnDPM9fHwDoj1DzQ1yTaIFr6OEoMfK+EAVR2xqWFUVtEW9W/CpEVbCZA5sxpVllgdwUotmXHXAHMgK2ks+MDoZR8DkfCOGdExFS1nKLN74QrhPKi8bNQ3EFeg2Doi14cQjmYg+kASa34cSya9wGGnm01J9MYcJVRDGPJYz0YhAVusuJoewQyhuG23G/3m1Hi+JxisgntBD9ayCoj3MoHK6/QmMqJBb7dEAkqVmplwRLL05MT+sk0wleOHqNAnnyzBGndhaCn38DHJ8pFszgRuNUuE4Fq/14F9y7aFfyfbGgb3Apd2d7FTFeqnwxVNjCw5rTjMiXf9XO1jhuXCpXDfe86qHxwdRO792tQK1JiC7kB2IbTFh6LIu8KJ0nWdWNXL85HZoSFG8MpkoSDpe0z/XCR+4i5ziUmiul6c9ET3ySe538qidHlTAUNyKsLAhdCvxOro10c1jVyJvVdd98omWmz5OjFpKpETmURCymfkoAgra3Ja+RClStnSMfaIkI1o0rCrdWZ8KUkim4mLONZBpbIpyvGFavUs4gHfkbWZrxFr434cRz4IbAe2ZZlKLUIZpvD45AF3hWrdImQccsh7h7AsfF5s8Skb+fHbnsb5htwLAQO21ExqxEjd+wO2EKhGgX+YWWEXDhv4l2ktaODLGetmCvI0/iEtLKaP47kCmPOKC5bXqMAGwUz4kHx+cNbfzgdJrY/ODsVuKH4ybJc2FLyFXuPtPslTXm2yAquFMj/S9khCP+J4rdgptrCgcw/hEM0BAqyb1E/wj0tZWW4PF5IoHtUFvZ2PF3qHK12lDJi6zNPy4bYY+Pi6hTGN125UluXUmt5cE5vetjioa1QTfIv3JcCe4lHcV9QE7sUCqzPYKmx9nBsODB+MNokt9jqsQuYceq3sAk6YUvsVm3IfcrzeqsNe7FgOiH9wtRobJYNFdVMoq3zMfv5tS9DZyiqMvb3Z7++RMmVA3w8fYk9ilY5Pj7/hZRD8yG01OkFqBQVwuCr1etpnrudLJZTNCdVJH9KsMY0zLO02FhKyabAgiCs7FjYWCNl3DnIhwvIvpp2aC4eWjZ6T564nHeDtz6D24E2otP8Qcr251jUdkR9AprngX2iXq9pSbo9C+QRl7c0cnlObQdSBLz4h51om+MX7GnyUEMvjdHd5kaRMWn2SYHWjzhew3Ga93U5VIpzPBJRLJfXsbxNY5gGWkA2aI/n/6I93oDCRi9j59dXAwbJMYxET4ndq20cEDWDKARqoXvUDLW30DSdz+tR2xX4MtkNNBOc1SfUJoO53Q7glZG0h5dicvt8kmyimecjGSRoFE0+O+yFc+V2pvIlBWetuosXaqb9zhp9Q+4TxQbMpyenL8a/jU87Fn7HF9TJPehBrViW0h+f5Egeyhl6jCydFCCl/mOud5LGQpO90ctYsrzJ60ny3dUnZBHUJhXs2WQyx1G5mo6xFEwiFpPmaSr1dIKi1OTt1avL9x8vvZpUEpZcRcx3pmZoatZ3LRKF4cANSW1eh9PPBLsG4QcVj3dduzSeUTFweIb/KVgKxEOr6/WUW/hs5GZDn8NwTM7GIk0DQDM8L2A1eOFyy2UFIYMGKR9csewnGbTDsdcnvRYKgKILnCeCOfoSZQ+a+g7niUgOvUB5BMD27ubJ9nhwibJH3O6WppF1Qy84F/u58+sNbi2w+cI6QfEYqM5xcizj8OlUZ+KyK25vLj/VZ3ncz4TiM9o+EPftGaRWEW/MDb/jE/UymB9b6L63QUFYW/8GWINW4g==
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={"providers_rac_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/providers/rac/"}
>
</MethodEndpoint>
RACProvider 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"}
>
Query Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"application__isnull","schema":{"type":"boolean"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"in":"query","name":"name__iexact","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
>
</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={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
pagination
</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"}}
>
<SchemaItem
collapsible={false}
name={"next"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"previous"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"count"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"current"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"total_pages"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"start_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"end_index"}
required={true}
schemaName={"number"}
qualifierMessage={undefined}
schema={{"type":"number"}}
>
</SchemaItem>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
results
</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"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><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","items":{"type":"string"},"readOnly":true}}
>
</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><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"pagination\": {\n \"next\": 0,\n \"previous\": 0,\n \"count\": 0,\n \"current\": 0,\n \"total_pages\": 0,\n \"start_index\": 0,\n \"end_index\": 0\n },\n \"results\": [\n {\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 ]\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>