950 lines
41 KiB
Plaintext
950 lines
41 KiB
Plaintext
---
|
|
id: sources-oauth-update
|
|
title: "sources_oauth_update"
|
|
description: "Source Viewset"
|
|
sidebar_label: "sources_oauth_update"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWm1vG7kR/ivEosBdUdly7Nh350+XBm5qIL4EjnNAG7gLapeSGK2WeyTXimLov98zJPdNWr2kda8faiCIVyI5MxzO88wMV4+RKoTmVqr8Oo0uI6NKnQgTK17aaVwWKbciGkSpMImWBU3DpA9uEvtVioURFsMF13wurNAmuvz0GEmaVHA7xVCOAZKblRN8MslUzHl0+RjZZeG+t1rmkw0N1zmE5Txj3h5GUgasNCJlMmcfb9+a42g1iLT4rZRawHCrS7G6H0SWT8iGah/RvZ8kjP2rSpekOFGQnVt65EWRycRtfvjZkOLHTQvV6LNI7IaF717BQSx44oPQkmfyq9DkDE0utRLaIcXvf3O/c5m/FfkEPrp80e/f7wxLpSkyvmS/QIjbsHPjN0o7xJeQwL9UEs5P6EQtrcLyf3064kdfXx398+Top/j+L38iM0TORxm5vbZkpFQmeE6DFDlwcHBsPM7Uos/ksdJzjmOIylKmFChllpFUf5brm/gbpDCryGy2gHjW1pJPmPgijXvABO2DQ+RaZdkck/5bNngNpDUXi5ZmeopDGCzjOcIMc0zLAK41X0KftGJu9hu2gsyJVmXx1EILhfhfxjh3mYt4rlIXqiIv54QhnmVYxfMloWhdmJWW/BS9dyKunIQbElDtH6qSKebWYiHu3djxQ6VApnSCY+lgA9TJLIY3Z/UHDNOGSBwFbTVYf3bjO2z7iIk3wQyy7Yr0Ekt0z/XvdKxTUeEjJSIDoIRhcsx43o0tZqaqzFI2Eu0QBJaUZryOgxAaIm3FA/gwxtEA0HYvI9QH/q1ebPvpIB+9ITVP6SRnd8tLjmhq5/jRRAvymXMOQvoBW9Cxt7AVfmBnyj2I+FymoO3c8zD/WmI5wRX0mChNT2OeCFAQ7Xoi7bQc+QeAmR6UmjhJFFQJmAAyZ5a7vGW1wPYoSaSpJOl2IeGL8IA97oz9YPodxr3b6mwTWzUTeVzqrO+od/MMKNl7DVwTxDnXy1xapBnmRB+zu6k0RN8Mf1SeLVmVDRmAznx+erFG7afn54GhlZZfPUH/2zaSTS7YYQDUQnViyWb8w2lVVhP39luRIEGbJ3HUaFmDcea9BgHiQXhXrec3rx5xN5aZeGLNE2GDT3JPt5jfqx4eMuUcYT8TywPYoJ5uBMBj+1YsNJj/HQKhMnlNBKcIhzk8iwGbQvTkCMxSgFq8EFkWz3K12HIw1bzPi5nZPwOjq06x9qm7+83dhbJxnRxC/XPfINBFuS+Xbj1SkNc2C0MsFEkJ/ywdc9Ynhk/3K1cimgImeJecnpz8D+rEYnZIgULE1z7imolGc+az+mBrxfmf1pjPVeVzVXmQ0ETNgaaAnd1R9AZ06YHD6lWIKCQObtlCMOIgNvUOQobxGaVGWhcN0Pwg9EgZER8GgVthS50HcUBCZ/Ue6XGRlZr3Zo7dSvy6vbrQTXNX82XfthlZwdKtZdvEPxf+f0jhP+c5n3QYbWt9UZl+45d0CovNpOKiyXiYcC3YvGcVVYjCVHAxbl4ovLG5lPnLnZQWKCpUEpzTMpSV44xPfFEp89Tts1KW13jFI3yhEMlUeSBXkva5nPjbJHPM/qFKNws+zFxAyvGyBWAATnL3+dX76wEblRYOL5zoKc8npFGta0Bq4YwaKB3MP+6L7kP6LUyTiU/l+45mQ/5za/bcmj23Zv+nrRlNANJHPJltM3CzxvFH/jqso9Do463DOrQKjA3d7O5AmqbDRZ8v/O98P3XIXfXeuooYV2cmTkqDTILYdWfTV8QfhMD1Hqd73IdiZL+UA2J8r5A9kbp3/UHd9qFytnfjeyWstecbvulzet2kd5X3b6rrqr5I6AuitchrNf6tKPYN/BqU/qBrjDYRtBufwfoNh6s1moJws8Bvrjxm2+49AvTXnNLfl/TfkfjLkS490B5fPumVx69gm9QtZVdaq553YtTAS5GlsaDxb2g3fXuZ9pFQhz/ft/WtGl80pnnLtvrj7An98UbkoOCEytwtDkHJhvqnP9ds3W07EIOA1qkHpTu26bvMqaLXvkXpX+NSEoyG4eXp0L0EHj5S8K2GFIVCP1TveB1coiEv5PDhbOhAWN2xfSC/+I21btrqLUytLaLwKtjlB4HORDt7yLO3zevaqy98XvhcUr1GrvjMX1I1n+u7I09vvbdF0dmY/3g+vnh5dP7Dix+OXp5fnB6NzsbJ0Wny08XZ+OKCj/lF1HPFc+jCbTc0nw4TcL/jPuZwEX2tfejo+9rzbo/S1zk1Tu7te7oC1lqGulPoyfyN3J6E3hrcyNPNWCf9Nl93C7ie76tL9JaWzdKrGexNJmvDTQ7pGQipgwpPB4SA0XaDT8DyyDw9OX15/OPxiw0eueEz6uK6sc2MJIwc++1Znji6ctcohDUYrX6eqOZSQCpiFYQIiu82sm6u73wKDgg1l8Oh79eOkdaGLRHD5mmUqdEQqvLh2+vXV798uApvlY1FomvD1hMKc0JY/69KWnS7+QOTEE1WfLFDhKXMQ9Hpbs4dazU/+YDfSQ3+Xoa0SbCYwiia9fg44kZ81NlqRV8jKjW9FMDjA0ed7Eoi0Bv610AoY56Z9Sajbev3t4GH/8y2GVphwV1qPfCspE94DOFJRq7uMW+KKgYoIv1+6LXXchSq9WrpRjJaDaoVr4CWwu6ce9/i/fcf6dRH4acxAdCaUx9O/zsrldu0o3P33WOU8XxSoo7BuBe5ClV5u+r3rD6oHlp9StcPOBA3444AjkOp3OIAT35ZrX4H2nbTww==
|
|
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 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={"sources_oauth_update"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"put"}
|
|
path={"/sources/oauth/{slug}/"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Source 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":"slug","schema":{"type":"string","description":"Internal source name, used in URLs."},"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,"description":"Source's display Name."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"slug"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty` and `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
|
|
schema={{"type":"string","minLength":1,"description":"Internal source name, used in URLs.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"enabled"}
|
|
required={false}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"authentication_flow"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when authenticating existing users."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"enrollment_flow"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when enrolling new users."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_property_mappings"}
|
|
required={false}
|
|
schemaName={"uuid[]"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"group_property_mappings"}
|
|
required={false}
|
|
schemaName={"uuid[]"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"policy_engine_mode"}
|
|
required={false}
|
|
schemaName={"PolicyEngineMode (string)"}
|
|
qualifierMessage={"**Possible values:** [`all`, `any`]"}
|
|
schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_matching_mode"}
|
|
required={false}
|
|
schemaName={"UserMatchingModeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`identifier`, `email_link`, `email_deny`, `username_link`, `username_deny`]"}
|
|
schema={{"enum":["identifier","email_link","email_deny","username_link","username_deny"],"type":"string","title":"UserMatchingModeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_path_template"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty`"}
|
|
schema={{"type":"string","minLength":1}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"group_matching_mode"}
|
|
required={false}
|
|
schemaName={"GroupMatchingModeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`identifier`, `name_link`, `name_deny`]"}
|
|
schema={{"enum":["identifier","name_link","name_deny"],"type":"string","title":"GroupMatchingModeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"provider_type"}
|
|
required={true}
|
|
schemaName={"ProviderTypeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`apple`, `openidconnect`, `azuread`, `discord`, `facebook`, `github`, `gitlab`, `google`, `mailcow`, `okta`, `patreon`, `reddit`, `twitch`, `twitter`]"}
|
|
schema={{"enum":["apple","openidconnect","azuread","discord","facebook","github","gitlab","google","mailcow","okta","patreon","reddit","twitch","twitter"],"type":"string","title":"ProviderTypeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"request_token_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL used to request the initial token. This URL is only required for OAuth 1.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"authorization_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL the user is redirect to to conest the flow.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"access_token_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL used by authentik to retrieve tokens.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"profile_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL used by authentik to get user information.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"consumer_key"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty`"}
|
|
schema={{"type":"string","minLength":1}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"consumer_secret"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `non-empty`"}
|
|
schema={{"type":"string","writeOnly":true,"minLength":1}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"additional_scopes"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_well_known_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_jwks_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_jwks"}
|
|
required={false}
|
|
schemaName={""}
|
|
qualifierMessage={undefined}
|
|
schema={{}}
|
|
>
|
|
|
|
</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","description":"Source's display Name."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"slug"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
|
|
schema={{"type":"string","description":"Internal source name, used in URLs.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"enabled"}
|
|
required={false}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"authentication_flow"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when authenticating existing users."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"enrollment_flow"}
|
|
required={false}
|
|
schemaName={"uuid"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when enrolling new users."}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_property_mappings"}
|
|
required={false}
|
|
schemaName={"uuid[]"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"group_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={"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={"policy_engine_mode"}
|
|
required={false}
|
|
schemaName={"PolicyEngineMode (string)"}
|
|
qualifierMessage={"**Possible values:** [`all`, `any`]"}
|
|
schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_matching_mode"}
|
|
required={false}
|
|
schemaName={"UserMatchingModeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`identifier`, `email_link`, `email_deny`, `username_link`, `username_deny`]"}
|
|
schema={{"enum":["identifier","email_link","email_deny","username_link","username_deny"],"type":"string","title":"UserMatchingModeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"managed"}
|
|
required={true}
|
|
schemaName={"Managed by authentik (string)"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","nullable":true,"title":"Managed by authentik","description":"Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"user_path_template"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"icon"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","nullable":true,"readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"group_matching_mode"}
|
|
required={false}
|
|
schemaName={"GroupMatchingModeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`identifier`, `name_link`, `name_deny`]"}
|
|
schema={{"enum":["identifier","name_link","name_deny"],"type":"string","title":"GroupMatchingModeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"provider_type"}
|
|
required={true}
|
|
schemaName={"ProviderTypeEnum (string)"}
|
|
qualifierMessage={"**Possible values:** [`apple`, `openidconnect`, `azuread`, `discord`, `facebook`, `github`, `gitlab`, `google`, `mailcow`, `okta`, `patreon`, `reddit`, `twitch`, `twitter`]"}
|
|
schema={{"enum":["apple","openidconnect","azuread","discord","facebook","github","gitlab","google","mailcow","okta","patreon","reddit","twitch","twitter"],"type":"string","title":"ProviderTypeEnum"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"request_token_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL used to request the initial token. This URL is only required for OAuth 1.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"authorization_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL the user is redirect to to conest the flow.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"access_token_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL used by authentik to retrieve tokens.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"profile_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
|
schema={{"type":"string","nullable":true,"description":"URL used by authentik to get user information.","maxLength":255}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"consumer_key"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"callback_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","description":"Get OAuth Callback URL","readOnly":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"additional_scopes"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={true}
|
|
className={"schemaItem"}
|
|
>
|
|
<details
|
|
style={{}}
|
|
className={"openapi-markdown__details"}
|
|
>
|
|
<summary
|
|
style={{}}
|
|
>
|
|
<span
|
|
className={"openapi-schema__container"}
|
|
>
|
|
<strong
|
|
className={"openapi-schema__property"}
|
|
>
|
|
type
|
|
</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"}}
|
|
>
|
|
|
|
|
|
Serializer for SourceType
|
|
|
|
|
|
</div><SchemaItem
|
|
collapsible={false}
|
|
name={"name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"verbose_name"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"urls_customizable"}
|
|
required={true}
|
|
schemaName={"boolean"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"boolean"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"request_token_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true,"nullable":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"authorization_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true,"nullable":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"access_token_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true,"nullable":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"profile_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true,"nullable":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_well_known_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true,"nullable":true}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_jwks_url"}
|
|
required={true}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string","readOnly":true,"nullable":true}}
|
|
>
|
|
|
|
</SchemaItem>
|
|
</div>
|
|
</details>
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_well_known_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_jwks_url"}
|
|
required={false}
|
|
schemaName={"string"}
|
|
qualifierMessage={undefined}
|
|
schema={{"type":"string"}}
|
|
>
|
|
|
|
</SchemaItem><SchemaItem
|
|
collapsible={false}
|
|
name={"oidc_jwks"}
|
|
required={false}
|
|
schemaName={""}
|
|
qualifierMessage={undefined}
|
|
schema={{}}
|
|
>
|
|
|
|
</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 \"slug\": \"string\",\n \"enabled\": true,\n \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"enrollment_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"user_property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"group_property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"policy_engine_mode\": \"all\",\n \"user_matching_mode\": \"identifier\",\n \"managed\": \"string\",\n \"user_path_template\": \"string\",\n \"icon\": \"string\",\n \"group_matching_mode\": \"identifier\",\n \"provider_type\": \"apple\",\n \"request_token_url\": \"string\",\n \"authorization_url\": \"string\",\n \"access_token_url\": \"string\",\n \"profile_url\": \"string\",\n \"consumer_key\": \"string\",\n \"callback_url\": \"string\",\n \"additional_scopes\": \"string\",\n \"type\": {\n \"name\": \"string\",\n \"verbose_name\": \"string\",\n \"urls_customizable\": true,\n \"request_token_url\": \"string\",\n \"authorization_url\": \"string\",\n \"access_token_url\": \"string\",\n \"profile_url\": \"string\",\n \"oidc_well_known_url\": \"string\",\n \"oidc_jwks_url\": \"string\"\n },\n \"oidc_well_known_url\": \"string\",\n \"oidc_jwks_url\": \"string\",\n \"oidc_jwks\": {}\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>
|
|
|