mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 09:35:07 +02:00
first pass
This commit is contained in:
Tana M Berry
@@ -0,0 +1,728 @@
|
||||
---
|
||||
id: providers-oauth-2-partial-update
|
||||
title: "providers_oauth2_partial_update"
|
||||
description: "OAuth2Provider Viewset"
|
||||
sidebar_label: "providers_oauth2_partial_update"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztWllv2zgQ/iuEXtpiHbt1jnZTFNhsmnbdK0GO9qEIBFqiLDYUqZJUUtfwf98ZUrJkR3acbYMWizzE0MEZzj3fiJkEKmeaWq7kIA52g1yrSx4zbUJFC5v2w5xqy6kIizymlgWdIGYm0jxHClh/uIerjkoq8pGzK8MsLAM6mjELnILdz5OA4+Kc2hReSXgBdzyGaxOlLKPB7iSw49w9lZaNmA6mizvtkULyrwUj5QpySQXexUxanoy5HBGbckO8RL3DnMnBS1JJ1oW9NPtacM1ATasLNj3vBJaOULxa6+DcL2PG/q3iMcoVKdhPWrykeS545IzV+2JQqsl1BdTwC4vsTYY6YRqsyr+Dph3cHpxgOTPIx5tnxs9YDbrBqozLd0yOwIS7T8A66B5U3csTJkJdtVElSmcUpA+KwhlcFkLQoWDeCItSvgIupDAsJkBH5rcgV3ADNmaEGqMiDuEQk4ZJCBifRhEzSD4cEyrBYxsNHvAYWIMrSumV5t9vJ/wyYZ1kFctZJOQz309nNh6HGYgMS0xjP6o1HQN7bllmbpZjCuwiwUGr0C+EyBDiMHGBzmSRYUhB2CQ+NqlAFxdDsBOG1yJvyy16I9h3HE/h7QGywPCcV3e/wZH4/cHgmpGI5uhRohKSUcgO+PM2gFcNGm7HuAQec00iyAP/2HTJkRNujieXJdegVhZUvyEs4Y5+q+7629s1rWGwo22lX6TwMRRGKmYh5DiPQfCbN14oFo4HQR6GSGWJY0QgSDGsEyhLJCq0BsmI5Rkjf/iI8SXl4Svn7l2SqkKbF0+ew06FZeZF/zmooWRsXmw+8lHsRbXqgsn/LOspUt+llJolmpn0dxcTQk4U4PNIUJ6ZkEsIOC9zQ9ShUoJRea0WDDwxOTMojeNAEq0yYiLIewPx7PKh4tjx9a0uXgZeU0tiJR/Ysoo5AixYXCaKMBnnCpLLiWr4CFMsvGCtZrxdzX3Lxr6KWUWQsdvXSQmpeSjFmFSNy9e5N59OyZ4YQamzaYZFFxou0h6f9Ld3SofHsDyyYaF5az2bF+BAogsZjVJydjxAv1Ii2RURXDKvbjEMM0il9kqXUpOyOERLhU7dhavSCP4aflx/K++hdXIxe5nLVQXypBi+ByFWVcdRAaXryjmSWkoMxJyAXsS8fampIISLkoFHDhwaBIEgJZkyFmqpYabjXBCzhBbCNrgklUG4MQUIvNwmI6GGvu7DsqoPrVJu4DiupV8KXc/FsiMBoRhI5ws7AcTj8nROaCFY7MT+cnVhQgN5GLEfaH+10Hty7KIRo9b3fJThzae3lTiGCQhDeOU3BevKmTcgYpvYwAl4R4wbnI+oBcAWz6OxY4/4YCEuhbIEeYMFEhxacbqAu/OpQ4cmh3LhDdh//PiXQMT8ogUxo2w0xoJR1ZlZcL1E47bjynsk+auRpMogoMrwWV2oX0Oh97FDZlSQAb51XTFyIUENVx6gX0GPdyaeBdt8dKDljM+vsGH60IhidLMkA2wZEnBo02sYYB1vRmi3Z8fvTHftbZcNPQuwrqZ4YEjMTS7omHwA2tU7DWl0EaVUSiZ+lbLLRLgTxS+ZHirD1mR+zGyhZRkowH6O+gbuYS4KDZ3u1pt4uhv3ypilrs+K2ynDK585WrKM/f0Yt3QMu7vB7fce1X7b4ex+HLsfx+7Hsftx7P8wjtWf4j+vwIOrIOq60GpdFNg6SDTR+XUsUo5UHRzHFjBXO0g6r006P+sFbvCcjzB0wNZPnS8/Yp/w6PVAa9Vy8oB6Y/yGDN/fIij9IBO3zZfYe2PoabAtFUfN/RoRVovmJVtqj82faI/XTEI3icje0WCJQWLwOG8Btyu1bcZ2yaDh+HLTFWp61Juq2J+YRak7TUOYFfRmB1U9fzzXm/B42sNzNKYvq7O2QgtcS3Peu9zsueJVfdM4QdN43RpfNmZapNbm1aGca+8MQKR2IqFxj+uTsYNvNMsFq8+r6vLU+jkh2Ezos+1kZ2tj++mTpxtb2zv9jeFmEm30oz93NpOdHZrQnfYkXJu2ZTD/vB7t+cIksAj7G8i51nMBIDcM0IqDr71fRHz1gmWYsF6xCpx5UDOHida14AJSqferIcd1fDHXfetWO9/d1nWEA56JcjFZZkwdqK6qGp8n/cf9re6zbv9aVr+nFzg2LXxxMhzDtesqOoxWkSseHu6ASkwI9ddIzXbqcoU5DpUFUF8zyN8PThEeuQTDZDG7vd4IgF8x7EKn6DVY9OqrIZikhyNd791g/+DDyYFLqBzwTUZlg/ksuYlPblKevZP2s/dGHVx+DF/Gs2XfbC+HYJGol5N/UhaV5ul3J/A7w8Wu8y1mRgqC4rLJZAho7EyL6RQfQynQ+I0ULi+p5h5QQ/WJucFrSJUEptJFeN0U+uFxWSkfkR8/3G9VtGpeEluXY4kVthP4pMAPcBhwKaPYg1F4/2Lfi7iBU3yD8FqvmXYqChxic7ty7XmjrB/tne7/A6uH5f8YlLmjKUIO/HVSKmczV6zds0kgqBwVdIRrPdNp+QG0OZL5mt2pLlCtVjuAP90Kh1DBp5VZfBkBy0yn/wJNA/Qi
|
||||
sidebar_class_name: "patch 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_oauth2_partial_update"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"patch"}
|
||||
path={"/providers/oauth2/{id}/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
OAuth2Provider 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":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this OAuth2/OpenID Provider.","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>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1}}
|
||||
>
|
||||
|
||||
</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={false}
|
||||
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={"client_type"}
|
||||
required={false}
|
||||
schemaName={"ClientTypeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`confidential`, `public`]"}
|
||||
schema={{"enum":["confidential","public"],"type":"string","title":"ClientTypeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"client_id"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty` and `<= 255 characters`"}
|
||||
schema={{"type":"string","minLength":1,"maxLength":255}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"client_secret"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
||||
schema={{"type":"string","maxLength":255}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"access_code_validity"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Access codes not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"access_token_validity"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"refresh_token_validity"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"include_claims_in_id_token"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signing_key"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"description":"Key used to sign the tokens. Only required when JWT Algorithm is set to RS256."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"redirect_uris"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Enter each URI on a new line."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sub_mode"}
|
||||
required={false}
|
||||
schemaName={"SubModeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`hashed_user_id`, `user_id`, `user_uuid`, `user_username`, `user_email`, `user_upn`]"}
|
||||
schema={{"enum":["hashed_user_id","user_id","user_uuid","user_username","user_email","user_upn"],"type":"string","title":"SubModeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"issuer_mode"}
|
||||
required={false}
|
||||
schemaName={"IssuerModeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`global`, `per_provider`]"}
|
||||
schema={{"enum":["global","per_provider"],"type":"string","title":"IssuerModeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"jwks_sources"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid","title":"Any JWT signed by the JWK of the selected source can be used to authenticate."},"title":"Any JWT signed by the JWK of the selected source can be used to authenticate."}}
|
||||
>
|
||||
|
||||
</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={"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={"client_type"}
|
||||
required={false}
|
||||
schemaName={"ClientTypeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`confidential`, `public`]"}
|
||||
schema={{"enum":["confidential","public"],"type":"string","title":"ClientTypeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"client_id"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
||||
schema={{"type":"string","maxLength":255}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"client_secret"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `<= 255 characters`"}
|
||||
schema={{"type":"string","maxLength":255}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"access_code_validity"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Access codes not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"access_token_validity"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"refresh_token_validity"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Tokens not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"include_claims_in_id_token"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signing_key"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"description":"Key used to sign the tokens. Only required when JWT Algorithm is set to RS256."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"redirect_uris"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Enter each URI on a new line."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sub_mode"}
|
||||
required={false}
|
||||
schemaName={"SubModeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`hashed_user_id`, `user_id`, `user_uuid`, `user_username`, `user_email`, `user_upn`]"}
|
||||
schema={{"enum":["hashed_user_id","user_id","user_uuid","user_username","user_email","user_upn"],"type":"string","title":"SubModeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"issuer_mode"}
|
||||
required={false}
|
||||
schemaName={"IssuerModeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`global`, `per_provider`]"}
|
||||
schema={{"enum":["global","per_provider"],"type":"string","title":"IssuerModeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"jwks_sources"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid","title":"Any JWT signed by the JWK of the selected source can be used to authenticate."},"title":"Any JWT signed by the JWK of the selected source can be used to authenticate."}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\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 \"client_type\": \"confidential\",\n \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"access_code_validity\": \"string\",\n \"access_token_validity\": \"string\",\n \"refresh_token_validity\": \"string\",\n \"include_claims_in_id_token\": true,\n \"signing_key\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"redirect_uris\": \"string\",\n \"sub_mode\": \"hashed_user_id\",\n \"issuer_mode\": \"global\",\n \"jwks_sources\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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>
|
||||
|
||||
Reference in New Issue
Block a user