mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 17:45:21 +02:00
first pass
This commit is contained in:
Tana M Berry
@@ -0,0 +1,834 @@
|
||||
---
|
||||
id: providers-saml-create
|
||||
title: "providers_saml_create"
|
||||
description: "SAMLProvider Viewset"
|
||||
sidebar_label: "providers_saml_create"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztGmtv4zbyrxC6D73D+ZE4j25THHDpbloYl+0Gcbr9sAgEWqJtNhKpkpS9bpD/fjMk9bAt2/J2F4sW/rIrKjPDeb+s50BmTFHDpRjGwVWQKTnnMVM61DRNwkgxaljQCWKmI8UzhAOo0fXb2zsPSd5zttDMAJChUx1cfaiIBI+dQLHfc6bNDzJeBlfPQSSFYcLgI82yhEf27v5vGgk/BzqasZTik1lmDK6S499YZHZzMGKK04T/wRTAweUgkeFMIxVBU1ajpo3iYgpQKRe3TEzNLLg6fekENDcz4MpzE04SuWjCmkiVUuA9yHMew1nkSULHCcAYlbN1Hn8EKiTXLCaAR1avIAs4EHhDqNYy4qDlmNQUQrgmNIqYRvTxklBBctGt0YDXQFr1As+9VPyPw5jfxqzlrCAJqMAlMFPY1F7odbwMU2AZQHTtPqoUXQJ5bliq9/PxgvxHOsxVshtY8TWzwYl+LE6DkxOriJgzETVafFXc9zTJGZETZwKPRhRD8MgaYMJZEpcQYAeFr3vkV1RPwiaGsDQzyw4RspnAgicJGQNuHLPYqo1rnYOP7nHHdVavEy3Jk5ALsIomN2B+sxy+sXYvuArn4P5xKKQJxwxUttflN+4oKBFLCWQyxFEiUa4U+BwxPGXk384Z5lZ7//zRGueKzGSu9H+6p9/DFblh8Dj4XjOI9Bgez/7V28YrHKQK6cR8glJKhpFVxzQcMM6QXHuuK6Yrnj3LGqLvszE8csS+ILuY6kJg1Mfkp+QvcC08BD8DqeEbcufDnLz1JNeFei3FhE9z8JIZZA8MFI/peC8iwFWRuCF2KpQ7CalvWcQbF5FMMff46lGRkkJjGmIxihzzKfwxpMkUcpWZpSgzE3mKRWhmTHbV7y8Wi97irCfVtA854qR/8l3/Y5rEmk//oWf0FERqBDztn5wjIEQ1wg0uLvdBIsluChGD8GevzltSvjgdYJVct1RhiTdWwutCwBsUDl2TTwU1oPhPlV1p2m0jfyWVxzhIEx6nhTY2cFAvrXFYFB8sT4lzkEQl1kEylVg7pFoxTynODtcYFT7Q6B0AGz5lfyYJjBwV8j+2zChXG8Hv37umwUiCtxKZm6lErHumM4hVpok7AwAGNrRqcw6F8q7eTsyhf5sUvdefY/p9jRR5jSXCnjZbWJuKNEuguWRxp0o4ZZ36RpNSw7rMPzZ1u2ZtSrmAzGRzdVTd1CMP0BAktp0SqBOAvXdZTHcg+dE5w9QfswnNE2Plh1SgltlnkP6mJLTVanvlhr4T8rlnyTWfaLhhfAeWdu0gI1k+hnRNnliZsSsZ8C1eDYqod07Y0cZsjeqoTtQSVnwOSkQavcKVw5JGTTdjKUGXooRR3t+2gGThmIvYl0WwzrsJ5MkqYUI94crNGZnUZmfYZT84Si7aHmt/WfNt4gE3bPAws7qAwg+qB+fC4lm09k9gHCjqVhmFTGRMo6edEeS9CbSQ0GWoDXr83h74jUMiNSRfuHFegZLc5YIbN5okcgrebrt1LMkcCzDorejcG2cQ15IEdQ3VpjYfE0ByhSY6tO29oCWCRtdaqdQNnB5f7EzpkwsKOTg5/QqDZfZUo8Xh6qkFgk4nfieS5Xpkuoa9eRo9zp9fef6EFAju5J1nd8z8xAxxnkNKLKIxMik0qczOaa4ZlgRyirEqLl1t1TvcVGQrRFhTfaiTvLF7X+VkCD6nBE1WrIYO1nFq5IL8cn+re62v3bYqWRu8KgyokDHXGSQP28PvvglTWDSjQrDkawm7jYUvIjj0NGOpWUvi9wzaDOEdBcivYO+hHmZJrmjj9mT3JQ5v710pMzRMZQxaO0gYXtjM4pJt5A9Y/vxt1j1fZsHzF1jp/AWWOMe1zXFtc1zbHNc2x7XNcW1zXNsc1zZ/i7VNB1roJIyhxUwkhV4DWnoIB9pu3i2gSYGPs1ZTK493aC1Da4tWpEejd+QOoPdRLA3dmuq9x9hHGXXVnipqd1hqdxfp5CA13IIa3o0e9lE8UA1AVe1Uw/Zt3tYFwa6dRdtZu+1aYMtWsVrXbA6nfsfWwf3cNqdfs1CDetfcY82zG9xybd5vHtC3LELdBnTVfBix5ycnn3Gv+d5VQMzoN0rJhi9lUME4BIcM/37ASs2t0OKmzSZOiXHM8Vqa3NXve6kV/5I1x9lWfZx9Rn38xAT0HBG5vhtuUQhkesob9hI7pa2HkydQM7u/dIeYbt8yk/ZbLOdsGcWNR9Avv6rq46dZ/QBnWzXHr6ywJNoVStCnGe/Pz/q2wBU79BGqxMlU26SX3GNbi8QsFNZfBp2EsqygUu+r77duPtI0S1j1XVWVfRoX2MHZhL66mFyedy++Pf22e35xOeiOzyZRdxB9d3k2ubykE3rZHOWtcRtWwR/a4T7Wdk91QYqdUvWuWOTUoHYsZnZDrWwfKtA9a4oKcGNd0FZRm0N3+1m7cW49bFytDzdtWd4YMNoirnXmbdHWu1bXpa/1qf5lrTOtt6GNHV0tc3AxkTb2fEaoAtKKq10eGJwMznuveoONrPWWPtmuf/W3HM0xLHu2NApDXX8AWRCzVzBjMNT8dyrLm3pcIieQOZlvvH0wvx0+uNrmbavBuFOwdT7uQcnt10j0q6dxIsd9uEr0b4evb34e3djEgakrpaJGvMxeBLMXaf6wtJbdt35j6pKWYR9NP0vgXt/c2t/kbKasf38KhoLb4D+M9pntxz4Ez89jqtkvKnl5wdeQ3hT+zgiPc6q4G9A+PALZGXRLGH2QXmGwcYsz5K77gEwgOHTdaMT1OvTSKTCuo4hlZifsYy3lYxMIwGP/sWxq60ygKLY9+C+UiE4grbZsPrfvnoOEimlOpwjraL74X+XqY5VL653iAaUq6rtY1jgE9ViIB/nEBKio40UxeAZ2gfj/AV34XyY=
|
||||
sidebar_class_name: "post 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_saml_create"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/providers/saml/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
SAMLProvider Viewset
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<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={"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={"acs_url"}
|
||||
required={true}
|
||||
schemaName={"uri"}
|
||||
qualifierMessage={"**Possible values:** `non-empty` and `<= 200 characters`"}
|
||||
schema={{"type":"string","format":"uri","minLength":1,"maxLength":200}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"audience"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Value of the audience restriction field of the assertion. When left empty, no audience restriction will be added."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"issuer"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Also known as EntityID"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"assertion_valid_not_before"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"assertion_valid_not_on_or_after"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"session_valid_not_on_or_after"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1,"description":"Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name_id_mapping"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"NameID Property Mapping","description":"Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"digest_algorithm"}
|
||||
required={false}
|
||||
schemaName={"DigestAlgorithmEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`http://www.w3.org/2000/09/xmldsig#sha1`, `http://www.w3.org/2001/04/xmlenc#sha256`, `http://www.w3.org/2001/04/xmldsig-more#sha384`, `http://www.w3.org/2001/04/xmlenc#sha512`]"}
|
||||
schema={{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string","title":"DigestAlgorithmEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signature_algorithm"}
|
||||
required={false}
|
||||
schemaName={"SignatureAlgorithmEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`http://www.w3.org/2000/09/xmldsig#rsa-sha1`, `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`, `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384`, `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512`, `http://www.w3.org/2000/09/xmldsig#dsa-sha1`]"}
|
||||
schema={{"enum":["http://www.w3.org/2000/09/xmldsig#rsa-sha1","http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","http://www.w3.org/2001/04/xmldsig-more#rsa-sha384","http://www.w3.org/2001/04/xmldsig-more#rsa-sha512","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512","http://www.w3.org/2000/09/xmldsig#dsa-sha1"],"type":"string","title":"SignatureAlgorithmEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signing_kp"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"Signing Keypair","description":"Keypair used to sign outgoing Responses going to the Service Provider."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verification_kp"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"Verification Certificate","description":"When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"encryption_kp"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"Encryption Keypair","description":"When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the the private key."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sign_assertion"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sign_response"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sp_binding"}
|
||||
required={false}
|
||||
schemaName={"SpBindingEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`redirect`, `post`]"}
|
||||
schema={{"enum":["redirect","post"],"type":"string","title":"SpBindingEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"default_relay_state"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Default relay_state value for IDP-initiated logins"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"201"}
|
||||
value={"201"}
|
||||
>
|
||||
<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={"acs_url"}
|
||||
required={true}
|
||||
schemaName={"uri"}
|
||||
qualifierMessage={"**Possible values:** `<= 200 characters`"}
|
||||
schema={{"type":"string","format":"uri","maxLength":200}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"audience"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Value of the audience restriction field of the assertion. When left empty, no audience restriction will be added."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"issuer"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Also known as EntityID"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"assertion_valid_not_before"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"assertion_valid_not_on_or_after"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"session_valid_not_on_or_after"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3)."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name_id_mapping"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"NameID Property Mapping","description":"Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"digest_algorithm"}
|
||||
required={false}
|
||||
schemaName={"DigestAlgorithmEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`http://www.w3.org/2000/09/xmldsig#sha1`, `http://www.w3.org/2001/04/xmlenc#sha256`, `http://www.w3.org/2001/04/xmldsig-more#sha384`, `http://www.w3.org/2001/04/xmlenc#sha512`]"}
|
||||
schema={{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string","title":"DigestAlgorithmEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signature_algorithm"}
|
||||
required={false}
|
||||
schemaName={"SignatureAlgorithmEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`http://www.w3.org/2000/09/xmldsig#rsa-sha1`, `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`, `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384`, `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384`, `http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512`, `http://www.w3.org/2000/09/xmldsig#dsa-sha1`]"}
|
||||
schema={{"enum":["http://www.w3.org/2000/09/xmldsig#rsa-sha1","http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","http://www.w3.org/2001/04/xmldsig-more#rsa-sha384","http://www.w3.org/2001/04/xmldsig-more#rsa-sha512","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384","http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512","http://www.w3.org/2000/09/xmldsig#dsa-sha1"],"type":"string","title":"SignatureAlgorithmEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signing_kp"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"Signing Keypair","description":"Keypair used to sign outgoing Responses going to the Service Provider."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verification_kp"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"Verification Certificate","description":"When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"encryption_kp"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"title":"Encryption Keypair","description":"When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the the private key."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sign_assertion"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sign_response"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"sp_binding"}
|
||||
required={false}
|
||||
schemaName={"SpBindingEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`redirect`, `post`]"}
|
||||
schema={{"enum":["redirect","post"],"type":"string","title":"SpBindingEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"default_relay_state"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Default relay_state value for IDP-initiated logins"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"url_download_metadata"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get metadata download URL","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"url_sso_post"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get SSO Post URL","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"url_sso_redirect"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get SSO Redirect URL","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"url_sso_init"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get SSO IDP-Initiated URL","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"url_slo_post"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get SLO POST URL","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"url_slo_redirect"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get SLO redirect URL","readOnly":true}}
|
||||
>
|
||||
|
||||
</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 \"acs_url\": \"string\",\n \"audience\": \"string\",\n \"issuer\": \"string\",\n \"assertion_valid_not_before\": \"string\",\n \"assertion_valid_not_on_or_after\": \"string\",\n \"session_valid_not_on_or_after\": \"string\",\n \"name_id_mapping\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"digest_algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\",\n \"signature_algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\",\n \"signing_kp\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"verification_kp\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"encryption_kp\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"sign_assertion\": true,\n \"sign_response\": true,\n \"sp_binding\": \"redirect\",\n \"default_relay_state\": \"string\",\n \"url_download_metadata\": \"string\",\n \"url_sso_post\": \"string\",\n \"url_sso_redirect\": \"string\",\n \"url_sso_init\": \"string\",\n \"url_slo_post\": \"string\",\n \"url_slo_redirect\": \"string\"\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