diff --git a/docs/reference/openapi/accept-o-auth-2-consent-request.ParamsDetails.json b/docs/reference/openapi/accept-o-auth-2-consent-request.ParamsDetails.json new file mode 100644 index 0000000000..e602438966 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-consent-request.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "OAuth 2.0 Consent Request Challenge", + "in": "query", + "name": "consent_challenge", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/accept-o-auth-2-consent-request.RequestSchema.json b/docs/reference/openapi/accept-o-auth-2-consent-request.RequestSchema.json new file mode 100644 index 0000000000..b0c1505c19 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-consent-request.RequestSchema.json @@ -0,0 +1,51 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "context": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "grant_access_token_audience": { + "description": "GrantedAudience sets the audience the user authorized the client to use. Should be a subset of `requested_access_token_audience`.", + "items": { "type": "string" }, + "type": "array" + }, + "grant_scope": { + "description": "GrantScope sets the scope the user authorized the client to use. Should be a subset of `requested_scope`.", + "items": { "type": "string" }, + "type": "array" + }, + "remember": { + "description": "Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same\nclient asks the same user for the same, or a subset of, scope.", + "type": "boolean" + }, + "remember_for": { + "description": "RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the\nauthorization will be remembered indefinitely.", + "format": "int64", + "type": "integer" + }, + "session": { + "properties": { + "access_token": { + "description": "AccessToken sets session data for the access and refresh token, as well as any future tokens issued by the\nrefresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection.\nIf only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties\ncan access that endpoint as well, sensitive data from the session might be exposed to them. Use with care!" + }, + "id_token": { + "description": "IDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable\nby anyone that has access to the ID Challenge. Use with care!" + } + }, + "title": "Pass session data to a consent request.", + "type": "object" + } + }, + "title": "The request payload used to accept a consent request.", + "type": "object" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/accept-o-auth-2-consent-request.StatusCodes.json b/docs/reference/openapi/accept-o-auth-2-consent-request.StatusCodes.json new file mode 100644 index 0000000000..95007e08c5 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-consent-request.StatusCodes.json @@ -0,0 +1,57 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Contains a redirect URL used to complete a login, consent, or logout request.", + "properties": { + "redirect_to": { + "description": "RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.", + "type": "string" + } + }, + "required": ["redirect_to"], + "title": "OAuth 2.0 Redirect Browser To", + "type": "object" + } + } + }, + "description": "oAuth2RedirectTo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/accept-o-auth-2-consent-request.api.mdx b/docs/reference/openapi/accept-o-auth-2-consent-request.api.mdx new file mode 100644 index 0000000000..571f98ac13 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-consent-request.api.mdx @@ -0,0 +1,52 @@ +--- +id: accept-o-auth-2-consent-request +title: "Accept OAuth 2.0 Consent Request" +description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider" +sidebar_label: "Accept OAuth 2.0 Consent Request" +hide_title: true +hide_table_of_contents: true +api: eJztO2tv20iSf6WWwSDSgaZyweI+aJDDOrZn4s1M4rUdDAZWYLfIktgx2c3tblrmOvrvi+oHH3o4zk7mcB/iD4nUj+qq6up66yHKUKeKV4ZLEU2j33IUwASw2uRS8X8xGodUZhhD3swVz2KQCnhZFTzlBt4f1iaHl8kL+KmQK+AauOCGM4NZDO9VA0zfajA5QiGXXECl5B3PUM2EkfYQFIanzKBdo+v5J0wNMJHRdwEGi8KCEXIFbC5rA9wkcLoYLu/ByWLIcaJzhLLWxu6bI2GBGfDFTNC+DumjgqMwsMp5mneYW+ALokfnsi4yC6Eo5IqmJLA0Re2IUqhlrVLUIEUfpeca5pizYpHMxExc5gipFJqOSnNWFCiWSLxiVYUic1BNb1Hg0nMNH85/oVmH4fCEWqM6YEvaMJorudKoxgRVYcYVppYQmUDv9JkIkGkzkcD6GBkJCzSWEwupSnf3njDLs5eg8J816o0b0vaK+MalpClWBrOZkAoUfvIIWaZZGJ41XAOKrJJcmB4wi1kfXM50K5QeTneNqbvG7m4G95JzPclRdTdyuYPVwEVa1BlqYFnGiXJW9PkQg67THJgGjVoTYzJmGCykCmcSS06PwchbFDq2Xx1LZiIcFrjXiVWtMSOgc6a5ttAWtalVyyTdCpBCXREYwtwwLjSw9qatlHQiskWbP69dTot60mNke0qGC1YXZgd7NLA7xgs2LxDuOHM3oBr4lQm2xAwO01TWwsDJfYWKo0gxgUsJaa2NLPm/cCdmMVQFMo0zkSPLQN6hCm+hu91MpnWJwth7SKI4khUq++U0i6aREzQnn0cO/rljXhRHFVOsRINKR9Orhw1l19MDHi+/EY7Cm4jiiNPSf9aomiiOBCsxmkaejuu0t45ujCvMoqlRNcaRTnMsWTR9iExT0SZtFBfLaL3+6BajNq9l1tAKulMUhj6yilSrJW/ySROeDz1QlSLiDUfdbru32ww3BR3y94v3787Z6lfUmi1JaiqFhCqJC4FLepP2ka2kutWwIkW74iYHAhDDxT9+cSJ8sWLLJSpiuydD2gcZreNoqZgw1078r63cX7M6s3dPKA2Z/TMtxuzQLwCNxunQsKWVys133r3uWmMCF51OJu2g0YBcwI3nKGa7EbohCrjBUu+4kZY2phRrOtJ0Kqt9pFzQXEeFXfrNSLDQvhJlhSWWc1Tb+J77mZgUEh1GT4xkNCjc89/hTZMpRhMBDBhSzeHBDv0BEgyFtUbgptX7rCRN5whtrT6NOo6Qbgsj1ofokR479vWEbC5lgUz06bpeyEdo+0kqdxm5XEEhxXKgb4bod+o3wMbM4scFaEylyLT1MTyrbl7cxE6PD8GseFFsAOEiwwX5EVg0RI0zH9E04sL8z1878rgwuERF5Hlzsv24+2K8Tfehnb2kSUf3llmyb6szTQoXCnXu7FNMNse+eTKroglWxxkv4FrXmMG8cWSHrfZRJPAWsSJWldw6AdZQc+0ODjzpbAUZZdFIgVChIn5wsex7YK33cSqMkrrC1Kr5mThdgBRFA42s6WrVHSd7njIRAH0ZSuww4+Qr1awoGlhwgQm8rr3YcpVBxSzLZ4JAt74dM51b4nkVg0ahueF36LmsZOlk2vO+5MvcEPl4X0nd+nVlAh80OvWaMoV/oXvn2b6rPT3+0rW+r1CcHpPVEmTOg9ex+2pa9J5zIrYpJMs0MOtjsIzuaCbmTbgku8k6W54TzhrTaYHH29SQNvL254zpDaRJAGDDA9phTnowLjsnMSDsHCXv4FXmaRDXcXR/IBVfcsGKM/IE3jnzbc2uVS3Op7Lv7eWLF19lioeXdrTHKwt4p7KsCjSk8W0kFAcCrC4s5JJimx4tQ10QQF4buUsFukk6jju12/mDjaz3un8Upbi4gTCUwQb3wim6xEpJKwnWGjgish63W6+m7wFdDTD+2F1t92QD1vDao3Apd1/hkFhp/byw+VJGdoV1Wv/A7Z0oJdUW19GO7l28ZZHt+usM5/Vyzy44pkk47eIKcrzfk5rrNCYXkOEdlDLDHXzujulB33dYN7YXTs4du3YBeMMpZpyJN1hUunNueEbisbDWASwUSBk5NlEc4T0jGWlfce8pcA1CmhBJ7yRNG2ZqfU35hm2c3lxensGFXQFHtKJ32l9f/PcTrO16U8A6wbRkuCBil9gNp8lqp7XiprFRhVRNzxxH06uP5OIbtqSgw0ssPQJSRs2BYgYLXnJzMK/TWyR8c3K+DlhWcnGQ82Ue0VpiwoUlz8UuBRNLYmtT4YXFLIqjgs2xiKbR36RqJs73iuLIxb5EeFlJZeBhJgDAh/CHFY/d9yMpFnxZu1DKjx3uDaZmYu0M3vPeYc9/JPEgTWZDxg4cvAKBq+ERo/GPYS2r+KnQhpHKcStb5EYDOGN7QIFtRNpaoSk4sfkRJpMnBHIwCqEtOeHOTcNs7GDvDyGnj3CEToaRrFyyYNxx4gGcHMfOAK7hFbAV4wOyk/1njtxVbBLsb2j/vpkY/xit41ZSfpY9CRGM/Ja+cFQsvaUosGTcaiEvLKOZmJlZCC1nkfu6KNuPUrtPskLBKu49/lm05Cav50kqy0knIAdLSastcxa1SO1pozGJ5MxsUgjTVzCLNkev/SOfRcRvd+nwGZ5w53TGfnbRaf81ICJ5h6v91z0a0/n75+EzbEiDpbD3JqavYOu8jRdiUa64z0vu2nB4dupmNx4K7SR/JgYVk1KmzS2kxD+vs9PkEQL9nSevWXq7VLIW2Wg8To427mO0eUHjx2Du5/84ObnHtDboqOYLi/VfXoHghZOPmVmUJvmpUlyYxUjq5MJkqFQMM2+fVpSBTFlRkEjcPIXGm5sp/HA3m4lZZLk0/sI5P9VFAdbwBF+xt9/tXtM/k0mXoLNa8uYRHKZe23VeDIHYxkHWhnA4HwJ+Epl9LFFX45lY91XDWWNy6xQE9UCGaa/9kKq5dpMzYXHoBhLyUgrttdm1vCbn8eV1yI8FL94Desy67AEcIPb8yQBtm4mbMFT/7Iqf3NPx1umyKyvL7bDAfaN3+wyObRTvkwi5JCgawtu24bS3JjZAyo2p9HQyqQrWuHeTVEqSg6ETqRpWcU1qkQBfIA4NZVI1LokMBdc2DcSKAnRdEU6YbVjVLp2ZWGMzMLg9wodaxRkOSwYp2KeiG/T2M1dCcCrJVlXCyTvjBeLOMFHSYU3AuI2ypcqs9bdhJEE5PDu1UT6lq71zBZUseNoktOvEGQGXI0dGqXjS/yWaXGY2mvU5ZcrrFHIVk6vqHFS300a2BEkzw/WCo3aZBQuG1qZMY+LoPWrpe41M9dJ5lp4pDB2+r76JfmaHVusExR1XUlzNotcnh+cn59eX79+evJtFH9srOBGG8ACvox3fmAAe3Ci5aNkY3qpd08PlMJiDDdNhk0AV98umDslncKSQCnN7D2Fae3oqfs07d653YufVdfDHA/emS6HDK3i+NRiM/3N4Rqb/qXa/c5T2qqQBno9a/WdfZfTpaKMaz0XHSbd/P+rdWmJTa0heDTj7BR072uJd/AUWvHp8etxhZTXjaBYN6lBy0TntB//7OKyptUV9iA5kn1w/i1ZJQ6urSThxuo1Lt2DgBTwdJfhBW6zgB8BxtLbxmc5uDzKZ2ui/F2hR5oAvBaMc6aMVp9E41JxczObLRY+WqHxEul/Gos1gdKvYRJZ9WJnqF7CGUfYmsKcVwTbOsxUsUytx6WBvmmJbQpGbfHvM9TT3PX9wJxP/dMoWrNB9Vv6Zt+bOegobK+eq7RTBvbrgUQ4OqpYdC7+NZGyybx+KT2HhaP9UUmbjLYSvgiL++PUSO9ocsCdQqgfvDaX9pXC8vMUmmu5L5cTRHStq3JXSIc6Eva2aadd/Vzff1c13dfNd3dBGF9NQhq52LSwmj6bRxOqSibTkTejfSegRmnhiJ44HFMHbQMrdRq0owA9B34MP9a51US/XOwO/iVVLilMxQvu6dLvFpeV9vSXqQsgt7vxOwRU1CL1DQz0mcOagAEFJ4HdZ21rugiqV1EXg2syu+jvoDmSBH0cB+dQNELKJzicB+UlaK0X0L9EcaMMocB4nnpshmLyg0o+jh5qt0rYcZNsN7EgrI3QePYa5jf6GK93Q1lJ3L7SUGgddAb8fNB75ksZg8MPgaqzJSDIsZSCwd9l0qdQjYSHLxaLgwkqzbzwJ4uecYS8Y5A8Pyv4aRqzgzAXRNx6K75e5IQEfDn09fNecJXhmy5KhVXBHvdpVSqgeQx+eyAdXL+9XcRzTif0bJZjN2tGl9PmAfrsh1UYFUgOeGAoexbe32HSCt1qtLC70OshwkyTSU9OTCpUmHXDgWHZgcRwnUfwEkVHNb9R8VbEUDyv+Fpuvxtt1bxGAgwLvsPi/J2MdR1RcPe/62U5CTa7fn/albrGrYFU/bvRe9Se6DifXYTfsDHrR76UhvKh7M2DBUutWYck4iZrPr/3NyVfX10ccu3Bz0VYN8JlrLsnq1OUQj/t9iS6JVxRQ1fOCpy4LRhqba6Ns7cUqw8OzU53A4XCCBq0ytP0u89C2Q72zLs0Dd6zgGZz5SwIn6u4RJXDmTrRQKBFWSm2KxnUecBFK/K6T9NkzuDh+q33jbeisBEfoHHVI7+hhPTo0e3rJck3F7YHdUqYt+LZRZSGp2Et6ghLPNVuinhIan+EX/91H9Z/hWK6E7fS4OH4L/8kfgehfyDf6+0zYHgz+YHPg6/++AYjdYAnbY6bMgDFXVT1PMrzrNIEfmPgioJ50ybDxTt5enZ8cHv960kHYKPfp7HYyL+R8UjJtUPnyn/b/TzKmzMSBIE+nz9vk3cnl8ChRL9EkUi2Hmqsd7rB+r5rEpTQn42+JrTQCt/C12J4U/J6r/lE53idV2R3lvj+Vs98AW7Qo7cT2Z7l5VAd673Ft5fZPkYSl3JYDj+3f2R0bHlWyOxRDSdDIVJon7cyE2vcWLDUTnZNxm3SlrPEfx/YTu2N75JawdQF7K7dV+UkPWWvlNgwHmZj0OijG35K3ZJmdxerjvInt6DcyKvaXHuP/FO0Dv/1PQd4BH5AARMPZm7MNUXSYcb2hLQbDg5e4wfU/jHSVVzvE2XLc1VgH2DYV30DUj4RQpie8k+3X98extSjt1BTn9bwZHqXqebPEUg8x7o9O6MPgvX1TbOmoPW/vnKqQg6NSysXphMtetBiG/Ke9mH4jbPVuC0dVdp6i0NYlDo5mxdIcKdsRxRsROr09Zqctj/1ePfnl9Ojk3cXJwcvkRZKbsrDRE6pSv19cuO5oyhIYqXtdbcHlpIgelfONo4KYYf3bSmpTMtHH6wuVqs0wv9dx+f23g99/O/j9t4Pffzv4//u3gz55QWkJaoDhNgllFfCDz7ReRTZuj9qcXhz5BFzgaxSH3DbNuZzrxziiBhva/vAwZxo/qGK9pmH300H760OuiQUhH/+IKh2d+3zb+Cn9DvvIcuWmXWn4UKWyZe+Q67WNy3FE3KQcS1vrOnJoHdhUdrd3q7++q3Adhjz0/rX9PPfZh8sojub+t5ClzZRGiq2I5Wzlahku1+5+DEFjrpWNMgjRNHIgKedjb6r7tVybswqZ3Kt2iommh+DDg1thUyrrdRSY51OOH9fr9b8BIEQNOA== +sidebar_class_name: "put api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the +subject and then tell Ory now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which +initiated the flow should be allowed to access the resources on the subject's behalf. + +The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The +consent provider uses that challenge to fetch information on the OAuth2 request and then tells Ory if the subject accepted or +rejected the request. + +This endpoint tells Ory that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent +provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used +as basis for future requests. + +The response contains a redirect URL which the consent provider should redirect the user-agent to. + +The default consent provider is available via the Ory Managed Account Experience. To customize the consent provider, please head +over to the OAuth 2.0 documentation. + + + Request + + + + + + + diff --git a/docs/reference/openapi/accept-o-auth-2-login-request.ParamsDetails.json b/docs/reference/openapi/accept-o-auth-2-login-request.ParamsDetails.json new file mode 100644 index 0000000000..cf090637da --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-login-request.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "OAuth 2.0 Login Request Challenge", + "in": "query", + "name": "login_challenge", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/accept-o-auth-2-login-request.RequestSchema.json b/docs/reference/openapi/accept-o-auth-2-login-request.RequestSchema.json new file mode 100644 index 0000000000..af99cb1345 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-login-request.RequestSchema.json @@ -0,0 +1,55 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "acr": { + "description": "ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it\nto express that, for example, a user authenticated using two-factor authentication.", + "type": "string" + }, + "amr": { + "description": "AMR sets the Authentication Methods References value for this\nauthentication session. You can use it to specify the method a user used to\nauthenticate. For example, if the acr indicates a user used two-factor\nauthentication, the amr can express they used a software-secured key.", + "items": { "type": "string" }, + "type": "array" + }, + "context": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "extend_session_lifespan": { + "description": "Extend OAuth2 authentication session lifespan\n\nIf set to `true`, the OAuth2 authentication cookie lifespan is extended. This is for example useful if you want the user to be able to use `prompt=none` continuously.\n\nThis value can only be set to `true` if the user has an authentication, which is the case if the `skip` value is `true`.", + "type": "boolean" + }, + "force_subject_identifier": { + "description": "ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the\n(Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID\nConnect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client.\n\nPlease note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the\nsub claim in the OAuth 2.0 Introspection.\n\nPer default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself\nyou can use this field. Please note that setting this field has no effect if `pairwise` is not configured in\nORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's\nconfiguration).\n\nPlease also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies\nthat you have to compute this value on every authentication process (probably depending on the client ID or some\nother unique value).\n\nIf you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.", + "type": "string" + }, + "identity_provider_session_id": { + "description": "IdentityProviderSessionID is the session ID of the end-user that authenticated.\nIf specified, we will use this value to propagate the logout.", + "type": "string" + }, + "remember": { + "description": "Remember, if set to true, tells Ory Hydra to remember this user by telling the user agent (browser) to store\na cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, they\nwill not be asked to log in again.", + "type": "boolean" + }, + "remember_for": { + "description": "RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the\nauthorization will be remembered for the duration of the browser session (using a session cookie).", + "format": "int64", + "type": "integer" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated.", + "type": "string" + } + }, + "required": ["subject"], + "title": "HandledLoginRequest is the request payload used to accept a login request.", + "type": "object" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/accept-o-auth-2-login-request.StatusCodes.json b/docs/reference/openapi/accept-o-auth-2-login-request.StatusCodes.json new file mode 100644 index 0000000000..95007e08c5 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-login-request.StatusCodes.json @@ -0,0 +1,57 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Contains a redirect URL used to complete a login, consent, or logout request.", + "properties": { + "redirect_to": { + "description": "RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.", + "type": "string" + } + }, + "required": ["redirect_to"], + "title": "OAuth 2.0 Redirect Browser To", + "type": "object" + } + } + }, + "description": "oAuth2RedirectTo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/accept-o-auth-2-login-request.api.mdx b/docs/reference/openapi/accept-o-auth-2-login-request.api.mdx new file mode 100644 index 0000000000..0d6c0000b9 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-login-request.api.mdx @@ -0,0 +1,47 @@ +--- +id: accept-o-auth-2-login-request +title: "Accept OAuth 2.0 Login Request" +description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider" +sidebar_label: "Accept OAuth 2.0 Login Request" +hide_title: true +hide_table_of_contents: true +api: eJztO2tz2za2fwWXmU6kOxKVzezsB3VyZ13b3XibJl7bnU7HysgQeSihJgEWAC3zuv7vO+cA4EuS42zT++FO/CGxSeC8cV44fIhSMIkWpRVKRvPo5w1IxiXjld0oLf6X43OWqBQmbFOvtEgnTGkmijIXibDsw1FlN+x1/Ip9n6stE4YJKazgFtIJ+6Brxs2tYXYDLFdrIVmp1Z1IQS+kVYQEpBUJt0BrTLX6FRLLuEzxb8ks5Dm9QVCE6zW7BH0nEmB8pSrLhI0XciGvNtAFR0RveJ6DXANSxcsSZAops2oPNeyni3f4ZrsRyaZLyUvDKgN6ytcgLRuttNoa0GOEqCEVGhJLMGN2FYAuZAO1MoC8c9uhxSqWgU02TMhM6cKRqqRj0jGo4bcKTEcKPEmgtCh3DSQfXOxXQTrku9QqAWO8WIRhINNSCWlJmoZESUR1Jb7hhpkqwY1Zled1TzcpkSJkklcpGMbTVCAmnveYMFWyYdwsZF9+Zydud0aIzUZVeco0FFCsQA9k3eifxJ0pzbLKVnpHtdxaKEpr2KpmBqwVcr2QnCVK3Qpo7EGDKZU0wBIlLRfSMN5ojTTeqntgDg2VfjEu6diBVXE0iVQJmsg5S6N55HTkNPgOoV04/USTqOSaF2BBm2h+/TA4cO0Bol3Mb2PHwWKiSSRw4W8V6DqaRJIXEM0joniZdFahQQgNaTS3uoJJZJINFDyaP0S2LnGLsVrIdfT4+NEtBmO/U2mNK1BCIC3+yks82sTY7FeDND50QJUa2bYCDK1NNP7X5+jo+AKV4k79UV9xR123coxI7y07zrkx7AIy0CATYHc8r4C0b9F8B7o3YIxQMma/qIolXKJimLDkUOC+1GDcmZsQBLjnRZnDhHFS4MCsKyPkmtmtmmY8sUoPcKGWB7KbRLzYx/OPh3n+EexGpR0GzYDDhXwei+g7TAmJyGrCUxDgwFllyBP1gEHMvu8KQWS0kSeaCZnSCtPf34hiSNTE7Sw0EdQKGmq3kzOjMrvlGqYGkkpDym6hRgkKC4XZY4aNbLnWvMa/E2cQtFbYHN/98/LD+wu+/RGM4Ws80ogXpEWy0Trjzktyalulbw3bYtzYCrthCGDCLv/1bkJu6HLL12vQHc0qcjmIHu4tyHTppb/MRQam5HJX26e0MLjr/cpjYTt6o7MMrQP1d4Nn82bSdffDsEVOrNmOocYRBilGGYywpmvaKP6sylG3tarYlsvWXyHGFUbKnAIPmtFNqVVR2jdSSbghzyhkpSqT123AcOaJelYyrxFCj/pgRoQBA4fPF7rG4lyrcAci4Wi/btONuRXljUchjAfZ0cdKqRy4RIVkSiew9EFhKVJEkAnYc/6+x5WXbuFZs44RAEfDIiq50FthYBE5ys9OmHI0gUynTlxoQT0X4QL73s0az7PxCcVCjs79EtYh4ChfKy3sphhfb6wt57OZKkGKNJZgZ3iWjX8wTZSUkNhpojRM/7J8FW9skb8IMI/y9cdA7YcS5NnJAt0n7vAuIbgsdmYZz3O1NWQO6DIAUwmmVlllnNsLYXa0iJCZRTRmrXCdEIRhlRS/VRASpiQXIF2udZ4DKlQqCyGREAZTHLn2wm7kK9vkY4YPMV+gc2iqFUtyLorA1dkJu1K34BhIFRiE74E6AbdbRCddotB5Jq1WKAcSAdEImqWQ8Sq3E/bh4hf2tk41Zxsu05yIbMycvISwhqmtZDzoK2Zn0tlte6icKGlrrSptIM8Wsu64aHqVCcjTmO0IyecpnUV0dqRikGWoDZGxm2BmN6gAEoCSmViTO8XUsuVE6YEMjklBrejgvqRUigWYXR2PkJM7wdlNOF14+m7QZQfpOoW/NAsZaCADG3dNgOfGORj0+47NlkIyoeB6XN6Q1yxRRVlZ6GogrTAgDGOv93VYaAAlldySLjb8jiDuAYTmdge6PpARs1Gp1Yqv8pqlgOUAYlVdbslmNTOqgIVUdoNh0Z0CQuB4P3OONuMi79MBnku3eOJz972kgPEekrgR6dKi7S83eFBQNYVYbyyh2JuDOE3aehky1iZoiXTXOZ751ed+8aVbe3YS/HMIWc/ziC6cOaeDVd4Wz1CetyfAKcMrna9DcZertarsXn5CObBL+4V/Q7mLj0KU3naKGWduVnWrCuEKNywQcKE7eN4xDYs5PNhWaWhLCOcUBqpLueUxO3MCMrzw0ErQWANhFHQW0x7JXrYbMnuyi3ohSWZ4UPH8mFtXmuZqjeePr7mQ+2Ni4HGZqSfEhVkf5aMbtWW58twPMxVX5aygERyklFkIzGISJVND/Ibg/8rlLS4zbPkiRnaBIMLUO41gVl7kjcGNXALOmwdO/GNk3RWW0TwS0v7tr60shLSwBo2y8L5rVww+Ewj2/Rnhftc6H7uV1XWD8+OkyVHfUlBJu1VfwBxK+ZLXueJpSNJDRc994emX7clKEf39VGmxFpLn51hJvncFIJVuRJyrcinFfv3q1WeVc32xHR+okwPV6OpysBDonmB4wmycekLufHd56ReLAeTSqn2G614iOi+7tkJHd3uoJH9pGquyiimsH/eYeogAmKd4Jp6h6y7FHX23BzxQzb7zJFyp/SrsM6so8Q+br1REKyhZ+QPaO9Va6R2pAz09uHjHFdP6ZQqran1gFzvBl+ysbf1gVPyAlQK/4yKnkC8kS+GOFSqFvR4/oOlAP4SsfXYQDsbNQwDeCmmRwLeQlx134JMhV0kTFJbwyhC1vrKK5pFrI3WOgk/LKMPea0KTyFhuK7PEnukuTW+vrs7ZJa1gx7iig+2vr/7yDLf3ODSw1jCJDVdV7jO7/utJRHW6sDV1pZSuj6j9R1l4NL/+iG0iy9fYtPIWi4cAnVE91dxCLgphp6squQWkd4NReMrTQsjpRqw3Ea5FIVwSe673lXO5RrHWJVwSZdEkyvkK8mge/V3peubysGgSGVXphBgvSqUte1hIxpivmY9KMXF/H3dzU//s6EArbiEfWaZVwV52UL38Fo0D/VibbDuf8YZJ2PYRjMbfhrW8FGfSWI4Ox61sSBv1E2ZCkIN1PrPp682ZM5lv2Wz2ySYgG3n/QGW8TCETEtKxg3uo9Tg/KAnEyUaqdF3ccSuBB+asd0LZDntkbzC3Fz1240P4Rk78fTa9Tg7tWcjxt9HjpLGMf6iORUhuxR10jaHkyS22egouyOt44xgt5MIuQv9oEbk/s6L5VRn3GxbbvBQ+219Ea2E31SpOVDFrTWK6VriaxJJVMiFsozGa4ML2uWPzN2wR9Z8t/YFeRChlp2T2O/ukjhH6ITEhnv/uER+/h+0h9Y4WIQNqaRkjMYc2sN/ZwBwWtn8Y5m/YDvrB0SD6S+Hr0H0bjs7P3NvBCcGdmMZMmJ6gL8bNDaTYn6vzs/ggv17x8Xc8uV1rVcl0NB7H73pqGfW1ND4M7ZASxvHpPSSVBceryIjW/3rDpMidcSxsVtj4+1ILabORMvGlTUHrCVv4YLTFkjDhriC5+TRnNzdz9s3dYiEXEUlm/Aks31d5zijGhLSws9/tfsR/ZrP2doRc4s1BCubesbXpCgLYpUBVFim46IN9BotdCsGU44V87HqE89puKPYHr4Dx52CYULpeupcLSRS0D2JMRnLj3ddSLTFHfL10FykhUfdgDoeQA0ADtE7KGGDtim8IQ3cxl+L0HpFTXkUrS5JzWOD+wjP6gp1gHAi17Ua5uiOcY+qz+bBBbUrsQJr5bFbmvHanJC61QjdhYqVrXgqDnhABXwL0o2Fc1lTVcZYLY7GS4nnOTFUiTZAOQmd74xUP2kfsTZfxvgdxkYLYQK/6XHKDq35BrVrv2ouqE8/3lgQonX4h21KNwATduyqdUoinhgBd7pyfMQP6jqpYlz+xUuUiwf75C3bq/K3v0PPEdRGaqxoN4ZIR6+5cbSe+bQJNOx+LUoRkuBUmE+CajQ4MrsWmZOz4PW74+w649rdbDT9z1s/pPlsTnPa61hSuNjHIO6GVvF5E350eXZxeLK8+/HD6fhF9bFRwKi3SwbxH9o0UyUTIlXwNjmIM55TWdGg5Cq5/ECYYXjWUwi+bOyJfsGMN2GI6iIQb4/kpxVK0OVsHY5u6tfDHnWymvWdlb9jLwaMQY1+yFxjtnxfq25zogCPq0XcwVI3Zi88I6ojU6tpLzknP7T5EcrsSBdOEjDc9WT7pUUcDaU2eZPvNUy/HLTXkA0eLqHfNr7I2B5/+z1OQ5hRvuvAcwC6T/i2QM2aNT0YjhPkuJe2CXox/LkHsG0M0sW8YjKNHKrRMejtNVUJlfKdiwhaAWEuOgxFPDB6MxmH0wJVefm7giTkFX1YesqdoWE/uzBxg1O6OJ3RnGPpl8hDUc6YgBrhoiMFWWl45yMMwi6X4Wg2ldTiFtPed/G6v6P5UnjKem64A/yw9OTzPEV7pEq+95nbgrD8ht96oSiu4L2EJQ6HtJ+7TghsdehEX6XiH0OvgWj9+vm2Ohg8Iw2OYQcBWuJPgLdTR/FDPZRLRTcu+3gvKJOxt3Eiz/qs7+epOvrqT///uBDe6ygNbZ5WbRbSbaB7NyFfMFDE2w39nni8zIzZnjnessKnYcRqoNBbgoTB78OXY0uTV+nFvcTYjp6MF3gkYPz/YbHHdcX/tEbVl3o5sfsECCG9634PF+S527qAwhNJOyWUC50xtGGC47u44VtKoHD6OAvGJe4DExmYzC8TPkkprkHa2Bjs1lmNxO469LEPBd4k3MI6fFTciaW5l6K6WnjTWgfjQ/FdUofVXukc7S51WcGmGczx0D9Sfm3Q3C72HP/VUQwEhTqFQgcGOqlGpiSodAyrLciHJjhk9ZcH4XCLrzQJzWQ2ZBrNhVBAaNuK54K7QvfFQlq5kvEHz7j/6fPhuwlbiQEMUTi2XfvqJheGnMDZE44T4yzPlYN2mzmWKEzqKf3ATMrzCuVLtqEMz3YRXlBJoUrpveFiD3kLdGt52uyVa8HRgWEZLxKNmZiVogx5g6kQ2JRrpLvzTJqPrn3HwseQJHJXiB6g/m243OYkApjncQf5/z8bjJMI7zot2NPk0XI35UeM2NtIU7nX4+2N3dvSpSU43GX14rrBF8PSITbuuHV1xsPvzGa86Qwrd+R2ZqXDTy90AAxRcoOX6ltrfnbm2896ogEv3Ltq52XvhJuDSKnFtwxOVVAVI6xo91LfLc1ZWq1wkrvGF7l8Yq+mGhXzr0fmZidlR/wU+7A2COp1C6rs2HId9RMrOvc6ZOzlhlO/cYSQo2PsqlLG5HxgWMlzcu08VXrxglyc/GD+CmnoOmGN05QcLHaTuLXP4OMQbqpvXbBC2S7kh8M1oSqbwChfdDvaZK74GM0cyfmfv/N++wP+dnaitpOmNy5Mf2H/ygyC6CvlCP78jtdPeDxs++PyfLwBiP1ik9oRr2xPMdVmt4hTuWsfiH8z8VZ+ZtX2w8V7ZXl+cHp38eNpCGFzqmfR2tsrValZwY0H7Sz7j/5+lXNuZA4FpU1e28fvTqz4qWa3Bxkqv+46wedxS/UHXsetizsZfklplcXR4QC9Re5qLe6G7qDZwH5dFi8r9/VzJfgFqgUjaS+0/1BBVC/oguuZ+9k+xhLXatQNP7T/5He+jKvgdyL4lGOA62cTNmxnXVuDXFDOzwVg5a2+uxn+c2l/5HT9gt0itq+4buy2LX01ftGS34XGwiVlnMmL8JWWLgd5FrC7NQ2pHP2NQoe/jxv8p2VO//U8h3gHvscCQh/O35wNTdJQJM/AWvce9kziQ+h8mutyUe8yZJO6uVHvU1qUYEOqfhMqoY7yz3dP3x6klkvZ6iotqVfdR6WpVr6EwfYq7T2f4S++8fVFqEdWBs3eBF489VAk27kwsVKf4DI/8bwcp/ULUmv0RDi/VRQLSUIYdEs2SJxvAlkk0GRT8ePY4vSYZ+71m9u7s+PT95en0dew+W6FiDHRhPmT+Y11sOVhlOrNqIeXEBgFo4/LYHIVB+W2pjC3ct1eBricvqoY9g84U5ddvmr9+0/z1m+bnfdPs63GspHHuQlBfhZzAg28dXkdUO0ZNm2oS+Z5SaCCiV0HU+MY1ET9OIpzqwM0PDytu4CedPz7iY/dRM30VLQzWaaGl/MRxHl34BtL40xfth1hydyO7neRwoUI3sKFxScOwk2gDPMU6v7mWOXYkTakr2+7dmdluL2OOQlP18Npuy/b8p6toEq38N9oFtf0izbcobL51rXjXNnYD9vjMzU1h/RrNIwcSGyuko/Yb3KYBE9qS180rLusOgQ8PbgUV9I+PURCd7599fHx8/DeQ8Cs+ +sidebar_class_name: "put api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the +subject and then tell the Ory OAuth2 Service about it. + +The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. +The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested +authentication process. + +This endpoint tells Ory that the subject has successfully authenticated and includes additional information such as the subject's +ID and if Ory should remember the subject's subject agent for future authentication attempts by setting a cookie. + +The response contains a redirect URL which the login provider should redirect the user-agent to. + + + Request + + + + + + + diff --git a/docs/reference/openapi/accept-o-auth-2-logout-request.ParamsDetails.json b/docs/reference/openapi/accept-o-auth-2-logout-request.ParamsDetails.json new file mode 100644 index 0000000000..cf52a89f8d --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-logout-request.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "OAuth 2.0 Logout Request Challenge", + "in": "query", + "name": "logout_challenge", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/accept-o-auth-2-logout-request.RequestSchema.json b/docs/reference/openapi/accept-o-auth-2-logout-request.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-logout-request.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/accept-o-auth-2-logout-request.StatusCodes.json b/docs/reference/openapi/accept-o-auth-2-logout-request.StatusCodes.json new file mode 100644 index 0000000000..95007e08c5 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-logout-request.StatusCodes.json @@ -0,0 +1,57 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Contains a redirect URL used to complete a login, consent, or logout request.", + "properties": { + "redirect_to": { + "description": "RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.", + "type": "string" + } + }, + "required": ["redirect_to"], + "title": "OAuth 2.0 Redirect Browser To", + "type": "object" + } + } + }, + "description": "oAuth2RedirectTo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/accept-o-auth-2-logout-request.api.mdx b/docs/reference/openapi/accept-o-auth-2-logout-request.api.mdx new file mode 100644 index 0000000000..bd81155f64 --- /dev/null +++ b/docs/reference/openapi/accept-o-auth-2-logout-request.api.mdx @@ -0,0 +1,42 @@ +--- +id: accept-o-auth-2-logout-request +title: "Accept OAuth 2.0 Session Logout Request" +description: + "When a user or an application requests Ory OAuth 2.0 to remove the session state of a subject, this endpoint is used to confirm + that logout request." +sidebar_label: "Accept OAuth 2.0 Session Logout Request" +hide_title: true +hide_table_of_contents: true +api: eJztWm1vGzcS/itzDIpIgLSbC4r7oMCHKrbauM3Fhu2gKCxDoXZHWsa75JbkStY5+u+HIXe1L5ZSp3F7B1z1wZa4w+EzLxzODPeexWgiLXIrlGQj9nOCEjgUBjUoDVwCz/NURJyeg8ZfCzTWwJnewNm4sAm8DF6AVaAxUysEmyAYNIaIjeUWQS2AgynmHzGyA7CJMIAyzpWQFoShhWKaHym5EDoDm3ALqVqqwlarBVM5lVcJgkaTK2mQiC0X0gAHjbHQGFl4f/EW1omIEochIjppIddqJWLUYBJVpHFNTkQk5JAvic6qgA2YylE7QU9jNmI8ijC3TsqXbx2iCw+IDVjONc/QojZsdH3f0WGtGD8NynlwnPA0RblENmCCKH8tUG/YgEmeIRsxL/csapCRDoTGmI2sLnDATJRgxtnontlNTnOM1UIu2XZ7Q8ReQYaev3zxgv6RrlBa+tqwZPjRENT7Br+2DMcHVFzbK8tTtAicrCXkoFL5gNymY0BSmCblWuGxVSxnVj1c+qJ8SMsJ4yxVG3ejioO2fG5grtWaXNcqUDLy/sgLm6C0lQ/nWkVoDLGuhIgJYVefTd1ftxDfDJgVNsWWqSvU8LqEcKVqpsq5P9sS17awyrlXNflKMUex4EVqv8J6E62VfqB1dKMHiTsKGHj6WYzzYnlgFpzQQziVC6UzB4326plMN8BXXKR8niIICTGuIFMx7tFzvUyD+6HF6rGDfBLh1bWPwRshLQF8g2ludm4DIib3WGzciOMCES+MQ4t3nHyEjZiPQI2tIAxIZYGnqVrvdaEBoxBYmFmkYnyI6c3V1TlcOgo4JorGat+++PuAeaWyERPS/uPbmr+QFpeonY+2Hax2TCeGj1373K79eMAMRoUWduOimdKbcUR75ErdomSj6xsKLpYvKdiVHkub4G6o9GaoucVUZMIO50V0i4Q32cSaD3mcCTlMxDJhREtKuHTi+ZiZcrkktW5yvHTI2IClfI4pG7HvlN6EUSrI9QfMqEJHTvAsV9rC/VQCgD9/Xo5zMfC/j+kIWRa69MMtLLTK4HmD1/NXZH0KVNYfOBU1HIHEdZtDr/+qouW5OJXGcooonnK3dq/Fp+8WSLE6wnYBfwTeKV5BGP728QC9MgRQHCtkjAshMe7X4O/Be9YAYm45bOEI+JqLFtLg4PnV8/rqQJzK/iu2HewM84NqGERyK1bYtEXOo1u+RMi4cJu+tE1vKqd26uPWnZ0y/3OR7b4q47+pHCXPhTcMTNlS2KSYB5HKwtpgw6Uiaif5opCRW63XJw+Y2g5+GB3BlHUGZ+WOmjIIw9IG8Al+2wS04tS2nWR0BC3UwTtcd1yGJvFcHHup9k0Yn5/6px3PoZl0fg9ADygI0eQdp6D0t/PTYHzQqqXOg9c8ul1qVci41+8Hb9sK6XUU1A8mdxgVFj12sXBr/+0IpEi9mqd2kdng+1wLaRc9ZYJLG6PWA5iWUXVNKWPE05R0++ERSD98GME3q+lUTpkTtf8by3xfpCm4aFklOI35fvaW/oRhnSK6vf/hMIRRuYXrk5c4PISgCksQLtp8HyNkEyOavD+V2+b2Ot/YxJ1j1RajWHow5Cm9mfmHU+kg1AMBHaypCdSMEp2Xs0amAuXsh6J2eWhy/pJ6nIvJHUnlwqijzJ1OKgL/i3bIMzih2ESGp7MzUcYl9crN5SlwGUMZygzFssTa3IzCME/5xrtokGtFR5cJlN7wXBiKAMT4ErEdo4N8AwsqSSAVxrq6Ik3BFDlhwrgT0OsEPXBBsxXrG4K3968PjE4MCiaPhVuFqGdASUIZ0rKiccrszURJOzSktPh3FzUxExJ4FCkdu4NnLayvbcbnp2BQr6iqKY9tyFUqok1AsyY+4hmnLORR4taADG2iYuAaq6Iohjmmaj2gJMinPn6mq8GIk+FWmIVAQ1m39myINuIGAy/v8U6+18g16rY8I2inEl9sCe7mzixNJmoToFwJreT1lL2ejC8mF7Ors58m76bsZmeCibSEA8pw6PXGJYjqBFeLnRqrLeVoGljGVeDtBGnghoJySTbyIJ/BsUYqdQ8uwo0p5cnFTNSZRGPFOqGo+feb53RdFcIRPO+OVefcc3hGp9yjjzjib/WmlMRL40Nag8FlWdC3GdVTCPEu8B61hCyTkFkVnErcZWHY64rRr5m6GNObslbhrxZ15jX852d5j1zsbTL0HJtgy6fooh3sgh5ZGUcPodQErSPv0YjgG+NAwTeAfbZ1GbSJb4exilx91kiFqbYTS8ltofFzrYhev2pG+KS61UhothvapUm3HHhUx6LdivD9BltoeeVZdw8Zqn+WqivJZ9IXe9dIRv4bYi14ah4nV+4P771WOuTrnxOp1fKpZfpT7NTrDgRZ3HdFId5ZlLTzPeJb3LDRoaJvwFY8LXBf8UdJTzV35+47+r/c/i+3/19ye5rocyUqcgvf7LUJG7HQ+XSonJgh/Q2rfnjo5Qm9Kih/d/mZF7nQlN5XueR9mUHOTFost3vzydDtDi2oe+YOhuYU30cqG4SszkwfKO0XytmoT/8O7VrpWzj3XIC4BPCLKiDiEhZCxiAsJZuUsFw3ZxwraVSKN70KfOQHCGxgkrACH0aF1ihtuEQ7NJZTPt4PSmVWOeol9Sq9PHNuRLTrX5J1/MjOCWg9cri5SyrblH7oAak3C5EuUrV2y7Ry0eOyB9cafN8yjYtcQYyZqgRs2JqMGqncC6AWi1RIt7HBjULlfT41KP2CsgONC40mAZfDGujxVHCfm38oucx8lvuBdkp76Mv5+0sMKWLXR/ebhEs4y1GenpA9JXnA6Qn41h41EOnLI/Vg/aRG29ErndTf6Rl2m51Xqiwzmvc/1MyXiDFBbDkepc23uKkdb71eOyy0O+j8IE+krWbCHLWhWnPoVTZ0GPsBGzzCZfTmZ6VvTc4jHOfiJzqjvhA3rCsGwxRXmP75YmzpKmmhqssCHrlTFDMuyKRlefydt2N900TILv0z9qA5/AxOpdUqLiLfAjhRUZGhtL5oczV4mkJezFMR+SKWAqMwVrsuoQs64/NTE8C4/YAGXdBRdEMwx7K+w7iswDiseCpiOC+VAd6lvLMGcO5XdFyojs2UsenGX0kJWd39GF+aPoPLk58MXRwKA3EpAXhB52iq6sy0LypotGHBwBX0uwVrUm4ce6cMmrNQdAtA+5HaOwVfohkRjE/wtvxd1hKf4EStZap4TAzg93yIRdMgT/T5RGiHrQ90B7788wQs9rMltCdc25ZirvNiHsS4qndcORCW7WoT1jV3f69ury8m45N/TWoOnca0iW/DearmYcaNRV02qk35P4y5tqFnQQlFU7fBu8lVeylZLNEGSi/bEWI3XKM+05vAdyTC/lOiVVbiA7wO7SQVd0I3l0rwLsizein/+7GafQK06CDtRfuD6i5Vsz643O6O4Q/xhKV66Acl2h/5ireXyvgKZdsTDHIdJcHuSci1FQse2dAkdIiEdcO4//VoP/IVP+C3hNbXZzu/zbOPpq1a57fVcOUTYePurf+UuqUT0J9YTcxdtL2f6VBZoI2S/u+FPSyn/yHgPfOWCEAynL8577iiRyZMJ1q0hls7saP1rwadJ/ked3Ya9zcZLbSbXHSAliNVydBw3vDh7vt6tA7S3khxUcw37aV0Md8sMTNtxM3RkL609tuToqWlDuy9C7pEaC0VUevFBEI1qrJqqPx2EOkToTX7Tzi6yxIRSuPqrCrRzHmUINXubNCphGnvcffY6bica8K3p8eTd5eT4cvgRZDYLHVVCurMnC0uUa+EuxcLrTKN1x2qlJMqZ9TG57EpKcPlt7kyNuOyietxTe5uVd14I+f/+1W5sgahGxa6HhOulnT2vS/7JdfMlQVsV5oPWFlHV6ohh3Hw6ZHvnNwMGN2+0ez7+zk3+F6n2y0N+1fl3Mt2wlAOXnWuPmOh3kVZNfcfcR1ySCjfutzTsKoanq6TX/Vr3NsyA5Ygj6lxsWubjqvOUDXrwetcrcbT+furSl/1q367ArBqi1zvHnG5afC+v/cUrm7ablklRFm/32y32/8AWxliGQ== +sidebar_class_name: "put api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +When a user or an application requests Ory OAuth 2.0 to remove the session state of a subject, this endpoint is used to confirm +that logout request. + +The response contains a redirect URL which the consent provider should redirect the user-agent to. + + + Request + + + + + + + diff --git a/docs/reference/openapi/accept-user-code-request.ParamsDetails.json b/docs/reference/openapi/accept-user-code-request.ParamsDetails.json new file mode 100644 index 0000000000..f359b820e0 --- /dev/null +++ b/docs/reference/openapi/accept-user-code-request.ParamsDetails.json @@ -0,0 +1,10 @@ +{ + "parameters": [ + { + "in": "query", + "name": "device_challenge", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/accept-user-code-request.RequestSchema.json b/docs/reference/openapi/accept-user-code-request.RequestSchema.json new file mode 100644 index 0000000000..b62e7835ee --- /dev/null +++ b/docs/reference/openapi/accept-user-code-request.RequestSchema.json @@ -0,0 +1,16 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Contains information on an device verification", + "properties": { "user_code": { "type": "string" } }, + "type": "object", + "title": "acceptDeviceUserCodeRequest" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/accept-user-code-request.StatusCodes.json b/docs/reference/openapi/accept-user-code-request.StatusCodes.json new file mode 100644 index 0000000000..95007e08c5 --- /dev/null +++ b/docs/reference/openapi/accept-user-code-request.StatusCodes.json @@ -0,0 +1,57 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Contains a redirect URL used to complete a login, consent, or logout request.", + "properties": { + "redirect_to": { + "description": "RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.", + "type": "string" + } + }, + "required": ["redirect_to"], + "title": "OAuth 2.0 Redirect Browser To", + "type": "object" + } + } + }, + "description": "oAuth2RedirectTo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/accept-user-code-request.api.mdx b/docs/reference/openapi/accept-user-code-request.api.mdx new file mode 100644 index 0000000000..0412c627ff --- /dev/null +++ b/docs/reference/openapi/accept-user-code-request.api.mdx @@ -0,0 +1,37 @@ +--- +id: accept-user-code-request +title: "Accepts a device grant user_code request" +description: "Accepts a device grant user_code request" +sidebar_label: "Accepts a device grant user_code request" +hide_title: true +hide_table_of_contents: true +api: eJztWm1vGzcS/itzDIpIB2k3FxT3QYEPdWz14msvNmwHRWEFDrU70jJekVuSK1nn6L8fhtx3vcRu3MN9qD7YEpeceWY4nDfuA4vRRFpkVijJRuw4ijCzBjjEuBQRwlxzaSE3qG8jFSNo/C1HY9mAqQw1p2VnMRsx7hZ+MKhPVIyX1ayMa75Ai9qw0c0DE8Tktxz1mg2Y5AtkI+Y53UYJT1OUc2QDRlyExpiNrM5xwEyU4IKz0QOz64zWGKuFnLPN5qOfjMa+VfGaZkRKWpSWvvIsS0XkQIafDQn40CDVlvxEScuFNCDkTOmFWwRKApelKpaoxawgR5Jp0oAVaIhYpaFdIAfliJp+xojUYoVNsVLbqWPQVd6GFt4PlRZzIXl6QZp871XmZN2Q6CZT0ngIr1+9eg75OWiMhcbIwofLn2nrY7AKIrXIUrQIHFI1F3IAEXGWdgBK05DKbWkdwZZ6SpK3Vm2zviweEjthwCboOK8SESWwVjmYROVpXOOiGaTwlwamWq0MakKoZITuEc9tgtIWkkOmVYTGEOlSiJgQbu9SbXY3LcQf6w07P85tAq+DV1CihrcFhGvFuhvttrAtrCICr8vF14q5GTOep/Ybdm+stdJbWkc3undyRwEDP/82xmk+37MKTukhnNVnZCIn8lyma+BLLlI+TRGEOzKwUDHu0HPNpkF9H7N6bC+dRHh17SLwTkhLAN9hmpnKbEDEZB6ztRtxVCDiuXFo8Z6TjbARu06wfRSEAaks8DRVq50mNGDGcpubyhG0Mb27vr6AKzcD6KA3uX3/6m8D5pXKRkxI+/fva/pCWpyjPuhJnBjOOl/vMrv24wEzGOVa2LXzykqvyfEbc63uULLRzUfyq5bPyWkXFkuHgJzReqi5xVQshB1O8+gOCW+yjjUf8ngh5DAR84TRXFLClRPP+/6UyzmpdZ3hlUPGBizlU0zZiP2g9DqMUkGmP2BG5Tpygi8ypS08TCQAgId/nImB/32i5EzMcx+FirHj/Q51Ijcw02oBLxvcXr4h+yBXZsmh1fTgCCSu2jx6/TflXJ6JM2ksJ5/jZ1boei06fccgRVuEkZMyzI3Am80bCEPoFS6A/FguY5wJiXHfrzsQI0aH5PWElbMAnvZrOR/Am+kAYm45bOAI+IqLllDBzoDe80ruSFKo/gDOiey/YZtBZQP/VI29l9yKJTa3PePRHZ8jLLhw/qUwg95ETuzEu8h7O2H+52xRfVXGf1MZSp4Jv8MwYXNhk3waRGoR1js/nCua7fQyy2XkuPX6ZGwT25EQRkcwYZ3B2+LwThgp2m8mfAFafkAVROqvLYDBe1wd2MZen8gfmABfoLPNE9s25dERbHHsGLZDnYkTr7JdC44vzvzTjn3TSspDBqAH5ExpcUUpKE7FxVlwvNOgis0M3vLobq5VLuNevx+ctjXd62i+HxzS1wHl94PxPUa5RS+wmDnAfzkCKVK/8RM7W9jgx0wLaWc9ZYIrG6PWA5gUIWWVoISIpynt9qeviPfp0wi+W04mcsKcbvpfYfFjnqbgwkSZ2TXW+9Ub+hOG1QTv0j7tZj8qvFKdbtDqbfYqt8T+sk3za8I1saHJ+hO5aR7yi7VNXOAuDzoFj70+Xun1rX84kY59PRBQJpGawiXdFvVClXHfFlknFJQOhoA9pNUtJY2vbxtZX0luW4NdGrrJPBPje+LvUiM3M3OqLif4X3RKX8Ap+XmyI8pDEkVUDJQnGbiMoQgLhuJCYm1mRmGYpXztj0qQaUVpgAmUXvNMGHJxRPgKsR3NgmwNM6UpeRfGgppRFgMmzwgTxp3QVxdtgYsZrajYELztQ3wUcGKQt3ws3NIHvwBKuAqfvcgb8XhnVk/aoSGlxX+6qImYkBSQlI5diF4JmzgqxxdnYFAvUUOZAkGmUhGtA1o19i7dOGUhjxLHAxZoExUD10jVxFLEGMMUU7UaUELp00i/EmzCLVEy3AozE2iogtGeDM2NuMHAy3tSyfcWuUbdlmcE7bTsyTvB3dpbS4tptglQLoVW8mbC3o6PL8eXt9fnP43fT9jHagvG0hIOKNyy1xuXIMpcR80qNZan1c1pYDkunX8nUAA3FBiKaSMP8gWcaORUVu5jwo0p5MnErahzrgbHOvWq6febqUrdXIAjeNkdKwP5S3hBYdzF8Dqh2e9vWhgOR/AXTwvgxN3qdaEjr6fHtmbqNaSMKkwctfRX+tItoXpd5Qy+poajrzzv14Cc6+tNisqqAKZmdeo8/Mc+XCMXaJq0PLGmjMVTdP4XKjdMdoejbRT1hFZMfwwY+M44PPAdYJ9tXGlk4rthrCJXeDdqHCraxVxym2vc1yfr9ctOma+UisbYoeZQVQgesCvWLQK3OmsUrVtduJNGE65d3HZpNSNTVbFsM3D9OZtree2pdaMpFc1z1dXSnlzR3jcSuJ0qe6oULcAznpqmSv5Y/Xtuj9FP5hOpnZa04wQf0kyry1qr5kmW8pXz/ijV9A48CxZxfwvQTekfPz7dxnrdAceBuiB4b1EaoaRX1R2u2Whfl2PAljzNcVe3g5RTrq3cQDX/T3fwpzv40x38/7sDWugTfWpB5f72yiZsxEJ31kPlasSQ/oaFdCb0codeC1TXuuLC6zrXVPaWhdBDUf7cmjSfb3YWQ6HzGlpQG90lEs0lvqFc3BSwuqzaUs6vVHCc6zW8R7tS+g4uPBUgKgH8qnKIuISZkDEIS5USZds3zRUnShqV4sdeCT7yAwQ2MElYgg+jXGuUNpyjHRrLqZjsB4UyywLrii4tvDxTbkRUXWTQ7viRykiIHxn51FVE7Zl+aGuq3xaaOkvVyrFpFVInRTO+NfihtTXOowcxLlQpYGOvaVMjlXkB1GyWCunMGdwolNbns8jCLiiR1DjTaBJwBZiBHk8F94Xlp4LKrS/RPpF9t4eeTt/fyEoRuws1X1dwCecZyrNT2k9JFnB2Cr7HTzcJ9OWRerB+UeP+wSud1N+5POjeelyrokYWBlDGmaJmCN3qScSYILYMj2q+O1zXhrdarRwWOh0UV8kSXSEUZqgNuYChV9nQYewHbPAIk9HrX5S+MxmP8DgTP+H6ybhhVRIYprjE9H8vxmbA6Frwsr7+Hpe3Sa376Mb1FN1tl7eMPHLZCC64IBMoekE/+H2vb+dJkiv/jG3dKr2AM2m1ivPI97tOVZQvUFrfoXANpzSFLJ+mIvIdG3Kkwljtev7OSR1fnJkAjtsPaNA5KUVXi1MsmhkYF+0GDkueihguCuWBN0Fv3AFceI6OCjVtFsrYdO3vsoUsL42N78O8gKvTn8xEXtNOx4UE4AWdoilbEaZ9w0mjjR0PXPeqYlhP5caRd8qgNTNF14d0fqlNmvM5mhHB+AI/F7+LMvULnKqVTBWPiQD8ng+RaG7IM32+ENph6wPdgad/noHEbrKE9pRr21LMTZZPgxiX9QktBsLi8smEdXOnv1O3N5fj49N/j2sKnWsmE9+F01RNwwU3FnVx7WSK/2HMtQ09CUpAmroN3o+v26xkPkcbKD1ve5RquEZ9rteBb7+F/edEq6zELbwO7TgV90I3WSV4H2SLmpX//VjNPgNadJB2ov2n6rKqSe9lV90Y/iGWMFfbdlCg/Rdf8jarBV+ibFuCQa6jJKiehFxbMeORDU1CQSesL1763472M1/yPXZLaH2dW9lttvhs2qp1dlsOlzYRNq7k+8+pW4qYPmI1MXfR9n6hoDJDGyX93wt7WCz/Q8B74i0RgGS4eHfRMUWPTJiOt2gNt05iR+vfDDpLsh3m7DTubwRbaNeZ6AAtRsoSo2G84fbp+3a0DtJOT3GZT9dtVjqfrue4MG3EzdGQvrTO27OiJVZ7zt4l3Zi1WEXUwjKBUI0qrhwqvu1F+kxoze4IR3fCIkJpXKpaJpoZjxKkV+vYoFM509nj7rHTcbHWhD+fnYzfX42Hr4NXQWIXqatqUC/M+ewKNdXlVLxbZRrvSZUpJ1XaqI3PY1NShstvM2Xsgssmrse/Ett5pa16l+8pNIoUn27f6OpUuFLNqeOhaEfcMJdFs6ryHbCiTC2bEg6KE39QtGfo7S26maXVDw9TbvCDTjcbGvZv41K7IhaGUtayGXVAnt5lUZT2YR9k3w/d0WYqu6ju2qRsdrh3zgYsQR5T1V/1Yk88y6Fr5dRrt16NrDuwx2UjZv/cZp/n4sM1G7Bp8e7wwhdMmq9Im3zlW1++1+TfY6Ux/4YDpepsxDxJKsbcJtRv/1ZFW9nKuKkecbluAHx48DNc7bLZsFJ3Rc39cbPZ/BcgG8FX +sidebar_class_name: "put api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Accepts a device grant user_code request + + + Request + + + + + + + diff --git a/docs/reference/openapi/batch-check-permission.ParamsDetails.json b/docs/reference/openapi/batch-check-permission.ParamsDetails.json new file mode 100644 index 0000000000..ffa2a18c0e --- /dev/null +++ b/docs/reference/openapi/batch-check-permission.ParamsDetails.json @@ -0,0 +1,9 @@ +{ + "parameters": [ + { + "in": "query", + "name": "max-depth", + "schema": { "format": "int64", "type": "integer" } + } + ] +} diff --git a/docs/reference/openapi/batch-check-permission.RequestSchema.json b/docs/reference/openapi/batch-check-permission.RequestSchema.json new file mode 100644 index 0000000000..58afcb3075 --- /dev/null +++ b/docs/reference/openapi/batch-check-permission.RequestSchema.json @@ -0,0 +1,63 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Batch Check Permission Body", + "properties": { + "tuples": { + "items": { + "description": "Relationship", + "properties": { + "namespace": { + "description": "Namespace of the Relation Tuple", + "type": "string" + }, + "object": { + "description": "Object of the Relation Tuple", + "type": "string" + }, + "relation": { + "description": "Relation of the Relation Tuple", + "type": "string" + }, + "subject_id": { + "description": "SubjectID of the Relation Tuple\n\nEither SubjectSet or SubjectID can be provided.", + "type": "string" + }, + "subject_set": { + "properties": { + "namespace": { + "description": "Namespace of the Subject Set", + "type": "string" + }, + "object": { + "description": "Object of the Subject Set", + "type": "string" + }, + "relation": { + "description": "Relation of the Subject Set", + "type": "string" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "subjectSet" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "relationship" + }, + "type": "array" + } + }, + "type": "object", + "title": "batchCheckPermissionBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/batch-check-permission.StatusCodes.json b/docs/reference/openapi/batch-check-permission.StatusCodes.json new file mode 100644 index 0000000000..396730e242 --- /dev/null +++ b/docs/reference/openapi/batch-check-permission.StatusCodes.json @@ -0,0 +1,145 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Batch Check Permission Result", + "properties": { + "results": { + "description": "An array of check results. The order aligns with the input order.", + "items": { + "description": "Check Permission Result With Error", + "properties": { + "allowed": { + "description": "whether the relation tuple is allowed", + "type": "boolean" + }, + "error": { + "description": "any error generated while checking the relation tuple", + "type": "string" + } + }, + "required": ["allowed"], + "type": "object", + "title": "checkPermissionResultWithError" + }, + "type": "array" + } + }, + "required": ["results"], + "type": "object", + "title": "batchCheckPermissionResult" + } + } + }, + "description": "batchCheckPermissionResult" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/batch-check-permission.api.mdx b/docs/reference/openapi/batch-check-permission.api.mdx new file mode 100644 index 0000000000..c9f03b0b47 --- /dev/null +++ b/docs/reference/openapi/batch-check-permission.api.mdx @@ -0,0 +1,40 @@ +--- +id: batch-check-permission +title: "Batch check permissions" +description: + "To learn how relationship tuples and the check works, head over to [the + documentation](https://www.ory.com/docs/keto/concepts/api-overview)." +sidebar_label: "Batch check permissions" +hide_title: true +hide_table_of_contents: true +api: eJztW3tzG7mR/yp949oKeUXOOI6zyXFLV5El7kbZXVmRlEqlRBUNzjQ5WM0AswBGFE/L755qAPMih7Ls1V7dVVl/2CQe/fih0UB3g49BgjpWvDBcimASXEvIkCkBqVyDwoxRu055AaYsMtTARAImRYhTjO9gLdWdHkGKLAF5jwqMhBvqTmRc5iiMnX87SI0p9CSK1ut1KNUmjGUeJTLW0R0aGcVSxFgYHbGCj4nMPcf1MAxGgSxQWRJnSTAJFszE6QkxvkCVc61J5lFQMMVyNKh0MLl5DDjp8XOJahOMAsFyDCZBzh7GCRYmDUaBjlPMWTB5DJZS5cwEk4AL8/XbYBSYTYHuK65QBdvt7ShQ+HOJ2ryTyYbmxFIYFIY+sqLIeGzFi37SBN9ji3gX13ckOljZoREeLNVRUChS1HDUNNMhTZ+4wVzvE7tsrcvebNJYFyzG/XnnVRfIpV3EihBcE8sGAG0UF6tgOwrk4ieMzT6p97b9+XQqUzqszPNp6dIyn/Nkn9qV6zs77Sc3EzMx5SZFBX7kFRqQ9bezU4iZgAVCoeQ9TzAJn5JAo4Xm8xfAs4UrNJ+P/keIPB/6Jwlt3VbgCpNgctPSshazxeq2nl73GW4yS6/G/eVoth0VqezHMaXYxnI5NLHPo9g9uaVZD2Op+IoLll2Qizl3vsT1k2C6kEK7RX/z+vXLe4dL1GVm9na4ss09fuFYgFWZ1tP5Zz80hOsUQaoEFbCMr4SGNTepXXQuitK4PrL1Ay7ngGzwTyIzVUqqPTFZlsk19uzRdYp2BxL3auXc8QJcQzWtXrSFlBkyQZCjZbRHkIkN2C5YoaADAxNYpzzzpxQXqx5eH7XwSpAn7C7uWo7DhCBxiPRZYptDtZBPcOgzUG8W1kS7QDw1ehS8/VU2ShakDRMJUwm8Vxv429X7czi+OPPQu8M03DODA2tmEYJqD+3NSnBRrvZnnVIzkAaMCw12FHDheHMpyNC5JjMqdcmybANCGmD3jGdskaG9vaRM0zVlgYCCGq2LxweWFxZx0jNhhi2YRmAJKwwqWDMNpR1NU5fcX4IwQ7rk9HndA2qTDyHx7GwLATm9fQn8rQMTgkiWKkaIZZklVp8FwlKWIjnId95hug9i/a2BclkquylbYAJtlRRBMFOq+siyDLoC++PIupSzU/j9mz+8/SMkErWVFh+47oWo7/w+O7U+AErBfy4riM5Ow5lYohVjLqSZNws6Vepb13EuzXHVPBM/l9KwOT7EiAkmNOzv1DL1DSS+KHPahL10g1HQpdDao14BOh5WckxkxqRDMOkn9dkibkdBjlqzVc9F4kfX0SxfY09+Tv+9xTBT6nkskx6aJzIhuysUahSmTdJNA5oGg7ev347g7es/0D+/H0EYhsOONVD/M27Wh12e9eE8tg7ixPuqXc/pdtdtM6l2Rs6vXDZ+pcumx2laWt85poHtXTLymF9c5RdX+cVVfnGVX1zlAVdJKGFcKm42NvEi1eY4jlHra3mHIpjc3FL+xLAV5WWCoknZ3LrQajOmq3rGc27GizK+o2A6oITQuCgXGY/HKV+l1ngIzisLmkvxZEysaPdvCryy4gWjIGMLzIJJ8BepNlGccedsnEMgOPNCKgOPMwEArUDmuOAj13YixZKvSpdv8m3vDsSHM7GFpZI5/K7F7nffUHohlkIbsraGGByBwHWXwWD4TTWWFfxM0HkRox/ZEW/QoTW0TDI0kLOHU0ppTUCU+QLVNxBFMJB2rVg2hIE/yMgNlyLBJReYDN3cQ3Hv5KDGO9QbTR+9zY/sUQBbOAK2ZryjVtjHb+AgrtTwiB+SbCaG3wTbUb3238nWmgtm+D22l7tg8R3t+pxxQbL65R/MxMzM3Ln+YGaB+7rM649Su0+yQMEK7hYWZsGKm7Rc2Lxls+DjlaTRFoxlKWLLbTAkI5uZSi+YHIHd2oM//fm/hoSi/Qa/QBdOc0hzIvCfHXnCc1wfWqeBZXGod4+rmJmuqU6OYI/XjuHSJFbwE4dN34TjizPXu2O7NJPuMSNQI3KYNLmmFLas/uIs7FNh4BcufMfiu5Wig30wHIY/eqgHFebD3tkWnkMoD8PpA8alQacfX1r5/uMIBM/cgs7MMjfht4XiwiwHUodXJkGlRjDzN7R1igJilmWUcPjwcW0+fJjAV/ezmZgFFo3hR7h8W2YZ/PX6+qK+C7bmu9lb+ieK6gHOSX3o5d6/1126gMjsyyFLQ3Jcdok/Q9G2nKiL4Uxs23v5YmNSm8mv9jOdDQdduFSbueucCStB0xDmMsFMO3czt9mZeXPuzBe0AzyVw57902i6HM5TVCtEd+kq1PW844LTZcZuTD+ysNBXA9w32rCv4JRceZXUSiVR0VBtantv957fXt6r0kuRsY3bMmGhJJ3wmkoxrOCa3BoRvkLsHlxhsaFgBRhkXNt8M8sy0GVBMmGyc8o1dZjQHg6dA7CleNedOLdv1TiCWfBccSu/+8qmNr2fzsvW0YsWH1aaFIXxoZtFh5qk4v+zKzUR4wJYHEuV2NO4TpLSdUmjogpXdeWBQmY83oQ0a+pudNqChSxOLQ/I0aQyAaaacgIsMJPrEZTaiefvgmBSZoiSZobrJUcNG1kqR4bGxkxj6PQ9qfV7h0yh6uozge417JNXgtm5c0OTabQOUdxzJcXNLHg3Pb6cXs6v338/PZ8Ft/USTAVFfgy8e3a4MQG8utb4gIhgrLauHdOS5bg6B3bODGCazgg/bOKEfAUnCpnBw0yY1l6fgs95c71qcezeshoew/piMrc1QziCP34NZBtm9/ysbywHnE2H3xNH9qtPOLGJp1Ebj4RDwxUQXM6/kUE3Q0i7+lA46oBywLMNav2P6k+jp5Q9eqJv2EhiHdlg5kN3L5Fcdu+84//uJzaxp0ibmiPXVs/3ovWnULtVsiOc7MvRDOic388TB77SViL4CnAYbG1go5O7MdW2KWxsRSiUL+IrlyA4kKofDKtqtgtzfPH6YJGqjtgOGU+wG8AF7djQqBLpFG5q5Ke+RO7Jurhij0grxmgfNHWMsc/EltFNqcT1YXmbOsVK7oLVfxc0D61LWy9y+ypVQfYTsCxZptu4/FbwOz6fBk3hbkp9trS/gQ9iMk/2QNkT9aZa5NunbOaJLf9xeAaHOsI8GX6SQM8HsZen67JcKamBDwaF9Z8WtzvcBJNDCYtRcM+yEvsSFwRTNbf2CfX4L77hi2/44hv+n/kGIuYu9ZRikjZXXzCTBpMgql4XjN3zrciqH1n1KYi1wYMDu1QU41aBzqMPb+Y6K1fb3mAnsm5DcUqGa//gqJ7istO+ZBU0YdMeSP+igIKqUedo6N0eXDgqQFRC+Jcs7dsnW7HhhiIhuk3ftGecSKFlhs17vtg12Dd9Oo0q4aO4VAqFiVZoxtowChaHoQewCqCuqHrm9FkwzeO6ouaMh1pqMyF+ZOMLG/F0R7qmvaGSwqI39plfJtfuRUo7UDrxmf1O4z86S5NuEsXCBHNZKeiIRvSvfUkoC6eAXC4zLoj9MdhWqKzQ3Sp9jYoulgqXCnUKNsDSMGAZZy5w/OCpzF0I9oHsvNv06fTdG0pB9aPg0g2imOl9geLslNZTkAWcnYLL2VOtgT48EwfjJrUqFA50gn+nGLBXI5U+BuYaUCSFpOhqI0sQiAmJ2DE8iunucPPEQ9L6DWmBSpMrGDvIxlZGW3f5uMmozT/pQSs9QTsu+Pe4+WS53YtYIjDO8B6z/301tqOA6tOXzbPVaVVvap6W3nSeKTZ1uurBYdPSvB5s2toPMPdb/aPIz6a/3d5SxVMsZVWCZ+4NJOaMZ/YFoc0//cXZYvPIl9C9cn3BXunqFZwJo2RSxi7Hdtp+oOySXFkG7v7mskRJzgXXRtnagnWcxxdnOoTjbgc1WscpRbaherNbMEx8ioPBPct4QgGlXVBw28JtuBAuHEdLhRJFudQm25CNJeSCF0qutcuozcSrV3B1+r2eCVu5r55Yg1N0gbpKf+hWGd+78ZYVuseANcNWxV9b8hYMmrOU9AKOfArlaUu2Qj0hMX6BH/x3H0r/AqdyLTLJEiIAn/NHJNoL8kJ/v5C0484f7DZ8+t8LkOgnS9KeMmU6wNwU5SJM8L7xGr4h8kUuHTVJpmEvtjeX0+PTH6cNhZ1ylk7uokUmF1HOtEHly1va/x8lTJnIkaCLUBvb8Hx63WUlyhWaUKpV18vVzY3U79UmdCm/aPiS0kojcE9eK+004w9ctVml+BAWecPKfX8usi8gLVqReqX9Tu6yakgfZFdXJn8TS1jJfTvw0v6N3bMuq5zdo+hagkam4jSseyKmDF+y2EQ6pYMwaio/w18v7U/snh2wW5LWBd+13Rb5T7oLrbXbqrmyiahV8R++JLZ0irsTqy3zrrQD++J6iSZOh58r9thP/02Ed8Q7KgDpcPHXix1TdJJxveMtOs2dnbiD+q8WukiLHnO2iLuSZEfaTcF3BPUtVdjTMt5of/f9emmtSL2e4rJcbLqsVLnYrDDXXYnbrRF96Oy3F5WWWB3Ye5dUpeuwiimvpkMuW5Fl1eQ/HZT0haTV/SccFaV5jPQ+alJnNo4LFqcIb8LXwWgnmqe9x2y3xdjP1dEPZyfT86vp+E34OkxNntlIC1Wu3y+v6Pdu9pocGalbr7uqKydF/6i0u8dmBIbL90htciZach2oAu1mAlrvWv+v/d7PRzJURKQKMLcRqUX40SdaboKdREswcpmmYOR+jkGvy6iaTEMfH+lp6j9Utt1Ss/tRIAU/Cdf2PavPtI18orb9M8Eqr2urOlX2xT5qGwWkP6Uh6uywf3w3tjmmZu7eo+EmJ0xRQGGeHNtONl28v7omTf2vEHObvAgUW1MIxdYuf+iyYO43QtTmHliU9llk4GhSeGizFxQM+t/XVGFklVy5qbuY2LQkfHx0I2zkst0GFWo+C3C73W7/DVEWO08= +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +To learn how relationship tuples and the check works, head over to +[the documentation](https://www.ory.com/docs/keto/concepts/api-overview). + + + Request + + + + + + + diff --git a/docs/reference/openapi/batch-patch-identities.RequestSchema.json b/docs/reference/openapi/batch-patch-identities.RequestSchema.json new file mode 100644 index 0000000000..f918520840 --- /dev/null +++ b/docs/reference/openapi/batch-patch-identities.RequestSchema.json @@ -0,0 +1,620 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Patch Identities Body", + "properties": { + "identities": { + "description": "Identities holds the list of patches to apply\n\nrequired", + "items": { + "description": "Payload for patching an identity", + "properties": { + "create": { + "description": "Create Identity Body", + "properties": { + "credentials": { + "description": "Create Identity and Import Credentials", + "properties": { + "lookup_secret": { + "description": "Create Identity and Import Lookup Secret Credentials", + "properties": { + "config": { + "description": "Create Identity and Import Lookup Secret Credentials Configuration", + "properties": { + "codes": { + "description": "Codes is a list of \"lookup secret\" codes configured for the user.", + "items": { + "description": "Recovery codes can be used once and are invalidated after use.", + "properties": { + "code": { + "description": "A recovery code", + "type": "string" + }, + "used_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + } + }, + "title": "RecoveryCode represents one recovery code associated with a lookup_secret credential.", + "type": "object" + }, + "type": "array" + } + }, + "type": "object", + "title": "AdminIdentityImportCredentialsLookupSecretConfig" + } + }, + "type": "object", + "title": "AdminIdentityImportCredentialsLookupSecret" + }, + "oidc": { + "description": "Create Identity and Import Social Sign In Credentials", + "properties": { + "config": { + "properties": { + "providers": { + "description": "A list of OpenID Connect Providers", + "items": { + "description": "Create Identity and Import Social Sign In Credentials Configuration", + "properties": { + "organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "provider": { + "description": "The OpenID Connect provider to link the subject to. Usually something like `google` or `github`.", + "type": "string" + }, + "subject": { + "description": "The subject (`sub`) of the OpenID Connect connection. Usually the `sub` field of the ID Token.", + "type": "string" + }, + "use_auto_link": { + "description": "If set, this credential allows the user to sign in using the OpenID Connect provider without setting the subject first.", + "type": "boolean" + } + }, + "required": ["subject", "provider"], + "type": "object", + "title": "identityWithCredentialsOidcConfigProvider" + }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsOidcConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsOidc" + }, + "passkey": { + "description": "Create Identity and Import Passkey Credentials", + "properties": { + "config": { + "description": "Create Identity and Import Passkey Credentials Configuration", + "properties": { + "credentials": { + "items": { + "properties": { + "added_at": { + "format": "date-time", + "type": "string" + }, + "attestation": { + "properties": { + "authenticator_data": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_dataJSON": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_data_hash": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "object": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "public_key_algorithm": { + "format": "int64", + "type": "integer" + } + }, + "title": "CredentialWebAuthnAttestation contains information about attestation of a webauthn credential.", + "type": "object" + }, + "attestation_type": { + "type": "string" + }, + "authenticator": { + "properties": { + "aaguid": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "clone_warning": { + "type": "boolean" + }, + "sign_count": { + "format": "uint32", + "type": "integer" + } + }, + "title": "AuthenticatorWebAuthn contains information about the authenticator of a webauthn credential.", + "type": "object" + }, + "display_name": { "type": "string" }, + "flags": { + "properties": { + "backup_eligible": { + "type": "boolean" + }, + "backup_state": { + "type": "boolean" + }, + "user_present": { + "type": "boolean" + }, + "user_verified": { + "type": "boolean" + } + }, + "title": "CredentialWebAuthnFlags contains information about the flags of a webauthn credential.", + "type": "object" + }, + "id": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "is_passwordless": { + "type": "boolean" + }, + "public_key": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "transport": { + "items": { + "description": "Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to\nhow clients might communicate with a particular authenticator in order to obtain an assertion for a specific\ncredential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may\nbe reached. A Relying Party will typically learn of the supported transports for a public key credential via\ngetTransports().\n\nSpecification: §5.8.4. Authenticator Transport Enumeration (https://www.w3.org/TR/webauthn/#enumdef-authenticatortransport)", + "title": "AuthenticatorTransport represents the IDL enum with the same name.", + "type": "string" + }, + "type": "array" + } + }, + "title": "CredentialWebAuthn contains information about a webauthn credential.", + "type": "object" + }, + "type": "array", + "title": "identityCredentialsWebAuthnList" + }, + "user_handle": { + "description": "UserHandle is the user handle of the webauthn credential.", + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsPasskeyConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsPasskey" + }, + "password": { + "description": "Create Identity and Import Password Credentials", + "properties": { + "config": { + "description": "Create Identity and Import Password Credentials Configuration", + "properties": { + "hashed_password": { + "description": "The hashed password in [PHC format](https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities#hashed-passwords)", + "type": "string" + }, + "password": { + "description": "The password in plain text if no hash is available.", + "type": "string" + }, + "use_password_migration_hook": { + "description": "If set to true, the password will be migrated using the password migration hook.", + "type": "boolean" + } + }, + "type": "object", + "title": "identityWithCredentialsPasswordConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsPassword" + }, + "saml": { + "description": "Payload to import SAML credentials", + "properties": { + "config": { + "description": "Payload of SAML providers", + "properties": { + "providers": { + "description": "A list of SAML Providers", + "items": { + "description": "Payload of specific SAML provider", + "properties": { + "organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "provider": { + "description": "The SAML provider to link the subject to.", + "type": "string" + }, + "subject": { + "description": "The unique subject of the SAML connection. This value must be immutable at the source.", + "type": "string" + } + }, + "required": ["subject", "provider"], + "type": "object", + "title": "identityWithCredentialsSamlConfigProvider" + }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsSamlConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsSaml" + }, + "totp": { + "description": "Create Identity and Import TOTP 2FA Credentials", + "properties": { + "config": { + "description": "Create Identity and Import TOTP 2FA Credentials Configuration", + "properties": { + "totp_url": { + "description": "TOTPURL is the TOTP URL\n\nFor more details see: https://github.com/google/google-authenticator/wiki/Key-Uri-Format", + "type": "string" + } + }, + "type": "object", + "title": "identityWithCredentialsTotpConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsTotp" + }, + "webauthn": { + "description": "Create Identity and Import WebAuthn Credentials", + "properties": { + "config": { + "description": "Create Identity and Import WebAuthn Credentials Configuration", + "properties": { + "credentials": { + "items": { + "properties": { + "added_at": { + "format": "date-time", + "type": "string" + }, + "attestation": { + "properties": { + "authenticator_data": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_dataJSON": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_data_hash": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "object": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "public_key_algorithm": { + "format": "int64", + "type": "integer" + } + }, + "title": "CredentialWebAuthnAttestation contains information about attestation of a webauthn credential.", + "type": "object" + }, + "attestation_type": { + "type": "string" + }, + "authenticator": { + "properties": { + "aaguid": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "clone_warning": { + "type": "boolean" + }, + "sign_count": { + "format": "uint32", + "type": "integer" + } + }, + "title": "AuthenticatorWebAuthn contains information about the authenticator of a webauthn credential.", + "type": "object" + }, + "display_name": { "type": "string" }, + "flags": { + "properties": { + "backup_eligible": { + "type": "boolean" + }, + "backup_state": { + "type": "boolean" + }, + "user_present": { + "type": "boolean" + }, + "user_verified": { + "type": "boolean" + } + }, + "title": "CredentialWebAuthnFlags contains information about the flags of a webauthn credential.", + "type": "object" + }, + "id": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "is_passwordless": { + "type": "boolean" + }, + "public_key": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "transport": { + "items": { + "description": "Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to\nhow clients might communicate with a particular authenticator in order to obtain an assertion for a specific\ncredential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may\nbe reached. A Relying Party will typically learn of the supported transports for a public key credential via\ngetTransports().\n\nSpecification: §5.8.4. Authenticator Transport Enumeration (https://www.w3.org/TR/webauthn/#enumdef-authenticatortransport)", + "title": "AuthenticatorTransport represents the IDL enum with the same name.", + "type": "string" + }, + "type": "array" + } + }, + "title": "CredentialWebAuthn contains information about a webauthn credential.", + "type": "object" + }, + "type": "array", + "title": "identityCredentialsWebAuthnList" + }, + "user_handle": { + "description": "UserHandle is the user handle of the webauthn credential.", + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsWebAuthnConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsWebAuthn" + } + }, + "type": "object", + "title": "identityWithCredentials" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "metadata_admin": { + "description": "Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/`." + }, + "metadata_public": { + "description": "Store metadata about the identity which the identity itself can see when calling for example the\nsession endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field." + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.\n\nUse this structure to import recovery addresses for an identity. Please keep in mind\nthat the address needs to be represented in the Identity Schema or this field will be overwritten\non the next identity update.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array" + }, + "region": { + "description": "Region is the Ory Network region this identity will be created in.\nOptional; defaults to the project home region if omitted. Only effective\non the Ory Network.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "type": "object" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.\n\nUse this structure to import verified addresses for an identity. Please keep in mind\nthat the address needs to be represented in the Identity Schema or this field will be overwritten\non the next identity update.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array" + } + }, + "required": ["schema_id", "traits"], + "type": "object", + "title": "createIdentityBody" + }, + "patch_id": { + "description": "The ID of this patch.\n\nThe patch ID is optional. If specified, the ID will be returned in the\nresponse, so consumers of this API can correlate the response with the\npatch.", + "format": "uuid", + "type": "string" + } + }, + "type": "object", + "title": "identityPatch" + }, + "type": "array" + } + }, + "type": "object", + "title": "patchIdentitiesBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/batch-patch-identities.StatusCodes.json b/docs/reference/openapi/batch-patch-identities.StatusCodes.json new file mode 100644 index 0000000000..dfc2ba4527 --- /dev/null +++ b/docs/reference/openapi/batch-patch-identities.StatusCodes.json @@ -0,0 +1,208 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Patch identities response", + "properties": { + "identities": { + "description": "The patch responses for the individual identities.", + "items": { + "description": "Response for a single identity patch", + "properties": { + "action": { + "description": "The action for this specific patch\ncreate ActionCreate Create this identity.\nerror ActionError Error indicates that the patch failed.", + "enum": ["create", "error"], + "type": "string", + "x-go-enum-desc": "create ActionCreate Create this identity.\nerror ActionError Error indicates that the patch failed." + }, + "error": { + "description": "From https://go.dev/wiki/CodeReviewComments#receiver-type:\n> Can function or methods, either concurrently or when called from this method, be mutating the receiver? A value type creates a copy of the receiver when the method is invoked, so outside updates will not be applied to this receiver. If changes must be visible in the original receiver, the receiver must be a pointer.\n> If the receiver is a struct, array or slice and any of its elements is a pointer to something that might be mutating,\n> prefer a pointer receiver, as it will make the intention clearer to the reader.\n> Don’t mix receiver types. Choose either pointers or struct types for all available methods.", + "title": "DefaultError is not safe to shallow copy because it contains\nfields which are not value types, e.g. maps.\nA shallow copy would inadvertently share these underlying fields,\nleading to incorrect behavior and data races in a concurrent context.\nConsequently, all methods take the type by pointer and not by value." + }, + "identity": { + "description": "The identity ID payload of this patch", + "format": "uuid", + "type": "string" + }, + "patch_id": { + "description": "The ID of this patch response, if an ID was specified in the patch.", + "format": "uuid", + "type": "string" + } + }, + "type": "object", + "title": "identityPatchResponse" + }, + "type": "array" + } + }, + "type": "object", + "title": "batchPatchIdentitiesResponse" + } + } + }, + "description": "batchPatchIdentitiesResponse" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/batch-patch-identities.api.mdx b/docs/reference/openapi/batch-patch-identities.api.mdx new file mode 100644 index 0000000000..9cafe5e32b --- /dev/null +++ b/docs/reference/openapi/batch-patch-identities.api.mdx @@ -0,0 +1,56 @@ +--- +id: batch-patch-identities +title: "Create multiple identities" +description: "Creates multiple [identities](https://www.ory.com/docs/kratos/concepts/identity-user-model)." +sidebar_label: "Create multiple identities" +hide_title: true +hide_table_of_contents: true +api: eJztPe1yHDeOr8Jr11akq/mQFdlJJpe9lSUl0cZrayX5Ursa15jTzZlh1EN2SLbGs46q7jXuCe497lHuSa4AkN3smR592PLeXp38w5K6SQAEQRAEAfSHJBM2NbJwUqtkkBwYwZ2wbF7mTha5YBcyE8pJJ4V9uzVzrrCDfn+xWPS0WfZSPe9nOrX9S8Odtv1Uq1QUzvZ9p2W3tMJ05zoT+XZvqIbqL7pkKVeM51az0grmZtIyobJCS+WY0+xCzgttHEuNQCA8vwPiOVd8Kro1rX2CQvh5mupSORu93+4MlVRpXmZSTVnBrV1ok9kOszqVPGdWTlVXKmaFc1JNbYdxlRFXuhOeOm0YL90MwKUceMfmws10ZnGUxxPmZoIV3KUzRmiEZTNuZyKrkbGlZ4YfcVnA+J92dnZ2WE0pK4RhRvxaCutuAM4dywW3jmklWJFzqZx47ypk7bh2b8a0f6Vl5nsAm3JupoKNAbGwbCHdrAWT7bHzmVgispTjFMu50KWzjFtPeWCAEiIDOsYiMGcsJtqAVIgl40Yw67QRWRh3Y5BBxpi0nkaRMVumqbB2Uub5soPYjLCFVhZAcVdaaA3Dfv1Tj0Dmue9t2YTLfKWTtIhLE88nOs/1Alix9/49E8ZoYwdDtbezw17wjJ0S7wbAgMBIVvBlrnmGVKornsuMaQMojS6EyZdsos2cO4ej3Nv5hh1oNcll6gbssCxyEC8RT5I2LPUtgJCMO84WwgiWCSdSVzMLZnwqHOPs2c4e+4E7seBLdk6TMRiqU5GVKbKappRZ+TcRJj1rQT1UJ0Z0YaKiKUQpeHFgloWLhFNaWwqQJyutsx2g2PHUMVsWwOpe0klg9LhyjrNkkCAFJ/DfcYUv6SSeiS90tkwGHxIAI5SDX3lBBEqt+r9Y0F0fEpvOxJzDb02lhnBZDZghvE5CU4CoBh+SeqDrEKK+M51nJMe5BEmc0EoUFgQZqFoCH4BwaUSWdBLpxLwF5ImXi4k2BAFmExaoF+s1+lJUzeuASGWH4S3bBxdp09shgKo7Jj1xEPVbhZlrfVkWIytSI9y9oL7EnuwMe96IA0RdTh8GOK4sOS1J7FpQZW1TfwCPYfXyasKHfuiMhj5MGPZlqYcvaFZBRmD/6W0WglOR6ithlgEAV6ALSysyBlspDgvUoNccHFQcnzhhoE2vdQjrSPaZidEkncQtC5EMEuuMVNPkupMAxhHHSSR1lAwSwNYF3Q0dpMuhx6syz0GDgP7KxVwoZ5n9Ne9VzyelSgEtz6Vb9tZRXdewwtiBwcyIwgiL8EDfNghm3OKuDINHdcNZQ/QiUyHCqMe/iNTB4PwDbgxfEgWNFjVF+9lcqiBSJE2R+JBckViRJD0QMKBRyyy9l5SfkZ1yJqeKHas7rqHm88LoK5kJ0yKX+5Wsvy6EOj6EpaNE6thJ1WejTH8U0besTW2mXMm/0ctYSMtSZntJJ1FlnvMxMN6ZUqyKXVOA37w5PgSeh/GvDwH275WBh8ag5XOpLnF12xJnnTndY29syfN8yawGSxDNJXkp2Lup1tNcvIN9+91Uulk5fteyLjqJh9VOTEC09c6W43fbwR5ZoTGln1Krmhxohp3YRIo8Cz2PD9m5vhSqlZTSihEvnR7BQFs2wwmYxR0y3eu1B6aUXthK7QGnwIxmUrHSAkNaSK7YCgtbly4Y3A32TqSxLqJ0rHUuuMLlV220g4uKhdHUvt28QMNG+7N0s0gSX8ssJWEMsn4vHXIr1I/tjRLLrb0Uy3utuRPq89C7bAvY2/bXpglSaY9mK55lt2xFq9IKtjPY9l41rICrD2najMBYbuCu9YhU7usaOpxppm0z30nSXArlENQfz16/ekBwIzCtPxWerrTIp0ApynEu09GlWI54PtVGutm8AUoq93yvBVS0v9eS8bMY75dupvbrmaITgVRwKCKg8JCPQQVEEwrqCo43Y5hHddtGH3Uc0csPLeISS0SLwPBpKbNPn1WtxGjBjQKsNRmV5uokoBpH6JdYw/Hl7s2c3Y+HEJh7E0dBmTbGfT++ZtIWOV+OFJ+383SS82nLWh7zFKw0kcupxL25jQ++EczbhhawmYy8eXhDiyth5ESKrK3JjWL5PVB/G/twiPdj26eLkbSjcNLOhbXtg6/X6qeic4YrC9q9AWjFMozFyLI5X9ZnAXbFjdSlZRUgiwehVM/npcLTupqSCU9qD31F6P8r594bwDIxkQrO2VJ5l5EeqplehC5sLqczF8EU4VBQcONkWubcrAi7VEwbb7vpMcwyHLS5tSCqWiGNnNlCpHIi06GK5pW90g58JBylwApPVnVcQdmoluCpyJcwxBNu3PILy8bgABqLXIoJjYTBQAB3g745Xw7VGE49PJ2JrMf2m5DYQuY5c8tCpmjT5YIbFSw571IBR1qT65yRZDDYpiMz7UryoZoKd1413yLf7JlnAM7DgP3Xfz7rfd3b67HGlLOqGzuKZq3hoV182dNm2j8/7Yel0n8CU5yJSbcx8ori7WSDdquxRSdEMmBfotjQ5CMj+FwwUFGtNu26AbdRH9y4N9159TcQrlt4kd0U8L6U1lXabMZVlrcc5t9YYX7Ed+CTqGxtah5kYgONH68b7m+yevvw421eDyCYvaAD722gouf7Mxi+q3BvsXzJtz3aPAw44q3cDoDSujj58cC7hz/DFcgTwtitfLnbbevmZqJjavEqgOFdgJwwpXFE6Di74hIP5xsPmwHMaC6nxMPRTOuNR09QpHjMb1wnkJYcC0ZARBadOqs2FQIGCDacKT9CUgH4p8k6MhnsQj7PN3uLnQ43OGf7f3oZX5LdWbYDKD0hGEXk0vkIBxHCuINbKEIbdtom/n8Ep0+DoE2unnt7b0olfy1rEF5J0wRGLhs0ha54Xgo2L9FwYHI+Lx0MkZEBwqwuTdq2kD6HK+SMz/OHd4XUUD+2N1KhXXEvvX3++vyE7X6//9D7QRvcW/YDoH1UmpZlDsDenL4MWzvCfnP6Eqyz78FQ1HTPx2VumRViwMKuQJ5F3BTI4eh/NO2t/kJeyv5PYtl9Y2T3e1pPrT76+03KuXbFx08p9IYpDVbLvdhfGW0PPK1tcB8dXI8OrkcH16OD69HB9ejgenRwPTq4Hh1c/48dXGFQH2/3Bggf0xdGIN47YRTPR7LFO3PkXx4fogtGMV1QXA4L3SAGwLMzIPHaSloKQfLn36GK22CYm6qh2KV1Yt5jdVSAaKAIR1k6BA8VT422luIuK19Uq0TPheNoNnIIpVkf4hnEhrLQKtrKUGAWM5nOKH4zXzKOYaGwSTM3M7qczhhCZfsnxxaiRmegv979cHTO+viiHznS/kVmv3/Xa5BEmuceNFXsI7oaj6SzIp9g9JcVgi1mAkJn8xz0Iyg68Z7DDgSdhsrCOLSqYqZ77FAzpR2FyjIrlJVOXonG2t4SvWkPF4t0zKbaiO022sB/BwKAoSI44NgH4+XsQdwwIcBrxLPMCGvbIu9CgNh+aFLrLZAetPmqV7iDxfFzTocosjiqEveBNyHu3DpTpq6EgOPKr1aFntWwcbOJYLATiEIW7FKIAng2lyqDReJ9NL4jRjdbH95cKXeREZejU+cZhq0yjBgMzK+cmUDLwkjnhBoqTT0V+lhD97KA02ND/a1YqUbwy9E059aOJtqMPotfjaJTw8G27Zid7TsKo5yJHCLNifl+uMDiqR6XkwnPda/QBYznbsfjFqls9TMjm9oJfEPvPhOB6NJrPVZcSd7yfMWVR92p8Q0+vCC3Qaz8qmkzg42Y+qlfXXDwPGy7r82SvRJuoc0lox4kn7Um8yLqp55J1Ruq136b+RbsXF7mDlcA+uCNRvfnTM9FACgnTM8lBr+z16CnxWQC7tArUQl7REZvqETZTYVyhufs6M0B/TZU3EreVdq4GWYH7FvJX8FfR9y6oSptFx+/Oav+Xgj8+2cBf4uSHb0hINgVWrA3Z0M1zfWY5+wH/JF0EjDHYEZqIpJO0sSdgHXTrX8DRNCz9C3xadJJCHQ0n9Xiet+d6i5g6sLkJIPkf3HIcIpH5dRqYpDeIgPDxxR6ewL8RkGtkf5DlQxryMcxh4uZIExf4JlKunZLoDo7r262mKBgVyFh8x6YGrgRYrN9L1Wy8fTY/xVNbvUgtLzTJN0DFZ1DpWvZ8c7xeXT4inadmkOYXhJnv+AFgdN+IXbYXGdysqSUpUzkAg542BVogoOgyCddK8yVTAWbc6WE8UBVUTpa1zxf8CUc8FgUeT6FzdetTTGdaDOE/s4LTGnyd63HBvJiAMk37f3/VrW69+4f3CRsvKxD8G/d9qte/4e3/VtY6A8CkUDVcxGo35B10r5t/gyGqk/gc2bJFtyGzQAWFFmtySDZ3Xm619152t15er775WD368Gz572vvt796z23+PWLtePDGMSmnZ8Sv+7AoDPKEMMTC1jU4n0KCWpPn7N0xg1PnTA+iY27oHZyOZfelesn+OzPL/3crhGzfqzbQMNtBksb53NQ+L7Tw7K/MmDWZyAIPTaBRRbOKhOt/4ArL9XzVpiRM3Pljl9l6PWyYB3EC2vGYekbwbMlGwuhqjUbj7ZhsUZOxND275LlUll26wzLRC7xeEH5orFVMecSDAo7t7Dl1PMXXtzRTKyZcoX2hhf/G0zHWg3cajyuXjNX1kG1qd2Ah3RDwIF5ahhh4tJZq4FxHhkV0lKWHGry8yr/layP4NsgLwR5+UTWCVZJUKpGuNKoShVDlh6leULaL2wvFvx9tkK4f3JMaazaGJFzJ5q5ocExN1RE2e266A5+HsxVvJd/qmhmTRJbocP7rjZyKhXPT7jh81d4uZEEtodhoGLc3dlJPjW/MspRDbDvlWNZT2pFWpVGJ1Umr2RW8lWn0ca8Oj9H3vMt1TSPbCZEs0YcT13rsQj1XFo50smECCEsCAo96iAf+9jMXysz/7NxaoIzDOQN+6ZH+DujH7LSfJVRQQyBxGSR9SJl4ZNBOwkCu5OJ+vch8TqQtMbG742e1/EKupeJK4pHgATAU3ElxeJAz1HbPjEiFaAmuzCqwVD9nh1wValdsJl8un2HCelmAnOi09IYoVy+hPeVEw3OHYAZh0i9OhglVrr6GBLw/Svb9xE4gNgbM+ASSHWxDKeb0JhwwBMC61O89SWoHqsZ5LzLTPg92ZIaArtiLDBRWJKXCgkLMFGDpTOupsJWrtMrSZ5Lb2CEVV116jTJCt04QwchWr+/Z8crxKOngyzhDkMtA2yzuQxppwoHDOcRETZB7OOBYnpXleuG0kAXVxFvO4C4MGIiTNSxJptbJv15Y84vhV/qoILwBh2ugQgRUc4zP5ZDrf773/8DEL6vBwQzZnvsYKa1FUEsPE5Mm/f+HGxHigHOOSE4sSrgEKnWQ3JheNG35GblEzw32Bnmu5FkjAWVOpCuOqUMFVr01jt8IYsXutfSBbILXtk5L6BqxH4T4kKXOWxUPLsSxpFY2xmn2ggW3OkZVA9AFzHi6QxVLjiWs4BTjcJNK4XpmPEriUeZjKoFGJ6CcaVQrMOqQbrFeyj8cACa89cScXaQSZ41zIVJwtUxXlZTCrBRspc0wB5Z7aRP2jVqpYyPD6saCY2d/i6m/f1sB1bv93ICRyGwDbitLYawwh56Pw/b0b329baSCDUg6Nkc8c3tO8neJ+3xmIXquMq4ydAnhw4AsJBoryBOraekb9gMaElttBMyMS5b4rUO4XHtB8BW8T1HfH9F6a8glPUSBzGd8XA4Fwoe0rZaGdtoo3PHx3DS5xkvQLxBSEoV3CwTqTK65iK92CaYG4YNNlg4ORLfwn1ukwJf90JkwCIM+WQpKgS/fUx0qVoXBAIdNZCuM7H6q2blpDSoL+NLo+B24Ogq8ZsfImgS/JrCWtEcPj5kT3e/3HvGMi2sP0RL28qitlXrbytDxCyx6PiwN1QTgWSMlHajekKPjPmeXrzSbj88HqpfS+34iM7vIoNmf4YnR/5BZEi1wk06SRPCnQyshyURbxut5dOWk/ef6EU9fbU8+T4b3ailHbVXiVgtw1CD9IVzsBTD1t7OXoft7XwJ/z3tsF6vt92QBnh/tyi6DWpvKpQwMkUFceB11eqxszZ6fadKGZFeOa31yor/cV1tIqwfCCmpyW8e1eSjmnxUk49q8lFNblaT/nb3UVU+qspHVfmoKh9V5SZVCVwSaWnQEXIBWY3LfQxGxPpLyeDi7TWgxfyCi9pn8pb898supLLiJWN3XKaXUGgvoYzfLsYpdnO9QNEBZp4hyyziyTkkZiTny0KcIXFJJ8n5WOTJIPmDNss+hZvDBRGqA2AmXYV/GCrGWHVRvV/IDj1ppD/5Zyfrtw9DdU0u1y8iPF98Cxc3cMfiqjp5pBS+Y0osmrC3tr8NbXkhjxVsE6nwLSO6thqQthFFLhxruRIZtFH6Lev32Va4PdquKfzgRbRDHrNr9h3jCy4b5PTaHC5bxJUWAoZq+9vkulNNzA86mhDFfdBJNRcFTy9hQc65VECXn5utoRq6YeKddcOE/pzMq1+1pd90IRQvJDGfDZMoQbCelO5UQ2scODjXEdvWNkjA0LWMgQ2+Y//cgNx7JRYtjN3aBs62vGC/sRWGD11THAbfsTUMK8IBnXghD2hsbR32T47p7YqEQE8wETrMdEAXQecKUq+SrJPj3ou2yQ0+0hc8vZwa2DG3trd7beNvYd527+i9SEsnaAByggT803dMyZw4PnSTuet9Xxip3GRL296Zy4QxHTb01k0jMvjdbeS+ezdgv7saDtUwwcFu34Lj+zLP2Y/n5yeVFRX1p97X8F+/X9+B4jp/14p9wNoeB0UKgNYp0aUDSk6b4G8daEynsMX2UF3HS+1k6WaYrxmWG+jVjepPm+WIXg4V4q8f9LCStaWVPwrO50DGqK4aTJBuHv8G2GtQx7BsZCg+0aJXVgEZiPTzHfYLCfs/LjjfskCOhwb0FyzEJ+wQ4rjCldhMWxffrftosjqmM1zlQeYcLYaeD/G0UKCCF9KCugHAZ0I0lX6vWPqr2VBGAK4Z6kyfpkoo4PpawDVODxV0Y/OIBt5UE6SJcRjfsWFyV3KDPnyCEXFef+KVWlXedTXdELNn4MqsdDNtfGR1RDUAg+uWNNUmw52syukBCwMi8SDc2FsJrNC5TOEW9gk7IiOIrqsgeQpxhPtGuA3y6f1QOTvXi46vqS6inAHuAJLlTtoJXM4vdUn5Y9g25Vb0aLwH1fhe0MVbYzwD1rRc7j0TlIIxctAZWtueUFfSaHUxTF4c7Z8enY7OX/909GqYvK2m4Ihul8LllE+Eg1ArbxL4MwRGavg1i20iWvaDfl/ZC+D2kRfSNxsQkU/CjfhGJNxaP55CjmRtmkQYYwulxrAdmQZr67vRv31DfXK3/RRwOLP042mMqSrqH9f0Dq2A0EqBfdcY3QZ9t9U6lO9an27XiFDhbA39qdQj1JPYruv+vh3jAJV8DIuAxbT7twK1HquUH8y2GKxTUTdobK53IYb9ziI97HdMbCfXaLHb7LILVXngNBSZ3uAGkVM69264qtuCFEHUGWS/Uy5ya3RPdQZpEYhk9TSSxAcdiI4DQikS6pyg3LRNwSFvqlfpbzeO3PvIxPk7DGbCc3v/0RRkDLTNyLqE3zCMVQm/cSBbLc9682x7bYAXYS2//bR527rpJWK+9hmECrLJaHiYYb3p2FmFga4fP8HUCn2rBRCFjT4uhMeF8I+8EACgD8f1Y8LRulkySNayQeHEgAYbcQLL+FTG5QdvUo5sXk6vWw3MPq4Mg+G2IVmv6kJONO9ZT2pTdY09fwEjLs7QOvHZVQClx8JndtCxLF2Ia7mIe0CYj85FXVkupQdYXc7O+oH4vo8Q6k+F61rHwUDf7nm2BaMVA95DUQxLmbHo+CeZgieVWAA+LIyBVmazJT1aa6rBFN3FwG2oMR4K31TG6YF3QDYevmlMzWyZGd7LxFyHARLQPvwPk5rqwtcdm0xyqQRWOcOnLMgf2QjelQ5mghETI+yMoVFr2RbPJSdj/Z2HMiKz9x1IePPR/eHTV1MUuLkT/60ZsFNXSqqH0u5UJetS3JUPjjpFjlRiOmYBN32Wa1c5bd9ygu/P4Ad+uGoKHtjRl2J5Q0nD6jtS8AUZUAJdYlkXaUT38O0iY5Y/a3NpC56K/UL+1FY2/Ra62SIA6ObiSuR//2FcdxK4RjutP4NzFNzizWDqi/j7MCuFqNa+01KXw/LfPLkInw6p7yKqL4Ikuzu7e92dr7q735w/fTZ49nSw+3Vv56unf02u315HX65ofGUilA28WK3iVyOoC/HVz6oqeg064m8RkP6/btbCj8YTj/wiLra1eRhrBbbaSmpd7LxtqYy1+tQXuMLHoU4V/tFebmqntaRTPfa1Sk6hdpPH2yjBRIkvcdGlnbXKRjXoqqDRWgkjgtMsWkTPmmWKomd1Lg9OD13EIY1r9X2oV1zRB9tFhXkuApF4L9IoFXKxU818KElaT/1akdVI1Fqe3Vh2FIcR1eL8LLJNYhzqGNYo6uqAcZxpXBzvUd7/H8n7aqGXekxrtTnqV23lNS5uqwRRd4+TPm8SJET65YR//WzyfK/77KunX3X3nj3f7Y6/nKTd3fSb519Onj/nE/48aaYz3gQznDIrYjCVrl40dfmCZh5+lKgeLTqazzqpu8q83piJfPFhdfgbsyfvM/yQhBppoCZDNmJZZ0hD/FZSG29kLXKS0gmv3zbC5+82DOwEAR0h7IdTJUYCOUi8A/8PZFhCJRFahmAqndG7ZO26/Ak7Vs7orEzpkuJQpyUEwfAq4wruBnypL3Szw4lMWmfw0hRPQVDFp8f2my+wtA+cgrACECTEoPUFieq+oBp9jvHEW2eMbFz/YSR2QhgRCnja59pCEgZWMpCKjY1eWLqSGKonT9jZ4U8WMhOlZZkfAaOBjoUN/uOoGHY4k8X1LfDKoUIYRRlZBF+lw9XfoYQbrpJPwTWqhuo39tL/7b2cv7FDvVCYW3F2+BP7mH8AIp6QB/r3G1Dbbfxjqw/u/+8BQLSDBWoPuXENxlwU5RjS2OojgH/Q97f3tl979bdbeXtxerR/+KejGsLKPb3NLvvjXI/7c26dMP7e3vqf/Ywb1ycQ4MuIedt7dXTeRKXKqXBQuK55ZKke11S/Nsse3Zn0tx+SWu2UWKMXqT3K5XtpYlQz8b5XzGtU9PddOfsA1AokqZXaH/Qqqhr0RnRVyMVnkYSpXpcDT+0f+RVvoprzK6GakmAFN+msV73pQ61J+NJx387gVNuv78y3P53aX/gV3yC3QC05iyu5Lea/2CZrUW7D4yAT/SjcaPsheYvZekhSTPMqtVtQoo9NhEtn2x9Ldtd3/yzEE/DGEBiM4eTHkxVRJMqkXdEWjceNlbjC9U8mupgVLeKMHKdgjga1y0KuEOqfBB9mJLz99dX36dQiSa2a4rQcL5uoTDleTsXcNimOn/bhl8Z6e1BqAdWGtXcKYQ4NVCncA9me1JGbODzyv22k9IGote07HITzyFTAZcagupDYL6DALNvt7YCB3fB7wtrj+Bp57Pva/svjg6NXZ0fd3d5Ob+b8xwWEmdvXkzMqkQS3AE7bKKI0mJxkjFuyY6FABNU3LbR1c64iujZfwK969qNwet/L1t0u6n63fxCm8j6GmFL6EgyGGVE93HBLwHPb5gh1ml34KKHIz/AZvkSz3YHSUfAhezBpq+/RQBI9fi8WDvldqcK3QS1VtkKudGGL0mY1GifkckefJKcMYEIj7OrndjAsBpnhR1wWMP6nnZ2dnbiyRYH56+iNvQF44zv1+F0cjF6pvkLTimv3Zkz0XXbqQZa/mfovtwv/GfZ1TFQsbElVTDBD3dH3330dIxExAH3elMfgmTMWE03RTks8kGCF0er78o1BxuXIiEaRQVlVOFBNyhwSyRu1U3wEuLQ47Nc/9QgkFIWd+wrPXOYrnSR9HNqH49SHoL337ymwHE5Bezs77AXPmPeZD1iU/VAlmlOlBjz9QWb/nHJF8qVPOnE4yr2dbzAmKpepG7DDklJb4sXLsPY3tQBCMFh4IegjHSJ1NbNgxqcCyis/29ljP3AnFnzJzmkyBkN1KrIypcgtnFJm5d9EmPSsBfVQnRjRxU8s1VOIUvDiwCwLFwmntLYUIE9WWmc7zB/cQ7hdFNgPstNHKcICVPSFEroIvUioCm8nvnZ420kgvg7efvgA+S1vTH59DY9/LYUBZ9fb+rITQ907yQzLOETxBj4kv4uXubW7Yy2VqI4ygHN64W5sG9/onuyfH/yYdBK8nB58SOZ01WE4BM7D/3idTvfN6CPEZxQ9WmK2REJAr/3XFaKandW1TbjMvKhecbWMSPzwgVqgc+H6Oun4sfhbN3D0/Q/Q0xKh +sidebar_class_name: "patch api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Creates multiple [identities](https://www.ory.com/docs/kratos/concepts/identity-user-model). + +You can also use this endpoint to +[import credentials](https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities), including passwords, +social sign-in settings, and multi-factor authentication methods. + +If the patch includes hashed passwords you can import up to 1,000 identities per request. + +If the patch includes at least one plaintext password you can import up to 200 identities per request. + +Avoid importing large batches with plaintext passwords. They can cause timeouts as the passwords need to be hashed before they are +stored. + +If at least one identity is imported successfully, the response status is 200 OK. If all imports fail, the response is one of the +following 4xx errors: 400 Bad Request: The request payload is invalid or improperly formatted. 409 Conflict: Duplicate identities +or conflicting data were detected. + +If you get a 504 Gateway Timeout: Reduce the batch size Avoid duplicate identities Pre-hash passwords with BCrypt + +If the issue persists, contact support. + + + Request + + + + + + + diff --git a/docs/reference/openapi/check-opl-syntax.RequestSchema.json b/docs/reference/openapi/check-opl-syntax.RequestSchema.json new file mode 100644 index 0000000000..31fd7f74a9 --- /dev/null +++ b/docs/reference/openapi/check-opl-syntax.RequestSchema.json @@ -0,0 +1,15 @@ +{ + "title": "Body", + "body": { + "content": { + "text/plain": { + "schema": { + "description": "Ory Permission Language Document", + "type": "string", + "title": "checkOplSyntaxBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/check-opl-syntax.StatusCodes.json b/docs/reference/openapi/check-opl-syntax.StatusCodes.json new file mode 100644 index 0000000000..20336ee64a --- /dev/null +++ b/docs/reference/openapi/check-opl-syntax.StatusCodes.json @@ -0,0 +1,150 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "errors": { + "description": "The list of syntax errors", + "items": { + "properties": { + "end": { + "properties": { + "Line": { "format": "int64", "type": "integer" }, + "column": { "format": "int64", "type": "integer" } + }, + "type": "object", + "title": "SourcePosition" + }, + "message": { "type": "string" }, + "start": { + "properties": { + "Line": { "format": "int64", "type": "integer" }, + "column": { "format": "int64", "type": "integer" } + }, + "type": "object", + "title": "SourcePosition" + } + }, + "type": "object", + "title": "ParseError" + }, + "type": "array" + } + }, + "title": "CheckOPLSyntaxResponse represents the response for an OPL syntax check request.", + "type": "object" + } + } + }, + "description": "checkOplSyntaxResult" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/check-opl-syntax.api.mdx b/docs/reference/openapi/check-opl-syntax.api.mdx new file mode 100644 index 0000000000..d6adc98497 --- /dev/null +++ b/docs/reference/openapi/check-opl-syntax.api.mdx @@ -0,0 +1,37 @@ +--- +id: check-opl-syntax +title: "Check the syntax of an OPL file" +description: "The OPL file is expected in the body of the request." +sidebar_label: "Check the syntax of an OPL file" +hide_title: true +hide_table_of_contents: true +api: eJztWm1z2zYS/it7yHQizUhkmubugzK+qWOrrdvU1tnudDqWR4HIlYiYBBgAtMxz9N9vFiBFUpKbN/fmZi76YEsgsPvsYrFv4D2L0URa5FYoyUbsMkE4m7yGhUgRhAG8yzGyGIOQYBOEuYpLUAv3XeO7Ao0N2ICpHDUnEicxG7EowejmLE8vSmn5HRuwauYrFZdsdM8iJS1KS18t3tkwT7mQ9MtECWacvnVRnekSJqgzYYxQEl5zuSz4EuFYRUVGlAbMljmyETNWC7mk38KmuIPFIViv1wN2N1RaLIXk6YRrnp3yjGb75wTY5EoaNITl+bNnW6h5nqcicgKHb43awp5rUocVfjVqrbTZlYk0nQpjSZvGgYNq6oAJi5nZQ0rGu4OvhUT6v1A645aNmJD2Hy8ajQhpcYmapIpUWmTyoyavN0Nq/hYj29LohSp0hBNlhJNkPWAZGsOXDkV3G9YDZizX9n8Q9Z9MnXBtcEx7wZpZXGte+mXVtCNnWZPX3rLOK4sBjblGg9Ka6pBU4wulgUt3uKrtdqbZPkVdQM5MuzbTNeZzNEVqCeOLT7TQXUs0lsuY6xjoqP18cXYKh5MTb5Dg1U4A91j2LjmnuY3cO6tinBfL3VXHNAwkARfSgJsFQnreQskALhNhyCUVpuBpWoJUFvgtFymfpwhcxpBwA1bBHAElDcaEGe94lrsNIzljbvmcGwQe89yihhU3ULjZtHQhZOy2DVPc61jWg4fEJg9C8NxqpwLJM9xFUO03xqQiZ5QQqSKNnTxzspNCxg/ynXWY7ipx86tR5aLQNkHdViYo780lt4XG2p87Bl3AZ84UYSVsAifH8O3z7178HWKFxqHFO2H2qkjEu9hOjkk7HAop3hW1ik6Og6lcoIMxk8rOmg0da/2Df3Cq7GE9PJXvCmX5DO8ixBhjmvYvGhlXAwRfFhkbXbG9dNmAdSmw693gcTdcqiGRGZIMbLSf1GdD7LrMrpp+9Q+a7WvsqVoT7NO4sdwWZhapeA/NIxXv+CVP0i8DWga9F89eDODFs+/oz7cDCIKg37EGev5FPniJErWInIM4qnzVeu3TA6Expk3zp+u6WbRxRt6vnDd+5YPu0tH60TNl7umCk8f86iq/usqvrvKrq/zqKh9wlaQljAotbMlGV/dM6fIwitCYS3WDko2urtfEli8N4dCYuqNiEpETHCqtyqHmFlORCTucF9ENkh5u0KohjzMhhxnGosic/ZBGL5zejGOWcrkkB1DmeOEQsgFL+RxTNmLfK12GUSq8v/E+gTSa5UpbuJ9KAIDzFp7DXAz86JGSC7EsfJk6lWtYaJXB0xbFpy+nciojJY0lm2pmwwFIXHUp9Pov67k8FyeSokKE1cwtBL0Otb5jk6J1xfQIvGW+hDCEnnL7wdN+g+S+sryBc8iwhgPgKy46bINuYdDzEhP5qey/ZOvBRqs/qpY2JbfiFtuKzHl0Q0cq40IShEqxvamc2qkPmnd2yvzPRbb5qoz/pnKUPBdenzBlS2GTYh5EKgsbPQ+XimY7GReFjBy3Xp+2b2pdg2F0AFNG32bViZoyUo/XFLyHLUVNbXe7RgfQARKc4mpr82gRz8WRB7pvweHkxD/d2j1aSRF7AHpAroEWbygFnZ2fnARH3Y2pNBi84tHNUlP46vX7AXUdeiRuPxjfYVRY9ADFwjH42wFIkXr1TO0is8EPuRbSLnrKBBc2Rq0HMK2SiVWCEiKepqSpN38O582bEXxzO53KKXOi9D/A4YciTeGny8vJJmVprfer1/QnDFtlL52yN1t8R3C0p5Klpbu8VWGJ93mX4AcEa+NCk/enct0+BZPSJkq2TgI5rAfditLlzD+cSse9GQgyFWNq/PmbqTyd+dp+pp1EUFHYL+02LY1ms+IwFxQDc++s3MzcqaWe4H+R9T+BY1wISftN0SpRRMVAfUJculdlvi7nS6zNzSikrlvpbTDItaLAYAKlS54LQweWCF8gdj1hkJe+kbFpXfE0BVPkhAnjLbeZU2cNLWoTOG/W8agtwbtn0zsvJwa5gY+FW3uUJ0CpY+WBsqLly9Hphxc2QWmrjN9ph4aUFv/eRk3EhAQeRUrHzr277I6oUJQ1qG9RQx0pIVepiMqAVo292zJOWcijxPGADG2iYuAaIdfqVlDKM8dUrQZQGA+vcnhgE26JkuFWmIVAA6UqtCdDcyNuMPDyHm3ke4Vco+7KM4Ju9P7kneBu7czSYpptApS3Qit5NWWvxofn4/PZ5dkv49Mpu95swVhSwcCh8ndeb1yCqONklUeTGuuj5ea0sBzWTnXLAQM35HCraSMP8gkcaeQWH2bCjankycVMNPG6xXE7bDdc+k1EhQN42g5NT+EJBabdqEQLrC4rgBVI1/IjUFUPkE6Q3HTcm6nEeuNDDzqYd5yNCx0HLn40BJx76E2rOqoipBbbqcnwn9vURs5vtil5Um1E1VN0Hgo2jop2Bke7GJoJnej0YSjwjXFo4BvAPlu73NLEN8NYRa5AbuWIVLSLpa/SdjqlvT7V1nSufYopfbefVLbn6qCbGbN20m11gQRDoy20vPQL93l3KjSWahvVdjZg71oR/5EgLnhqPh5j7iPhPu21Lewjwe0gu6pPxPXnqbG3bzDI4r6rUfDOoqQbIY/qBks2eqj6GLBbnha4twqhzKBevDGvzYKvZvZ/bWZEwMdtqo+U6+Lk3CZsxEKVp6GHHjpZKHl0SYHHX2jKLesE5r5KW2YmLZbrvUlM6KxOC+qN1Pd/myW+WVF1MFmTDu1o4w9KFKg5eYp2pfQNTDwVICoB/KEKiLj0DTxh65vdq/aKIyWNSvG6V4OP/ACBDUwS1uDDqNAapQ2XaIfuqg/jflBprU6MLqiZ6uWZcyOiTYPVba4b2ewu8SODmbtMpjvTD+1MVZTuPHf3g6laOTadBOioavR0Bn/rbE1SxpoHMWaqFtATDekvbWqkci+AWixSd3XJDsGNQm1uPrZVLUsKbxoXGk0CLnEy0OOp4D4hfFNRmfnU6g2ZfXfo0+n7S3hJ7UR27ie5zCJHeXJM+ynJAk6OwbdwqPVEXz5SD9YvajWsvNJJ/Vu9oZ2WuapyW3qbQMa5oiKmVAVIxJggdgyPcrUbLBvDW61WDgudDvLLZImUTZgwR23ozA+9yoYOo2vDfdhkdPm70jcm5xEe5uIXLD8ZN6xqAsMUbzH974tBzWO5UPVtBo9cdMKMC9rSqib73u8jG9TOlJBd+Gdspwv4BE6k1SouIl931u9X+ErBFX5pCnkxT0XkKycKo8JY7TpJzukcTk5MAIfdBzTonI6SaUmtey8sxlXaz+GWpyKmlzycMsCblDfWACaeo6NCxVOmjE1L2h/3Yspcq5XxVeZUPnkCF8e/mKl0lyBxJQF4Qedo6pLAtG5EKhfY2sHAVZEbhq3LE+PIO2XQmoVKU7Wi85hWb6WYEcF437yl4j/v4VitZKp4TATgcz7vobshj/R5T2iHnQ9sD3z65xFI7CdLaI+5th3FXOXFPIjxtjlx1UBYtTRN2BR6/b26vTofHx7/Om4obDUvTXwTzlM1DzNuLOqqmWmq/2HMtQ09Ccoc2roNTseXXVayWKINlF52PcRmuEF9psvAl8Fh/zHRKitxB69DO07FndBtVgneBXnWsPK/P1azj4AWHaS9aH9U26wa0g+y2/Sh/xJLWKpdO6jQ/sxveZdVxm9Rdi3BINdREmyehFxbseCRDU1CQSRsupX9L0f7lt/yB+yW0Pq6Z2O3efbWdFXr7LYerm0ibF2r9B9TtxQBfcRqY95G2/udgsoCbZT0Pxf2sFr+l4D3xDsiAMkw+WmyZYoemTBb3qIz3DmJW1r/YtB5ku8xZ6dx30bvoC1zsQW0GqlLhpbxhrun78vROkh7PcV5MS+7rHQxL5eYmS7i9mhIXzrn7VHREqsHzt45da47rCLqaZhAqFZVVg9V3x5E+khozf4IRxcpIkK6ah5tqvbDnEcJwvPgGRtsVcJ09rh77HRcrTXh65Oj8enFePg8eBYkNktdlYI6M2eLC9S3wl3KhFaZ1kV5nXJS5Yza+Dw2JWX4xoMyNuOyhesDLdjtarr1qtDnvhxdZe2tV53XlUbuq07CFVN5Shl//cK07yZcDxhdg9Dz+3t6Fec3na7XNPyuQE1X89dNv8Ddyg9YgjymwnnTD6veHhi69kfTBeugqedS1p23e2U770Z1uiGTs4tLNvD9mdE9y1yhzTRfUReGr6hltB64urv1avCmmKlL/KvNIy7LFu/7ez/D1QDrNRtUIKta9Hq9Xv8H/P0F1g== +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +The OPL file is expected in the body of the request. + + + Request + + + + + + + diff --git a/docs/reference/openapi/check-permission-or-error.ParamsDetails.json b/docs/reference/openapi/check-permission-or-error.ParamsDetails.json new file mode 100644 index 0000000000..01af238a19 --- /dev/null +++ b/docs/reference/openapi/check-permission-or-error.ParamsDetails.json @@ -0,0 +1,51 @@ +{ + "parameters": [ + { + "description": "Namespace of the Relationship", + "in": "query", + "name": "namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Relationship", + "in": "query", + "name": "object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Relationship", + "in": "query", + "name": "relation", + "schema": { "type": "string" } + }, + { + "description": "SubjectID of the Relationship", + "in": "query", + "name": "subject_id", + "schema": { "type": "string" } + }, + { + "description": "Namespace of the Subject Set", + "in": "query", + "name": "subject_set.namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Subject Set", + "in": "query", + "name": "subject_set.object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Subject Set", + "in": "query", + "name": "subject_set.relation", + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "max-depth", + "schema": { "format": "int64", "type": "integer" } + } + ] +} diff --git a/docs/reference/openapi/check-permission-or-error.RequestSchema.json b/docs/reference/openapi/check-permission-or-error.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/check-permission-or-error.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/check-permission-or-error.StatusCodes.json b/docs/reference/openapi/check-permission-or-error.StatusCodes.json new file mode 100644 index 0000000000..0efc849078 --- /dev/null +++ b/docs/reference/openapi/check-permission-or-error.StatusCodes.json @@ -0,0 +1,148 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The content of the allowed field is mirrored in the HTTP status code.", + "properties": { + "allowed": { + "description": "whether the relation tuple is allowed", + "type": "boolean" + } + }, + "required": ["allowed"], + "title": "Check Permission Result", + "type": "object" + } + } + }, + "description": "checkPermissionResult" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The content of the allowed field is mirrored in the HTTP status code.", + "properties": { + "allowed": { + "description": "whether the relation tuple is allowed", + "type": "boolean" + } + }, + "required": ["allowed"], + "title": "Check Permission Result", + "type": "object" + } + } + }, + "description": "checkPermissionResult" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/check-permission-or-error.api.mdx b/docs/reference/openapi/check-permission-or-error.api.mdx new file mode 100644 index 0000000000..3a04625ac6 --- /dev/null +++ b/docs/reference/openapi/check-permission-or-error.api.mdx @@ -0,0 +1,40 @@ +--- +id: check-permission-or-error +title: "Check a permission" +description: + "To learn how relationship tuples and the check works, head over to [the + documentation](https://www.ory.com/docs/keto/concepts/api-overview)." +sidebar_label: "Check a permission" +hide_title: true +hide_table_of_contents: true +api: eJztHGtz47bxr6C8yUSakcjr5Zq2yrgTx3YSN4nt2u50MtaNDiJXIs4kwACgZdWn/95ZgA9QpGzJ5+v0IX+4E0Fgd7HYFxYLPngRqFCyTDPBvZF3LUgCVHISiwWRkFBsVzHLiM6zBBShPCI6BhLGEN6ShZC3akBioBERdyCJFuQGX0cizFPg2ox/14u1ztQoCBaLhS/k0g9FGkQiVMEtaBGEgoeQaRXQjA0RzB2DRd/3Bp7IQBoQp5E38gzOC5ApU4oJfi5PpBTSG3gZlTQFDVJ5o5uHtSmd0RRURkMgYmZIv3Sm5Q08hp1+y0EuvYHHaQreyPxnxngDT4UxpNQbPXh6meFLpSXjc2+1GqyjOp9+gFDvgEeYAbshKcHugKZcyN0QXeWGutPjHTApO2bCot1wtRapQE6uQD+BSoH2X2S9dkP5Eku3G8ZtV7ELTkrvhxFkOm4MngmZUu2NPMb112+9QQmNcQ1zkN5q9W7gSVCZ4AoUjnjz+jX+FwqugWv8SbMsYaEhLPigcJoPDoY164KGww4tWUCTRCwgIjMGSUSYIilDpYaIMG46/Hh9fUGUpjpXJBQRoFnIJBoGzSxNBYg2ukUMOkajFENly6wdQ0TlsGrWUyESoByZ6En4LWcSgd5U8N8NPM10gl2PjPWrTRG5BJUnuoZVSMcKYTWJWjNixcDVwHv7yaxVmvKIyoicyyX569X5GTm8OCWA/CR2qdvMM2/b4IxlJeXSt0ZFMM3n7VHH2GxWmDKuiOlFGLe4meA+uY6ZQubnKqdJsiRcaELvKEvoNAHjXGKq0ItMgQDHxghphnuaZobzOM+IajqlCgiNaKZBkgVVJDe9ceiMFT4KEkAfVK9KqSWDTdNGM4TkmdGGBag/bQpQPEBpiJBFIpchynWeRGY+UyAzkfNoI95JA2mbidVTzcpZLo0oO8wkwioIpzqXld00CJoEF1ZuwXRMTo/J79989fYPJBKgDLVwz1Qni1iHRp0eG80hOWe/5SWLTo/9MZ+BIWPChZ7UC3oi5ff2xZnQh2XzmP+WC00ncB8CRBBht79hy0nRgOTzPEXl64TrDbwmBKObjQkMvPvhXAwRzBDn4I26QT2bxNXAS0EpOoc2m36xL+rlq+WpGON3cdxauQlauTbMIxGh3GUSFHDtgnSMI+m9ff12QN6+/gr/+f2A+L7fb0gDvt/C7q8bstr0zYGDZKExEEeFrVq3mFa7HHtZGSNrVy5ru/KkvTSwfrBIrZn8au+BPo8HimBG8efeC+290N4L7b3Q3gtt8ELIJQhzyfTSJByEXB6GISh1LW6Be6Obd7hx0nSO+Qgvq0wtEnM/FHI5lFRDwlKmh9M8vAXkAqZChlk+TVg4jNk8NsKD7LwyTLOpjYTyOWr/MoMrQ5438BI6hcQbed8KuQzChFljYw0CsjPNhNTkYcwJIY7HOMzYwLYdCT5j89xmWsZ8RWZSpORLB96X34z5mIeCK43iVPcmB4TDogmh1/+m7EszdsrRIYRQ9Gzg7zVg9Q2SBDSptvMjYuXyGxIEj+ZxSE+YpaJJn/QKP4ZWOOcRzBiHqG8h2xV2wW7O2WwLs3TsLtTHkjTbwi32/qeRC/jRpMyOkK9An23FaSdPsTuK8ydY/knAL7fg/TMQpPT+GLMlI8LzdAoSwW4ztpT7h8IcDkyUQFbkgNAFZQ2F8LvTmT2rk5UKFDpqBbd4KCWueKwEpfnsLm/rzbkLr83P4kXJhzHvf+NhbqmwPz8Ix+5wqtkduCYno+Etep6UMo5MKUxQb8zHemxjy3s99uzjLK1+CmV/iQw4zZi1PWTszZmO86nJGtc2aTgX2NtwfZbz0GDr9dHQjXXFPjI6IOM6nzspXNDYwxW1MkM+km1tiyHOSpOBa39vALqVZUGI1c7AwCyfNkDd0rIg3EouLODqcQPkbU2LA9oVsQYS98W2PO/W0ya2c4f5661bLcM2SC4b69Fu33JlNqMq1QoRmOCn98c//bmPwMwT+UiaA/hYN73u6IA0dMQ/g8WaD8ZBNGNHVoe6BhxenNq3a27YiqTKBkQOMLjDwRUk33HgF6f+UbcNK1Tc/46Gt3OJ25Bev+9XK96r9LHv2+XpWU3q+yUTe6Ua9P1SLqNeJcFVoytnvQ7ZczsWmNbFxu1SYW8vet//pVi1Xrl8ff/kHsJcg+U2mxlu/e6AcJZYMzTWs1T732eScT3rCeVf6QikHJBxsbddxMBJSJMERej9Nrx9/35Evrgbj/nYM6vTfwLP93mS2BRGuY92xtvRK/wnCKoONv57vwH/iBx1JRAQRpsIkWsk4rIJeat5umSCyvpjvnJd0MVSx+YspHRDGFZvjH6FXE7syzE3NNQNfioiSJR1x5M6WJ9IMy9SQNgw6XVgElQ15DBjuFHLbFhtemaGO2UH+4QK/oocYxCBUoCmIxYIRZHSCJicRBFzmMREeaCaJXRpFczPpECRVXjASjOm0F0i4CuAZszuZ0tMxBBKEqaMYaRJQlSeIU0QrQX49dmqb6KbRuzvTLxpfmz4YKaBNnRbckt//oqYRJ21XWnu7DrA5uxyHQPXRVrKcAebhGT/XKcagTFOaBgKGZmNiElBIBTcCiqQeG5dbudIJhIWLn0cdWKtvDLMAhrGBgdJQcciIlQCyaS4Y7gvn0IiFgOSK0te4R+IjqlGSIpqpmYMFFmKXFow2DekCnw736Nqft8BlSCb8xmR5hZz55WgZuxE42DsrXzgd0wKfjP2vjs5vDy5nFyf/3RyNvbeVUtwwjGrRUlhzC3fKCes3NEVfg7ZWOqW6ePQclj6jTUfQ6hCn1J0G1kiX5EjCVTDZiRUqWI+GZuwemfpYGxuMGsc/bW4mhyQL1th4ZfkFfrznSLCOjpHkM2IsIa3ZTDoRvcIbj0YrAFuHQc6Af6ERQi0fmqD3T4IdOEq0JMGZztfbMHlTTHTOrKa4e3Wp5i/LQ53Hbran16TxzCl9H5iTuTJAfnD1wSNlG4HfthTy2WhIIWSmNQ/JbWrqt+ivFdu/KChJm0HJ+TE5LXqcOyg3nYWMn1QbDwrqTyoNp+OVB3UPwfdQnHQ2TroWNSDdtOgc10OuhoHNWMPql/9mkHG4/bGRf68YJSYNfNSw79s5NXIhCQuQAvRZXzxFozvJ1UIgDYPRm1S6g6NaHBrisgXyhBFviDQ91Ymx6ii2yEWWGEG10kW4tENm9tc/caCql6/LKmyOceOmqj1LPduFVd1knZGEwUY1K3XQz2O4NE6q83QnQKax+E/UWK1GUO1QXkSxVPFVU/icHc5u69Is/JoG2Tnz1ma3dFcPneNtkVVbt5qBDbF10LgpPvcyLtK9zWwaJmDLZbSueTXFnDnlgGPWOZiXRM37aP1vbPJ3KvlXi3/f9SyPBVswu8AsrXaZTZl0OUEO8OiXRTu82rbZ1W1F9czW/37CIJP1rJmFLnjQuwo/U4cusuaPAfL85ZnBxWbRC0da4G/Kf3eu2d6uF5nq59GfXNyDvcaOLZbrbqFpTfadCo+8O5okkPX6ThOrBxbRbtV/33Uu3eve/e6j3r3arlXy/8qtdxHvfuodx/1/q9FvQjCnhua2lVtVEzH3sgLytkP7QXbwCgmnmCbg0mrg7nEA+7yEPWhODqdqCSfrzoPUgMTCUuGRcQmB+wOsVW9Ram/Vx/JtnjyKx5WYhX/GWi86UsuLBSCUHzyq8hJSLmtdGe6vC5x4444ElyJBOobwKFtMLeAVRyUxAdhLiVwHcxBD5WmeBDd9wvOlYezV3jrwM5nShULq5sI5u6EaanWGPGh9Zua09RmT9vU6irwyPWNuReZiIW92OEewh4VFdGNxr83liZeRpL6EaSinKAFGuC/5uqlyOwExGyWMI7oD4lpJaXQ2VOAorYfDwIkzCSomJjDW0V6NGHUHkq/L6BM7PHuezTdzabd4dtb1xzr7r1L2wnPY88z4KfHuJ4cJeD0mNhaZ6zRxh9b8kHbQU5lt2U6sn+tiLp1t0QU5+tMEeBRJvDAbClywgEiJLEheHhefAvLR66eV7fOM5AKNX9oWTY0NJp69adFRi7/gVfg0dAeZuwn3I/uSLe9Q48AhgncQfLvnwbesuAzUV77oaHZMUNKWWIstakL+dauY32jGCm7su+8Vrn8K3LKtRRRHmpzPHnsfg7AFp8kCbHbeVu9EaWMM6WlqSU1Rufw4lT55LD5AhuN0RE8WeIdFztZiIrSA0ruaMIiPDwzzCBWpKyw+uTCYjRQsIAjFUonS1wfc9trKsVC2UqXMX/1ilwd/6TG3NwWKj9oQOxEp6DKsgTlXB0qTKCzgr6pZKkQOreMlAFvmIFjZgIveaE+YoFTTuegRkjGR/Jz8VwcG34kx2LBE0EjBECe84cg3AV5ob+PSO2w8UfWG3b/ewEQ3WCR2mMqdYMxN1k+9SO4qzWuaAiKomYV1MUm/U7e3lyeHB7/clJDWCtfVtFtME3ENEip0iCLcmZV/B9EVOrAgsDoweWtf3Zy3UTF8zl+i0DOmxaiaq6pPpdL35biBP2XpFZoDi16DbUnCbtn0kUVw72fpTUq+7wtZ1+AWjAkdVL7g1hHVYPeiK6qRP8skjAXbTkoqP0rvaNNVCm9A96UBAVUhrFfvQmo1GxGQx2oGJ1IUJdM9j+d2g/0jm6QW6TW5mIruc3SD6rJWiO3ZXMpE4FzCan/krxFD2g9lkvzOrW9f6BTmYEO4/5zyR4Wwz8L8RZ4YwoE53Dx48WaKFrKmFqzFo3mhiaucf2Tic7irEOcDcdtLW+D2mXG1ggtWsotgyO8QVv7Pp1aQ1KnpbjMp8smKplPl3NIVZNitzXAHw19e1FqEdUG3bvE6tkGqhCPWZTPhLMrK5uKXxspfSFqVbeHw2puFgLeyRxVG/jDjIYxkDf+a2+wthNG3aPmteFxMVYFP58enZxdnQzf+K/9WKeJ2aWATNX57Aq/LmUqwwMtlHOjtAw5cecMUtk4NkFm2CyaUDql3KGrXYa3voF2rtH/p31Yq9gAYF0vFmUzs5EzzH0oMhM33lpmwhvYpCFeYsXCbuzy8IA34P8uk9UKm+1Hh8wnuJgy1+aLfMwjjHkqY9hJqT34c1Nh5TmhORfcHvujGcVHUFeZsWfifSLZ+AhmJ1v2TNxP5SEfQd5IdT4T/ROZyS2wr3/x60XW/llUvLQYPIuIrSXCDnU/BVb3f1cnDM399YGHtgczZ9UZPW6lM3eyrS+DNNKcP5xcewOTLHO+U1ZlIMq83E31ivKlA/vhwfYwG/fVyiupLxJI71ar1b8AqA4Pyg== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +To learn how relationship tuples and the check works, head over to +[the documentation](https://www.ory.com/docs/keto/concepts/api-overview). + + + Request + + + + + + + diff --git a/docs/reference/openapi/check-permission.ParamsDetails.json b/docs/reference/openapi/check-permission.ParamsDetails.json new file mode 100644 index 0000000000..01af238a19 --- /dev/null +++ b/docs/reference/openapi/check-permission.ParamsDetails.json @@ -0,0 +1,51 @@ +{ + "parameters": [ + { + "description": "Namespace of the Relationship", + "in": "query", + "name": "namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Relationship", + "in": "query", + "name": "object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Relationship", + "in": "query", + "name": "relation", + "schema": { "type": "string" } + }, + { + "description": "SubjectID of the Relationship", + "in": "query", + "name": "subject_id", + "schema": { "type": "string" } + }, + { + "description": "Namespace of the Subject Set", + "in": "query", + "name": "subject_set.namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Subject Set", + "in": "query", + "name": "subject_set.object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Subject Set", + "in": "query", + "name": "subject_set.relation", + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "max-depth", + "schema": { "format": "int64", "type": "integer" } + } + ] +} diff --git a/docs/reference/openapi/check-permission.RequestSchema.json b/docs/reference/openapi/check-permission.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/check-permission.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/check-permission.StatusCodes.json b/docs/reference/openapi/check-permission.StatusCodes.json new file mode 100644 index 0000000000..860b379370 --- /dev/null +++ b/docs/reference/openapi/check-permission.StatusCodes.json @@ -0,0 +1,129 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The content of the allowed field is mirrored in the HTTP status code.", + "properties": { + "allowed": { + "description": "whether the relation tuple is allowed", + "type": "boolean" + } + }, + "required": ["allowed"], + "title": "Check Permission Result", + "type": "object" + } + } + }, + "description": "checkPermissionResult" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/check-permission.api.mdx b/docs/reference/openapi/check-permission.api.mdx new file mode 100644 index 0000000000..91219f4084 --- /dev/null +++ b/docs/reference/openapi/check-permission.api.mdx @@ -0,0 +1,40 @@ +--- +id: check-permission +title: "Check a permission" +description: + "To learn how relationship tuples and the check works, head over to [the + documentation](https://www.ory.com/docs/keto/concepts/api-overview)." +sidebar_label: "Check a permission" +hide_title: true +hide_table_of_contents: true +api: eJztPH9z47axXwXlTSbSDEVer5f2VRm/qWM7qZvE9rPd6XQsjw4iVyJiEmAA0LLq03fvLMAfICnZks9503nP+sMWQWB3sdhd7C4WevRiUJFkuWaCe2PvWpAUqOQkEUsiIaXYrhKWE13kKShCeUx0AiRKILojSyHvlE8SoDER9yCJFuQGX8ciKjLg2oy/HSRa52ochsvlMhByFUQiC2MRqfAOtAgjwSPItQppzkYI5p7Bchh4vidykAbEaeyNPYPzAmTGlEJyfS+nkmagQSpvfPPYmcsZzUDlNAIi5obmS2c+nu8x7PRrAXLl+R6nGXhj88+M8XxPRQlk1Bs/enqV40ulJeMLb732u6jOZ79ApPfAI8yA/ZBUYPdAU63gfoiuCkPd6fEemJQdM2Xxfrh6i1QiJ1egn0GlQAevsl77oXyNpdsP466ruAlORh9GMeQ6aQ2eC5lR7Y09xvUfP3p+BY1xDQuQ3np963sSVC64AoUjPrx/j/8iwTVwjV9pnqcsMoSFvyic5qODoWNW0GLYoRULaJqKJcRkziCNCVMkY1IKCTFh3HT46/X1BVGa6kKRSMSA9iCXaBE0szSVIProlgnoBK1RArURswYMEVXD6lnPhEiBcmSiJ+HXgkkEelPDv/U9zXSKXY+M2WtsELkEVaS6gVVKxxphtYnqWK9y4Nr3Pn4xa5WmPKYyJudyRf52dX5GDi9OCSA/iV3qPvPM2z64EzOoWvreqBhmxaI/6hibzQpTxhUxvQjjFjcTPCDXCVPI/EIVNE1XhAtN6D1lKZ2lYHaVhCrcPmZAgGNjjDTDA81yw3mcZ0w1nVEFhMY01yDJkipSmN44dM7KzQlSwM2nWZVKS/xt00YzhOSZ0YYFqD99ClA8QGmIkUWikBHKdZHGZj4zIHNR8Hgr3mkLaZ+J9VPDynkhjSg7zCTCKginupC13TQI2gSXVm7JdEJOj8nvP/zh4zckFqAMtfDA1EYWsQ0adXpsNIcUnP1aVCw6PQ4mfA6GjCkXetos6ImU39sXZ0IfVs0T/mshNJ3CQwQQQ4zd/gdbTsoGJJ8XGSrfRrie77UhGN1sTcD3HkYLMUIwI5yDN94M6sUkrn0vA6XoAvps+tm+aJavkadyTLCJ49bKTdHK9WEeiRjlLpeggGsXpGMcyeDj+48++fj+D/jn9z4JgmDYkgZ8v4Pd7xqyxvQtgINkkTEQR6Wt6lpMq12OvayNkbUrl41dedZeGlg/WKSeeTunaDHfTOWbqXwzlW+m8s1UbjGVyCWICsn0ykTFQq4OowiUuhZ3wL3xzS1695ouMGj28iaevkWBEHI1klRDyjKmR7MiugPkAgbqo7yYpSwaJWyRGOFBdl4Zptn4O6V8gdq/yuHKkOf5XkpnkHpj7y9CrsIoZdbYWIOA7MxyITV5nHBCiONYH+bMt21Hgs/ZorB5gAlfk7kUGfnagff1txM+4ZHgSqM4Nb3JAeGwbEMYDL+t+tKcnXLcECIoe7bwD1qwhgZJCprUMeeYWLn8loThk8kGMhBmqWg6JINyH0MrXPAY5oxDPLSQ7Qq7YLcnFnaFWcU/LtSnMgm7wi0D1NPYBfxk5mBPyFegz3bitBNM74/i/BmWfxHwyx14/wIEGX04xpB+THiRzUAi2F3GVnL/WJpD33gJZE0OCF1S1lKIoBOuDqwy1rJfKqeV2PKhErXysZaQ9rO7rr035y68PiPLFxUDJnz4rYeZj9Lw/CAcg8OpZvfg2pqcRne45WSUceRGaXsGEz7RE+tUPuiJZx/nWf1VKPtN5MBpzqzRIRNvwXRSzEwyszFGo4XA3obd84JHBttgiBZuomv2kfEBmTTZxmm590w8XEorLOQz2dWoGOKsGBm49vsWoDuZFIRYZ04MzOppC9QdTQrCreXCAq4ft0De1aY4oF0RayFxX+zK880K2sZ27jC/27rTMuyC5LK1Hv32HVdmO6pKrRCB8XoGf/qvPw8RmHkin0l7AJ/o9nY7PiAtHQnOYNnZfHEQzdmR1aFNAw4vTu3bzv5rRVLlPpE+enU4uIYUODv3xWlw1DFepW4H39HobiEx8BgMh0G91INaEYeBXZeBVaFhUHFvUMn/MKgEMh7Uols3ugI22CB0bscSU1de3C419v5qD4Ofy+UaVOs2DE4eICo0WDazuWHT7w4IZ6m1PxM9z3TwfS4Z1/OBUMGVjkFKn0zKaHaZACcRTVOUnU9PMvXTpzH56n4y4RPPrMfwGQTfF2lqk7pVyOyMt6PX+CcM6w7W1fvURTwmR5tyqTi4j10UGrFftkE+PTOXMFD5cMLX7jZzsdKJycZXWw36zFtdWyFXU/tywg3ypiHIRAypsnvttPHEp9JMiJQQtsy2C0yCqocc5gyjsNz6zKZnbthSdbBPqMTvyDF6CLjgaB4SgVAUqRTdJBxKh8JkHaqzvDylK6tLQS4FSqfCsz2aM4VbIgK+Amg75EG+wiwLoSRlyhg/mqZEFTnSBHHHe29O9wLjurQce2fibRNjXQQzDbSTu5Jb7dnviDmssPYpK5yQAuy5RaET4LrMORnuYJOQ7F9dqhEY44RGkZCxiTJMfgGhYJynQOKRaRWrkVykLFoFOOrEWnJlmAU0SgwOkoFOREyoBJJLcc8w6J5BKpY+KZQlr9wDiE6oRkiKaqbmDBRZiUJaMNg3ogoCO9+jen7fAZUg2/MZk3b8uPdKUDN2qnEw9lYB8HsmBb+ZeN+dHF6eXE6vz388OZt4t/USnHBMWVFS2m3LN8oJq8K1ci9DNla6Zfo4tBxWe0NnHyFU4b5RdhtbIt+RIwlUw3YkVKlyPjmbsiZsdDC2o8cGx7DjO5MD8nXP9fuavMM9ey+vr/HAEWTb62vg7ejwuR48gus6fA3AnX09x4mfshiBNk99sLs7ei5cBXra4uzGFztweZtf1EXWMLzf+hzzd8XhrsOm9ufX5ClMGX2YmjNhckC++SNBI6X7zh321HJVKkipJOb4k5Jmq2reorzXG/dBS016G1zjcB00EWUpygdlTFkL40EdVzrCdNB89TfLwsHGVn/DWh70m/yNy3GwqdFv+HlQfxs2fDEb7WBS5sRL/oh5O9c0+u8ui8bGAXHhWEAum8u3YHZ6Um/4aOFg3Keg6dBy854jhHylDC3kKwJDb22yhCq+G2EBD+ZgnXQfHr6whc2294+8B8OqZMemCzfU3HQT1PtV9DT51TlNFaDL1q23eRrBk3U826E7BRpPw3+mhGc7hjrSeBbFc8U7z+Jww5X9V6Rd2bILsvOXLM3+aC5fuka7oqqisAaBzc71EDiZOtevrjN1LSxaFmCLcXQh+bUFvDEgwNORheiqYC8S1g9OmPimj2/6+P9HH6uTvDb8DUB21rfcZgI2bXuut7OPnv22Svabatirq5etJn0CwRcrV9s53HMh9hR6x73cZ01eguVly7OHZk3jnmr1wN9U+9ztC3e0wcbWIIuH5pAbHjRwbLdadQcrb7ztANv37mlawKaDbJxYNbZ2a+v+b+7t23b6tp2+ubdv+vimj//h+vjm3r65t2/u7f8R9xZB2OM+U0+qjYrpxBt7YTX7kb2SGRp9DMs6CjyANueKVhcLiefT1RnoY3nyOVVpsVhvPAcNjesrGRb4muyuO8RW3JZl+F5zotrjzT/xrBEr7M9A4x1RcmGhEIQSkH+KgkSU2yp0pqsbXzfuiCPBlUihuTsa2QZzf1QlYUV8GBVSAtfhAvRIaYrnyMOg5GB1tnqFNwLsfGZUsai+JYCLY1vqtUZ8aPxm5jC03dM29boKPDH9YC7WpWJp76a5Z6hHZbVyq/HvraVJVrGkQQyZqCZogYb419zdE7mdgJjPU8YR/SExraQSPpvWL+vuMbMvYS5BJcScvSoyoCmj9kz5Uwllak9nP6EJbzftD9/e1+VYE+9d2k54nHqeAz89xvXkKAGnx8TWIWP9NH7ZkQ/aDnKqri3Tkf2dAufevQ9RHo8zRYDHucDzrpUoCAeIkcSW4OFx7x2snri0XN9XzkEqtAAjy7KRodHUkj8vMnL1D7w8jQb3MGc/YgC6J9329jUCGKVwD+n//jTwBgSfi+pKDo1MiAwZZamx2Kas4y92HZsrqUjZlX3n9UrZ35FTrqWIi0ib08Vj9yK5rR1JU2Ljd1t8EWeMM6WlKfc0Rufw4lQF5LD9AhuN0RE8XeH9EztZiMvKAUruacpiPA0zzCBWpKywBuTCYjRQsP4iE0qnK1wfc2F1JsVS2UKVCX/3jlwd/6gm3Nzkqa7CEzvRGaiqqkA513pKE+isYGAKUWqEzg0gZcAbZuCYucB7qqiPWJ9U0AWoMZLxmfxUPpfngJ/JsVjyVNAYAZCXfBCEuyCv9PmM1I5aH9Jt2P/zCiA2g0Vqj6nULcbc5MUsiOG+0biyISzrjlXY1IoMN/L25vLk8PjnkwZCp8JYxXfhLBWzMKNKgywrjlX5P4yp1KEFgV6Ey9vg7OS6jYoXC7zMLhdtC1E3N1Sfy1VgK2nC4WtSKzSHHr2G2pOUPTDpokrgIcizBpV93pWzr0AtGJI2UvuD6KJqQG9FVxeL/yaSsBB9OSip/Ru9p21UGb0H3pYEBVRGSVC/CanUbE4jHaoEN5GwqXgcfjm1v9B7ukVukVqbfK3lNs9+UW3WGrmtmiuZCJ0LQsPX5C3ugHbHcmnuUjv4B24qc9BRMnwp2aNy+G9CvAXemgLBOVz89aIjipYypjrWotXc0sQO17+Y6DzJN4iz4bgtxW1Ru8pZh9CypQoZHOEN+9r35dQakjZaistitmqjksVstYBMtSl2W0P80tK3V6UWUW3RvUssfm2hivBcRQVMOFFZ1VR+20rpK1GrNu9wWIzNIsD7kuM6kD/MaZQA+RC89/xOJIy6R81rw+NyrAp/Oj06Obs6GX0I3geJzlITpYDM1Pn8Cn+XyBR2h1oo57Zn5XJi5AxSWT82RWbYJJpQOqPcoatfRdcNoJ0r7v9pP8lUBgBYlos11cwEcoa5j2WG4sbrZCg83+YMywARsxS3vocV2tj58RHvqf9dpus1NtvfrzG/5sSUudxeZmieYNFzOcSNNNszPzc5Vh0RmiPB3bE/mWN8AnWdK3sh3mfSj09gdvJnL8T9XGbyCeSt5OcL0T+Tq9wBe/fHo15l7V9ExWuLwYuI2Fki7FD3V6Wa/rdN6tDcMvc9tEKYQ6uP5zGozt3J9n6/o5X4/OHk2vNN2sz5yas6F1Fl6G7qV5SvHNiPj7aHCeHXa6+ivkwl3a7X638D1y1sPw== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +To learn how relationship tuples and the check works, head over to +[the documentation](https://www.ory.com/docs/keto/concepts/api-overview). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-browser-login-flow.ParamsDetails.json b/docs/reference/openapi/create-browser-login-flow.ParamsDetails.json new file mode 100644 index 0000000000..354bed385d --- /dev/null +++ b/docs/reference/openapi/create-browser-login-flow.ParamsDetails.json @@ -0,0 +1,52 @@ +{ + "parameters": [ + { + "description": "Refresh a login session\n\nIf set to true, this will refresh an existing login session by\nasking the user to sign in again. This will reset the\nauthenticated_at time of the session.", + "in": "query", + "name": "refresh", + "schema": { "type": "boolean" } + }, + { + "description": "Request a Specific AuthenticationMethod Assurance Level\n\nUse this parameter to upgrade an existing session's authenticator assurance level (AAL). This\nallows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password,\nthe AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ...\nyou would set this to \"aal2\".", + "in": "query", + "name": "aal", + "schema": { "type": "string" } + }, + { + "description": "The URL to return the browser to after the flow was completed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies\n\nWhen using the SDK in a browser app, on the server side you must include the HTTP Cookie Header\nsent by the client to your server here. This ensures that CSRF and session cookies are respected.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + }, + { + "description": "An optional Hydra login challenge. If present, Kratos will cooperate with\nOry Hydra to act as an OAuth2 identity provider.\n\nThe value for this parameter comes from `login_challenge` URL Query parameter sent to your\napplication (e.g. `/login?login_challenge=abcde`).", + "in": "query", + "name": "login_challenge", + "schema": { "type": "string" } + }, + { + "description": "An optional organization ID that should be used for logging this user in.\nThis parameter is only effective in the Ory Network.", + "in": "query", + "name": "organization", + "schema": { "type": "string" } + }, + { + "description": "Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows.\n\nDEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice\nof MFA credentials to choose from to perform the second factor instead.", + "in": "query", + "name": "via", + "schema": { "type": "string" } + }, + { + "description": "An optional identity schema to use for the login flow.", + "in": "query", + "name": "identity_schema", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-browser-login-flow.RequestSchema.json b/docs/reference/openapi/create-browser-login-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-browser-login-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-browser-login-flow.StatusCodes.json b/docs/reference/openapi/create-browser-login-flow.StatusCodes.json new file mode 100644 index 0000000000..cd4b4bc6bc --- /dev/null +++ b/docs/reference/openapi/create-browser-login-flow.StatusCodes.json @@ -0,0 +1,1621 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This object represents a login flow. A login flow is initiated at the \"Initiate Login API / Browser Flow\"\nendpoint by a client.\n\nOnce a login flow is completed successfully, a session cookie or session token will be issued.", + "properties": { + "active": { + "description": "The active login method\n\nIf set contains the login method used. If the flow is new, it is unset.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the login flow, this\nrepresents the id in the login UI's query parameter: http:///?flow=", + "format": "uuid", + "type": "string" + }, + "identity_schema": { + "description": "IdentitySchema optionally holds the ID of the identity schema that is used\nfor this flow. This value can be set by the user when creating the flow and\nshould be retained when the flow is saved or converted to another flow.", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow started.", + "format": "date-time", + "type": "string" + }, + "oauth2_login_challenge": { + "description": "Ory OAuth 2.0 Login Challenge.\n\nThis value is set using the `login_challenge` query parameter of the registration and login endpoints.\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.", + "type": "string" + }, + "oauth2_login_request": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "refresh": { + "description": "Refresh stores whether this login flow should enforce re-authentication.", + "type": "boolean" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "requested_aal": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "session_token_exchange_code": { + "description": "SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed.\nThis is only set if the client has requested a session token exchange code, and if the flow is of type \"api\",\nand only on creating the login flow.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method to sign in with\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the login challenge was passed." + }, + "test_context": { + "description": "Admin-test extension of a login flow. Populated only for flows created by\nthe admin test endpoint; included in the flow's API response so the admin\nUI can render the pre-scoped provider and (once captured) the debug\nround-trip result.", + "properties": { + "debug_payload": { + "description": "Contains the parsed claims, the Jsonnet mapper input and output, and any\nschema validation errors. Bearer tokens (id_token, access_token,\nrefresh_token) are intentionally excluded to limit the blast radius of\nthe debug payload leaking through audit logs or admin browsers.", + "properties": { + "error": { + "description": "Populated when any step (token exchange, claims decode, Jsonnet\nevaluation, schema validation) cannot complete.", + "properties": { + "message": { + "description": "Human-readable message describing the failure.", + "type": "string" + }, + "reason": { + "description": "Short classification of the failure cause (for example,\n\"access_denied\" or \"traits_invalid\").", + "type": "string" + }, + "step": { + "description": "Machine-readable identifier of the failed step (for example,\n\"token_exchange\" or \"schema_validate\").", + "type": "string" + } + }, + "title": "Classified failure of a step in an OIDC test round-trip.", + "type": "object" + }, + "id_token_claims": { + "additionalProperties": {}, + "description": "Claims extracted from the ID token.", + "type": "object" + }, + "jsonnet_input": { + "additionalProperties": {}, + "description": "Input JSON that was fed into the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_mapper_url": { + "description": "URL of the Jsonnet mapper that was executed on the claims.", + "type": "string" + }, + "jsonnet_output": { + "additionalProperties": {}, + "description": "Output JSON returned by the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_stderr": { + "description": "Anything the Jsonnet mapper wrote to standard error.", + "type": "string" + }, + "schema_validation_errors": { + "description": "Identity-schema validation errors produced from the mapped traits.", + "items": { + "description": "One identity-schema validation failure recorded while evaluating the\ntraits produced by the Jsonnet mapper.", + "properties": { + "message": { + "description": "Human-readable description of the validation failure.", + "type": "string" + }, + "path": { + "description": "JSON pointer to the field that failed validation.", + "type": "string" + } + }, + "type": "object", + "title": "loginFlowTestSchemaValidationError" + }, + "type": "array" + }, + "userinfo": { + "additionalProperties": {}, + "description": "Claims returned from the provider's userinfo endpoint, if any.", + "type": "object" + } + }, + "title": "Diagnostic payload captured during a test-mode OIDC round-trip.", + "type": "object" + }, + "provider_id": { + "description": "The ID of the OIDC provider this test flow targets.", + "type": "string" + } + }, + "required": ["provider_id"], + "type": "object", + "title": "loginFlowTestContext" + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the login to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL `
`.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "title": "Login Flow", + "type": "object" + } + } + }, + "description": "loginFlow" + }, + "303": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-browser-login-flow.api.mdx b/docs/reference/openapi/create-browser-login-flow.api.mdx new file mode 100644 index 0000000000..3fe0542053 --- /dev/null +++ b/docs/reference/openapi/create-browser-login-flow.api.mdx @@ -0,0 +1,57 @@ +--- +id: create-browser-login-flow +title: "Create Login Flow for Browsers" +description: "This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate" +sidebar_label: "Create Login Flow for Browsers" +hide_title: true +hide_table_of_contents: true +api: eJztfXt/4jiy6FfRsvfcTn4HyDudZE/vHgJJhzwJkE7Sw1wibAEKtuxYNoTM9ne/vypJfoBJp2d6enZnmT+mgy1LpZJUqnf9UrCZtALuh9wThYNCe8glYcL2PS5CwgUPOXX4C5OEkl7gTSQLSj0qmU0iyQLieAMuSN/xJmWS/XTCHYdIFpJwyAj1/cDzA05D1hGW5404dChsQkXIS9VW85i4jMooYJIE7CniAbNJ3wtmhoRxZLkjOqLeJ2EWUkk8nwlmEwqgOlyMCBc4uO6jSLiGqsdIwGweMCtkNgm9jniQzOlLFoy5xcpqFJxZOeLdKHAeyISHQ+wMXpJ6DWdGJT56ilgwJT4NqMtCFpCHf0CjDw9lUu8TSsbU4RpbkknJPdER7JnLUBLqBIza02IazHwQyUMUOLJssz6NnLBr3ingIuEwmQtLRzz8I2D9gMnhhzCI2AOZUAmwL0SiRR2H2WTMKaGCVE4rd7ggTIYKyoBJ3xOSEcsTIeVCJlgBHHlRSGgMepnUcQk6wqKSEa8PfbIg8ALV2QP+Xeb2A7yDJ6etq8tkjJ5nT4lFBaDDE9DBAcD9oPHY1fjr0jHlDu057OGAtIdMIZvH+CWSD2BncFFOf0ydja7ZbA8H5CJyQl7qUyv0AkKjcEhWWHlQJpt9uopo03hgNulFalvjOEMqifDM2pIpIvdBMisKeDjtWjLod8fccyicsIcDciMAUljTPgut1K7qMYtGkhFK8EDE3xDPsqIgYHamX24zEcIfLpcuDa2hnnsCJSx9GAWiG3oPhNp2AJuEA7AhoY7jTdTO6uE87DKp2I+RDNWW0EfH8kSfD6IA4fgL4B6G8JBYUGdu5+OZ6VpD2ENiwGAwOCeTIRMkklwMyFlAQ0/iVumIk6kdUBiKCnJVicLhpqYkLcZweA+WYbPrB96Y2ywoR4GTBakjFCxlBdrMXr68apP6ZfvosnZUQ2piOZyJELYsDYntISaGdMwS2kZWqsPAc1mRHPOA9b3nIimXy6tw1GOyFTAiGLNxPTriwgsY4aLvBa5aLb1f+14E9C0kP10FUzPvGxjiHLD088owDH15sLY2mUzKXjAtW567ZnuWXBth2zUgSSVNk9aQJq3BfishkleRev6E/TXZgMtQIYTUPCtymQjx168fJEj1uVouFAuez9Svul04KFgBoyE7VDjD+Rw73qRQLMR7QRYOfvpl5m5pKkoE5BmvjZgcIinCu8IjQKaKahMiJQzMR4Ig1YRdlPmc9KYdQeUIXsSHMvTw0OPmGlAu9O2ke9TXUkfA/oJjZNGQ2V0akpC7zNAi3T/MngP4uNsLxYKgLiscFDRghWJBWkPm0sLBL4Vw6sOrnuc5jIrCly/FeRzg8SSUtHxm8T63SCUBgnvigoVDzyYVKaOACouRczZmDuDoRjKFl+TAhR6J/EFAbZbBj4b8nSSpCQJVizt1oFOyUqmcryrUdASSBEmmXgTdUjnCI+POUsUE0jK5hYNNBTG0KMa5OuxIPmE5AGP/7VMpJ15gFzsCsFupnMMZ3cBbEgadcDmEkTsFPaVOIb0M74CWKNpHelOSs+A+C+AUkvZVu0HWyC3rAWbX4AB3BI7gRY6teRIu1ViUOpudwqI1ptTJW18ZBlwM8pYXyONN8xz6VsQ3c7UDXvu4bvGdiYTF9R0WMnvxTtNk/NtgOWm3G6SqqBbsn9uEDMP4rdoZHo8YOur7ReIJjfRgDAwLtxkujgs3AxeWE9mKNKc6JyeM2sBrSCZCWBu8OZDUwoynXhSY/oYsYDGjqNg9pMV44QFFM2c6TWyBHUA+KMbPEAdMEKTg+DbsVERyj6mLSFGV+PbCjekDsRBhMbm4HLiCFDVk+h4DAq+6gAW2kDFMrrT4cMTXmLlHx9SJGJ6ymWNteS6TpB94LnmYuVMfcHtdz1y8MoXrjqC+7+gzqnmYhzXs5h8znX2gPctmD6uLNt5M81+PYC8YUMFfFEj1mlp0OcTzqPkPxIPjDQZqf3KpuTi429tZ9ACvL5wpYf0+s0I+ZoZdgYW4ZOHEC0aLppSG5Nvm84lTA7LmfXFMs7zvJLEChj+oo5knm6UmqdeoTK4A9oA5bExRxCJAg1KyTe2o0TyqVtpHtQN1VPqcOTbM2mZ+wPCuKpOGw4CnDpjrAQJCtV3wsGkWUJYTZhj3rfAmRDLgdqyhxy3WEV6fXBxXUoAjVbSGnieZ6jBFVxVdsDxhE30fcCFDRhfSrTGnv37LJHcKfo9XnTSnhaUFzwWjxwyyBuA1SH4uFozQIeH95vo6/APrzEQIf6bO1NqjBGh/SfWXI0N7vUdmhSRgmoTImO1RPG4l9Ysgxw2iNvDtVAkXnUJdP1IcI6k06mSNaKaLAMPVKXREzPDCpajJLm6jK7jn6cwo8V1DZGRZTMp+5DjTIqEzlJd4sbRKQm/ERCyWcikjRYpBpGdByBXKKJ7EPGQwot5pUFxkcFJMX0aSTLfRckm9n9yXIL6wCYryQCGEEmUNa0GqyUZuT33W0M87wuO2Nfv2ql6rdkTohf7sG+AgOsLxvFHkdyWzAhbONjnHlx0xYT3gisTse819CFB32Gz2bdWzGbxWoI/YNA/yEZt2hB94fe7MddBQjztCUteZfdmqXJx3hM2Aqc8FroavNHzqnPQ5C7p9Hsi5mdbj98fwuiNAt9INmOWN4RKaad3Uz89BAfPqS5DPCdzsQC/TpHPqM9TfKPEUNwW0R3GEDaZkJR4btsRqmZB6aORavEngVjYCbIqy6RPJQxB6ymphvjoPWKlCscBE5BYOfiqYnQYSEbetQrEA+6dQLGQ2S6FYMPuiUCxYqgu90urgwOIBRaIuMJippQJiNrMg0Hsa5brL5PfPxRmCViw8lwZeCYAuwWksHBSWR2R5RH7PI/KlqJUCIEbP3wJV9a4SqjkNmeMD2xoGkRVq/gZu9oHXi/p96nhl3/PhjlFqlcJBwaYhK4F0Xpjd7F+KBfbs84DJ3JGP1Ds1MswXRfyVm3Z1VSmm4rtF9xJfOEplG8K9B7IpQ97I8QaEi2JHULiI1IegAVSKtPgSfzvs3J6HuV5L8w0GwHdw4fGniJF6TcvemjUzIl1y1ysNSkfMdMNtwyqrpjf1d3JWi3dAQGl0sLb2P68rxf++pvTc/wP/73L77+kpRxG382ebZcrmp64btBTXZ9hBZ0qGnmOrWdRrRkUzxySCXKFEB7sjYskqZZ9QMpfW0QH3oeVVxSUDTnEbG4zi+lJhd0TCyAcM2BU4RJntA8pOOmY2sE6WJ8Ys0Kp7KrxwyIKYWZ1HCrJUubu3jq/esHllSINv2ndatzor4s1BADIVSrJks7yuOdFqLCPHeleFV63wTZQM8+LrrM5Yr2Ra4YiaALVBDXcLkpFmF3NEcBIDuYnfXvlMgJSZI41rRcSaadMwQvlXcaSlKsBQlvN9BXn1mlm45AoxM1YT1L3mDq+Y+ZwliZejqhXaoCZBup4S15JWKZRUPSGAwqvjTG5kRJH/TxpbSZcdMWACsayoc0oGkmQy5NaQTKhSPFiekJHLlPyZdOYFswNb1Kc97nBAXp4QATJJFyWOrrnNXkNABT8gbRRRWvoD2JTqBT43j81SxLekwZiZJVHDK4EHdtwnNN0pGqSQ/PA4CR8QoQ+eT58i9lDWz/Be61EbVpoWUc5eqHxX+6oEHNfa4yQsqXFLOG5HtFgY058YVtCcEbhuA24zNY+B4/Uo2lixORfkQTcH3KZR+ZC7vbQNqGt5gex6AR9wIb++2UhFm46qV80WuVKfKXkTpUYX7CE3zXNJVpAos4O1taEnw58OfC8If17VGweQmTJCuXTEVI9GeQFsJ05TYWtNSaGGHuhLGpAeBBSXlrl+qE2p6pC/k6pHNbWs4YisPMC7buX8/Or2qNa9atY/1i9bD6sdYQRd3B1GwzE/nGTaImpmoTGoZub7TNgJd/Z1gModccgIncDXeIsxMeaBJ8CWQ8Y04Gg0VEAfXVYOz49qD+TiptU29xjYiJWJN772Qo/EqrCQuTJH8xFvC5wX7orI5kxYeTfB3E7QTfG8CYWIksNlSGzW58LsYdOjVFBpzTCaZ+P116uujx5MoUygS/0pcbjLcU8oZwIgQ0hFptqovIAihF4R0cGeKeg9isRiAWruQJeS3C0k0cZy5T0ATLzXx31cVrsZcQ0WRaP8mwx5yKRPLUXI9BCgndbH3p3angu2Jzj31OdoWZNFsvC978lQfuNihUMv0OrMLnLrg4CKsJshpA7vA6CosxKRg5bywgEa2go+DUMWwPL+v5/WS/s///eKkP+M5D9d+U/5T/efw9X/M0c6ioWQhzjTy8hxanoDvwoOt/9lQNFmux8NT49aI2tIhWAO8BNeFHaNI4LxQcg5cdm785Bao1JVdQKcGDhbtLSSrqk7gbN4qMyPekej/NifwmmcDBlyonCKmg3jaaNtMBSsPWTFaP3qtVVSdSh3lVyDlp9YelCDd4Q5ZYa9mZquTS+x38xVI2FYc3ARBdzw7YrT81wehsxWJFa7vSRHtE8dyVKXWmxwzUV0FPBfhdubZh3Q2Wwokx4gSTGf6KahZ2pkQhSZCXyG80RtPzU9KTxpUeOq8Qq3102J43/oWdbg5ImncxdBvWZMWorh5a4bhQAZ3pvC04+1AcwGdfPNTb22HSuVYz7zNcwovf5XgbmkLjPgDCOXihI4AeH1CT0Y9jsxUPaYMfPFFzaq1UsoE9oRgEEy9OQ1KLUG8OtwtrChgVSr0GIt+8yBU7qV+JoEq7HDQOJ7DovIjoJhviMEA+Em9niIu+WSjJiPxqYhlUPFz7tw6IVt9EJazYOI8vDO9V6VS/RMu68pXxZMmmilDKnE849tXOjqJEJnikDJyAe2EawiAGmYEjSpM6FTSdYzIi8X4e52AjMXIRuwIAV0Pi2YBVOffPXrpllXbAFQAYUF5DrIhPWITwdMb2zFhCeOQLTnaT+x2CqTtiinzOytk6ub8xqxufQdOlVskvYigFbxXuQC9E6Ww60RLlOfyuHC7QhsihW+haOvqqaGjUMO1+vrqcpEFYVXCOBcCXzwDfGZ5zuxWyDvgcI1ZkDVvIugr+QWKnGYS7ljnNHmGCfm+P+rf5a9YPBNrNBr2sf5GaOOB9yl0CO1IxL9pHK2SLQtMqSunyUaytQbU4K36VuUrrmb5Uv+SAL/CkA/nl17BZg/iGHrB54IfyvHdgyd/H4sG5eSrKD2MFAOgXMc3Iy2TZIe64j4cvlWxi0PJ9+Pc1vQ+69D8m/h3QKQ3QN1+YJ3Wx+wl+LeQDLNoB6xDIYqo9RE1/avrga5qNxnLvt4CICMaT/hGFR0JAcuABmUmBUQuI42dOhywbR+RRMs3wsVM+lMlSsfEGsNEjoDK/4H/G5AhRGFfyO8TxjHPQcGBANbkfS8cGg0Drk3jjqu8Pgtl85HaE3AjiRnL56kLXaJ5i6ZZtqyuoNIsjKpxl7iILgfJLd32mqlBj0gD/O89kNHVNLEh4BVK24/L00+dMTMNqy7oJbgZmYribPOX1YPyAPXrx86wvjBKqnAjJGhc9B9jAXV7ugZzsaAHUAsgDjgLOwf4FaSB6ghO0BklQBZB6BU7DEasCDTkTJqZqf21b40acZJf9ONbGb8h95yM0D8+JvtcTLKOQ4Y53DLeuSMTUkLPQaymvARm+Z8dg7KNa9P0p/LrDuhPvgd7KFTyLrN0dQpy4Cwcnp7ttoR2IUsk8OpodyKjHuBnRguTm/P1FgybUZW/doeHGfg3AHxUxgw/tYPWJ8FqM6jrqeUg26RUAfCRgbDjHkBtW8wUIuFEs112ikNXZPRzZhCyJBSMnopILWDGA86wo8C35NMFoGm2UzCZZtRhs4YH5xBvvtSB151CmSFOgMv4OHQXU2j1Vh2pFYH6zYEhA9UAve9oCPg2okv1RGblkmidVTXp/EV1NS3Z4xi5ipCsl+vXFZIJ9k/LT4QNIxA5yxsciSsYIqgk4qBAzaBtq5NOwL42Z7DUQbsTclPp7eVn0Ft32MqVCnS6ufYKYuSquc4HC6MEpAuyWVItZidZd+brc2d3VxRJBgDYpOWjdKClna2Xbt7uVcv7Z6wrYs9+v5uY3wb7rY/1p+3nw+7HxtbF73tlvzcqmyPS14wPn15afLr4bnTbO5tCHp7/9y/rtyHO1zW6rvd6ub5fs++9baPjxuPH6+Px5de867UlYen08N6N3BK7cOB/Hzv3TiVx63T/c1b936Ti16l1JhMT/uS1us1i90fVkvsrvTMq9Hu08XT6DPfuphcV47Pd3sXduPoYv1l+/TQmhy3tz7Z/LZSb95Elert9SS4u3jafb/5/L5/EdE6PeHv72ofB+EGD4ebW9XzPm0euaejaL9xbVnDXtiNju5Lw6fg+H5XhO2wte3T29vrx73d5/Pz/e1Wqd3fHe8+j873N/Ya/fPWVftp96768jx2jicvh6dPFV9Uhr3J0/mj3xgObj6ubx/VmsFT0Dq0du43Ds/ZWOzW/Z3hRmXIpDz0tybno+vBSzfwmDUKS9Pe+OWs/XjUuojoQPhP5+Or9vv7/TGrR4PNi0nj9HN989Oj9dK0NsYvF3Jz5y44vt6r+TfTUu/S9vf22+64cjexwpsLfmoPThzvdLK5VR2vbw3qN5VRTcj202d35Pfq/ZIV+IPLs2P3utE9qp15bM/vNu4+fx70e82Ab116R58+Nt5fjHanR9He+ePpsOoMP9PDy8fodrJZOnMO+1eVrcH7fXfYPxSjumBs5+xq3/3Y3Fl/aow2PpUuvODm/rJ9fPG57q6Pjo922f2n2+PDyenJ+dn98ORma7vm8bONT42SHH/2q5tR5eL4stK9OT2aXOxXrzd7e09su7TD9ul0cjGeWFElaI4qhzvuYb1/Ra9Oqbfl9qPRWeUodzf72e38cVs27kbW7j3dn+55p7f73fr54/Zz5PvRuvPCuyfvP7VHrb3nx52WfbdleUfrHnfvJ891vsncdiVi6zdXdMf2B8cfp4en29ZeeL356Xh7ffOuGQ3Oau3GHh3dD4+9nbBSef/+mnUv3TC6/2xtVbfcrfrm9sfNj+PmjmzVnm+mlcvNl6e9877YP7px5W5wv3XV27tn/GzU5oeP67nTecpOR+47lZP9/mBwKL3j5t4VtTab3aPNwWRzbzNob44+XlWG47rjHLWPNlg/qOwOo5ub8UX/0LrwxZ7zxG53xy8v4v5+p9W6Pn7vX9jVLh3Ut8THvXrP3zi86a2f3vCANi+fbvrnQ+u617X3Px5v14bv2fvt215Ter2mJ6LH9v3lxnOVNnbbV7sbj+Pb4K50vrEXPt9Ntve3r7vWYJTrNJSdTeW6cpjXbDSzhnQyGETH04/B7Rkdv6/cbX86uxnkfpinOlXXyYjbcJ2AUxuIBZkr2hilMabPuH9BmJC5M5ArV+2UcQtslBDUU0z5bqsLlqJl0OvDt/FlTc292hFatwlwBJ7jgPpPX0vKMwuulYSfQKCNINcRkdCggY+uckfKNEp5JcyOXCQ27yMvEHZEGjbDXrRYaJRicG/aGNdkhTMDlAlZuQKGXy8PUVY5a5h0r2bu8sEQHd+U0g2kudn5EN5H6+JUBQQmHXQKo3BqVgsWedVMD6JAYYrg+8CVwIjSVEeAkD6mDpoAHGAlKfg/SyPfpeMzYlcZt7yqUK8h08yY0jxC+GxJMiE5OlKrTZa9fTd217fsPlun/b3+9s5+7vU6CnOcKfSYs5NcyOAgh+ENAuoPuZWwOx3Rpy53psmKG06nCL7mQ9BZdwrNVqVTAH6jUziqdgrleGSNU8UCdcQrPBCZZYGAf1Vy5O/H6MRLkwD75pVptip5iyGyhGXcfgqeb6bXDae7uU6f+juju5NJ7XPAnNKZN677e/I9m5x69ubR3YmzF946zcOtbpO5W9tnk8P+k3N2/dHfEE90WNrZONk+fQmiJ7ZuHTd29oaNo3q4e/sUjIV7Wr17FpdR/XBni991o5ubu7uT2skho41qq+ldnr5cTuWjd7q13q7fyLNDzoPhIX3f39zaadz1zviJHVnnbPxpt2GdPZ/uWPd7L1ebe7tPp+eHt62GW7qqs/HkSdZlq36yvX0duvuSe8d8NBz1zife0+T2qvmxcr8unN278acrZ1ip2eePh62nVoW1N44bUbVWFXeTl2qtuXe5Xz8+7NYf7VZ4PKqWgk/h5tnO4X2/Ya9bW9Njvzs+aW7ssKa9/nK6d3f9fuIdVvc+CUmt3aNwwz9r7ez7d7ubO7u1xm20d1Ozj64856zSGFh2d7B56Vfe71oVetx9tNp764/7Z8HRy2SvPV4Xp4cfmYyqj43Lx4+ye/Zij27bN3fh5taJ2L8+lba1cfE5orfr/OnukPkn9/177+mSOS+fQrax8T7cPpx88tdHNxe7E7Zef5reVR36eXBV32uVbmuHk83u1dh299jOpTu8r/Sco0/edGDd7d1v73onu70zTqvX/bPqce3Cag6qQ5e9r3hHG9PPn+9lo0c/drfqj42gun1+eHFyPdkLLvbt28fTvbr7yK3x5w2/4q7bz6Wzk2pja7rT+HQWPB/W+hsvrSt52BxdtR4P99qNq5o4vXjZLT3aO8N2+PnZ/9yYNLy6XaWi/Xnrc203ah76bbc2Cf3mR3d36+Zabrg7x7eNSW+9vVk/zmUOZlid3cve6G5Su70Z8hJr7uxUB73+5vvj0XWtdlun7hWtBevB48bTen+jf3z0snG7U+mu79+PP67vH/PxRuVqs1Tbazp7g9bGp9HLJl9/qbaexHS6V1nf3Lm7sppjfnVx9l7Un4+2r066jSM58vbssB70ttru0ebw5m5cHbkvk/0j2T7eOL8+vPpY3eWRPG/fMb9e3Xjej0bVs+PP12N7EB5d9a53Ri/2/uXwqWTZT26LXXw6954b5/ZGzxnzT+39T+5eabqxWQ3vfXZ6ckXrtfBT49w5HJ7yQ69xdjvYGj+33O2757rDL69Y/4kN6o5023W6deG3dm9vnerZ1vRkSMP161LQfK4921P+yf7Ynbycjv31+qS7OXHle5+VGoPLxv345vZk/9Qf3jZ2zrb27p+ODvnp8d11HuJnmLL1ysax61/dNvc3us3Krf8UsNsWHV/Sz719ccfO+KG3Xrv+ePiytVnrPZ09Xe+1tunhqdtrDk8tK3ysnj9SLkp8HIXb79+HlZsL9+V08um0VnvavPh8PKnuX5e2P91/do9vtk9OeTi9jlovJ/dsd7v5eFk66l5er2+2b4cft64/3u4G3tOutfPe2t8Pght51J6cnvJJa+9ix9/YueDRy85WjV49jkvR09Nx5bg/nVzu3I6eT3oBPbQeT8ILfh1Nr3vXT6Pq8bDkUXEymtxfsmkoL4ftaNO9difNnVpzM/A+b4oGP36s7gppj0qV90dbra3Jxcv9/fHk/eO4d3vr3d96++PD7fXuxf3m/frx/XXryaq9WId166m7HgpBZX/r0+32sf286+6tN1+uepvHUjji/fjsrpKPeD7DGU4vuv7uaXA3bfGXjdA7Hpz1bj+VTu361uP19tSP9oPexe3zVnB9eth3w/Vj7/5lcFP/fPTp+Mi6epowt3m5t/Hi1SqUlg5H62e3lx9rj6cnn2t2zT0e3m5VLt879ZIfPY+67snnj6cbG8HztLl3tbNzd95iW62G2+yfTT7Xd6c3m9ufn8fXZ8f39dB27Juzjy9Xu3W6+9I+G1Y+NW/yphPJHOM6hJyvdAp+1HMUBwq3e6ewOssTxKqOCNN8KD+t5Kuyvj3x4yy7y1zf8abaFiFsjMQ3Rg8wdqaGNswxOnRpRYcYEJuGFC72MQu0zQSZPKMX6QhPYJsy+ZSwpZbnuhhD2ilIjrqd+INVxZ4wYcFjFmtUVrO3uuS5XP9zdlP097auTrdqm8/HG4eDvXHU2w/P2cbg5OLl0/tdtteO5H7UOBk3Px3lLsrzjrWIYXveQfjuyjvr++jWBkICIM8aUsgPkY4mjjkcfAcsvdKTa2/Nxln9Lt2FJD81j6s7m3vrP2vGZ65/kgkuMFl3kCWLFYzpj7RdS1mUy4QcUWvYEdqYntEgaj9ayXa3SwwDUGyy0oI4X0+QbegXgNve3d77mZRKSteomkeBY75YJbWjJvmp3r4p3+3ur5c39ve3f56bp4KqrLSncy812syGgh2oZmG8LtEipuJ9Ut99m7flNLtdnrvHRy/NaN/d2j05v+yGEdvd2T+/9O9ud/3qtBXy0f3jWf22vkNzLuEvEMRqDJM/4YFWLL+SRYuo4ExixVSsT0pzDWGtt6x3xqbzkH55y2egx9Ya7zf6WcyqwcFYh6kumudxpG/V2NznGv90env2M7F1xpM4bkf3DQc6TtojjZK4hR4XGEBqzoWiVtBcC8MrcjXVFoiOzNjfYlKhY/STQRWhMxIsmPeoI710vLgxS72TJCEtKKWuyNViyjkaSZ0WGDUgaBTEb+IUSfG8zPgoh6OpTk+oI0AxPDMWjuBi2hCTOgmcsoB6rwB2b2RGAozlnebR9U29qbPpUMdRnenzG6v37Y4wKEhTdUatIXzwTqbvCwqZFirGBiA9N6VC12a+RGpH8dTLpAyAuXZEakmy0y0S28OUKJ7JCNQ8ql5dXGBSoCKQLRVKjBm0MMEISxbxeceat9aq2CIItFDubESR4JgY6vgIo3UxTm96aZTaRnlBBimqoh2MVbhZ4pGGs4E3HaEUQuEQ1DvGKyxLduaozeMk7Coz4B9qgwNb/hsJAljvje2+kna4MpvLkOPYEwc6z528y0IK9z7SYQ0ZkJAmnVwwCfsuG5wPdKyceql8BrxgJMmEYQxgOEQaVCSt63Plddea0MEgEzykySMED00EC94w5StohwEU8IeO+dQXo3bOMJPGLo1GbrajXCT4nsOt6RuR38DGBv3qV57zG2JGuc6jPW7WzdIP+JhaU6IGjwk00FnIu4VA9JgkQ320bQY8IEY6ZBKFWJ7jMCuURSTBRWA4kGAr3NtcWg6Y9yDiSWLOCGTz8tEgQ+NSksqdx3NMrCa8peHJsNTUbVNeJcpbwfA4GBoATooOT8i1ctdQpJyrayCObxjq7A5Hwi5B9q53OilYZYDJczJp/2LdYEcsmkCKPKnMQpjwAUCFoNQeS2JEZ0yfX+VMvoKmuc0To8rgyDyA37O2Z+O9YQYhkN0wvvGteD9ngypSMRM6KAicCsHh+xtnlnYo+yMJYx4kP95DIQ+KP8jpLh0FmlmTrzqB1aaCutxKdmMqnDQdEqR2ZvIyFSdoooKNBSbygdsrkgEYLLyA2AwypyS0dzNmulRwPd7X2RBik5AFzP/w+xUoc+lWBh+vejC/HRuaxU4/y/g5hzqF2TejIX8CSPe66lrsap60m+tqMTMHkynvSuUkaGn+vJIYHIDNbIEU0PoZeMaU64XS9iOxNdJazDAaRj/bv4xzaMVOfo4z26YjNL/PpUGt6T5gj0i00dcEPddVzlFtCEGPNQ3dq4haQG3zUTN3HaV6MWyliu0JkKMspYwpyV0FSMG8o2E8dyVwSLy6LGoNtc+hzockDQsC+TVkiu/XnUqGkOEtrSILwoCzMXbimmEwkh0NbrG0gyZCExDdEVcN5fmjhVo1k5wZKklpboKxCUp/30192k0frI4AVkKluIiv02+9LJU49mbvx6ZJcZvrAJll7+J0uJj2w3jlx5yE9om0qFBORvpxxmUxFTdbnUune4nJTHEbvOrSeABEQznH12txgGVyh9806+DnaMcejKZ1JRVWPdvctE0B8Yof5rc7IUrL898SNdSCdoAN/CPDhacUQWCOpxYY/GCjAI/maI88HMfsyBUqIbmM4nNxXxsF1lZ5K+vhCsqs3ffb+z+vzq4oJE1GedE4JePuRSgyYepZrSSAsaGgKW2qf8tb6t+D7TzCIxmkcuumUty85YJp4VckSXxjpAZ1cxiBBUNdVXIOlhbcIfqZOlbkqGuyIVlke2LqepFM9SnTPtcms2ZMbSShHYGJf/Ckg7u1GDhsRgmZYZa120AuGkbc74IlPzfjQmvE/ap6SaCltoSbJ1YAjPZM2Es5nbwPlhL0zR2hw7VjxRG1XRWPnO8Uj3Bpxv9V8JSEMg+kFgd+CKyRuuXVm6/tINUYCaDxYH1I9yC7cfDXA6nNU+iUXhsSLqljiJqiOGYs3Z05m/HMVewVWgW4rX3MTYbTB5/yYMIl07kelBUiP42CYpENgcUQlq7KX6dwgG60kDM5EzXXo5JbmPornyxpn2+T3C+bI5hcxDn0mnG67zgoP9NSZ9IzolW2W3WqUvktVHr1HEgfDsChHaeySloMcBIHiGocZb56AM3aQzpp4nNpMpmUQBItRYGj9fQPxKj4tUYL08pmLwCV7LU8BxeIxA8H3xWYNBCQex4GRWVGyLojNu1Coo8DkNcTXXRbJSwANUgql3Q26u9BeIKpD9VKaKOWSbWyovyDwC9IFonr9YCowQ+TLANOZJyrXM0pn4rl7cXXee5FGy6X3f7aZjOsdcKIL9h3+bC/1WrQZoGLPGhLJafKVRjiQNo7fE5DFZoedHqrjjBKqhklBJlRWVGkOgG1wohCJnGVoV8OuQ/UMpwwHSkVh2zq2NxMd9kGlsX8UOIlrxKSw9bPqjlz8aXksjcGPJ5TEBfwizjmUf38asyjA5+qwd4e7QhTg1jYrhKDujGD/C2S343uBDcjsxOmeU4GzJP+MrYKszOhyzp0afqSSWoXuBOMR+NMsQsTln162+6In05v2z/DzlGVUeyiDr1DGBXvc3rbUrQ1jqLgqcA4nqi65uCZyRyOGRggOTuqYNvHpb2YYiIJ0gn7Eo5rNk8t0TIbxvLk7KMviTJmdtPkKrW5bXWxy+ecTFjUCrrqms3Rq1ab2v6udQwztCND9KtqBJi+lKQZx40kxS1Mxuck70vm0kikyLpOOZjwDZicRgmrMxsPTUfPvopN1rRXZcoHnWUWXl0c5LiyCv0bw6vKvJvtVY2HhiYKK4959g864u8koae/BhnGCbY1I5KktfRmQ+vYFEvb8qTWxZt1SBCnTY0clMfK7mJATCVg9gMPJJA4U/cM9E1TMMaI4CawCPMiUWPzzwkMUofm7ciQNOSyn1K9ZxepI2Llt1okOFfKWcGgQ6U4wZ2J1sCYAqSltk0FV9Kep6vBUORAP3lOJEIKaTJV1pTpTFb3b9Mo6FwA8+eoppMEpCXUlDtrsuDGupK7vrp7mYM0PAVGXNBpB0IW9KnFMNtBbHI2JgztQGGOVeL8fQAhsRCw2F4Exlzig1eBuakrX2sZoqZVSX2QwDptQsGEDGPOJrE/gOk943eEKro0tecxYTIxy+Y717PBScT3/Mj/feeCQ6QnM+HCVqkr2aKXqQzzKhVWqtYWkfxFnVidB7zU9ywUwG1OIfIZLy71PSDE60kwgGsGJQSlmx5EhZsjKfU934dNF/mYj64MtvDIGv6+mFFBqAoMoMgBbkTICg+u5fEGLXfEhP7Oi9Qp9JmKuPOH4EZVUHo53WVc3CF3+NgjBIwmrh+ayG1LK35SyREN+5VacAAt8QvILLQZPT/nqjbjDEEmsJCjwNvatnmI2VUb6Vv8y6xQWq8h937CRajYEUIDI+HgTw1prBT0AzbmXiSdqc4Wb6hzLk7UPQNJno0bGcCZZE/piJStVGeHATuED3xppoDPfPKCOctEwsmopJ4wVE6YLbyD+SIoMpXJRSXtTCXzTBPCdJyJyRRMVsAewOC6pMF01RSzwCmm7U09jJVtNoBRhGIOmGaaypHMjhBHtxJWSqdSISteQFSa2QS4VeX7AxjCRJ1IuQHR6hypWyPBuCbrRhkOq5FZL5MKOJ1IN97QEFbREXgiiIjcHl4bykigMg0lF6vhfbFxVzfGnRUXrFBbaq7oh04GnC8O8a7jWdTJ4z1v6ufqlSHx8Y7ituY+YLoOFYNIERagi9hBwqpnr8IimfV+7IhFuuHDamP7vfKp3N3e/Tkeh4RU392yqLghtRHS/NBxNsDLRAx3RKfQD0rVCumDMyxGvqR8WVKh1gD+Mfw5VOwNnlDI4UsFtWlR7Q7dYCVdwm8Aaw5R0+BZBf6vRcjsow33vSk5EgMIr/nKR5gsA8v8GdoLPlgBk3DD8r5y+NLOZHEqYM1ZQX55tWxYcy2TDspohuez+L6Vx0pJPlWjSUyqj+TmcZph7Odz9ybkJTE2OfP7UTPIoK3QG1KlBKXOQoFGqb7jAoTTGenHyliijQkXJRjI4aGykstXRSY0tHjp7L2x+SeVP9vAHGd0gmVR5fCKEBHXEYoIQgkjlW5M2FNYaCzApbMF24xqf6rkDopdZJJkNa8ZSkHxkfbZWJy2NBayTLrSbMGRtDElyTeaLfc4i+3kWvkWE6GBe4FJKoZTWaAyQCZDq5ffGTaT1ygvYlVnK0oyWWeL70Eq+lS+/BJFTiVg6DQ7U+iPrEBZUV1gZg1KFzGk/X2HDlZBIuVoWdRF+lxTYUliAN78IDa3UxUcU+XvZji6eHSU2ONRTTIiM7LR8ajE/gEVtudqD3GSTXEeyUSGhPgBOxvUILLcECauEwRKaehURWuYbLIjdK4jbaKBw/sunaBeJUWEM5ZySqFSehbX/ungr5qqrBP7OqtSQDrVLWBsockr35aE6ipViBHzp7B5c/Mwc0JiB13c2ym3aHyIN2fCFKo0Uap7oAowV4Alr6afTgCUqWuqxjBaN0wz0veCCQ3szKfqo9jYfJ7kqjf8e7bioVJxkjU0eZk9k7oHXrV55eBR27f0qUGoksIFsfpXuWekudgyuVT1GzAJtK4cDBRWJghBNxyhjr5Uluu3XA6aqcrk6kdzCaAfU5gnq4KOLUnFP2itZxSixQ6N0kp5nS0/EZcL1nyToet4vvqU57FvM6ELmYpzsEsTPMdZ8bNX7M85l3n6DkfBjnhi4CX1Q1+7vtN+qJosZmpbgCl91hPuNSc3SHea8rXLo/4qJ5QMvQB1jybtG5fpEl4mRQxMDfWhpZmanLmb9BuZEV31O5U5LXPY8XAnRW2R6UiJMugbbw5kpjCuWphEeXvTPH8HLH44hL2ikqOlsnV/7fqnOZNpZwX6nJqnmXLSqgDoRqdQjEuBFlX4F6XOFsSnV8iQD2AltJwCOYdkWh0ypAEWv0QtiwDBnlojRYGg2FrguVznHaCW5UW6ONtHQ9uLMQhZUgvwzdxjuugeLIaKsR+CnbBSOd+codITT7eV6s5LFUj7b6yOuqruTHQP1on7IJczgZSyQsWExUyv1IiTxFcVB8Eei5ofEnoHuTUOdG1hLHVgQSpZP5RrqVxrqXpalDoQyQQYUP9sqn+20ie6klnQmcq4qoht/lYxZVNz9jy8antZLivZ4vGneHHku80olklbXHVuNsyStpCHQn7ApHFDdjupaaMT9WIlrBzXLqNUiF3p6Ex5vqSubIpaxD7gSYlZfQWaEppwA/D+4ot9dhgzUQRUXcE8W54PLjjQh3UK1OedQlHpIHAwb6a4TraG4zyKQxrmITNUmZAzhY2wbaw10PCjN4NKiKI9Mg6wrnGaSzD5UoyjRKpwtCruCmN0MW3tgbq5Ue0SYzbtNQp9qrMGVTXMHXaQvQVBCI9LL8bm4Znas9hMdVRGhh2od8rsNmNaA7ecErQh7DmEXBSeUBmK0wUnG54P/lZMLwbQK6wCo3NL21hHO/HyUd1pg/3f5hJS64JUUEchtpJKL/ES6ghQnlKTTFMpfAJWQm7FjmvhIgJWMN20RX3gyuxVrYTvRYOOCKCKeikMuK91BvM1Y7Bl16dTx6M58ks1fcJ9GgDlVHpLpU45lSDNh8QF2xRw736kmCIvCv1IZ9emYtoRusaUDgNEr0rQa0C6PIyxMsUrVozCtUjSIirGr6S86ldRq4GRcKGpccWek8ysWPICQeyhCT6gNo9kHF2N0yZ62kC5Ne8cqFx6kc1DWH6JyhVcUV3nOafsDs5jHnXJjlHMnpgSGTKfrGRpQdHogW2mqIJGaUcw4DSpCsObw94qbA+Q3wxxmofLVaFY85CdZN05dDvjpxEX76LcgXi+/MuB6iquM9Rl6AUhTEhKFVmnz1KqP51DdiVdWAT0cXqxbSY4s02WmzCgPJRdLnDincLqAlLHckSxC2oNuWDJPOeLSAFIaPKFZZkFKHs3GYjUQnRNNGs+SGnlmMYFcH4aAUhbcEyVIRdlWyQYyXnNZatjU8S3WyG06YE9o/eNYUO1pI2d5o74qPZiF8/1N1k9kBCgk0XMA/eR/mlqnyUcrw6umuSz38Bkm8SaWVIUD8ueQc5Hwp0yu+RHfOoRFfH6lvle4RdqwrGhXIuS3zBVGdosyKElFTGFDF+DvIlOAi9E7gbU3DaIDUiQ8k9KZvcCB6aI8OJKgqVFdBsuITuy0lsJAbKJOrQZHdoMskRSezCnf3NOoKRCYMesuiGHJqhPDZOAsRDbv44qpl6aHTYPY364JA1zRFTcGsgOJAoW5TGMO1WTomSIBWRlQRoBZFWgqHWbyVBVf/wUd3WEF1SO5tL4mf0KShJv8nj1DVPyTtWeR9czwwGhSoyKac7mT9HKGqcD4cmQW/HNbNiauJAIEsoSOBUouvkVkmmAylXOtjPVMLG7mLNSJcCAKCNrHtJgkO82OqN8SQ/4SraIzHpprxxcoYAKic63C1mytmnS0DhKpT1E8ySmdImXRTGxoUeGnjfS8f3IhIMJHfgTmYe3fCf0tpFUUEYB/jTJNPdAff4Ad+SD5pSUv7eeL/ipGwVJ3MMCS+RCLpQFWTvdSfviHEx82vJpxa0AMog9V1YSzOeAXsnQFjGg6bRS+OYWY8/jbirKnylxGUmrsrFqpPoSVT8P/5N68qFT+OUXUtYdfPnSKWiJ6UMHo6s7hb/nu8draoVgLUi8vFCwAZzo78H2r5pB1UoGspMKtYxk6LnKYdYMtYD1yCjxFhSKSdZb6eu+ChdRIN0G4NuJYiN1WcBxZykDab6z88LdGfcL2wtsd32PgIdoRygrKpLCjtAyJGmpf1MqFSSHRc3Tg+JUNXhLkfC3DjZLMlStX0CVHuQVuhHxtqEUaVo+20DqFA5xGEWGMVayOk/tWy2+KxtP46rVzlUJCc+e2YnZji/hPcplM9Z9PKjMYa4KfzROGNpx/6ZOkpSfUhntE0acEhjWKB6pIA//w93B3x/A/I/aRvUI+U09xN8fVHZR8Kx4QBO576A5jD2HDzllU8Mw4L0o1AIxhym5XIC6DBkGih5b2HL+9A0D1s/filBT/J0k0ACiP8C4piU3Y05Rx+mAgN/+G2tbV0wR60SYWbRSCwKJYJGQGmd0QOjTZwOdwFAeYwqnxOW4lb0+eYAGZXj9oGo6Y00y7tIgzlsKFjZMOQNCKQ25LjKpigz7TIC+Y6u8DgXVhbaKqBrmIKozayi0VVwXp+KQ85R2CuAkB16rsLPhTMNSo4DREdwdkLpLBww2SgXUVXDgcLqkhf9AfOqY1PgYc5OmladvOtTfbeCEz1kS8CUBn+0CyYhpVVQ9Joc4rc3HrVaJSdasKjchZsahFT/A0527MWw+znOTVrsWFOtxeFuSBACFGOBsxuDiagNnnMSXg98rRW7TaDtrVxdkTXkVzxFf1BXl0Tl8gSUHlWd2qoB8XF9Ii1G1q4vcXWbyFy0QbfKqjGWQAHy0IoLU1xmpSsr6CwGO6eQAyv0ydgFUyDPOrFPi0mkmicIDQFYql8sPqfV65dj+EXfA730FvP0GUJD/XtcA7P8fexHkUY/cs24+yTvt4NU9c0jzN5A7yGFaGHiZ5ahA8LkRiDnM6m3lIZesCmxU7g5+r10Ky/ij2RUZLEifihvjnSTSiwKMH30TOzvhdp5e7BYef/OWmzlDAKq+NdUwRbPHFxwtxMU33KII2OJLNNaP52jBv2UUXDIYZV5IiULPmHoWOm7ELZKuYwds7LvcEUr5k4Wskvr0CN7DHn6tUZs5HREFrzW5CZyO0AEHpdiDYnH7qmra0C2hGu/kLd9dsknyjSdUUG0JPQEWf3QlWJu76EWAaV8CZDQmrAdOI+K1Wem2t7pp6ogiYpERhP+DtaJYmJ0/bMfUtArFQgbiglLJZoB507FfLup3XVQVQQhmgFyX3lAmJ+qdJKapUed76AcIqolXynU6tMecpSy4lAVxRVz6DJ4reffjBX0+x1coRaRyIcf7z6XP3I1conp4Y0Hv/HLw7VS3WpmGZd9zF+7PxLkhl/R78W7IHPxo7s0TWOk8z/pahReZ7fRIx1T3p+L2E3E7bT7HHrU/f3phkNwq0faW9cDhUAm/tbiIK6RvAbpkBk9VYo5D1sDAu2KStqgAbcgoDYsbcDlCYmc6aAccUgdjcBejdu7+1BjQTRciwnSVxgeN50FC/frreDGxq2Hcoa8z/J7SMVXrRPqRUEYgk9kaEykEU5O8XH8steFIxtWf4D6E5OLp3Htwx6B9rwzlCKYG5kzCSvNQT1PmNcp8jeGbCz/Dt9geABqxaX7z9Mu51um7ty54+OrXs43Tvb060Zw26W9bLARfAvmWPvLapg74AtQDdzeDVvUoPb35J7MTzrSY7/81EN9Cc5b75gfvG6RM+ab9K3EOBv1fQZmhv99ImHHo30CX4fu3kWUnabkIB9+BKCNKljT5P+psLWnyct/8Wpqs8jgu0K3pwP1MFkwtKinhG+klGKYcrDeBDkbKtRFy2aoUVuCpAMv8oKuZaNGoGKcy1IQs5fSvVAo6QQKDeg5rduD5tjcRJKA6yA2sfKQfMIY5GVEM1+o+NQ7t4TAdYcYBispFpGNicDCa8pFQHxdVREKc2BRqVkG1AIxMM7KXyR97U9fmMNvDqGIHzH8Y5fWKH2gz7cyl88+qSaIHpjK16cgwg2rPpI/MItdOIzeuDI+3lRLzKJEWdWigfZJBNl1RB7Cog9OKWNJLq2hWUxnqoDZaj4bcTQXm4uALlrEj5tfRp5h4RcdHqDs0s5rzllGcQf52TGWsMnHXMuqpBHlmO8YZP5Ah4NYIw5dMrv1X5pbCrsYoZDOC2xCqAIW4D3KRqqCaxSpJIbU8py5Rk3xVRwK6hBlF+pVvTu2sR2tcT+E1zYZutDBCUgE3r4gJRjrTFa5ifDTj7HW5ir7F6q1ZRYtWc+EJzE4YVClKLbBAdwoNUkpWFWw53+QSX0BUF7NGPe85p0lVv+qIIbdtNqs2hSYn+CLfkgDvFyqb1TQcUKLBZs1528IXHdGLwtDLG/sQX3QExF6gThhznOQ0hDSdoA3G1DWq/YJWeTpveHfTrKf4Ca3SSyvyEZmg5NcoA6MTogY+yxgD1HwLxYKaVwFdE1Lw6wfabPBmTdFyk/xLbJIvxddotTnlKhfGXOD7LEFEvazeACkrxKwZ81uopQr8AKhyco7KqVhg5dVSJ7YgGp558mYFnpQq/86r3WA7nahHl7b6zj6PqNwGqfQ1OHT1PGwHYajDf0fF9r+K64zeVD9asy283ExFl55J2FVtNVRCa2yJ+ThAj2DyJ+lgcA7pBcb4OiBVlecXcpYqzYaq31buiHsvMkwthv2bDpJUIOBrPJOiKds3gINbHpIMGGigEx6Wyb3O4aJKXap4aj0Gfg2cvpoHjvaXfKYFc7AF+ly9dg5N01fO4EK/D92Fcvv4NlOe/vSifnE0Q0sWxNEojw5FnuYmmCU76aMfU07tVSUQ0FwXELW9cn2rNLTo724SGYN2LFHG5dpV89M6L32jgBIBbn4vOoR4/+HO3LmLvbTf/wfa72e60F8v9uuEr97sFaY0Mgs8z77ESoPpJRr0UwOiqp1d9QsHPy390v7jXJiWfml/wkVd+qUt77WlX9rSL23pl7b0S1v6pS1t2UsfiOW+WfqlLf3SljT5X/xsLWnyct8s/dKWfmlLv7SlX9rSL23pcrT0S1tukqVf2pfi0ldi6SuxtCn9J9mU/jhfiTlis8yCtcyCtcyC9f2yYC1T4y5T4y5T4y5ZhD9LatxlrMwyVmYZK7OMlVnGynz/WJllwvFlwvFlwvE/X8LxNDuWy4hR4nCJypUUO6bqzjwAp/ehU+h7XqfwgPsWBEW5ikVcB4EX5VR5/AiPifSZBfvSUCBsrLuNrQ6Zytaryf4jPeZ4YgD+N2W029LICUlN/Yv9p0wXxlChn3vctnCb1WtVqDtnxR8EXh+q1jXUv/opzIecczHSvzFyAAID9O/QC32sMW3ae94o8ru6vPE5/tKv4vgB40+QgnTEpkS7Feinycnt9nkgQ1KPHxzDbwMP9UNrSElV/aufSuo6pFW5ONe/bTbmFlOj1/DvBID0RlcYzFqnAGGKJgNaCsUCoAQuKRVmAgiAh+l5gzojCWvR88NrKzsn6EXBDcINddF8lYAKg8Mfm1AKGDbjm07hcjv8tu2wrGG2lPN/Ww0zmoclLomLWnpdWRvuFYhcUrWn0f+IayUill8HxglWRLmewI3fEYZBSpyNbuo55Z2XEVHLLZtSTcXsDblUvOsFCymOrzdbbmaAhZhLMcC/n73XFKhQ5WCKBbwglUKi+Mfzo1oKHWj2IVWOL3V3aFKQ4i8B/VnOEgqLvlM83StFTXPIDRYunINLlwGNCymaAoiv7pO4VCnWMvXBdcPu0pzjeKPeVbTMM2QOFHPWwony4QIOeOD1on6fOl7Z9/xMDB18jvGnX9UPqJ2usMyeffCjB5CKBS5lpMBTHzAZdlWAcARmFxmC808K5coPF8rW5oSiz4mzcY1bQMXW+tY8Do5cH5z1mfSBI1MyP8oaQCWLJF2RHVqhLkW1shn46trKpxJruwKwEdBbWym22Ezf4B4YTn0t7m2ub6BUsb2+HhNzoSp++76jK9evPeoi98rrcIG2xlTdvgqmyt8QJE5FidRazV8piszNowM/MiDPfWWzXjSY/6oGj00wgiTYKn35JeEXkYxw8qCfo2PK0d0Hb8whxegDiFQQ6NhTxq2CqNfzBA1Cj0pGqE19qGENtdUjbA2f9rmwURmhvQbz7o8F04bMBaYaqcKbCe3MQqB3KLPjvUAs1NHAfHqw6pGwF47bzQw6j8T4V4LKfhTMcRK6iLygUJbaGGzjgusJwFd4LJQaol4jG5tb2zvE9phEaNkzl7koylO/1GuKRGgljEJRvVbuiD5DMLrCC7vJgh4FwbF6cemFFfO4I54iL6Rd9mwxBrEkR0FwDU+O9IPUpZHbb6FYyPbwplvj+4KYSBM5frCaB4mXL9lP+ptcpkbRjS7KnzmFp202a0ZSXabJzcr2+naRbK9vwf82iqRcLq9mdgO8f5M1f9G9MmAC+DMkEFr9Pkfl1elKUeuYGCm60kzoyldJN/b1UQ2q9JRKlF+SyiWpXJLKJalcksoFpBIAowOJOyPA0XHtn0teMC0FNGQOd3lY6kXWiMEERwENPVnyo57DrZLLbB65uDcAWy3EicQETg6FEuQF9DM3kpvWTBT+1wumayrIB7h2ZXI8KHDX94KQ/NIRhBByrMGp+LyonlQ90eeDyIStfVGhNu9Svb37G1iUQF0awl5JWpMPRLBJtoeV1b+ZttTndQHU3mK6ZWr0lUxPqziEw9DaGjA5PDBROX8ja2tN9Qy0Oyh6SCbRAEHqfSJZaHLaFJUyH2OOAvOJUKQDdCzZj3tTQuUInutg4gD6kXygNCEDys1FoDvEkVQmK2NAQKmJgPRlCJvuvUxWjI5pFXzblPYYjNQmImxVTZdS54Cos6VmihSbUNJStgyLVJLhuCcuUAglFSmjABF7zsbMIRjkjLP3aUBdFqrZRP4goKAWS2FBQ9jpvJNZWwihcacOdrpSqZyvahygcU2Z4sHUJkcoXbmRE/JSn1r4eQZQE9wntLkwnMa4jTCkG60yJg/SfxtVehGxWKmcAwXfKMMKo5cAl0MYuNPpFPSk4M80ynFCceh3/ur6LMAYRFCmkzWjJF8D+qOGwdtRLTSXZkBKnU34982LGrAwCkTbS68s3Mc3zXOlZoTXCFgv8CYaNtoPTVQl2DGBWTDBqPabR7Y8b8RZelyUiqv4WBK1Jgr/MFKrdoabPYaD+n7R3NiSBWPQRXBbO4REMlG0hkbgVl2TE0ZBdYpie2+KrxXxACjRK0N3N2QB03uKCRmpYH4akmqreYyclTmfloYZ5Hzg8Jj1LYjAs14dUgfSDmUQUknUv+RkageGqFimMW66OGryDEmzogGWB9wlhOEou3Iw1T3A8lkqclKQK9hTm8m212H7QZmkQj9VjG7mvFqeC8G7QH0fEKRuDNIDbp3riAXT1Acyjd4UF24MqWvYyz9m+vpAe5bNHlbfjEovGFDBX7DrRYhMtwHubcZ3IvZAcLzBQG0+5K6RVdS7IZkXxIYKZ0pYv8+Us4d26ACEX7Jw4gWjN0M/5jQN9CdODVyZZFV6sZCIWAHDn9RR+xg4lmQuGutlcgUwBsxhY4qxs0DLN/HwyjIhtaNG86haaR/VDtT8TJgysePsFmXScBhICAFzwfeJh2r5cUE18y6VcgtxhZtQeBMiGZg6rKHHLbx5Lo4rKaiRcGm/KBU3m1A+dbAtT9hEk22TDOOtCDWoaqGIt2hDJERfhepq/ywTmq6OHODqTeMajuIXzUUWUbgiX8gHQieUZ1iNshUwGrJDRdHOjfZxRXE7mi/QvA+lTtE8VyRb/1TER//I0hL9ML3j9aMxp/qvLI46YvVv6OykubePXoprA5f3MUszbD61RsCWuxQSGoBmHRm4lY7ohB1jcOoU1M++G//pSfWX5zNBfa7Jb6cw4OEw6pUtz11LeLrSwIPWiFtIMIKjrawCm9gJDfN08EHlClxbQ26M/JP8e3NiMDdKHZgX3updLW90CjBFtZFxkj+KCfuTsWA/kgFT+1QdWrWg5teCVf1uDBiMrOiDGlf9vWDUPy/7BWjIUkaFjuyzBWhZMmHzTBjS7jQfhehMP3kDMv9QRgxmMOZUAT7mdAG8X+HBlhyYwmSWiVBIzT57w374VXwYMAVA49KqnoMPJMNYlC/ZZEbxg9erz6uK8OR9UGnU1dsZ7Y8i5tIvkqAI6kL4OO6pHGuNGvVyNZ+5M/41h9QagQeBsFdWV8uaW1nRLMhquUKdFUodeKPuihVzaayWFSVdUXRvtXyeIWMrWaq2Wr5KnbOV9KFbLX/idGXM6Wq5nlmslezarZaPVDY4hTfex3n/5QMR3FFcWCfsu2H52A+4CPsrniy3QpsFQZF0tN1DORFRx4Flf/g6lh4eDsh/jTsd0Skglle/Mspx5DjqljEWltT36usv8L+1tbiBppwLxj8g8d/w3fzAHuR16hSa2d7eMLM0YEz6qx3xJc1xN6bhEH04DNcNetiFqlIvmHbVy45ACJIHZdezmSPLipwjn6A/Ss1s9psAmEndrOJz0M37StmKLX1EgWmgfsEJ/Ct4m3JhmIWhJ9FJJD7acFtreQnpzTAMfXmwtuY7dKrOQNkPPFBYy7IXTKnPJQgB0HGLsawmt+xPVSqrxC/bcYiMfICJ2TNq3/iGkGWUzDIa4dTEs/RBiUY4DSBlbwXXSCkA9xEEgADdVcddcQCYfkurmTXvDzp8s4LYJgVUxdCVGRqEjIPPdbMDBe1fidpwiwehUmpZ0uddnqi7UyOmtd7JCKsZgZR8IG0Qtf76Z5G0tHhNPpB3KUnrHfkr3FNLIevfRchKdCPd0IPFjH/ML+l3lLASHQyMmZWwkgH/zMJVrHhKhAZAxcyjeZwsJas8yWpWYweozJOs8vH4BwtVWrcIMKeEqgTUpTz1BnkqrZbtamHoA3k38+j1ffCrhSkYPAymmqnIMBaJMy32ozlbmbQEjiFmrz9k2Ayt6u5qCtdNuFIj8nww+m5Yyg+g7k6o+Yf4r6ImSB+02nuW8HyY+V3MnIgPGVU47NQPoAmfxfaHmd+ryRSR5V3paJ8lPVWvn3YXKP194VwPkPFPd6f6SyNOv2XIepOYAweSxg7mAUkaZGSsN8JD/ksiSOS/CFvFYMjnkrRHJduz0C0t5b0BrnJ8oHyjCgeFBaaLVQx4C6irnEBUcZSCXtr5HBOzvin/hqxkIe2pg3WKQJrTE6eYknLWkWp2zktHin9dR4pXl9eoZL66xr+N33wVBkUIvwrBn4wBfRUlWQ3YV1Hzn86H/t+/Pm/V/maY0Vcxm74/vwmvP54vfXUeY06/Cv7S/2IRt/oqarO642/aJG9nWnMg+LloyLEaL+ZJMBeDN8u/LNLOh88pdffbmZklJ/NDOZk/GR+z5GKWXMySi1lyMT+ei1nyMP82PIyvLMO5epg8vdqSe1nMvSxZlz8T69INvddX98cyLkuuJbmVX0fMkmf57TzLvzPDsuRWvie3oq1Vb98dvw+vshL/VXbtVYwwZs8hE1JVhfzplwJkQzxYFGIc14DKDzWGeZvvY0tVqm7U0mL1Z9LzLC1WS13PfwzXtNT1LHU9S4vVUtuztFj9CTmZPxkfs+RillzMkotZcjFLi9WSh1larJYWqyXrsrRY/TtzLUuL1dJitbRYLS1WymIFTXUNDcjPqyqCQRX0wppkTr8EVIlbTB2RNU0GIT0DUivFvUBZioM4dcAvOmFAVzrR4Etu+oA1NGMFHLIlm4pT8ScqfbHOaV5IEhHMYeseFju1vaGAF2arhl6SgqSY0puH5jz8lP6i6gnpOeznFQO8pR4AsGU5XDPAr1lREDARrg1YWJIhhfQLUPoO0WeuWGRI1Xx6VHIrTrmOnBw+iVcfxgO+scdowIJsS/VorqkqkIY1h+CkYJL3KBx6gSYhVZ36OfPwJrM0QyDCZZu5npmg6nQN/o91ZzxfTcDr9x0uGNbSwaemmqetgu/0GQOyZHjL0BsxIckKdTiVqrKl7qVLscrPAzC92Uff3j904TMBCcYTvlDoum5EF3YDatqG5lhZBv54Ix5C9VEqhbVCOqA/mFYQZtXxfBL9VD1dJmzfg/QhwBYIxmwAMbPxIE3FiE2TjTeZTBAWOB1g6IWdCOGOcs1ngQSKUFIoKyGMeCF9fcsE01svGEmfWqzi8zOWV1P3dbjJxHRQUhzwD58GlsTue6a+AbXQ3M1cymFJdTaU/1XrCHWAFN0FyFrq3Xwx17+SuggDz46wilBH1Dwrgmz/6irGlCuOQ5Q1HnkuartccBkGmBcSiU6lUZdlUsm+gIeqlhlccT1G1GSZrTOeUOBquE0aGhlEbSm1WcukoUbEXoCtcz0ZmlqqXBgmVGIt2b/+FbhTCUVl4WrUMyBqoj0mTTYUmaqRkBfT3o6bQanepJyCxO7j+6bvgbSDciMVgwjqPh0AGP8k5/q3jtb9J6l5E4FlhoF7/jX/QRfpBflO//0ToC1l/iOzD779v+/QRX63AG2NBmEGMT/5Ua9ss3Fy4vSDNZ2gVK4lOW5Wc3H7U/OoUrs4SnqYSUUq7dFaz/F6ay6VIQt0alKp/12zaRCuqS6AhUjjtnx51M4OJaIBC8teMMhSiPhxAvVVMC2rDEBrq98TWi8UbA5ehPbI4c88SA81ZM9l302GUr/fitnvAC1DkHKh/ejNDpV0vXC4OKvs77ITBt78PtDQntIxzQ7l0jET2Z0gGQ2sYTl+s0aDkANvvSaHcImsJfnAVn87tFDzfMG+BWiVI1W8b333UWZRi/vWPDZ7Yi1VkGH1e+IWbkB1Y6VhnoV25RYulT4LreHqrwW7pD//XYBXnWemQGAOjZPGzFZUkHE5Qy0yjzMncQbrvxlof+jnbGfEuEpUl4F26vMZQPUTIzKkNu/a/On77dAiSLmUohn1ptmhgqg3HTBXZiFOP12DPzLn7btCC0MtOHtNUJplhrJAcSTL3EtJZeaR/mshpN8JWpl/w2FFbItB8ZmDWMCv+NQaMrJZXofSjBkxA84exdeIY/2tXDuvV48uW0elzfJ6eRi6jqoLG7jyqt9S4jaI36EnU6VzDMsJkjMLpK7iCMhA/tb3ZOhSkYLr9Uw2s8J0qnZYoZ0RBbjgoBrhL6BqNCxoCUpo2Uq3kk6wk/0UtS6xncCHMmABpyGD9IRadwm8tQh5CbWbLqNK4RnLggBydkilJQLOs96fEVowDSMTILWoWvZiZDhe3UcR9AAIVQ8ETpsHqDQlodcRD6Du0NqOshoFZ1aOONTdfFCqzFgLXa/hzKjis59mNI4P/4BGHx5QRWqYfsSWcY4UaHoAI0LAqD0tZpTeuSCShyhwZFmrRrrmnQIuEg7IETmwdMTDP0zeITALPaACXbJwIRIhsQ6zMbkVFaRyWrkz4riCMk4GlClRpXTzPBx6EVhqDHhlUsclgILlKn8QmF0gU6rq7EEVHeP2g7EZYb2neIyeZ09Rouox4gnoAMWOB43HrsZfUpTr4SBR+/EYv2hoQSmqnP6YOhtds9keDsjFrO1Ga4g3+3QV0ZbUbutFYWJIgbpzwos181NE7oPRC3UtGfS7Y+45KM48HJCbpN4c3I8J/nrMoiCNU6Xuj78hnoUaKDvTb6xbdLl0aWgN9dwTKGHptRHmgVDbDmCTcFW8Dc1XamdpbTOIs49Aj3FL6KOTycf5F8A9DBGrKWd3/mx2PI57TSl1lF0lNhSEw45QZgEuUvYARUkgGSoMrxQw3dg2EAVOFqSOULCUFWgze/nyqk3ql+2jy9pRDamJpvVK2W57iIkhHbOUjWelOgw8lxXJMQ9Y33tWldAImp0Sk4vAUm446oUXsEx1Pb1fsZIfoaHSmeh538AQSJVf0ZqoeICsBhZp0hrstxIieRWp50/YX5MNtBLCE1nh+dcPEqT6XE3VnIMcr5AflqN2DW+8X7TO+KdCujO4LgHQQrFg9MY/FwuQahZa/vILEPSbwPnyBR7jPkJtss0l1m7UuuxXLqoFhnBN136DKbwjfpUtvCPeagzPRaWK9Uh8AExwCAaCfAtWfpW1HLD2u9rLO+KHGcw74nWLeWwv/37W8o5YYC5XxvLCV1Zd+UD8yhX/zRb0V7djYsT/leB9N0NyR3yrJdlcV7+PLbkjvj0B6uvYnjfQfwec/yY7s75Tv93Q/MosZ8zlv3KKP8QcDRvohxmkO+L7WaRfQb8y9H+HjfVNJupXAJq3kSfA/ZxYigsHP/38pVgYoifNN7IKaS8fWNPf2c+nI36Eo88rKK0az6fMMqt3YHPy09Gnc7XCM04BH4/ahS9f/j/Vm+aF +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures +required for browser-based flows. + +If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID +set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to +`urls.default_redirect_url` unless the query parameter `?refresh=true` was set. + +If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the +`error.id` of the JSON response body can be one of: + +`session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested +but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. +`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! + +The optional query parameter login_challenge is set when using Kratos with Hydra in an OAuth2 flow. See the oauth2_provider.url +configuration option. + +This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. + +More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and +[User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-browser-logout-flow.ParamsDetails.json b/docs/reference/openapi/create-browser-logout-flow.ParamsDetails.json new file mode 100644 index 0000000000..d62f9368d4 --- /dev/null +++ b/docs/reference/openapi/create-browser-logout-flow.ParamsDetails.json @@ -0,0 +1,16 @@ +{ + "parameters": [ + { + "description": "HTTP Cookies\n\nIf you call this endpoint from a backend, please include the\noriginal Cookie header in the request.", + "in": "header", + "name": "cookie", + "schema": { "type": "string" } + }, + { + "description": "Return to URL\n\nThe URL to which the browser should be redirected to after the logout\nhas been performed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-browser-logout-flow.RequestSchema.json b/docs/reference/openapi/create-browser-logout-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-browser-logout-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-browser-logout-flow.StatusCodes.json b/docs/reference/openapi/create-browser-logout-flow.StatusCodes.json new file mode 100644 index 0000000000..fce1e2ab4d --- /dev/null +++ b/docs/reference/openapi/create-browser-logout-flow.StatusCodes.json @@ -0,0 +1,186 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Logout Flow", + "properties": { + "logout_token": { + "description": "LogoutToken can be used to perform logout using AJAX.", + "type": "string" + }, + "logout_url": { + "description": "LogoutURL can be opened in a browser to sign the user out.\n\nformat: uri", + "type": "string" + } + }, + "required": ["logout_url", "logout_token"], + "type": "object", + "title": "logoutFlow" + } + } + }, + "description": "logoutFlow" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "500": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-browser-logout-flow.api.mdx b/docs/reference/openapi/create-browser-logout-flow.api.mdx new file mode 100644 index 0000000000..baaa8fc8e6 --- /dev/null +++ b/docs/reference/openapi/create-browser-logout-flow.api.mdx @@ -0,0 +1,44 @@ +--- +id: create-browser-logout-flow +title: "Create a Logout URL for Browsers" +description: "This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user." +sidebar_label: "Create a Logout URL for Browsers" +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/it7zHQizUhkkqb3QRnf1Gc7rdrU8dnO9DpRxobIlYSYBBgAtKw6+u83C4Bvekmcxk3aG+mDLYEA9tlXALvgbZCgjhXPDZciGATnM64BRZJLLgxwwQ1nKf8dNTAYKznXqPpjpjGBQqOCVE5lYWCSyjkwkQCDV6cvYD7j8QxiJmCM1C8BI6krUF8zs20qHImRWCGn4fjlOQyPz4+OD48OYSIV7J8MIU45CqMtBSnSBcylutIjMedmVqLS0DmYKZlhD55zhRN504MwDLshPF+ZZSELwjYSMUtTC+cy0phO+hrVNY8xckxFLOeXlp2EK4wNkSV6NOClWsAZas2lgHN5hcIzg7Y/1w7lNUt5YpmgMXGhFAqaRvOpwAS4cHKA4QSEdPLkun7aA9OSjkJTKKFHgsHTR48BlZJOiL/OUAAxw8V0ZcxEyYw0x+IrFEkP8hSZRkChC4WklVzJHFW6IJhzphIL9cfz8xOIpbziqMOgF1AXRgYyTIJBECtkBv/txP7Cyup5KudBL8iZYhkaVDoYvL5dsSw76YGblFAPJ14TVgl3AM1FnBYJEsKRkIpPuWCpnxFmyBKSn7AMKHxXoDaEnRNt9zToBYJlSCzYQUEv0PEMMxYMbgOzyOmJNoqLabBc9lbxn1rxk8xenb5oqttIb/BE2Vsj6Jks0oTsX6GzH+cFbGLQ2YOzspGYMQ1jRAE5qolUGSYV7HcFqkWN2hnAhZEfBP6mFyjUuRQaNT1/8ugR/YulMCgMfWV5nvLYKjR6q4m528Z8ba6dfqFUsLUWw93MjoMLQw6wbaT1jtVQ4Dkto0ehyXD3f9r/L3G+wk+vJFOodBsR0oInIXP0vlXFK6JITlVFHgpD1nEIBDMDKBRfJ7wkOb4ruMIkGLxuoui1OX9TDZXjtxgbmoqblBrS2juWNGEbfPNpL3j6WXoiY9SGiYR8mMLTT2cvj23Ys3ECHKvhmg7t0/Xpjuyg0o7WRiU4Lqbrow6pGYgDxoUG2wu4FzOXIgQb77mGQhcsTRcgpAF2zXjKxina+E7uYCSpEgU1Wm/AG5blVqLEZ8IMozUIWMJycqc501DY3jR0woULY5hiRqLcYFNb2D5mGRI8O9qKgFxvHYGPL5iQiGShYoTY+jvxM0aYyEIkW+letIiuC7H6VYtyUigzs/GtEiZIZ9GCGYrlclKjbgN+aa3SLV7DQ3j85Nun30EiUVu0eMP1RhHxZB3b8JCkw6AQ/F1Rimh4GI7EBC2MCyHNRa3QI6WeuwfH0uyXzSPxrpCGXeBNjJhgQt3+Qy1HvoHgiyIjt9s4b9AL2jM0fNAz0Atu+lPZp2n6xEMw2DzVH4a47AUZas2muC6mX9yDWn21PfkxGwOdNswU+iKWyYY5D2RCdpcr1HYXU0/phgENg87TR0978PTRt/Tnsd8BNa2BngfOhoJBwIX559MaChcGp6hs7NsW0qYoUPHYBogDH6tWY6Xzrjf1oCoYubhyWseVNpkNQdLO9YMj6sLk412Y3IXJXZjchcldmNweJr/b7SZ3YXIXJndhchcmt4dJAsam2lqGstSt7m/6Ui36ihlMecZNf1zEV0gMXilmpO7nxTjlcT/DhBeZtQ2S1pmVict8pUxMybkXOZ5Z6pQzYGNMg0HwvVSLyOUiKY9j/Z2kleVSGbgdCQCA5x7Ofs57ruVAigmfFi4PNxJLlyV72Jjt4TPKacRSaEO2UveGPRA4b8/Q6T4r+7KcDwVF+xh9zwb1TmumriWRovHZwQE4e3sGUdTM7wF8TnYP7pbcg460amVpFzoJTliRGorYhUhwwgUmXQfVpc3OZRNsK5kHcC+pPNiQybsLxlIPt973enZJgiXsAZsz3lJQuCX52nFG4rTiLabkeyS6zwLKZ3qr/EE2rFEww6+xaYg5i68o3GSMCwLnDbMzEiMzchuKGzMK3M9JVn2V2n2jDBzLubNJGAVTbmbFOIxlFtW22p9K6m25nxQittQ6XTL/kXFcwGAPRj5Te+EjziiAKPJqhPfwNU2OgJYSdlDLX1vAfgWTI+mSOJuxYLAHLQ2FxzhfiQw0iOX8wGlw04D9k6F7uhIenFB03gPVo/WEBlczhVVYORmGB1vs2NtX+G8WX00VbXw63W7olNJxxtANT72kO6XIu+HRDcaFQQeeTyzxf+yB4KmzqZGZZCZ8nisuzKQjdXhmElSqByO/O503iyiXd4B6eTmAb65HIzEKLK/dj5B5XqSps9hyI9wY70Yv6U8UVR2c4V5uAzCA+geNXCctC0OkT9vz3YW5JjbUeXckls0YcrIwMykacYRWzK2LmlSLC/dwJCyEuiHMZIKpDn1G3RYS/agmc6ujFGpT9tvPOe2jcrcw2p65lULZwf0iZ3gAhxR2XZ0MYSa1LTqWDmOPDD5K23PDzJhcD6IoT9nCWWOYK0mbCx1KtWA51xTYaOIzxPaqG+a2qAYMUq4N7agpMOkiJ0yYrCzRdekstOtBa/VuMN52VRfoLRsUge4Kt4y8hPtIUEhh4B3PbeyZAF5uCfxRoK6g+rprA9R+6eIr4QCYJvf33QYO7QNwNredCNPadaWxvN6aNCg2dyg1hW5zFYQ9eNhePR7CAwrHX33hqBfnCyMJZvVjHelXWjUIolELr7K22rxjWhxk4D546LovaaSKYXstNfoNzIXHfNHwex/e9/wmphbRXvWtW9OwPt0Z+QO0pyUnzb1r/1/biQ1scGvO5yZsQvdP0QYXqGIMWTUO1pHUHVpryV0BwTfaYoJvALvB0p5DdHLVT2RssySNwwRlbvjUHdW3F+Q73bIk7w4lq7Xv1SPu9nL9F3GRoHnqm7BUI603rdL3ufwo7C/lLxvQ2sK7hekQvmiVd6dyVW1bt0DmprGf2enwr6PD3O16Nrrfxoh2Z+39LVTnbp58APRfUnGd+muYJV2b9cEbg4Jubzm9XOEiGGxL+/SCa5YWuC39Q1Iqx1fhuhqzC9t/c5ffhe2/vw53Yfv/ImxT5wzNTCa2cGCskswsGAQbr+96xJSOQHVd3km1twirg/KtPx5f6LSYLjceliMbzBWnOo7dhzeHuMKKzRdQ5rQ6dq+J+DdZKFtIPUZDl5fhxM0CNEsIv7krya7YyE2p5NfNEQdSaJnim04JPnYNBDbUs6gEH/mLxtEUTV8bRsmGbujlpzEuFDeLMyr8On7GTPO4KgaTElxLZTJEj9xojEyhavd0TWtdJSvM7Al1JX+yZKhFKv67zQwc+KJUq/FVSzWzRaJYmGAmSwbdpBH9tRdgZe4YkJNJygWR3wfbCqWVuYOYdxU6iymcKNQzsBc3NXRYypm2h9hLP8sFi2PU+pJCQLvp0+d3N6cFlT6DU9eJkh4vcxTDQ9KnIAsYHror5CQ3O+6OcnCXT5vFNSd0Er9a7FvM55uv5p7b2+YrIYkilUBMCGLL8Cgpc4WL2vDm87nFQt5B2x2yRDr66ihHpSmH0Hci61uMtmT4cZNRi1/pVn/OYtzP+c+0pfpE3O61AJqgn+I1pl+eDSp0i4ksb16w2G76MGOcVOpzf987Pdb3ugnZmXsWrFUsH8BQGCWTInb5zUMZF3QPweUGbYIxTcHtSd0rGEnGBddG2cqODTr7J0Mdwn77ATXaoGPfVRgjOGYx8fk95t9fOPHCAGdS/n0HOHEU7SxMIWRS07sN9oo3F9VbGfae9YMHcHb4s/aveySeA3CMjlGXuT/duL3hQ2BDg6FdmSqCjYse2k5fvWkxkWkq5+SPlK0u2BT1gGC8hxf+t8/cvIdDORepZAlNAH/kQ1M0FXJPn/eEtt/6wGrDp3/uYYrN0xLaQ6ZMSzCv82IcJnhde5xviHyJUUd1Rre7UbavT4/2D385qmdYKSbq5Coap3IcZUwbVL64qP3/KGHKRG4K2kM0ZRseH523SYliiiaUatqOEFVzjfqlWoQu3x117xOtNALX8Fq0Rym/4apJaoY3YZ7VpNzvu0r2HtCihbQR7Q9ylVQ99VZyVV34T7GEqVy3A4/2J3bN2qQydo2ibQkamYpnYfUkYsrwCYtNpGe0iER1/av7+Wjfsmu2xW4JrUsnVHabZ291W7TWbsvm0iaixlWR7n3KllZAt2I1Ma+i7fxKi8oETTzr/lHYfT/8TwHvJm+xAMTDyY8nK6bokHG9Ei1azS1PXJH6Z4POZ/kGc7YSd4XZFtpFzleA+pbyyNAw3mjd+z4frYW0MVKcFuNFm5QqxospZrqNuNka0ZeWv90rWiK1xfdOC72ywsWULdQhl41TWdnkv21Fek9o9eYVjkrzPEa6Fjeo8gH7OYtnCE/CR0Fv5SRMvsfsYytjP1ZHL4YHR8dnR/0n4aNwZrLUnlJQZfrl5Mydt+n8baRuXOort5x0ckal/ctuJAy7v82lNhkTDVwfqyyuHqcb95p3LyzvXlhef2HZH8roQgNdhuD2cO1fIHU5o9dBU4LVK51BLyjzRm96AV2soK63t2RBr1S6XFKzey3XvuHMtb1V7tNZHzDTL/v28Eb+XZWimRMsCxu22lwmuYLB6zfLXvnK9Kdx+ZXe8f4Au1XStua1KtjQgTZvFnjWXpFopRx/ODoPlsv/AU2mj+c= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. + +This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call +the `/self-service/logout/api` URL directly with the Ory Session Token. + +The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error. + +When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-browser-recovery-flow.ParamsDetails.json b/docs/reference/openapi/create-browser-recovery-flow.ParamsDetails.json new file mode 100644 index 0000000000..0e6a904a1c --- /dev/null +++ b/docs/reference/openapi/create-browser-recovery-flow.ParamsDetails.json @@ -0,0 +1,16 @@ +{ + "parameters": [ + { + "description": "The URL to return the browser to after the flow was completed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + }, + { + "description": "Skip redirection to the settings UI after the recovery flow was\ncompleted. Instead, the user will be redirected to the URL specified in\n`return_to` query parameter or the default return URL if `return_to` is\nnot set.", + "in": "query", + "name": "skip_settings", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-browser-recovery-flow.RequestSchema.json b/docs/reference/openapi/create-browser-recovery-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-browser-recovery-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-browser-recovery-flow.StatusCodes.json b/docs/reference/openapi/create-browser-recovery-flow.StatusCodes.json new file mode 100644 index 0000000000..7ddd706ad5 --- /dev/null +++ b/docs/reference/openapi/create-browser-recovery-flow.StatusCodes.json @@ -0,0 +1,1351 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This request is used when an identity wants to recover their account.\n\nWe recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)", + "properties": { + "active": { + "description": "Active, if set, contains the recovery method that is being used. It is initially\nnot set.", + "type": "string" + }, + "continue_with": { + "description": "Contains possible actions that could follow this flow", + "items": { + "discriminator": { + "mapping": { + "redirect_browser_to": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + }, + "set_ory_session_token": { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + "show_recovery_ui": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + "show_settings_ui": { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + "show_verification_ui": { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + } + }, + "propertyName": "action" + }, + "oneOf": [ + { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + }, + { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + } + ], + "type": "object", + "title": "continueWith" + }, + "type": "array" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting,\na new request has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the request's unique ID. When performing the recovery flow, this\nrepresents the id in the recovery ui's query parameter: http://?request=", + "format": "uuid", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the request occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. recover account via email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the recovery challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the recovery flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "title": "A Recovery Flow", + "type": "object" + } + } + }, + "description": "recoveryFlow" + }, + "303": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-browser-recovery-flow.api.mdx b/docs/reference/openapi/create-browser-recovery-flow.api.mdx new file mode 100644 index 0000000000..dd5b6cf54d --- /dev/null +++ b/docs/reference/openapi/create-browser-recovery-flow.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-browser-recovery-flow +title: "Create Recovery Flow for Browsers" +description: + "This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to" +sidebar_label: "Create Recovery Flow for Browsers" +hide_title: true +hide_table_of_contents: true +api: eJztXW1zGzeS/ivYSW1ZrCKH3sR3H5g4e4okJ0xsSSfJ590yXSQ4A5KIZoAJgBHFdfTfr7oBzBuHMh3JWW8y/mCbGLw0Gt2NRuMB8D6ImY4UzwyXIhgFVyuuCRNxJrkwhAtuOE34v5gmlMyVXGumBnOqWUxoFMlcGKJYJG+Y2pBFItchORMRq5SL+8SsmC9K1jxJyJwRxWKuWGRYTIyciJlmyUIzdcMjFkI9OvTVhjmf5iqZkTU3K6wLvpPxMdHMEKox6ZccCMiooikzTJHZ3yHT81lIxgtCyQ1NeExyIEAzrbkUE8FuuTa6Th3XRDGTK4Fk4adIigVf5orF7hN5ffEynIiJGC+IqTNLk4gmCYvJDaeECnL44+E/iGK/5Ewb25BiOpNCY7WGcqFdaoWD2E+ZG0LFpmCTngipCCXPnj4lcxr7SglTSirCF1hN7rpAE8VovCE0NysmDI+oYTGSfNWk9/TsioxPr05Oj0+OyUIqEiWcCQNkUUNiSYQ0ZEVvWDn65OBopWTK+uQFV2whb/skDMMejEQk5TUHSVGMCMZi1+orqUAiFlKlFKSMRFSADCxkLmJCDXl7pjbkJ0WN1OTQSdWF58mxjPKUCYNF3x2E4RBkZeCEZYjCMnSyOPCc7IVBP5AZU1hqHAejIFKMGvad7YSv/UUi10E/KARHB6O377c0gsGYg0A4CaiKjJGELkDkCslcIyfSLGHA9qAfcKgFJTToB4KmLBgFtqapkUE/0NGKpTQYvQ/MJoOP2igulsHdXb9Jy+U1zwqhAFY6KdXMGC6WmrweV8hpyBXVE1ESRsZCG0adfuY7lRM/Q/91xiK+4CwmXEzErOjBbEv7pG0+ZguaJ6aiNyCp1YJcTwRImGZmF6P0Nc+mvnv3MutdP/DqpeH7l0+fwj+gaUwY+C/NsgS0gUsx/FkDQ99X6muxg17NuAYGxWS9YgIUm8egV2ZD1hSVRXpWQ7+58qYRpf+NHYc0ZQL0lsZcLJE9b3+bqGdU67VU8UAxzcxgS/JBnBWIvuGWDzQy/IZt9/AQ0/swJpqZ/g6TlDKzkrG1B1yTOQPygRkhGWOKM/XJpjaUjcHp4zBwkbMpmLdtYo5845nUms8TRigKuLNEkcyTmCxkAoKMVndhNZcblmIvYw7VpVxQIxUkpDTLoO3R+8DL89QpLajdFgVjEaOlxCmBGiv2Y6s6tvm5NdvQi5jMN0Sv5Bq4QUtu5byV/VbUttkvhdU5mqzpBpgL2rFF62wiWlLJkaPlDTcrW9mFy+WM3JW8tOzvB0zkaTB628qJd83R6ge3g6UcQJkB0Izm6iHt3/X3G4KapbX5G7Z2W7Kw7l9yrlgMHXTcbm+w7Kmc/8wiA7Vxk0BCVOnMVjegA5qZqVSbqfMfpkZes5ZRLaTIChH1/gbOClzrHBwiKmLsV8UegTCBjOWaWfnG+nFKrk3j3iTph8pZa39mE9Ga3jLWl8ycqc2lzXUFmbaErZ1l+4jbg4m46wd7DBaWABsGg2HbkAs3n2LB/cXtvn7eK2zbXUBpW8n11FuVac4/W3PVJBQkqJHUNm4rufaz3uvxtuA0e7+XzPzGZu/6Ac4lo/cNTvC43UKNj72U1PyroB9YDzcYBXnO47ZJMFfJbqvXVml1nXFDk5yBtOJsXTOQ4L090VWfFEvASoVc1cqaTcZhkbIhOag6GhhBwREoXP8hOTy3gqRbZvKGAvB4f6vqGM/R6d6pScjLj66zUBrvKj660hQu9iMpTYVQrzSVpB3Se+ly7FKaau/3Vprf0OwDlKbg42MqTa3SP5DSFIx/RKUp6yyU5oYpvnCeyKMrTrXyx1KeBsFegRrJO6T5/yq5dilSkyN7K9MDSHiAUtV4/JiKtVXx56dc/cASSecJm9I4Vkzr9n65j1aEncM9933EuEZtbflBJW5teU8trEnAI2p3vV6s0wnT5tRGVFy14CILdrZoiXh12t5pe6ft/4navhUw7uIRXTzi4fGIbh3VraM+B+P/+a6juvBcF577j9aQTx6e+0w1pNtv+xz32/YsCT11+ahSdAO/2W3GFdNTarY7fGK/HZrCyeIpIwevr456dm/farjD1tjMCCEqIBLagPysuV4x3PfPs5gaVp07+xNBiWDrop4VxZxzj4pyqJDCGkEFAyCkzSS1WbnxMVEsg+1/i9QpSH6iSS74LzkYwZC8gQ5lTEFDHnNQs159NEMg7LXKuFsasaqaPdFNlMeIrIzJRsPhNx/Ebn37d0fg8294/O0+ltiuTFrHcIyf9htCGUW5Uh/Db1dy2joVXNiPCGRxvLLgB6tFYMVgWeXqYDFZKJmSEtyEkAkHfgIIxUQYCSZ+TVVcB0hZNAQrRuL1xcsnmmTUrABcY0cC5gZ2SwHP07pOLiFGLR2BT1eyifnwdBdFcY5qq1wbalowJZeQ3JROzGvnzxJTM4K5M1pJqdnUYkxGhOrrUtOMJPYzoR6EcsDCZVhAbTz+EMB2LKU86cFqUZgp/hhhTfhf1MA5Y4LAZw9pgkYmAtA0LJ5GKwDuiSUb1eQHRlPnUcS0XuRJsU4u9KIohjltXSEaJUWFhvl6mtFNImmbr+KznNscBcjISKyJxNRQK0HbWC4jyUrKa40k2U4almYJzKdB03YWRrLN/tvqNhlDwWTcrJjCiZFmfAbCNnMGfRZWjPAVFHA6UNTQKihtuwkO7MNUVVIo+eHq1UvyQqoUvKICIskUUraW6tpCQOfSrMgPV1fnmBc58OPl2elvjkSUoSFkv0OULrBumwO0e/ZNJeX5JHj/noSugru7SeBE9PkkyKQ2k+DbWSs3UqY1XToH1kOX6tQiXu22xfABT1z5J5q4bCF5rRnIJtq+KNdGpvxfYO59U2GbPNhppTCJXJj/flbm48KwJVOV8R4foxR9iC5iSXqjuDEQyRCEpkxxlCyxTLhetXJlt3QW9YJ4TQTYSDIWCzkRFvl6An9PhNNRcmn/rThgUAJ+Qj5AD7oM+/hg+zbWGipEVrlG7nFmcn4FGZtuTDODtrIDErbNp1fWOPKK3Nbs5fnZ5VWvje1Cxg1JrFd8Ct8RzFuoqdUPVFSWsBQVV3rUo1uovB4T4MYNTeBzCFrq5ynrG8mY+VmQCjL7hqfLb2fE0GUf6rJJIsuNb+LbGZkDHjrRksy0TBnJEgoTI7s1qGYNdTdG8Xlu2AdxgXRb+1aKLdpFMeHi+okmkIEcxEwbqJJL0SsA4VadRiRXfF9X7tA7bBZRuuBW69pGatquJTBIaI1rky7XyOYnuKJk2mM1KUk5irJckBlkCOHzDGzoRHBNMsVTqjgsP91MRBO7HkszavicJwh6BSt8ljEBC9GvwqchIWMXS9dG5ZEh3BDDopVwa1m33OKaTAI6CcIJmi4Ckg06DUM9hr8ngqdLMk7pkoGgHIJ/AAqH3SWX+M9ExPyGHPMb7gKiXtPpXkr9aA3fFTraGfDOgDerQDPic/VtjaUSvyvLW1E7LExW03cujRnoLAX0ORRA7W4VjJjfbI+El1qimUNVg1VHHYdVBIiLsjBxsubxkvkDIK5LhKK36Rcjx2evyJDccLbeNr5RQtv24w4JfgBMf3M/TjERM4VLHeeZH5+9apUycIjRbMcxh3ppcl5re7tAnQngT1sjSDPg5jXbDGzkLaNc+R0yxZwj7xcKsWOeO0HDNiSlm8JdBP7NgLJBGIazynjdo7b/jjngU08B+88AlvJPNQ2A/P++E0Gb9WjVdV+kTdsJLeTMK2m7AKXLFqeF8eWqxbD/gOk+cs2hV9VAyI5Jo3NVnKDydPmppBSG8fd2V7SK2udoFIwnmmiZq4jt686uedx2kOcNJH+0yDV0CEh1s6Ztpu9lfIdqIS8+YhZFwnZPosjrNhRklpuPaQWHDFrZXqTkRvqzeDvgK5UcZdU439jIY5bDATMb/KlTdlgpegLfQYbvy3TFkonI1X1ZXqtkIjCaKszAn0G7J/+RzXruck6EYOt9yp2ydVlGChupHUSwZtxd6EywK56yIxmziYDAHjoaazYHrIq4r1cu7xuXtaKiyFh0BOFviAf3g2b/QRwr3QoQUldSDOWaxOyl9t2gPuqgolusAbfVMq9dMr/vARU+0cRnJQvOEusFqpxBaGJBE101GHMpE0ax/oTOWdKtBbu1II5ISm9hW6BtfnxFb1/iJ1xFuBh3Tf5SesvTPCW2hnA/j82elm6d3V21LphGIGfrwP2RPDf0kj6V74bOwe/tvUkRJTy63h6bM3EEH2ri9DO9oa6+9YpHq8pym92yKIc4LmwzQkEHQakODJpbu7R9w+aHYEPRIzyG0UfY54i81mCXfONOZbTfWYOxZzc0Oeg5AlAuNItyBYOruL5GY+cruFJ8uYTbK+ydBK3y6Tjgsu5khK+qyg9a9IMY9/nDfHHL/aJESjPcyKfkR3pD7TiRRS7sJlCm5A2PLVDlTG36rgFXWBfH2XUerSCGDvPhTwxu+Fhybew9FTDHJHLJgdtSbTzNF9UsPtF1U7dlqpV+CRXuLIZfMT8QdM027dmrH7dyV+feseDm3tLNzNXa7u1oS55qWY/G26eOtrwVBd/BeouqrTHOJlW7t53S7HAtx3b995G4j83p5OZ3lhu0TO1b/GfiJWzs/wbLDPU90DBj0w+wy1B+P7OclDl38eARjDKypLPJfyrd6mxyJze/1SajAdp1NAwWHHBPG+z+6HpMrUQR5rAxlWzAnCLAyF4VNRExW3AByAhBZjDMM4+1tEujfgHVdobM7nBZdAaGFKgmFLBqCYvMMFYyi+VaEEURe2VWsMtHFoqxAYI5cBVhw322HTrHZibCt+MhsRbIi43RCkbCFu4T7XDnlghAfs5pdI3gQ7/2SphdeL0e16+AS2D7D26Asvd0teNFLqpgLpiFEgDFQichnuJA7gsL8fCsBnxfC3PjKnNhxAqEvFvmUaIjmlBlCyN+7cAqYJ+IPJ0z1ccr81yIpkc0U+5CQjgBOKeGpyW4zja+YxjxyERjHDMKcTDXC2rn0Npobu+MYg/axdF2zuJH3RVsOp+nEHeJvThyTaxIo0PAo2u8XM+uuO/tW4W7jqOECQOzoZawhgY5aGWqparJVVJhargVLrGdvDdGArGERiD9LPNa2wRzZ9QYptqOylUiGy7TDhCsJ247EKOuLV/tKBaq6Yu0B/p2h7eagRYX5kINrHcYQik2LLAjdgoZKkFW5HxLllP8ADBaFl3P5W1LliP3aSJWPI5ZM2wKWX7AD+07CfB9Z7DZdiOBIBoIa8vXS/wwEfPcGNnW9nf4YSIAk40x4URGtK2dY2owGvwSvtv8O3K1xbzh2+uLccWfcCG9aiAfmQlBfscy2HRC1kCx2maA7W/QD2y/AoQmVOh3CW7bYO9IUSckn4WQwBHz3bbaazlmCVFukgTmt2AE2wRNg4hxWScAlV2I5jbmx1hL3MtFqrb3G6jeiB27vG7ViTmIo2fbvEVKai0VB7f5vmowH7EZSSYTHm0eGfOIwW1Yld5HxxNNinwA81/9Jwa2PxfojBOq3zuyLaSIWocGLpIGd/Ho8hzW/YcEc5KNzDGOAHev4hEsjY4vT2G5j58VnpWDOfjSRzbOUUTDifinzGv3GvsKymOYgDXmC2zGN1GvG8hBkYe7jj01UAk3IYH6YYsM0cruAItrA0uDp2/7ga39pd1pWTClmHJ6dZ8e+qz36OBO3IerwsI+Pm4rzxV9NX510rAlO84JWkSHNU9bHaybnarqF5bToaoEEtoKAbHi1YqtctQi3t3FgPDETRmMa91X9TukHz53/OfDRgFvPpUdQr7/7mDu1sHu9u//hPv3jSpc6d24Tii1NyrMRmR2IM+2L+sqG7z3vq4Ol/YHhzB1uLQ/4KB2uLRuXutwaR0urcOldbi0DpfW7WV3GIhObjpcWodL62zyZ65bnU3u5KbDpXW4tA6X1uHSOlxaBznqcGmdkHS4NLjju8NKdFiJbk/pz7On9O/DSmwZm+4WrO4WrO4WrMe7Bau7Gre7Gre7GrdzEf4oV+N2Z2W6szLdWZnurEx3Vubxz8p0F453F453F47/8S4cr7pjrY4YJQnXGFypuGP23ZkZeHrPJ8FCykkwQ7mFhaLu4QtZSyXzbFuyvodkojMWgVx6C4SZXbXFrkPlHWqpeqX8kTlLJLxha2SI+7Y0Tww5tv9i/ZWtC79R4dIljyMUs/HxkRSCRUUBJRc8YeTc/utSoT/kJRfX7jeeHICDAe63kSYjV2dX5z6/lNd5NtUsUsyQl/jLfSrOD3g8QYXSa7YhDlbgUkvNnS640oaMi4QX8NvTQzMTrSg5sv+6VE3ThFwevnrpfscMnu6zrR/j/0sCqoJuOVjfnQKGWZsMbAn6AbAEJil7zAQYAInVfkM4ozzW4vqH01a9T1CLpRsWNzTF7auSVGgc/vPlNJL47tteWtiJw8PEoXvDrFvnP+wNM9rGJa5JilF6LqIkj8EBxJNL+LqfRPxR9X1MdJxgRCz0BGb8ifAOUgk2ej3W2w5jdyKqE9lKaKpwb8ip9V1fMUOxfSdsrTcD7ORcxQH+dPu9/oEK+xxMP8AJ0gYk+v9+f9StQpfOfag8x1eZO5wpqPiXwP66ZwkPiz6xPt09j5q2mBt8uHD3U9XuIUX/AOK9clI8VbpD3mxfK29OV98urj8njG+h+pdzq4418e+kkxf2ofpGT++2Vpb+MVj7VHs/+OrpV9vieJJmAJ1nOgP/yK7A0fMHm9WvPh8Mz9XbyIbNFTNAzsYW4YgvrQLROVi/2IaZWKNuAOuVb9d/+fRv6OM/e/q0MK0CTRjNsgQcdi7F8GdtH2W1GMAdsRNDRQxAUHhEGdF/sP6zdsFq6LaBt0Znmx1YyJO8VSpm83y5XeoYkstnkjFXdSoqD0PkOsfOQ7SM3lCO4Bucv8oHwJlAmE2IIoOsd/2E9fycwlvHMc0MnDig8JY3VgFvRHP38rDD8LVZ8x3dhnsE/Nuglm/+oGWdgurjz24LNMKICfRnDqOei9anurHSaa3RbSYWv0pWLnK1Na9LG+8R1OSK+e1TbKBO8Blqhg0KjI/J37786tl/kVgyjdSyW65bWbTjMXUMUriQiGXR+DiciAVDMqZCmmk5oCdKvbAfTqU59MkT8UsuDZ2y24gxONlxotT/QsqJS6iY8NZ6g35Qr2EvG/64JJa+fQsq1XkEtQfDLbNcmZ3PhOd6iqvBlmeg4623wm2VVXNz8Ozpsz559vQr+OtvfRKGYa8mDfB9r731XVZ+yQR4S2ggXDB8y9pb7apY7cIYWbtyUdqVD1pvrOt726iNGtqFdWcqO1PZmcrOVHamcoepBMLoUqNkKGwdx/52INVmoKhhCU+5Gczz6JpBB68VNVIPsnye8GiQspjnKcoGcOsSeaLxOqWEwoPgAaK+/TrKxQmC/5FqM7RHbsB7txuAo4CnmVSGvJ8IQgh54cg5zHjfphxJseDL3B8iu7MHX55UanvyNezvQPDSgKyUuclzIti6XsNB72ufl2Z8LMDaR8zlrLR+UKuph00kDDbWTK7ElRwRK3Ffk+EQbNnri5c2YAKfUazmSq41HCeShC6MPx8GOzJgaP2xujgkBz740gPQlw2rwu6tPyrVsy3ra575w3DV1i+veUYUi7myuw9+90u7vPCOfEmAX/G0UjK2x4D7/jSxKo4r+frLzTXosN9egC1AMrN9nxo5I7/k0ERGFU0ZtOzO3/neOS5BFXxRK8itOdXM7MUXP5Tvnfr2cVYjd+Q5oWvKa2McRopRw76zw3JRWfkdWEnzQ+sEr8rvieh9jbuzTsC/lxXBBozeDavKdEaja7BcKYUTmBAKQBk/mIiJmfgI2SSwPxdp8V+p7f9kxgTNuBVvMgmW3KzyeRjJdFiK/WApITdyAU5EY2sHPdCkifF9IaPnZBL4X1NnwCYBGQ6dCJFfyaPJL7RcZZttvZqyg4I/gQzDME1M3T6NnpPaUIenbN2wVlCIZvzIikJbgcPzsf3aMFlWDHTWJ6oPcxwULmoKC1N3Pg6PdiqGj9J+R6NriEOJ+KDXCy+cOB14ueqFl5UxPqgOeC88sWf8bVf4Akn5y3MieGJFdWIWqQlfZIoLsziQOrw0MVOqTybOf7ahYZokICuzvQifzUbkrzeTiZgE2PfeBxp6kSeJDdB4Z71S3pa+g7+GwyKDnYdmu0kYkepPKL3dvIRju5Pgol7nfl2sUsh01puIu6qJOt+YFUbpvJmCuX3n9CvVZmo/TgQSUSaEqYxZokOvdVPUOleu3sVmScW08TkPMw5eX2anccyZIS98BvsL1OQL2FXkAoYbNG4lNQIgvCrhAsepIa5yVsZkejQcZgndWCkNMyXBFdKhVBuacQ22Eyq+ZKzuI4TZxh5ZLvffk4ToPAOaWNxwKAproEOcemq+RqXjdSW28wl2A+zhvuR64w50nwDQh1C/bWKXIXjM2jkwbuEC3qEfR8xTIerQK3/DUOD55oy7bCNL7RfESt7uRqjWNiuU5aUjVWmx6k+VLfSq0+3USPKcPCl++AniCfkCpofHnZ38tD4t5pXn5EktYbv5P8nUBKwxauNGvyYBtag6KoszR7rMDKNbWMbnNZFwftfUjdi0ZkcOCuKeF//r18foee1Xr2wT7cXBxIUSXNtyUfXiB9/e1/gIzWe1RltltTPuK0PTRQoLBjrDRtu0lBlqs9b+JJG/aqSK/JWwHuKGbgc6vh7EMsKYUWVpBXEsvrSBi2AU7HZvewgPUTS1izR7lWDhFG6toZtrx4cpYFBd1OIFmzBJORqqnsIH6fijamILh971/fBYjlw09qmWsjn69/hw5rbihHWi8AcThcz6ea3GYIfNvU8IpqYuBb+3CBSG/n4qOgGwyl39EaZxD2N77NYwoe3tSG/fB4AKHO0K7hV3IbQH+WB0fPliGqrcn9BNR392Eeymo04UuumoE4Bd0xEUcEAx2PaysHc46h8MNUsWA80UQKOHnilDN3YQpGLqhikrFQD8GhWhk/cuYDLVSb68aw2fDHGaUhz2IT2yuihiNwYdWiAoAzFbA/tPOD4HQIBTZtZSXQNQHfeBoZby4B1ulsNda1b83lZLHEmhZcLeHXjiI5sAxIZ6NfTED907DcMlMwNtKISf8AY24KC/wfUSgAu2P3OqeVSAGfBILaYUggrtgUrOGVX25tYyp03aymoPAiC2NpFr/5DJSir+L4wVHblN1Vri69rQrDaxomHMUuk7aCsdwt+Ir5SZ7YBcLBIuLHIPU4ub2ezi2cEDYP2s2EIxvSJGXjOhyQFNOLXXOs5cLVOKaNYZGJN60sfXD1VkTMDWfXBhM0EYzJ5fIO4AA4AAriA7IijhP3vywdhClc1hy/Q7vIr0EGm2FW/DUyrnRpmIMwnhUzgMKpi9UbEmeBCmu2abUvDW6zXSAtoBjhxIIoQr9DBjSkMoaGBZNkAaccv7wyKjNm+kutYZjdhhxn9ibWdH76ebrH0Fg4TdsOT37wYe/V5IjxyiEbqz9lK4UeCiwf9jxzHwjzEEQNml/bZ9aPELMhZGyTiPbMT7WEY54GhstBhDzklCrLeNEW0ap1y4K05vGBqdw/OxDslh/QMkWsy+SPA0o+0si13El8IhXx6Tc8cMYkXKCmtIzm2LWAtgVFOpjT8zyIWfOTWemfziC3J5/JOGw5Nck9j1gNiOzt2t07amAgniTGBlBC38tWiwAlTSWH1xPetCwoFF0EfYw8gB3zwCMn4lL91vF237lRzLNV5LDRWQ3/IHqqgOyCP9+RWoHdT+kGbCx/95hCraqwVqj6kyNca8zfJ5GLObUuNcwtDta+thGePvtfL27cXJ4fGrk7KGxg62jq+H80TOhynVhim3o63dv8OYKjO0VYAXUeVteHpyVW9K5EtmQqmWdQtRJJdUn6lNaHdAhr3HpFYawbboRWpPEn7LVbWpFbsNs7Rsyv7el7OPQC1Dklqp/V42myqr3tlcAUb4JJKwlNty4KiFC+HrTaX0hom6JGhGVbQKiy9Dqgxf0MgM9QomkWG5K9p7OLVwtn+H3Faur/dym6U/6zprUW59speJYQXq1HtM3uI9I0hSleYmtQdvYFJZMBOter+V7IEr/kmIt5XXukCgD+c/nDdE0VLGdcNa1JJrmtjg+oOJzlZZizgjx+12fY3aTcYbhLoUv2SoCO9wW/seTi2S1GopLvL5pt6UyuebJUt1neJq6hD+U9O3R6UWmtqhexe5bsxwEcRBdchlZVXmk9z/dlL6SNTq9hkOT35HDGCdoyIScZjRaMXIl+FTd+VwucwA3aP4GXnsyurhy/HRyenlyeDL8Gm4Mmlizz+qVJ8tLu2KG1bgRuoKKNW7nLByZkpbPzYBZqB/m0ltUioqdH1wg7i5nq4A8+1h1WI1wAU39o5zQEY7L3QA+PQYHFyZC1OPm4TkDPAGZTkXMvGhn9aoyUTMIOjgYg4hLnILYEuYczhfNrPgiiJiND6GUAg4q5DUjKrM/g6Zns9CMl4UrjeGbTTTGj1/xIbrOnVcuwBMGczxoAyEw/vYDLrh40Vj6cQ17izDdfCcwrrv8MfDf/j1bN/FmNyGeA093Yg8cbOScL+92BRs0nirPiXPnj4lc/fADKx/LUiaL8qwFN7VrxiNN9UbJJh/w6VB7+nZFRmfXp2cHp8co4j4tw2qrxDg5UjF6JODo5WSKeuTF1yxhby1QGyC8TJ5zd0hO4FIcmz1lVSsBu6HZZI/SADPG+DC8ifc6IBlEUpVIb21BcG7gzCsB6hQWIZOFgeek70KBh2QOUN8lgHUBfX0vQt2vQ2qdWFYzZaHS8ZdwOtdPwCMEGR+/x4k/7VK7u4gGYXOvldbPHOJ0bh71euBgdHWTtm9oGps1m8f2cuL9ibvgRFTQF89Ssh0Ih4pZjoRlaDpPbxrRpVL/r0rA5bB6O27O7illMYQuSs28WApn1U37bYON9XCrd+fXAV3d/8PLzOSbw== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to +`selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the +browser is returned to the configured return URL. + +If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request +error if the user is already authenticated. + +This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. + +More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-browser-registration-flow.ParamsDetails.json b/docs/reference/openapi/create-browser-registration-flow.ParamsDetails.json new file mode 100644 index 0000000000..1de2b67d9b --- /dev/null +++ b/docs/reference/openapi/create-browser-registration-flow.ParamsDetails.json @@ -0,0 +1,34 @@ +{ + "parameters": [ + { + "description": "The URL to return the browser to after the flow was completed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + }, + { + "description": "Ory OAuth 2.0 Login Challenge.\n\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.\n\nThe value for this parameter comes from `login_challenge` URL Query parameter sent to your\napplication (e.g. `/registration?login_challenge=abcde`).\n\nThis feature is compatible with Ory Hydra when not running on the Ory Network.", + "in": "query", + "name": "login_challenge", + "schema": { "type": "string" } + }, + { + "description": "The URL to return the browser to after the verification flow was completed.\n\nAfter the registration flow is completed, the user will be sent a verification email.\nUpon completing the verification flow, this URL will be used to override the default\n`selfservice.flows.verification.after.default_redirect_to` value.", + "in": "query", + "name": "after_verification_return_to", + "schema": { "type": "string" } + }, + { + "description": "An optional organization ID that should be used to register this user.\nThis parameter is only effective in the Ory Network.", + "in": "query", + "name": "organization", + "schema": { "type": "string" } + }, + { + "description": "An optional identity schema to use for the registration flow.", + "in": "query", + "name": "identity_schema", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-browser-registration-flow.RequestSchema.json b/docs/reference/openapi/create-browser-registration-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-browser-registration-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-browser-registration-flow.StatusCodes.json b/docs/reference/openapi/create-browser-registration-flow.StatusCodes.json new file mode 100644 index 0000000000..c2e46bb889 --- /dev/null +++ b/docs/reference/openapi/create-browser-registration-flow.StatusCodes.json @@ -0,0 +1,1462 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the registration flow, this\nrepresents the id in the registration ui's query parameter: http:///?flow=", + "format": "uuid", + "type": "string" + }, + "identity_schema": { + "description": "IdentitySchema optionally holds the ID of the identity schema that is used\nfor this flow. This value can be set by the user when creating the flow and\nshould be retained when the flow is saved or converted to another flow.", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow occurred.", + "format": "date-time", + "type": "string" + }, + "oauth2_login_challenge": { + "description": "Ory OAuth 2.0 Login Challenge.\n\nThis value is set using the `login_challenge` query parameter of the registration and login endpoints.\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.", + "type": "string" + }, + "oauth2_login_request": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "session_token_exchange_code": { + "description": "SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed.\nThis is only set if the client has requested a session token exchange code, and if the flow is of type \"api\",\nand only on creating the flow.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. registration with email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the registration challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the registration to a webhook", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "type": "object", + "title": "registrationFlow" + } + } + }, + "description": "registrationFlow" + }, + "303": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-browser-registration-flow.api.mdx b/docs/reference/openapi/create-browser-registration-flow.api.mdx new file mode 100644 index 0000000000..6fda98beed --- /dev/null +++ b/docs/reference/openapi/create-browser-registration-flow.api.mdx @@ -0,0 +1,56 @@ +--- +id: create-browser-registration-flow +title: "Create Registration Flow for Browsers" +description: "This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate" +sidebar_label: "Create Registration Flow for Browsers" +hide_title: true +hide_table_of_contents: true +api: eJztvWt74riyKPxXtFjvPpM8L5B7OsnavdYmkHTIlQDpJN30IcIWoGDLjmVDyKz+7+epkuQLmHR6pntm9t7Mh+lgy1KpVCrVXb8WbCatgPsh90ThoNAeckmYsH2Pi5BwwUNOHf7CJKGkF3gTyYJSj0pmk0iygARswGUYUPia9B1vUibZHibccYhkIQmHjFDfDzw/4DRkHWF53ohDv8ImVIS8VG01j4nLqIwCJknAniIeMJv0vWBmZBhHljuiI+p9EmYBlsTzmWA2oQCxw8WIcIGD6z6KhGuoeowEzOYBs0Jmk9DriAfJnL5kwZhbrKxGSU+wHPFuFDgPZMLDIfYJbUi9hhOkEh89RSyYEp8G1GUhC8jDv6DR+4cyqfcJJWPqcI07yaTknugI9sxlKAl1AkbtaTENbT6k5CEKHFm2WZ9GTtg17xC4hXixqOMwm4w5JVSQymnlDnHMZKhGDJj0PSEZsTwRUi5kMkOYrxeFhMZglEkdsdoRFpWMeH3okwWBF6jOHvDvMrcf4B08OW1dXSZj9Dx7SiwqYGqegA4OAO4HjZOuxkWXjil3aM9hDwekPWQKcTzGFZF8AIvNRRk/tqKAh9OuJYN+d8w9B5ft4YDcCOgDMNdnoZVaux6zaCQZoQSpL/6GeJYVBQGzM/1ym4kQ/nC5dGloDTVUGo/MJg//ClgYBaIbeg+E2nbApAR4hRcS6jjeRK1fD2dil0nFfoxkqBZL06nliT4fRIrk/vZjV3Nuu+YtLQzZnh3v8qpN6pfto8vaUQ23pOVwJkLolobE9nCGQzpmCZ8gK9Vh4LmsSI55wPrec5GUy+VV2Cjx3g8YEYzZiOeOuPACRrjoe4GrQNQU0vciYBIh+XwVTMlZQENPkhsY4twbcPFlZRiGvjxYW5tMJmUvmJYtz12zPUuujbDtGuzrkt7Ya7ix14CSSg58voos6DP210wjqOZZkctEiL9++yBppK+WC8WC5zP1q24XDgpWwGjIDhXO0uMfO96kUCzErEQWDj7/OseuGblpngNNKcLLMI/QI7QPTCjZyYh813dYyGyAhUMvyLMKxYKgLiscFGISLhQL0hoylxYOfi2EUx9eyjDgYlD4+rU4CwuszVUlCodks7yuVoZUh0CnYsAMWwJOiTzN8hQamOKm8cebuBpXPhP1Gk7AQtZKhXkNGGYBWTNtGoE35jYLNN0yYLERQxrFXZOwYstzmST9wHPJA6581zLgPSAWr2d4t2QiBBimXhR0BPV9h1uKNFZYeVAmD2vptf3XTJ/vac+y2cNqsqH6jIYRkLhaBBpy4Erx/E+mdkDJZMgE7qYgEoKLAfHUokKLSxZOvGC0aOFmAPi+5fsOUhqzgPcNKnLoCiZciVvPMx2eaqzYVZQ+6xDtNDsKcyl3yh1x4wNbUB8DcnLBKaqVh9mYPoHdwiS8MQsCbjP8UB+guQd/utMyTn3+vAUmj9S2aEHwu266q+5v3FwVQTz8mzrECwZU8Bc1X9glwILl0IscOz1VhXemtwFguKzpMKFwkJeEMyWs32dWyMfMnEJvoLY0GL99MuZMJep7ABwOZLV9c4hnETTx2azheA2gL8WCOR8lvN9cX4d/4KhkIoQ/U3t97VEC0L+m+gMplgUhV19TRBz8NTNLfF4kHLle8ZWT2GXh0LPVOnJJegwoWwkIdXyi5XBn2hHAGSSDU9qnUk68wCbVgOHkqSPbU5819POO8Lhtzb69qteqHRF6oT/7pn3VbnSE43mjyO9KZgUsnG1yji87YsJ6NAqHYvb9LesBkxYg3dts9m3Vsxm8VqCP2DQP8hGbdoQfeH3uzHXQUI87QlLXmX3Zqlycd4TNYA/nAlfDVxo+RS59zoJunwdybqb1+P0xvO4IUCW6AbOAgcwB3tTPz0HfePUlyK5E+szi1CFW3JAAiaK6ovYukAgqL0gjbDAlK/HYsAtWy0STBtAD7ng4RowImQBAvN4js0LCQ2BxZbUw35wHrFShWGAicgsHnwuG0kB24bZVKBaAfgrFQoZYCsWCoYtCsWCpLvRKw19q8WBjUtcpFAuppYI9PbMg0Hsa5brL5PeX4sy+LhaeSwOvBECXYCcWDgrLLbLcIj9zi3wtFtizzwMmuzScPwGO1LsKQgGjhtxlZOWmXV1VYl4sl+te0EgQy0MyBOFlwuWQSZix4w0IF8WOoESwifpwSKVWKNUZocV6pUIVDgo2DVkJhi3MbpevsOfmYa7XSMD8gEmt3SkAf5EkEvwpYqReK5NbgN1nAYxihLC5g1oJYR0x0xu3jYiR+SLiv8hZ28kBAZXrYG3tP99kl/nnmjK1/Ce3/5lGQRRxO3/2WYlhHhW6QUtJJkZkcaZk6Dm2mk69Zgwcc4KMPs2B8joiVkdSRjKlqGgdFxSj3jQlDAOOUTc0GMb1psLuiETWCxiIFEDaGXLikkg6ZjYBRd0TYxZowxEVXjhkQSxJzSNFyojZudRcx1dvIObYdvJmQvSAG212Z/WXORC+rWKmEAtIYLDzDQLnlb5ZY51eygxlgjqKH8b2ELA9/lxV9ps40raeeWH0FeTVa2blEs5uZqwmqHvNHV7Ze3KWJF6OqrYIgVHH6CCaSaQWLYWSqicEMF61o8mNjGBzFVONraTLjhgwgVhWJuGUhC7JZMitIZlQpa5bnpCRy1BtT3XmBbMDW9SnPe5wQF5ZiSgZud5iUnZDb8RE1xwyryGggh+QNnxAWvoD1IXxBT43j81SxIeXwZiZJVHDExweKO4jWo4VE1JIfnichA+I0AfPp08ReyjrZ3iE9qgNK02LRDJGFlqvFF2VQBBae5yEJTVuCcftiBYLYwYUwzpkAYs1aTWPgeP1KFr6sTkX5EE3B9ymUfmQS17aONq1vEB2vYAPuJDfJjZS0TbV6lWzRa7UZ4DxK7ApB8QFg+JN81ySFeTK7GBtbejJ8POB7wXhl1VNOIDMlHXWpSOmetQbQoI0iNNU2FrDicT8QJ/agPQgoLi0zPVDbclXm/wXqXpUU8saecnKA7zrVs7Pr26Pat2rZv1D/bL1sNoRGfMFFzJk1M4ZDvVL9LDoWWgMqpn5PhN2IjR9G6ByRxwyQifwNR5jTIx54AkwhpIxDTha0xXQR5eVw/Oj2gO5uGm1zUEGLoowiNhDYoYLPRIbE0Lmyhy9PCYLnBdSRWRzJqy8k2COEnRT3G9CIaLkcBmClYcLQ8OmR6mgUgxGeRTi9derrrceTKFMoEv9KXG4y5EmlEsL2BBykan2gyzgCKFXRHSwZwrmqyKxWACnN6k06qmzhSQ2TK58WCBbe32k47KiZsQ1mOS1TQHoOGTSp5ZiZHqIwkHBbHt3ansu5QL3PfU5mqZlkSx873sylN+5WOHQC7RBqItC9CCgIuxmGKnD+wAoWlRE5KBzp3AAxALKYhiyAJb3/35eL+1/+f9XhPx3JP/tyn/Lf7v/Hq7+f3Oso1gIeYgzvYwcp6YJ+FVwuP2XASVg/YDJ4R8NT49aI2tIhWAOyBNeFHaN4824XXN2XPbsPKTWqFRVnYAkBk6kluqENHUnsBcPPc9hVGiKRrWuP4XdOBkyFEVhFzUbxt+rHUqUSG6TFQ0VqddWSdWh3FWKjuVENov1CDV4R5hdZsSbqena9BK7ba8aicSag4so4EZwV5Ke5/IwNlVrK3CyRfvUkSx1qPXUjBcgOgr4b8LtTbMO6Gw2lJEekKSET/Rf6pkaJRE1WQKf4Ty1QV33pPCkdY2rxivSXjelJf+pe1mDk6evzh0E9ZpxBCmBl7tuFAJkeG4KTz/2laxtFwklNzf12nbsKojlzNcwo6zO3wTmkrrMgDOMXCpK4LfG4xN6MOK3PoaUIq/V5fjA7ggm7BIqhXYEYJAMP3kNSm2Y+zacLWxoINWWLYOQ2Q2nPJbxMQmuH4fRIGTPYRHF0XAIoqNgoNzQAZwqJNUtl2TEfAguAevFUMnzLmx6YRtzjba+IKI8PHO9V/USPdPua9aYBZMm2kpDKvH8+5w5CArqsSJ0pgiUjHwQGyG4BCANU4omdSZ0Ksl6RuXlItzdTmDmImQDFqSAzucFs2Dqna9+3TTrSiwALqCwgFIHmbAe8emAacJWQnjiSac92PoJrSnGpkktLaiS1snVzXmN2Fz6Dp0mnjQtPca0yAUYoiyHWyNcpj6Vw4XkCGKKFb5Foq+qpkaMQwnX6+upysQ2hUcI4FwpfPAN8ZnnO3HsAzhXU4YXNe8imBG5hVYc9CmaKI05wYk5/n/pn2UvGHyXKKR2SL4ZZX7GaOSBeAOMi+qIqvq6EmpHbGJukSF1/SzT+EVqK5FC/dvsLcoE3M3KJX8mg38FoD9eXHsFmD9JYOsHngh/r8R2DJ38PJGNS0lW0HwYqIiaOQluxtoGjs6OiA+X7xXc8nDy4yS3Bb3/NiT/HtktAN09UIcvFYT3AXsp6Q000wzqEcvgPzJGTQyw/OZqkIvKfeawj4cAyJgOoItBxThGkAJQQIlFAYHraEOHLhdM21c0w/K9UAmTzpS4kRNyYNYaJIySU/KP4w0GYMKIwn+A75xxpDlwJRjYiqTnhUNjccg9cdR2hcdvOXQ+QGsC7h05e/AkbbFL9ELJtNCWtR1EkpVJNQ5sBMX9IDm9084kNegBeZiXtR86opJmPgScTXH7eW3yoSNmyLDuglmCm5mt2HBsWnCq/G31gDxw/fqhI5qKo2mtwIyR4XPQfYwF1e7oGfbGgB1AKKo44CzsHyApyQO0kB0gskqArAMwKvYYDViQ6Uj5GrNT+2ZfmjXjpL/rRDYz/lNPuRkg/viT7XEyytkOGJp7y3rkjE1JCx35WUv4iE1zPjsH45rXJ+nPZTYIT2/8DvbQKWQDj2hql2VAWDm9PVvtCOxClsnh1HBuxca9wE4cF6e3Z2osmfbuqn5tD7YzSO6A+CkMGH/rB6zPAjTnUddTxkG3SKgD4bCDYca9gNY3GKjFQon+OmvoeRLjiamEEGRCIXBdGRm9FJA6iokHHeFHge9JJjEeyGaSawdZTMIzzgdnMI/xNuKSOoNOgaxQZ+AFPBy6q2m0Gs+O1OZg3YaA8oFG4L4XdAQcO/GhOmLTMkmsjur4NPFkmvv2WBxOFuuBHVGvXFZIJ6GfFh8IFeEIB8GRsIIpgk4qBg4gAu1dm3YEyLM9h6MO2JuSz6e3lS9gtu8xFSkfafNzHDlFSdVzHA4HRglYl+QypFrNzorvzdbmzm6uKhKMAbFJy0ZpQUs7267dvdyrl3ZP2NbFHn13tzG+DXfbH+rP28+H3Q+NrYvedkt+alW2xyUvGJ++vDT59fDcaTb3NgS9vX/uX1fuwx0ua/XdbnXzfL9n33rbx8eNxw/Xx+NLr3lX6srD0+lhvRs4pfbhQH66926cyuPW6f7mrXu/yUWvUmpMpqd9Sev1msXuD6sldld65tVo9+niafSJb11MrivH57u9C7txdLH+sn16aE2O21sfbX5bqTdvokr19noS3F087b7bfH7Xv4honZ7wd3e1D4Nwg4fDza3qeZ82j9zTUbTfuLasYS/sRkf3peFTcHy/K8J22Nr26e3t9ePe7vP5+f52q9Tu7453n0fn+xt7jf5566r9tHtXfXkeO8eTl8PTp4ovKsPe5On80W8MBzcf1rePas3gKWgdWjv3G4fnbCx26/7OcKMyZFIe+luT89H14KUbeMwahaVpb/xy1n48al1EdCD8p/PxVfvd/f6Y1aPB5sWkcfqpvvnx0XppWhvjlwu5uXMXHF/v1fybaal3aft7+213XLmbWOHNBT+1ByeOdzrZ3KqO17cG9ZvKqCZk++mTO/J79X7JCvzB5dmxe93oHtXOPLbndxt3nz4N+r1mwLcuvaOPHxrvLka706No7/zxdFh1hp/o4eVjdDvZLJ05h/2rytbg3b477B+KUV0wtnN2te9+aO6sPzVGGx9LF15wc3/ZPr74VHfXR8dHu+z+4+3x4eT05Pzsfnhys7Vd8/jZxsdGSY4/+dXNqHJxfFnp3pweTS72q9ebvb0ntl3aYft0OrkYT6yoEjRHlcMd97Dev6JXp9TbcvvR6KxylEvNfpacP2zLxt3I2r2n+9M97/R2v1s/f9x+jnw/WndeePfk3cf2qLX3/LjTsu+2LO9o3ePu/eS5zjeZ265EbP3miu7Y/uD4w/TwdNvaC683Px5vr2/eNaPBWa3d2KOj++GxtxNWKu/eXbPupRtG95+sreqWu1Xf3P6w+WHc3JGt2vPNtHK5+fK0d94X+0c3rtwN7reuenv3jJ+N2vzwcT13Ok/Z6ch9p3Ky3x8MDqV33Ny7otZms3u0OZhs7m0G7c3Rh6vKcFx3nKP20QbrB5XdYXRzM77oH1oXvthzntjt7vjlRdzf77Ra18fv/Au72qWD+pb4sFfv+RuHN7310xse0Obl003/fGhd97r2/ofj7drwHXu3fdtrSq/X9ET02L6/3Hiu0sZu+2p343F8G9yVzjf2wue7yfb+9nXXGozypsOys6lcVw7zmo1m1pBOBoPoePohuD2j43eVu+2PZzeD3A/zTKfqOBlxG44TiDUDtSBzRBunNCa7mKisPrfiMwOlctVOObfAR0mFxYpol1HHpDpgKXoGvT58Gx/W1JyrHaFtmwBH4DkOmP/0sSTDILLwWEnkCQTaKHIdEQkNGsTMqvikTKNUVMLsyEVi8z7KAmFHpGEz4kWLhcYoBuemzWXIhRXODFAmZOUKBH69PER55axh0r2aucsHQ4xHU0Y30OZm50N4H72LU5VRk3TQKYzCqVktWORVM70e5PAEmO4juVIYUZvqCFDSx9RBF4ADoiSFsGRp9Lt0VkMcKuOWVxXqNWRaGFOWR8j4KkkmJMeAcUVk2dN3Y3d9y+6zddrf62/v7Ocer6MwJ5hCjzk7yYUCDkoY3iCg/pBbibjTEX3qcmearLiRdIpERkDKknQKzValUwB5o1M4qnYK5XhkjVMlAnXEKzIQmRWBQH5VeuTPE3TipUmAffPKNFuVvMUQWcYybj8FzzfT64bT3VynT/2d0d3JpPYpYE7pzBvX/T35jk1OPXvz6O7E2QtvnebhVrfJ3K3ts8lh/8k5u/7gb4gnOiztbJxsn74E0RNbt44bO3vDxlE93L19CsbCPa3ePYvLqH64s8XvutHNzd3dSe3kkNFGtdX0Lk9fLqfy0TvdWm/Xb+TZIefB8JC+629u7TTuemf8xI6sczb+uNuwzp5Pd6z7vZerzb3dp9Pzw9tWwy1d1dl48iTrslU/2d6+Dt19yb1jPhqOeucT72lye9X8ULlfF87u3fjjlTOs1Ozzx8PWU6vC2hvHjahaq4q7yUu11ty73K8fH3brj3YrPB5VS8HHcPNs5/C+37DXra3psd8dnzQ3dljTXn853bu7fjfxDqt7H4Wk1u5RuOGftXb2/bvdzZ3dWuM22rup2UdXnnNWaQwsuzvYvPQr73atCj3uPlrtvfXH/bPg6GWy1x6vi9PDD0xG1cfG5eMH2T17sUe37Zu7cHPrROxfn0rb2rj4FNHbdf50d8j8k/v+vfd0yZyXjyHb2HgXbh9OPvrro5uL3Qlbrz9N76oO/TS4qu+1Sre1w8lm92psu3ts59Id3ld6ztFHbzqw7vbut3e9k93eGafV6/5Z9bh2YTUH1aHL3lW8o43pp0/3stGjH7pb9cdGUN0+P7w4uZ7sBRf79u3j6V7dfeTW+NOGX3HX7efS2Um1sTXdaXw8C54Pa/2Nl9aVPGyOrlqPh3vtxlVNnF687JYe7Z1hO/z07H9qTBpe3a5S0f609am2GzUP/bZbm4R+84O7u3VzLTfcnePbxqS33t6sH+cKBzOizu5lb3Q3qd3eDHmJNXd2qoNef/Pd8ei6VrutU/eK1oL14HHjab2/0T8+etm43al01/fvxx/W94/5eKNytVmq7TWdvUFr4+PoZZOvv1RbT2I63ausb+7cXVnNMb+6OHsn6s9H21cn3caRHHl7dlgPeltt92hzeHM3ro7cl8n+kWwfb5xfH159qO7ySJ6375hfr24870ej6tnxp+uxPQiPrnrXO6MXe/9y+FSy7Ce3xS4+nnvPjXN7o+eM+cf2/kd3rzTd2KyG9z47Pbmi9Vr4sXHuHA5P+aHXOLsdbI2fW+723XPd4ZdXrP/EBnVHuu063brwW7u3t071bGt6MqTh+nUpaD7Xnu0p/2h/6E5eTsf+en3S3Zy48p3PSo3BZeN+fHN7sn/qD28bO2dbe/dPR4f89PjuOg/xM0LZemXj2PWvbpv7G91m5dZ/Cthti44v6afevrhjZ/zQW69dfzh82dqs9Z7Onq73Wtv08NTtNYenlhU+Vs8fKRclPo7C7XfvwsrNhftyOvl4Wqs9bV58Op5U969L2x/vP7nHN9snpzycXketl5N7trvdfLwsHXUvr9c327fDD1vXH253A+9p19p5Z+3vB8GNPGpPTk/5pLV3seNv7Fzw6GVnq0avHsel6OnpuHLcn04ud25Hzye9gB5ajyfhBb+Opte966dR9XhY8qg4GU3uL9k0lJfDdrTpXruT5k6tuRl4nzZFgx8/VneFtEelyrujrdbW5OLl/v548u5x3Lu99e5vvf3x4fZ69+J+8379+P669WTVXqzDuvXUXQ+FoLK/9fF2+9h+3nX31psvV73NYykc8W58dlfJRzyfkQynF11/9zS4m7b4y0boHQ/OercfS6d2fevxenvqR/tB7+L2eSu4Pj3su+H6sXf/Mripfzr6eHxkXT1NmNu83Nt48WoVSkuHo/Wz28sPtcfTk081u+YeD2+3KpfvnHrJj55HXffk04fTjY3gedrcu9rZuTtvsa1Ww232zyaf6rvTm83tT8/j67Pj+3poO/bN2YeXq9063X1pnw0rH5s3edOJZI5z/UYystIp+FHPURIonO6dwuqsTBCbOiLMTFdxWslXZX164sdZcZe5vuNNtS9C2CAWMeP0AGdnamgjHGNAlzZ0iAGxaUjhYMeUv2kcOGnsIh3hCWxTJh8TsdTyXBez8DoFydG2E3+wqsQTJix4zGKLymr2VJc8V+p/zhJFf2/r6nSrtvl8vHE42BtHvf3wnG0MTi5ePr7bZXvtSO5HjZNx8+NR7qI871iLBLbnHYTvrryzvo9hbSrfkRFrSCHBOp2DG0s4+A5EemUn19GajbP6XboLST43j6s7m3vrX7TgM9c/yaQZmNoPKJLFBsb0R9qvpTzKZUKOqDXsCO1Mz1gQdRytZLvbJYZ5ITZZaUGmpCfINvQLwG3vbu99IaWSsjWq5lHgmC9WSe2oST7X2zflu9399fLG/v72l7l56kRSZT2de6nRZggKKFDNwkRdokdMpeGkvvu+aMtpllyeu8dHL81o393aPTm/7IYR293ZP7/07253/eq0FfLR/eNZ/ba+Q3MO4a+QYmkck59xQyuRX+miRTRwJilcKgUnZbmGpMtb1jtj03lIv77lM7Bja4v3G+MsZs3g4KwDczb47Ew6atX43Ocafz69PftCbF0yIE7k0X3DhpZxOLExErcw4gIrkph9obgVNNfK8IpcTbUFpiMz/reYVejM9mRQxeiMBgvuPepILw4ZRQtuPJ+EtaCWuiJXi6ngaGR1WmHUgKBTEL+Ja03E8zLjox6Orjo9oY4Aw/DMWDiCS21G4mofEJQF3HsFsHsjMxpgrO80j65v6k1djoI6juosTi7S5n27IwwK0lydUWsIH/wi0+cFHbAyqRgfgPTclAldu/kSrR3V07iWh6pT40HqXmpJstMtEtuDZZWeKanRPKpeXVxgVY0isC2O/kQHgoax6ghLFvF5x5r31qrkIki0UOFsRLHgmBnq/AhjdTFBb3pplNlGRUEGKa6iA4xV/lkSkYazgTcdoQxC4RDMOyYqLMt25rjN4yTsKjfgn+qDA1/+GxkCeO+N776SDrgyxGXYcRyJA53nTt5lIYVzH/mwhgxYSJNOLpgEuktn3VECfKyceqliBrxgJMmEYVJgOEQeVCSt63MVddea0MEgkzyk2SMkD00EC94w5StohwkU8IdOxdQHow7OMJPGLo1FbrajXCT4nsOt6RuR38DGBv3qV17wG2JGhc6jP242zNIP+JhaU6IGjxk08FkoXINA9JgkQ721bQYyIGY6ZOosWJ7jMCuURWTBRRA4kGEr3NtcWg649yDjSWJhAxTz8tEgQxNSkirdxHNcrCa9peHJsNTUbVNRJSpawcg4mBoAQYoOT9i1CtdQrJyrYyDObwAMQJsjYZeg/M0vuqpOZQDTz1adim2DHbFoAin2pGqFUKJaYZZqjyVJozOuz29KJt9A0xzxxKgyODIP4Pes79lEb5hBCBTXik98K6bnbFJFKmdCJwVBUCEEfH/nzNIBZX8mY8yD5I+PUMiD4k8KuktngWbW5JtBYLWpoC63EmpMpZOmU4IUZSYvU3mCJi3YeGAiH6S9IhmAw8ILiM2gek7CezdjoUvlvON5nc0hppqWwf0Pv1+BMpdvZfDxagTz27GhRez0s0ycc6iLEn03GvIngHyvq47FrpZJu7mhFjNzaGqWeaVKBbS0fF5JHA4gZrZAC2h9AZkxFXqhrP3IbI22FguMRtDP9i/jylNxkJ/jzLbpCC3vc2lQa7oP2CMybYw1wch1VSZPO0IwYk1D9yqiFnDbfNTMHUepXoxYqXJ7ApQoSylnSnJWAVKwIF8Yz10pHBKPLotaQx1zqKv1SCOCQNkLmZL7daeSIWR4SqvMgjDgbIyduGYYTGVHh1us7aCL0CREd8RVQ0X+aKVWzSRnhkpTmptg7ILS33dTn3bTG6sjQJRQlSfi4/R7D0uljr05+rFpagXmBkBmxbu4riBW4zBR+bEkoWMiLSpUkJF+nAlZTOXNVucqQF5iNUAkg1dDGg+Aaajg+HotTrBMzvCbZh3iHO04gtG0rqTSqmebm7YpIF6Jw/z+IERpef5bsoZa0A6wgX9kpPCUIQjc8dQChx8QCshojo7Iw3EMRa5QCTVflJyLdG0MWFvlrWyEKxizdt9t739ZnV1RqPOJ+qIJSkbqRSgyaepZqySAsaGgKW2qf8tb6t+D7TzGI5kVekE3VXnmLQdMC78iST0aozWok8MoLJjqqqpzsLTiDtnP1LEiRx2TDcki2xNT14tkqk+Zjrk2tfJibiMJ7Qisx4M7HcKtxcBhM0bIjLCswwZy0TDifhc8+bkVF1oj7lfVSwIttSfcPLECELRn0l50xRGV2ARLCfbmjtDp2rHhiNquykfOD4pHuLTg/yp4SkOZB1KrA38IrJE65dWbb1GQaowM0ESwPqR7kN04+euB1OY5dMquDXWQ1DZES1GcM5buzuzNeOYq9wq9AtzWMeY62p08+JQHEy6ZrvWgvBD5ZRSUiGwYLKawdFV1OYUDDKOFoqOZrLkeldzCilz5bEnHfJtysPActoWOGrnA/pUYZ+rgxkn5mZa6zp1RrbLdql2Vqm+hKgLnQPpwAAHtOJVV0mKAkzhBVOMo89UDWNYe0iX9nkuTyaQEmmgpChxtp38gxsSvLVon7XZj5gAYMqpKjc7ABSrxw8EPBSYNBJRLhkHRmBGy7ohNu1Do4wD09cQW3VYFC8AMkiCeZbP+HoQnmPpQrYR2aplSKysqPgjigmSRuF4PmBr8MMUyYEfGxX7VnPK5WB4tvi5zLyK4XHH7W8RmROtEEF9Ad/mwv9Vr0GaBizJoS9WnyjUY4kA6OnzOQhWaHnSFq44wRqoZIwSZMVlR5DoBtcKIOiRgqnS1HHIfuGU4YTpTKk7Z1Lm5me6yDSyL+aHEQ74jjNSWNXPm4kvpZW9MeDynoC7gF3HOo/r5zZxHBz5Vg7092xGmBrmwXaUGdWMB+Xs0vxvdCRIjsxOheU4HzNP+Mr4KQ5nQZR26NH3JpLQLnAkmonGmordJyz69bXfE59Pb9hegHFWm3y7q1DuEUck+p7ctxVvjLAqeSozjialrDp6ZWsBYgUF2BLpXb9rHpb2YYyIL0nX0Eolrtooq0Tob5vLk0NHXxBgzSzS5Rm1uW13s8jmnEha1gq46ZnPsqtWm9r9rG8MM78gw/aoaAaYvJWnGeSNJ1XdTMzep+5I5NBItUtlmaEpuwOI0SlmdITx0HT37KjdZ816HjZmDNsssvKoc9eZxZRX6N45XLIg206saDx1NFFYebJ/yoCP+SRJ++luQYYJgWzMqSdpKbwha56ZY2pcntS3erEOCOO1qjEviJhhPVQn2Aw80EDUKl7PQN01VfKOCm8QirItEjc8/JzFIbZq3I0PSkMt+yvSeXaSOiI3fapFgX6lgBYMOVeIEKRO9gTEHSGttmwqupD2XKcRQlEA/ek4kQgrVK1XVlOlMLfTvsyjoWgDz+6imiwSkNdRUOGuy4Ma7kru+unuZgzTcBUZd0GUHQhb0qcWw2kHscjYuDB1AYbZVEvx9ACmxkLDYXgTGXOGDV4G5qatYaxmipVVpff3IcdIuFCzIMOZsEscDmN4zcUdooktzex4zJpOzbL5zPRuCRHzPj/yfOxccIj2ZCRe2ql3JFr1MVSFXpbBSN74QyV/UjqWq3GCp71mogNucQuYzHlzqe0CI15PgANcCSghGNz2ISjdHVup7vo/Fsn2sR1cGX3hkDX8uZlQSqgIDOHKAhAilyyG0PCbQckdM6E9epE7B3CngDyGMqqDscrrL+EqE3OHjiBBwmrh+aDK3LW34SRVHNOJXasEBtCQuILPQZvT8oqvajTMEncBCiQJPa9vmIZZXbaRP8a+zSmm9htL7CRehEkcIDYyGgz81pLFR0A/YmHuRdIBLQQFTw51zcaLOGai9bMLIAM6kekpHpHylujoM+CF8kEvTSpc9X7xgzjORSDKqqCcMlZNmC+9gvgiKTFVyUUU7U8U804wwnWdiSgeTFfAHMDguaTBdNdcB4BTT/qYe5so2GyAo8lDFlREqRzI7QpzdSlgpXUqFrHgBUXVmE+BWVewPYAgLdSLnBkSrfaROjQTjmq0bYzisRma9TDXgdCXdmKAhraIjcEcQEbk9PDaUk0BVGkoOViP7YuOuboyUVTYXDimSmrs2QVcDzleHeNfxLOrkyZ439XP1yrD4mKK4raUPmK5DxSBSjAX4InaQiOrZo7BIZqMfO2KRbfiw2th+p2Iqd7d3v8TjkJDqs1sWlTSkCCEtDx1nE7xMxnBHdAr9oFStkD4Ew2LmSyqWJZVqDeAfw59DJd7gDoUavlRQmxYVdegGK+mriQaw5pA1DZFVEP9ahMo+2nHfm5IjMYD0mm98hMUy8GYqw3shBitgEk5YuKYBAr50MFlcClhLVlD2XS0bXlqUKQdlLMPzVXzfKmOlNJ+qsSQmV2Tk1nGaEezna/cm7CVxNjnz9KgFZLBWaIJUJUGps1ChUaZvI3Ka2c9U7TWeaOPCRQ0GanioMuXyVZUJHS1eunpv7P5JFdA2MMcVnWBZ1H1SRciI6wjFBOHiH1VuTNhTWOipF8XVgm1GdTxVcgbFITJJsZrXHKVg+EjHbCwuWxorWaZcafZWkLQzJak3SuVr2E6Ole9xERq4F7ikYjiVByoDZDK0evmDYTN1jfIyVnW1oqSStToCk7I2mQL6JYqSSsAwaJbONF6Bu9PURWRkjQTMZcj7+w4drIJGytGziMaWACqFiTjyM28Qm9upK9AEwTv9TK2+tFXSjI4aezyqKUZkRjY2HlXpP6DC9lwdIU6yJc4jmeiQkD9gZ5MaRFYawsJ1gsANF7pU0RoWm+wIXetIu2hg8/6SrlCviiLCHksFpVApPYvr+HSIV0XLcaaWOLrNaFzqFm8hWuTyyvclobkKw3uwjAdn8+7mYWaHxAG6SNupsGh8iCdnIhSqMlGqe+AKMFeABcQdY8aK9AVYugBQ5sI/NYaxumGZkb4XTGhgZz5VH8XO5vP5O8EwCk0iDHGcC1lDl5ehmdQ58KrPKweP2r+ldw1CldxcEJt/VXhGWootk0t1kwMWgdYXVwKHlQlCMAxHqK0vlef6LYeDFqoytfrRXQLoxxLmyapgYIvxhymHmZ5RiB47dEor47VZtAwVYqxQauHU/urDlWLfTF3IXKcGVJrgOa6Knz1iv+Qc5ukzHBU74okBBoMvKr2fsnOm4lA1W8xcbgGu9NlIuNeC3KDc6W8QC/QlVKkaZplth9ssuZ8Rj/+UUoFR6mZrZO54VChKzKg3zfNfQNgOh7BqqkxZqm72goPY3KqWMxF41fbIzP1bBu74U9yX+VEJ6kTSDi1d+gqLUC08opDdmipZKM0kd4boOqh4/09O5IzR2eJIJRpzAC0YZO90jINr0xfwtbUNCfPKYGvx/mKOOTuAmSKCqHib/tzcLgKcAwwNnQL1eadQVModDublXFuSj9aQhnkIDFVx2cytMdg2VsQ05OggVjUmtJP7ANh2hvGaEhTG92zO3VQMIsp+WAt0tYOmli7+OFC8ERXbGMXpuDwYQt3TBPcWGC5xkOUzoOZEKNX1Iyd2wGXGjz/F1qq/MkpGARUSXcc+nToezSvhYZo0VIt00Q5UrjEhMT4BM+OiL3LCekPPG+WxnfzIibahAlx/INekPMID9fkDbNoHfW2kClLQrAeCKwwviXtYoD7Pj6s5Kd45nVIuT9oX56CXanXdilsBZJAwoZYXk5DQlQ5tcR30hcRKSsm5/EONm3epH4hx2dsWtfyFV52oL5FLPvxn6sn7TuHXX0lZd/D1a6egafJ9B1MCOoV/5sd0uCoHBMFaUC0s5QSbXy39PRisVDO4aoUBOar44EiGnqu8vGao3GNo5uRZUN04WW91yHwTLqJAug3AIYnWAOqygCNlKa0+30O/kDrjfoG8QOHsewTcmh2hVP8j+H9H6G1JWurf1HV38AX8hHZ42qsGb7lw7q2DzQoZ6oYqQJUe5JXUyIi3oeGs6jTbQOq8ozj2J40nFbMT70ag0gyDbFy12qu5hUI8e4YSsx1fwns0kcyYpHCjMoe5KmbXWA51tMlNnSR1aqSyNJl7MvC+MzgrtTRBBXn4T+4O/vkANisU7dQj4UehGeKfD6okDpgDH9Cu4zuow7Hn8CHnrp8wDHgvCrXBjsOUXC5o6GHWlEvRzYAt53ffMGD9fFKE++l+kQQaQMgSaITKEhXrAGo7HRAINnnjDW0VcxVbYlxdtFILot9gkZAbZ05ZdETZwCcw/szYbyhxOZKy1ycP0KAMrx/UTWRYSJ+7NIiL7cCpgnmS5oZjdTOKuhnLZwIuO9kqr8PlfEKL8ljeCQzNIbOGQptydEV1DoV6aKcAnh1wtQJlw56Gpa7D/zuCuwNSd+mAAaFUQCCADYfTJS38B4Kqx6TGx1hQJ7XT6Zs29Q8bOLHyLRn4koHPdoFsxLQqqh6TTZxSKhWpVWKWNSssJ8zMeGHxA9zduYRh83Geb19RLagrcUxmkrmCzgd19TGZcHvAQpkkRYCzlhIQLI1SV7u6IGvKFT7HfC0In8jjc/gC78mYueI6VRRbC+O1q4tcKjNJtwv8i3ml8TNIAPFZMUHq6zTqkjJZQFRuOqNF+Qxjv5VCnvHATolLp5nMnweArFQulx9S6/XKtv0zzoCffQS8/QRQkP+sYwDo/489CPK4R+5eN5/k7XYIRZjZpPkE5A5yhBYGrpF5ujjB5/GlpjCrt91pshRVgFC5O/hZVArL+EeLKzJYUPMHCeMXSaQXBRj0/CZxdsLtcDjf4S08/m6Sm9lDAKo+NdUwRUPjC7YW4uI7TlEEbPEhirienxsi/3tGwSUT+vb0rJIShZ6x8eWvSrpF0nUcNYB9lztCGbWykFVSnx7Be6Dh1xq1mdMRUfBak5vA6QgdJVOK72Jf3L6qmia3sws2ect3l2ySutFdqEjwEtpXF390JVibu2ibxVzFAAWN+Nr2V2al294ml92bLYqIRUEQ/g929WJhdv5AjqlpFYqFDMQFFa+eAeZN2365qD90UVXYK7hUcv3Q5jZz6PAXSUxTnbUGUmAQYQTDK3fMOLTHnKUuuNQFcUVc+gxegLzz8YI+n+Mr1CJSBbxi+nPpM3cjl6ge3ngLXf4dhu1Ut9qYhncV5i7c/yTJDaWknyW7oXDwR0tvnsDr+XJynKDKhjXKkNMjHVPdn0o2SdRt9gyxHXAnk1AX/ukglPTCILtVqu0t64G7Xym/tfjmIcg5BL5kBk9dHxbHWbIxdVZMpqHKKoAyaLC4AZcjZHamg3bAod5VfC12Hn1qDOimCxFhukrjg8bzIKF+/W28mIDrMO7Q12WpTumYqnUi/UgoJ5Apx4bZP8HUVNzTH0vtOJJxyXI4D6EiXsaN5wUqhKAMNTSnBuZMlRXzUE9T5jXKfI0xxws/w7fYHgAasWl+8/TLudbps7cuePjq17ON0729OtGcNulv9eX28i195LVNbfAFqAfpbgat6lF6evNPZiecaTHf/2sgvoXnLOnmD6Yb5Ez5Hv0rcQ5+/N/AmaG/38mYcejfwZfh+7exZSdpuQgHP4ApI0qWPPl/1d5a8uQl3fxWnqyKjyywrelsk0zpFq0qJbfSRuCYcrBIKgYYYbkhCgWYVN41RCrAMj/oErzxDdym/oZmZMrDpaIz0KSgs3oYFCFdswPPt72JIAHVF/KCl4/0A8awkAiq4drcp8ahPRymI8w4wFG5iHSkIQ5GUzES6uMilCoOk2o8UGgdSlxiEKfRvUzRo5u6dofZHobCO+D+w0zNTALAbHRmKphLF01Sk8TaGMrV1lchHgbVnql5kkWunUZucgdlcjs7JdKiDg3Uxxi/tqI2YFGniRWxDr020aymyipAQf8eDbmbiibHwRcsY0fMr6NPMVtQzYKqMzSzmvOeUZxBPjmm0qxNsoCMeqqqgyHHOE0NBQJujdS1yLpA5CtzS2FXYxRScOE0hNLVIdJBLlIVVLNYJSmklufMJWqSr9pIwJYwY0i/8s2unU0giYuAvmbZ0I0WZvXk36h9QYORTs/GVYy3ZlxyIdfQt9i8NWto0WYu3IHZCYMpRZkFFthOoUHKyKoyGeebXOILiJtl1qjnPec0qepXHTHkts1mzabQ5ARf5HsS4P1CY7OahgNGNCDWnLctfNERvSgMvbyxD/FFR0CGBNqEMTEvpyHUlgFrMOZbqvYLWuXZvOHdTbOekie0SS9tyEdkgpFfowycToga+CzjDFDzLRQLal4FDE1Iwa8faLfBmy1FSyL5SxDJ1+JrvNrscpXANZetMcsQ0S6rCSDlhZh1Y34Pt1TVJwGqnEI5cioWeHm11oktiIZnnr1ZgSelShp9tRtsp7NLdT32HxzziMZt0Epfg0Nf+YDtILJ/+N/RsP1XCZ3RRPVHW7aFl5tee+mZLPNqq6GqsGFLTCIDO4JJ+tUpNtwFdR9fB6SqilNBoR1l2VCXDpQ74t6LjFCL+Z2mgyR/DWKNZ/KKs30DOEjykL9ooIFOeFgm9zrxUN3PEt8tDq/xa5D01TxwtL/lCy1YOCDQ++q1fWiavrIHF8Z96C5U2Mf3ufL0pxf1i6MZXrIg805FdCj2NDfBLNtJb/2Yc+qoKoGA5oaAKPLKja3S0GK8u6m+BdaxxBiX61fNr0W2jI0CTgS4+Vl8CPH+hwdz5y720n//v9B/P9OF/npxXCd89eaoMGWRWRB59jU2Gkwv0aGfGhBN7eyqXzj4vIxL+18XwrSMS/sfuKjLuLTlubaMS1vGpS3j0pZxacu4tKUvexkDsaSbZVzaMi5tyZP/4ntryZOXdLOMS1vGpS3j0pZxacu4tGXI0TIubUkky7i0r8VlrMQyVmLpU/rf5FP682Il5pjNsgrWsgrWsgrWj6uCtSyNuyyNuyyNuxQR/qeUxl3myixzZZa5MstcmWWuzI/PlVkWHF8WHF8WHP+fV3A8LY7lCmI0vow4JY6pe2ceQNJ73yn0Pa9TeEC6BUVRruKFWIPAi3JuifwAj+M7nQ0Hwsa629jrkLrc0AtWE/ojPeZ4YgDxN2X021K4Erim/sX+U64L46jQzz1uW/o2Xn0Zr/kg8PrcYXAhMPyrn8J8yDkXI/0bMwcgMUD/Dr3QJ+2rdsO097xR5Hf1pXHn+Eu/ivMHTDxBCtIRmxIdVqCfJju3q270rscPjuG3gYf6oTWkpKr+1U8ldR3Sqlyc6982g+u31eg1/DsBIE3oCoNZ7xQgTPFkQEuhWACUwCGl0kwAAfAwPW8wZyRpLXp+eGxl5wS9KLhBuaEuuq8SUGFw+GOzixeWircJY0ty+H3ksLzDbKnn/747zGgelrgk6npvczEsJZi5hLf7eRh/lL5nFAUnWBFzrzqEoKYuM9YRMTd1OS8wLjOiliSbMk3F4g25VLLrBQspjq+JLbcywELMpQTgn+fvNRdUqOtgigU8IJVBovjny6NaCx1o8SF1HV/q7NCsICVfAvqzkiVcLPqLkunk4lXIYTd4ceEcXPoa0PgiRXMB4qt0El9VuoDe1FzZsw/R7F2KayJlxGz1d/paZrwL1VyV+8qg6SjvY8ebFL5+nVMt59sUC1vrW/M0eeT6ED/PpA9CklLDUfwHxlVM38VchFZo3lCtbKbuH8YwR7xuFSCPpLrrGD+c6Rsi9sKprzWwzfWNstKJldhoeKzAP6nvOyC5c0+sPUp1O6sKBlxgRAmpsCEiFG6lxjBAUAQVg1BbdZ7TK+4zjxL8yIA995XNetFg/qsaPE7uncZWmVvc46yISEaIADCb0THlGIWDBxlcPRx6mEAgMN6mjLSD6NfzBMW+R+GWY5v6cDU03CMcYWv4tM/1rcM6mC+PrS+YNhQUMJeEKryZjMssBOnbtLUv1ELTCcynBysfCXvhuN3MoPNIjH8lqOxHwdwB7ynDj6BhFLD4bnsYIAvwlbo5Hq0D9RrZ2Nza3iG2xyRCy565zEVRnlWkXlPWCm0bUSiq18od0WcIRld4YTdZ0KMgOFYvLr2wYh53xFPkhRRuFmcMUjyOguAanhzpBylenttvoVjI9vAmZv5jQUyE/JzwVC0aZG5gV8jS3yy8IDySC+5Zr86w/qTLNMtZ2V7fLpLt9S3430aRlMvl1Qw1wPs3OdkXcd4BEyA2IYPQVvE5tq92V+rcipmR4ivNhK/MHFjzXBz7+qAGVYDRgUTKCHB0XPvnkhdMSwENmcNdHpZ6kTViMMFRQENPlvyo53Cr5DKbRy7SBmCrhTiRWCzEoXDdLd7Z3TJSgpaCC//lBdM1FVAOZ5Mybx8UuOt7QUh+7QhCCDnW4FR8XlRPqp7o80FkUiS+qrDuX1K9/fIPvNHdEzIEWklak/dEsEm2h5XVf5i21Od1AdzeYrplavSVTE+rOITDwGwcRoFoewdEUdw/yNoa8DK4uBvVAXiNZKUvM0czYz802Q9gbwRGa5JG7DJZMarFKoQ0KKMB+CZMIsCqGhlTsKrJhfHJ+HBQXYHmTDbL60SlvMQNIS6gTyTTgfWWBycQhIUqO6f5dBOPDWWAQJAtFdUvzGvJgjELyJpp01CZZUGZpLITVBoJmFppQF0Gs7Y8F/JLYNEecArJpfcPiLXriAXT1AcoM4Se8sukDm9j61tLSyT/munyPe1ZNntYRagg0UMxJeC3swkeMPWTqR1QpVkBFw8iIUCz0mcCtLhkIdwH/+ZVwqX+yALe12A3fx/BjFNd5VIPqcRtM0l72JanmhZNBmSQpFgo62xmDAxvLpMbHw9O/BZQkgtLUS02TMV0afRib8yCgNtMuRk0vh4kc/pASNxiZehAltN9lnHaZd26GzCbB8wKu6H3oION37oKXjCggr9gr2nEVxI9PtMGTvQZ302i4ANSmaZrQJ+WvxKKhcQU4UwJ6/eZ8jTx305AysAWTlsooi4C3rQyaS3al2nSuOYo4U3DG8b4qz4Miygjkq/kPaETyjMcs2wFjIbsUNFsc0ZJWFG82zBLzcqzHEw/XLhh9Pv0MulHWRR1xOo/0C+oD58PXurQURfFp88bn1ojkCpcCrl/oITi+bPSEZ2wY2wznYL62XfjPz2p/vJ8JqjP1dFDOoUBD4dRr2x57lpyJJUGHrRGnEIuLo62sgqnXCc0WCEH70mnYH51tXDRKZC1Nb3q5N/kh50tMHJ2AdT42WcLoFieMH/oCQNrtXBfqGVb+Pr309HyyFlw5OD2T58auBLpJwuQ/9c4dgD8LOtUE8g+e8MUfs/hAxyxE2bF9IP3JMNVy5dsMiO0447weVVx3bwPKo26ejsjuSuOK/0iCYqg6sHHcU/lWOJv1MvVV080Y44/pNYIDI7CXlldLZtdt2LY+Gr5PMNQV7L8dbVcWbRxVxZu6dXyVYpoVtIUtFquZ1ZvJbuYq+UjVT9CYZD3EQN/e08Ed9Rh1An7blg+9gMuwv6KJ8ut0GZBUCQdbb1SbgfqOEAHD2/G18PDAfmPcacjOgVE++o3BjuOHEfZ/oy5LPW9+vor/G9tLW6gWf7rYByQ2UfQyzwYHqSHdwrNbN9vn24aWib91Y74mhZKGtNwiBZhI5iApr1QGfaCaVe97AgEJHlQdj2bObKc3mRdxXjVt/PTne0hYDI0rSs+B1uMr5RrbOkjXkwD9Qt27d/Bk82F4cxDT2LQTcwV4HTXfBRtj8Mw9OXB2prv0KnaMGU/8MBAIcteMKU+lyA1QcctxrKae9mfqjT5JObDcYiMfICJ2TNqfswSZRlF2IwFIDXxLE9RsiROA7jgW8E1Yh3AfQTBZYQaV5069TG1X5sVtDkRbDZmPbFNCqiK4UUzfAtlI5/rZgcK2r8TRYWLB6FSarna512emDdSI6atHMkIq2mRvRt65D35Jf5hDoVfyN/hSPixcmmsGiRCFgw+82gehKVQ+gcLpbG61k2LUN0Mybz2/ndR0VIqXSiVzqrJsA55UmmC97+KQJrW5rtamnxPfpl59Dr8v1caBRjCYKo5bIbLZqrvwGGKvWoRQCYfABeNpZL3Gdar7SRdTdPduXN7Jd4e7+O/irP88P3M7+Kr+/D9ay+LmQV/nzGvzK7F+5nfq8mUUSxY6Wg/np6610+b0Ev//NbcD1BiSvequk3jU79lKKWQWFgBLs0O5uFJGmQE1+8Di/yHRMjIfxC2iqGpzyVpj0q2Z6HjNuXfAGcyHyjvYeGg8LpVbBWjEAPqKm+JqlgbW4DmnFmzTpzfd+YW0t4lrOMM8qmGIaulfBOS5dEbd/l//v68VfvHzzp/X120hQrjj6Sk5bmbPndfXY80L/3mEvyJR/Crk8gaEL5rGt99EucA8qVo+KEadpaHYkC/N8t2v2G6CZ9ThpAlD17y4CUPXvLgJQ/+PTzYVwbNXPH3FWXnNe7bDbOb5g/nvQlDeR2OJef9y3DeBUruD6OjJef9/Zz3vx3b1daOt0/ij2C6K7MPyq69iqGc7DlkQqpSz59/LUCK48GiWM64sGN+TCcgw3wfGzxSxSCXho8l6/+rsP6l0P3XZ/1LoXtp+Fjy4CUPXvLgJQ/+H8KDl4aPJef9C3DepeHjr895/9ux3f9Whg/4UNdXgHxaVS0KKmQX1mC5S3q9M7t4TdM6xNwim1HcGGomHMQRoL/quM+udKLB19wo0DU0igQckpxNUaL4E5V1rEsRFJJ40jlM3gPjSS0SsDpMModekpqVmIkP1xSpVf2c/qLqCek57MuKAd5SDwDYshyuGeDX9BXnawMWlmRIIYoWLy8CLJrLD/HUVfPpUcmtuFICLIt6ElMGjAfHYY/RQF16mLRUj+aaqhpaWJYGtiDWZojCoRfoXVDVGduZhzeZpRkCBy3bzPXMBFWna/B/LE3i+WoCXr/vcKHKreDT+FIjxYB17QFgMQHrB0wOSeiNmJBkhTqcqhvRHnQvXYqFYB7gEM8++v7+oQufCagLUGiqRnj4qcNO1/4ChtCG5lh8BP54Ix5C9VEq81wh/Sve4ldBmFXH87UvUiVXmbB9D6LAoY6qYOoysgzhQbTxiE0TwptMJggL7A4wGwIlQiiWXPNZIIFblBTKSggj5tN/m2SC6a0XjKRPLVbx+RnLK7v6OtxkYjooOWzMnD9+Glg1ue+ZsiTUQuOpuk/poKCD2v9LrWPB3GNeAMha6t18vc+/k7oIA8+OsNBMR9Q8K4IiHZrTQuS84xBl20V5i9ouF5oNjtXJUGnUZZlUsi/goSp3BSdKjxE1WWbrwHUKByK3SUMjgyiSUsRaJg01IvYClV1cT4am3CYXRtKQWG70738nrdqZhLqjXBJbz4Coifb0ha2qp7jMRF48aTtuBtVckyooEruPz6K+B7U+YT9CSkYEpYEOAIx/k3P9W0cS/pvUvAne6AodkN/yH3SRXpAf9N+/AdpS5j8y++D7//sBXeR3C9DWaBBmEPPZj3plm42THacfrOnEXLmWpCqs5uL2c/OoUrs4SnqYScGV9mit53i9NZeC5KRTcqX+d82mQbimugBJIo3b8uVROzuUiAYsLHvBIMsh4scJ1FfBtKwSOdZWfyS0XijYHLwI7ZHDn3mQHmrInsu+mwylfr8Vsz8AWoYg5UL7wZsdKul64XBxNvVPoYSBN08HGlq4Szk7lEvHTGQpQTIaWMNy/GaNBiHvUytck0M4RNaSJK/V3w8tlMVeQLepm58N3fruo8yiFunWPDY0sZaqo7L6I3GLJfoRpDTMs9Cu3MKh0mehNVz9rWCX9Oc/BXjVeWYKBObQOGnMkKKCjMsZbpF5nNmJM1j/3UD7Qz+HnBHjKvswA+3U5zOA6idGZUgR79r87vv90CJIuZyiGfWm2aGCqDcdMFdmIU4/XYM/Mvvth0ILQy3Ye81IzpxwFli9ZJl7Ka3MPNJ/LYT0B0Er8084LJpsMagZdRAr/xWfWkMGFj19W2eiZsDeo/gacay/lWvn9erRZeuotFleLw9D11GlQwNXXvVbSusGLTz0ZKrilRE5QXNmgVRyrAPIQPnW92ToUpGC6005OLM6daryn6r1GmsEXPBQXREMpde0JFqCAni2Mk7lJAple0BTE9g38UoYH2r5BRxv0rQ8b8TxOmxQlEJeqraax8RlVEYBS67TRcizIytjFMih9f6MCoO5tQwvglbFz0V8S4HuowhWAWMAM1YrNBt1RI7JKz3BcsShUuSDMk7GhuN6DSdIlfD9NGMwffgXNHr/UAZDr9EEEHeSSYmKCNbBgyuqA0btaTFjX8yFlDxEgSPnbW8A3EK8QFYP3PTMKeilldPKndG3i9rupBOSMqXjlBWTh0MPbqyOwdD1/WEZqcphgmK2kPuuOntQxQC5/WAybbEOWzxGz7OnqDL1GPEEdIB6xYPGSVfjIimW93CAOgsijse4IuBOQDWpjB8rk0zXkkG/O+aeg8v2cEBukgqNcDQlM+sxi4IiTAlSX/wN8Sw0/tiZfmOTn8ulS0NrqKFKajI+/Cu2Kj8QatsB6HlclTs0t8erEpOg3oEm+QisUN8njXBlMpr/9mNXc97onLO06lqLmfEur9qkftk+uqwd1XBLmkvk09e94y00MZ8gK9Vh4LmsSI55wPres6oJSNAkrvd+wNDigHjuiAsP/ACpOpOaQrCmJdwjj2aIMwzCggrPgXKnvGKIUAFbWdsmbuw1oKQS+idWkQV9xv4yjDOjj/72QdJIX01VX4Tsd8ic52iwwkPkV22N/VxId4b236QPuEBaW2S/FAuQiw8f/PorMMebwPn6FR4jG0I7bXx5sDIdv8r7f6fHLHdiKjQu7Wwx0XTqYpo3g/e6I01vlJ/oStPXvfwkZ1pH/Ob89XjD/khX2itrOe/+/I0r+gNda3ir1s9wrnXEz/Cu5coa3+1ee2WNvuHv/I0L9mN8cZpav98Z98p8Z/yJP2B+v8VN9wqA8+7CBMYviWOscPD5y1e4SJba4CGKQ5PBZOynQ5HnKnRnXHsfjtqFr1//H++5FMg= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF +measures required for browser-based flows. + +If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the +flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to +`urls.default_redirect_url`. + +If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the +`error.id` of the JSON response body can be one of: + +`session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF +violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the +configuration! + +If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. + +This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. + +More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and +[User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-browser-settings-flow.ParamsDetails.json b/docs/reference/openapi/create-browser-settings-flow.ParamsDetails.json new file mode 100644 index 0000000000..86e84bcf92 --- /dev/null +++ b/docs/reference/openapi/create-browser-settings-flow.ParamsDetails.json @@ -0,0 +1,16 @@ +{ + "parameters": [ + { + "description": "The URL to return the browser to after the flow was completed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies\n\nWhen using the SDK in a browser app, on the server side you must include the HTTP Cookie Header\nsent by the client to your server here. This ensures that CSRF and session cookies are respected.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-browser-settings-flow.RequestSchema.json b/docs/reference/openapi/create-browser-settings-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-browser-settings-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-browser-settings-flow.StatusCodes.json b/docs/reference/openapi/create-browser-settings-flow.StatusCodes.json new file mode 100644 index 0000000000..5ef8acd600 --- /dev/null +++ b/docs/reference/openapi/create-browser-settings-flow.StatusCodes.json @@ -0,0 +1,1682 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This flow is used when an identity wants to update settings\n(e.g. profile data, passwords, ...) in a selfservice manner.\n\nWe recommend reading the [User Settings Documentation](../self-service/flows/user-settings)", + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.", + "type": "string" + }, + "continue_with": { + "description": "Contains a list of actions, that could follow this flow\n\nIt can, for example, contain a reference to the verification flow, created as part of the user's\nregistration.", + "items": { + "discriminator": { + "mapping": { + "redirect_browser_to": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + }, + "set_ory_session_token": { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + "show_recovery_ui": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + "show_settings_ui": { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + "show_verification_ui": { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + } + }, + "propertyName": "action" + }, + "oneOf": [ + { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + }, + { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + } + ], + "type": "object", + "title": "continueWith" + }, + "type": "array" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the settings flow, this\nrepresents the id in the settings ui's query parameter: http://?flow=", + "format": "uuid", + "type": "string" + }, + "identity": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this flow. It knows two states:\n\nshow_form: No user data has been collected, or it is invalid, and thus the form should be shown.\nsuccess: Indicates that the settings flow has been updated successfully with the provided data.\nDone will stay true when repeatedly checking. If set to true, done will revert back to false only\nwhen a flow with invalid (e.g. \"please use a valid phone number\") data was sent." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the settings flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "identity", + "state" + ], + "title": "Flow represents a Settings Flow", + "type": "object" + } + } + }, + "description": "settingsFlow" + }, + "303": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-browser-settings-flow.api.mdx b/docs/reference/openapi/create-browser-settings-flow.api.mdx new file mode 100644 index 0000000000..3b394efaae --- /dev/null +++ b/docs/reference/openapi/create-browser-settings-flow.api.mdx @@ -0,0 +1,62 @@ +--- +id: create-browser-settings-flow +title: "Create Settings Flow for Browsers" +description: "This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to" +sidebar_label: "Create Settings Flow for Browsers" +hide_title: true +hide_table_of_contents: true +api: eJztfW13G7ex8F9BN6fX0rnU0nFy+9yj1mlVSU7UyJZrSfW9T5hDgrsgiWgX2ABYUazr/37PzAD7Qi5lOpbjNNl8iMXF22AwMxjMDAZvolTYxMjCSa2iw+hqIS0TKi20VI5JJZ3kmfynsIyzqdFLK8zBlFuRstIKw6xwTqq5ZbNML2N2oRLRaJQOmFuI0I4tZZaxqWBGpNKIxImUOT1SEyuymRXmViYihn5sHLqNSzkuTTZhS+kW2BeUs7MTGJhxi59+LIVZsYIbngsnDJv8GSo9ncTsbMaUZrc8k+lIXZgV+9Zwpy27FNZKrdix1jdSMGmZVElWpiJlUmGfRvxYCusGjLNMz6WiccMEGjOMR2qkzmbMtfFmmS6EEinAyFkm1U3o2SNjwKT7pAgJ64eYGKklt9DFDguGNQgpYb5bkZDwLBMpu5WcccWO/nb0PzVmCc220MoKlmjluFQEf4uocKa6dIyrVQWIHSltGGdfPv6czbSZyjQVigljtGGyMUc/PeZnh3CeiEKoVKo504qtdGlg8Jmcl4YDD6xNIpfzhWNGuNIoHPCLehiClUZY0ELrpTDsqHQLoZxMuNNmpI6sLQ0HzjgXtyJje0dH5/vMLbgCFBXaWjnNBMwDe5QptHWrmCEvJhw6LwqhwpChAo5ZcGuX2qTsP9lSTHnpFmqkEiOwDs8s21suZLJgS11mKeC7zICt2dHR+ZN9Ni3dxiy0ylZQ/DmSC2EDZ6yTpDR2wLi9wUZAQCPlNLNyrqDPiiatSLRK2YwnThu2R+Bbxkuncw54ybIVzheIXJgDK9Oa6JDg95k2LFlwNRfYY2uJHpjc2lRW0VjMzpBjRyrhVjA9gz4RE9TZBP+OZTqBMvjyt8uLF/UYU52ucPWmgmkFHRwC3BMrktJItxon1szGt1JnOKnJIbtWHAjBaTYTLmmw91QkvLSCcXZ8+eoZq9rQkhiUQhO/hmOpeOLkrZgcsheagdS7bHDBTJcqZQfVmnGSAzNprIub0AUqG+fS5twli8khu6olo0jZ5M/EFmOnJ4ynqRHWwioo7RjPgBVQXEyRUtKYHaU/lNbRqnlh2FrW3wF6rtbX9MXFFTt7cXX64uT0BGkmyaRQDpaOO5ZqHG7Bb0W9QbG944XRuRiwZ9KImb4bsDiO90E8JijxLeNGMCVE6gX4c21Aqs+0yQmxft0IW9yx7xq7xzUMcRlk1H+wl0bPZCbYc674XORCOXaikxL+wM6+34vjIYj0Ay/Th0jiQ0D8QZB1+3E0iHQhCBVnaXQYJUZwJ/5KcwrjPcv0MhpElXC30eF3bzb2cMGuX50D8r3gagp1pxmfwbZQ0z4iJi8y4UQKcEjoBXeRaBApnovoMKrWOhpENlmInEeHbyK3KqDQOiPVPHr7drAOyzdXVy/9PmsB068XQrHSgviF8S9PviUqDNDxohgwrbwYAenAUDqsdMlyIB+/U2OFRufsG8FTkEcW8D9dEXkhqcCMUc77/hbCCC9chbKlEZ6WkLe4qneNJrEAW+MOWOFngQPWCCI47sXO94MoiAcL5U8eP4Z/QBoJ5eBPXhQZ7BtSq+EPFjD4ptFfh6qGCygtshhbAnJhWwk7xJIjp2hWFil39c46Unsinses8KSbcscH1V5iPb/gwjR0EZZzpYRBjnkNKEl0ngsF2wpPw4p+12aPn8AJQN4GWMFJQhPJs00EHOH3AeyLqLq0pLoRc2md39Nz4RY6pWWWlk0FQEtS6cyR/ocaXbYaKZAnoCtEg/X1G+BKSVWKMWwXmwAdBwBA5bMO94wEyuyAxk5wF55pkI4kCAEBuJ05kDkDlHDijgMzVhPCTWkmjAAdwitgt8LImacU7GTASF6gyllw48KuBMh9ZEeqiRAkYidyRG8qYQ65VKCuwIecFwVM+PBNFDbDsedP4P+NaZ+pFCARYZYw6vUZkSbNeEpbLqAuBea0C72EJeBIRLegrpayc92JBTbXHbYz0E55tuQrWFE26YB1AtPe+MqOPSyvpVtQZ698LS9tr/QlrfkgEqrMo8PvOjHx/TqJDKK7g7k+gDYHADPKzQ8Z/+1gtyVoiXyqvyb0N8kZ+/6xlEakMEGP7e4B65nq6Q8icdCbdBl8SBqT2ZgGTMAKN9ZmNQ4KitM3omNVKyoiIuIt5V1aW8JxEsQzzKshJ4GYgMZAQUKWwv6RkXitiIs0aC72Q+mscz4T2Hk6vnes9aVwF2bllbIrqLRBbN0o24XcPhiIt4Noh8XCFiA4YTFoDN06EO1ObvfN815i25wCUttCL8dBqoxL+YsVV+uAAgWtfepat4VevvI1rs82CWd99jvRzE8c9u0gAqTBjNuYkGm3hDo7CVRS4XFG+ixp3tFhVJYy7dp5S5Ntl3pdnTbPiLc8K9HMg2pCS0DS7thUjrHF9atzryJWbd2q8CfXElgdBYzioIFUR5IhO3pJhGQ71Ic1BpDp7lLVI16i9r+VkxCX791nxTRBAXtwpqnsOQ/ENA1AA9M0Pm2h3qCRbmOa5ux3ZpqfMOwHME3LLvZQTNPq9FfENBXiH5Bp6j4rpmnq4Q/OOC0l/4GYZw3gwEBrn7dQ8z8atbYx0jpGdmamDwDhA5hq4yD1UIy10fEvj7kGEQEJZsext+B1zyuY95CEvcI9DXMMbhNZSaZ3MnHnyDtyYYsCHpC72/1in56YVi/IxOO7BRVZiYtZh+mt5/ae23tu/3fk9g3LdW+P6O0RH26P6M9R/TnqlyD8f7nnqN4815vn/q055KOb536hHNL7236J/rYdW8JMfT1uDF/Bb3FXSCPsmLvNCZ9S2ZGrlCyZC7Z3fXW8T2EHVTSJ78VHjwkfZ+iAeJbSLkQzHqGxcQ5GijMlltQJBKJR7BB55n3gRSWHoPUBgNAljLrk29kJM6IwwvrYIQL2kWWlkj+WIPtihrEphTAwSghnaG3rA5Q+QOOtnmQVNtrQ0B7Z9TjMQ7ZwrjgcDv/0zvjOryhi808y/WoX6RviPTpYV7HvQun3ezC+PRwOl8tlrM0qTnQ+THVihzcY2TRMtEpE4ewwNDnAyIxcpyLbb+KPs71FmXO1T6srFcSZxRsCxUckdBLUMZURQXG2EFmBdGLKxLGZFBgnYdhcT8vZjGc6LnSxOwk0IiBRsqWphHF59rIF4AZIVdhka7IQ+gOHRVZ3y3DIjQljPBuG/nieg5jAV3z5XFjL56LdLQT4xI1CFOZLbW4sWwpkF7fAoMIBu/z7OR02L5d8PhemsX95NqdJfyJ0E73MJMajbbBeXVjPvxEi4zmw0Qdt8mvIZhiFKGwrdmUDknWZRr83xDf014h7EbCjuaUQiqVyhqE2Dge1AGCDmOKRqiJuG+QC/b3030dKyzRZL704OzmGYFlXrJdcXVy9HKlM65uyGFuRGOHWq5xj4UiFCN/18tdieuQjf3Uq1kuPdSqgmEC/EasuyG/EaqRCONh6OX0eKcvzbL3w8uj5+UilAoRZJ3AnWOThqxd5jCGn65VrWnkGxSMFofOV8rteO2hJ5xBff2+hrNiYZxuEBWM0QtuhPgZKifmK7bW01v2Y+YAxiBKjmDvpFiGatSE/iCuZdCDrY1qYd84DVqqhAgVKA6OETBNgPO2KaBC1iCUaRIEuIohQwy78SpOAgsWDuESeZ9EgaixV1ORcWhDovYly32X9excdrGeRnkU+JovAgRMVyO697prKPtJedyuM7Twm/YMKKFbTNgI18as/BNcIiCGQfFZmpD7jXYegdJIawSjwtwWZVO4PX9ZQSeXEXBg8W2zT+oMu10AoTGM31SfLWktGQawUG49Lu2bVpglAPG24xNKlp4g7J4zi2bhLUT/1hWcnuHqK6YI0NxaaNewUa3dlQhy000iiI9W6LgOB76ruxa6sEzkeU6qLT80hMNoc5onqyUjxxGhLKPFdStHtZtly/pC2BXN99qg5PqYrEIKdBaDPThDfwEtwqMcbMSlqgq3P2gq1FtM+K11p4PaKzgvu5FRm0B+0BIzm8p/eV6UNaELOyGkJXgnrNLS2ZbKASOJjndwYzZPFyV/jXY4iuXAcosnHPM1lB5O8KLPsI+nE+DfcGLk+PwdP0wHE5pdZBn9Hh86UYjuTQL2/Wa3qkVuTKcppJpN/89loM+fKL7tnvdZyfrl9hGqrDyPAxK+vz07IYOJNk96z13W0CuL7KFSpg/WBoVztdBQdUgatLNhB83ZD6yDQPodNjeA343nGrR3PtBk3p/5g8/6Ux62NSXQaZT/dHglW2c7z2a3svjfUMo1Rc6p8jz0rEF4Qlp64No6BoKHqHEilABsJrDAOOO/cxl/h9yCt4d7XC+GAZxm1aG9wUG+hc3SKx3DthU1XtO/kZebkgW9TgBZgnTB/ZAgFXHG6uLyk60ZSzTMRaqaiyPQKrszAYVOUB4lQzvCMnV4f018jxa3kB0obtxDcOnZkJX8Bv0456IOlPcDP15fV76XA368F/BYlO72mTrAp1GDXlyM1z/SUZ+xr/KdxDqmBiAZRe+xoEPnh6C8YCFqWviZ+jQYRdb3T4eETTvltuLzVqZlcYlG9kddqCF78pOLGjUdkILyHHBSj1ubvDJeuW4HwQHQ6VWgYsD17MBoelure5BLuuHUP6LXK6oYj3DQFWI3OUfsgBj9kMHgXaI67DoPKJXzu0HCwelxd7CRvDRh38d6qctkKLmuL2Qwu3I78zVWGvdHtrpGSra9n/leDPKsPoeZOZPYeQ4Vpj7365QVqtyhsbBRXYCKXcJUL2ZnZH7O4+j4rVUKKbVtNbpiycL06jFe0jg1TmuqgK7ys25RS4W4xbVsDlutUzlakc6QC7n76poAHf/HvYO3mH3WqitKte4M8nYNuOodt3W0wRipmUokUe5/UFD6JO84qNMVPfs5bC1nqUmz+UdV6b9WmCqfyt1XBlN6+mHf/SP581Fj6GuQw5HuZ5F+THwfPEM6s6F4w1Qd2o1uJ0WH05PHnXx48/vzg8edXT744fPLfh//1h/j//feT//9BDhpyQO9yxABeLHdB0CVWpIMcnJTEXSJEyj7/A5yjDE/g+jTlzOCVWyuTuaTLqsGnc/n3c0/CG8BsEu4WGN5FyV2Yz2BD840eFv2VdrY98g+rgNj2w7KZ1n9BAk10vp1bRNfJt4qj8/krwhiYMiODu8MrNgXTe9VHY7YtdXyqdSa4ao73M8lir7ZuIiwVmUR7FV0xbmpNOZewhdocYx3r9QsFO+rANVJuUZ/y5H+PXlyLgZ+iGXeFb9ZaUUs5qfao7+vBK8tF8yCM/sGQP6HyVnaYhiiuspNHzrBoBwd0lRRjZ4bwkZjdCtcrKmxoXP6yOAUA4Ime20ZeDFClGvPFK+aN0yymTJlps+QmbeecoG2jTkJ0/er8EdzldgvIhkLe5Mb98E5CrdM0dEwEiq70+j35AHfVFMNr3lv5W3OKY11STGVID3Xm2I3SS8vcUlMFizlRMMIJEIEpS9ClDGYXlBAoGRKdZZh9YQCYkP7KPuocIQa39F59bfJGyDL0DPlibJkkwtpDthbVu5luqBrTi17mm85KiC2qUtwURt9KSBgFgMYjdQIpXlAnso6vGHASkaURBe6g2YolC5HcSDUPNkc0EYN8Y2nV2ohbYRyb8uQGE8HwDHLPKEhMQNkd6nQ1AQOMcjmMoiITkKmGMsVQUbGAnlWZT4UZRfuEVsqGpFzstUxlIT5qXPBVpnnX1hyqvKQaTTsr+EuoVyT7TXw6zRZa31hcJhR9DMRNBmvQJQG2OGwDc6M3ArhJSLcQBgOReCEnQBcTH0DTUinR1SsbmX6gh07q7rq95TM6CNO2631z9fycPdMmJ404qWoBZGgrwAWaaregJCVQFzHgcwT9tMjvmq4R/bxB8tQSRdLkT40vT0fRmzcs9h28fTuK/E71dBQV2rpR9NWkExs5GQ4pYLDbyoZ5S+46RDXgxLd/ROqwuHNr/o7SOp3Lf8LBOAzV6SxYs3VtcYA09h+0zb0TLkYgvTbSOUGZkHJhJFKWmmfSLrrPZFups+oXyAsOOTPNztRMjxRlzzqF/1eCiF3Svw19AVrAT6gH26yvsMtZdtfBOvd2RJUf5B6lopRXUHFTg2hXsN5uDrrQBp6eUxoW2aBbn5mFRNjLi8ur/S60K52uUeKaHR7KfZ4ez6bEH8ioIih9lGFNVoGh12cMsHHLMzS3AZdWyVcwHA1cxX7r5opN/iTz+VcT5vgc9yH6hKdhP8RXE0ypxjOr2cTqXLAigwQugOPJZnwUd97t8s48LHyT+xZGzLpJEXxfjyyDCmwvFdZBl1KrfdzY20Yeuev57GjTW7VtpcbdXAKLhNK4pSmgozgFOYHxNiEhD2e5pKxzMzaBCjEUT0CGjhSkzTMy50ZCuK/fiTDlGGt7u1AKXxRCQeDvF/Fj8E37g5Y3E0jHnEgWyscOe4OGtGwU8VEUj1B0MaBs4GlY6jP4/0jJfM7Ocj4HzyA7UskCGQ6nyy7xn5FK5S07kbfSX0CpDFY7MfWDDfy24tFegPcCfL0LFCOh1oB6rJm4cbAjUjuqRNa6wl8LM58rkWMD5O5Owkjl7eZKBKqFHJLwiaR6ZU4HcjHeSLuU6VyERIB+SmAG1LpKtnpy8ZwN2a0Uy47gVPAOdsk5LICkbuv3H41QqTB4PvPBHScXzzupDBTi++JONxu0kQD6NAlBXgA2b8TqgGznBZcm3Eg0AtXvOi4n9cgLYQQrlvNVyx0xAcgO4jieNNbrHrb9FHvAx94Cdt8BCPKPtQ0A/f+8G0GX9Ojk9dCki9sZr+gsMGk3AeXzDqVFQD7dTbr4Br9XYT0wq13CnnpVhQhV5vOPRaWwjD+3umJNR6zNVSAMcCvq0iRiV3V2KdOubI2v4fN7k9waDwGoftekYQaBxrewFuLiPXZRBGz7Joq47jK6F6V7n1FwyZQPHm4fUkqnQ3bYLU6DRo266zqhNfQNsQxo/GlDdtRoegrlQMP3VboS2UiV5r4q1yYbKe9fPqhCkbfXP6aqdXCyEstd2r0Qy0ZAsyLz8gGGF29vdKEEuBwgjBWCECDaMBdV6u77ZuXrvq5jvdc9DU7A/8kwvz5/IMfGtCJMYVJDjHEaa8DsFq3RL+pDLiqqxRZcN10BKCJcOIMOH1kWqnpntzcng2kC7cYNgdHwnGV8KrL+LNifBXFFcn6XCTXv2h+f87tzLMJTRMhF3KS/nN/JvMwZ9bBToHpIl925u/tuvTGNQc3Ohfs1aW6oJX0s3Q2Vg59be9MqyWRys7k2F+oYClrk9AO/5b4/eqiiPm6LO5FgSDr4RqFhHeVfLQyKWzrahhs+4ZEPIzDNziG7xmzzYXDPMjaE3MDai1ue7e17AOgejH8GgRlpb1DYhQ6ujMTwbIhxEjztpE+PAV91KyJCV0188GoezPnid+Ml3BpwVYcF3j/h7G/8ltM6VUEOtetyugI39cAP4BvbkLK8ugIA++G3YtXOqK4NvQETw0ssqwDzq2aV8NFP03ZVarU+x0dltjXDUqzvL2N1V28WbtRu7r1nSrp7W69XbvZ270Q76jTbhuwnu/TRVbfB4FtQT1mMWoijT83pbX5Zn3Crxmb/94G4i8zp6eZnphuUTN0u/gt1Do79nyCZob8PFMw49AfIZWi/m1jO6prbcPAAQhlR0svk3xRv9TK5p5ufKpNRAG1Lxekf0kLvj23b1Oq4xxIcU9kKxCkGGFGMJtw5h5h7DMCcwDJPQpIbOhoNqtRYXpCRh4uiM9CkACG6kEkSou+GqdFFqpeKGY6xV/iEHQR+CXGAwRx4iiBzH43DpzjMSIVxQgoiutKHg/FGjAQ1HjDr83wREJByBwLiMGIynL0yQQev67P2U2CQJQBe7JLunlj6V63sLnj/itEkMXieXG0zCvEIqNZWdCE3bSIXVqzKSOaPeZzZhGfcUGOMX9sjBhz4wLwBvmboTTT78EyVf1wSIqKn3Mm8EVxHd8K7lxEjKdfWseCYzIRmwWkPba3mpmf0nvhwmhwFvfrHIW05zcHukgZyxMcvnb9DV8jkBh9ZoxP3vXNrYNdjlMLhkR4w6HOkOpFKUK1jlTWQGm+Jr77XRgK2hDVD+kURuHY90UzBHdwdv9+y4SttidwNwG0aYsxNeDYPVrFizdCk29C33by1bmjxZi7kwPaEMfsGmgW22E7baT0I8x1VXlAEqsIQ2Km+66hy7ItGakHPeW5W+QYLuj0JUL7V2EzTyMCIBsTaUXqJBSM1LZ3TXWP/FQtGCoKC0Sac6YR3jXPCHVqDz6Gc6m+p1WXzhrLrV2cNfcKb9JqGfEQmGPk9ysDphKiBZi1nAM03GkQ0rwhDExrw+w/ebbCzpagnkl8Ekdx/lydwOVaJNy65rwtEtMt6Amh4IdbdmO8jLekuK0C16W/gdqW2eHn9qRNrhDxrm+IN03FoI+ddaSYa3VDaDqrICp3JZNUlfj8gkACN26Yz/14NxyPLqnpwyWDx72jY/qWEznii+rkt2wryI3YtDTzMCOri8eVLOPcfMaxJj5ZyeoYTs15aVHxlDsd9QY+SHtPjn+wyWDZeIonGI/W/umy9bxs6qC9SQ6yxnOEwYYh23wAOkjw8YxqggU6kixn0Dy4yjFZOFlrbagxsDZo+zQNH+1230jITxgjj+eo+PgxV7+HBrXEfvgsK+3g/V55v+vzs+emaLNly8Y4iOkg8bUywLXaarF9JTh9VpRDQzhAQIq/O2CoPLca7exsQ3ripjXGdftXgIX13nuffXmwU4OZjySHE+88ezN252L3//jfov1/rwrfeHtcJrXaOCiOLzJbIs83HkeoB730fqY9L+5WHMPVxab/CRe3j0vp9rY9L6+PS+ri0Pi6tj0vrfdl9DERPN31cWh+X1svkXzhv9TK5p5s+Lq2PS+vj0vq4tD4urQ856uPSeiLp49LgTeU+VqKPleh9Sr8dn9Kni5XYEDZ9Fqw+C1afBevhsmD1qXH71Lh9atxeRfi1pMbt78r0d2X6uzL9XZn+rszD35XpE473Ccf7hOO/voTjTXWsUxHjLJMWjSsNdYzenZmApvd0FM20HkUTpFs4KNp9fCFrbnRZbFLW1/CZ2UIkQJdBAmFl323ldYAYeqDfBF522a/pj01FpuGlLKdj9NvyMnPshP7F/huui+Co8N+1TBMks7OTY62USKoGRs9kJthL+td/hfmwc6lu/G+8OQAXA/xvp13Bri6uXob6Wt+UxdiKxAjHzvGXL6ruD4R4ggakN2LFfFiB/1pz7ngmjXXsrPrwDH4HeHjhkgVnx/Sv/2p5nrHLo+fn/ncq4DVaGv0E/64BaBI6YbDtnQKEkUwGtESDCFACmxRdMwEEwMfmvMGcUV9r8fPDbas9J+iF4IbDDc/RfVWDCoPDH0/GiVZAjDtxYU8OH0YO/Rtm/Tn/w94w63zyVVqWo5VeqiQrU1AA8eYSvu6nMf6o+ahn9eAzhZ7Ajj9SQUGqg42uz+ymwtjfiOpJtmGaqtQb9oJ01+fCcRzfE1tnZoCtmGsowB/P3xseqKDnYAYRbpBkkBh8en3Un0LnXn1oPMfX2Du8KGjol4D+tmYJD4s+Ip3unkdNO8QNPly4AZd/BrR6SDE8gHgvnVRPlW6hN5qruCsgmh1eWG6+ttx+AxnfQh1EjYea6eXfBg6ewcGnhYMQRsqgqOPC+MahM7wTi/XfDqIvHn+xSamn8DI1M8IWoDrR4RwPBSDOBs3nkAdQC40eVCsVEFSbUvAjPsJKL2cz1HWw4VrfEMfnVoU/lz15/Dmq/18+flxJXYXSjRdFBrq81Gr4g6X3Wik8cItZxXGVQowoPAqNgYFwNCSRQcy7KftJHm2iAxsFkDdapWJazjdbncDn+tlnrNXcpep7EqUtcfJgSOO3XGJcDm5t8C6y03ilQGEETtx6lB7fQueOT+EFYp7ywsFlBG5ZibXxLWOJDzWLEN7XJei3TBtSDIRnQwlv4Q5mG4LmY9beO5qgMQXmM4VVL1W6ddxxa9BNJFa/alTOSrOx5WsyBSnuSiOCZxUHaAN8gZxB9oKzE/b5ky++/C+WamERWnEnbSeKuuwkZydkv/DWEkLR2Uk8UjOBYIyVduN6QU+NeUYFL7Q7Cp9H6sdSOz4Wd4kQcOnj1Ji/w5dT/6Eh3Tv7jQZRu4edxPvDglir/R0Bq15ZaD2ATsjybbY+e17aMR4UO16ITjfePqcum+Jm78vHXw7Yl4+/gP99PmBxHO+3qAHKd3K7b9sA5kKBIoUCwtvJNzYC4q6GFK+EEcmVV7Vceaf0xr6+pkFJTH7ei8leTPZisheTvZi8T0x+0YvJXkz2YrIXk72Y3C4mgwenF5W9qOxFZS8qe1G5RVQCYHxukTIMjo5rf3egzerAcCcymUt3MC2TGwETvDHcaXtQlNNMJge5SGWZI20Ati4RJxbzdmZczYG54XphMNh7h1T0F21WQ7rbDbZhijQ7jGReaOPYm5FijLFnHpyjQg7oy7FWMzkvQ7aCt3TD+lGjt0d/hEAi8JI7oJW6NnvKlFi2e9jb/2Ooywt5pkDaJ8LXbIy+1+ppH4fIBERwudKoK33IiOL+yIZDkGXXr87JMwfFSFZTo5cW7q1rxmcuJCIACzgI2pC/IY3ZXvDy7cPtAvLfQ5hguJO/TyMnWt9I0RwX7dPH+NkyukRfYhYaGOny5Fv0lFVw8KIYBGlnhbkVhlmZ+hjK0ta+SRdM39Q1+0Zw8DaiAX26wmJCPECJgYy+u4Uwwm9OQtmS8t9wx44vXz3DXckKa0kgE8xgcYfdUSS7IiKs3RvPrwPcxthb9pTxJZetRY0TI7gTf6X5XzYcB3tEWmEtPaURVCO1/0eM+PO0/LVu0DDc+7gVTfIteHIDQirnkNUD3EtIznsjNXKj4HUdRfRzlld/akt/6UIoXkiP0FE0l25RTuNE58Oawg/mGmrj/CHLDo62tw9MM3JhFuzwKRtF4dfYy6pRxIZDTzPsX+zBSBVGJoTRuPT3llF/vYQKKwKIaEqdw6estarxC7Fck0HQiBfymKDranD08oxK1wQRrbgtBswMYOeCxlVPcSXAXp7Fx1upPzj5/8qTG3BjqnRvfz9+5SlnL5DQfkx43SMs7MenlBaKwJczHP53T5mSGVHiyM1yFz8rjFRutqdtfOlSYcyAjbwmTNEEPMtg7Sc7ATuZHLLf345GahThfPffMdCzMsuIKILa3WhPrd/C/4bDqgLtKJPtIByy5k9ovTm8hkwvo+hVu8/dptiEUNhif6TeNiXQy5VboGM3SCHYpbdupNqsxlQ4UghE/SHOdSoyGwcf6hhZ3LdrT3G9pRHAd1TzqJCgvxW0IWPNAnERKtAvYI3PIBBNqsDqC20xZjawD/Kal/R4Xlk4V9jD4bDI+IooMy6MBqXGxtqseCEtiEbo+FKI9m4fFyvKclOHbGYZs2UBMIl0TTUouOG5cMLYGPeUltbQmHibcWmjwGmA0NsV3CC7Ae5TiA1nPETa0IECM/N4VcQfQUDPC+uIdRpAHQWGXxMOmBKnkL7aIUH7GSPK2z4It5aqQltZq0SNEZuaUT3CfnMfHTvNnrJH1Y+wFzxin8FO8LCbT71fw5jtzace8Ne97wAOnFn5ZW4tdSusArnCyx1bV4ZlrETg09bae81p7DEzbgmMvWqFn1Z/DTzET/1WUY+ComBv5M/7fjQ9a6raB1/dN9whSsZmj9RlE3xfKlAqsUo4ATuIw01Y6gqtDWl3kNjvLULFfs/EPkaR3x3Y9OYg1QkadhrnHzA2yTlZF6LDaLtKuo/BwobndJKixNKVOrdx0F0/4H0Yb0XNkyemW4f9x8NAa/pOCH5lzNaBku8HYT0IEZdrsUhzvb7c9+hg7q6hUPVr/+++9gUpaZ3svkWO3rfqY9de9k+85v2CtxZ8r/kjztN9NKmJOyeUpeyX372J4NbH4TabWpXrqtu2BqsR2lcbSyM/Vr/B/OZort9gfttr328wv6EF79pgoIEP7Qf/EV1UhORM0dCKbHYAgMpEDAMNDD1ywEaEcyAqgFD9w8py8cbbK8Y2K+dvO60XQ9x4jASHXrgLVzUhD5t3u0e1HWRjPf8XcAke9RfCLbW5gauF6FCFXupUCeh1huy4tJbfNVsca2V1Jr7fC8An9AGAje1iGIAf+pe1hnPhDqzjYP3BnLmAwZBz/xIiAGg+U25lUkUFwFLQl4o+YTxgwanghnLt1zXp00ZVurqJt6EyvQxPzy20kf9EU82x9062Pl63lmaxSg2PU5HrMEHqdAj/xxsxuqAJ6Nksk4pu+eDXKpcuHXC9nx24x4iZEXbBnL4RyrI9nklOibgnvpcxx/tHExAe7U/v3z90UQgFPvDoFVUCKxTdOGX+yil406+gOt55gT92xIOjRg0vKyH9LSaPP0KYqePNOI9Gpg+h0kKD9RKEhRKUA7tFeGAluxGrmvCWyyXCAtwBqhlQIpgU7LAQxoKB5oBQdoAwou/43SRjVq+1ubEFT8RRIb8VXdk+7oebLUMHB5m4FdnPPw1M1jPTIQSHJ6igUhrfw8gbY/9C6xiF57MigOySyjbTTHzGzpQzOi0TMjif6KSEgBQy1qLFN8sY6c8oiXmaS+WT0t8KFDpHL89szI7aBfCRblmqDPNP0GRF6g2uHNKyyJS99MhgRFJErDF7SSNiLyDsc21dyPIgVdiaLGa5+Owz2LMspLuQlqV+BowmOvXvhFBPVUiFF4GNFaRbSdWAjYgfi91XCfVnGlJMAD+CC6GEG2mHAMa/2Ln/7S1i/2IneokPieCe+lP+gy6aC/JA//0LoD1o/cfWP7z/fw/QRXe3AO0JN66FmO+Kchqn4rbmOP9h6L3Gdlib2Pc7cfvdq9Ojk+endQ9r/mGb3gynmZ4Oc26dMN5fbP2/w5QbN6QuQIto4jZ+cXrVHkqVc+FibeZtCVF9rqG+MKuYHBDD/YeEVjslNuBFaE8zeSdNc6iFuIuLvB6Kfu+K2QeAViBIndB+rdeHqrveOlzl6v8olDDXm3TgoYUnfNpD5fxWqDYlWMFNsoirkiE3Ts544oZ2AZvIsHZK7n84tJCNaQvdNh4cCnRb5D/YNmqRbsPnQBPDRszQ/kPiFjPDIUhNmNeh3XsNm8pMuGSx/1PBPvDNPwrw1HlrCgzm8PKbl2ukSJBJuyYtWp9bnLiG9Q8GulgUHeSMGCdveQvaVSHXAPVfwpGhQbzDTe77cGgRpE5J8aqcrtpDmXK6movctiFufh3CHy1+e1BoYagtvPcKjtKtoRKwbNpY6sapLHzyf22F9IGgtd07HObqSQTERx5WloejgicLwZ7Ej/0jEfUxA3iPYzHi2Le1w/Oz49MXl6cHT+LH8cLlGWWsMLm9mF3SiRtO4E7bRnRnUDnh5CyMJT02A2Sgflto63KuGnC90227fp5uRLhHV63TgFTS0as0tjaQHECgdwq6KRg0/CBwMo3ZBfj660bpoGXnCe/iGJFKg6YM5vRITcDi4A0OMZ5wq6CSuJSQDmBCgQ2VeejsBAYGTRU+/VgKs6pjMNjkz1Dp6SRmZzOmNCneIwV4/Bbt4+zSm1e83Qafj0GTThoUZX8KHUAACD7ARWYpP4HGDFEjP5utnaIwLEXgE0iU9ktV+fk8MgZgmPiUCAnrh5gYKbC4WeF2WDCsQUgJ892KBPCGw4NGksM5+OhvR/9TY9Y1nfitsOwWUeFMNbzQpFYVIBbfheIQUA2UPaUXTyj2WjbmGOxofnbhnUWhUjjPaEVWuXbETnsSlGnHGy1hwC/qYQhWGmFBC62XwrCjZrK1kTqytjQYBXOO5+i9o6PzfXoiDFL6aWvxza7qATOf88IbCOFMueBFAblqZq0KOGaVjes/q1fVRyoxAuvwzLI9ygq39K9fWYiDlYodHZ0/2ceUpOuzwAPs0dH550guhA3KSZgkpbEDxu1NeIrSQJ4uBjZk6LOiSSsSrVIGGp02bI/At5CETsNFCcpuAfMlW+IBmlcD0SHB78MTVcmCqzmZWdvBWQ9Lbm0qq2jMZ00UkAqMwky4JzHqbEL3OmQ6CQFQGFJfjTHV6QpXbyqYVtABHpsnwWg4TqyZjW+lznBSk0N2Xd+XAeWpBm4qEg6mGk4W4qoNLYlBKTTxaziWipKFTg7ZC40n/ssGF+A1GHZQrRknOYCZ0OImdIHKxrm0OXfJYnLI2vdsJn+urP8TxtPUgD1D0hWW8DgfXRsCMwZYTH6ALd8/17W5rL+jFJ5ra/ri4oqdvbg6fXFyeoI0Ex7Maz5thxl3awv+3vHC6FwM2DNpxEzf0aULhk6F2qCu8NYIEtNzbUTrIo9fN8IWd2T78rvHNQxR7a7/EfLasedc8Tk9G9ayYny/F8dtqzqS+BAQfxBk3X7j+gmE8g3x6T/Y4FGzeOPN899FzY7QGk/t4SErb6L/fhBBUCFUfvMG9uprk719C59xY0DDffWIEfkP7lUIPtB10zkp8kc3vUfBhY0RUMFFEB1+9/1beMkBHCvvCXjT6QNr/JHdPiP1c/h97kHmcXCE1ZisHP9gbCyagQIb9xhbDqGvT6+it2//D8Ez9Zs= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to +`selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is +included in the request, a login flow will be initialized. + +If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID +set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. + +If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden +error if no valid session was set. + +Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level +(AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result +in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens +automatically for server-side browser flows) or change the configuration. + +If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the +`error.id` of the JSON response body can be one of: + +`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was +found - sign in a user first. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust +this in the configuration! + +This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. + +More information can be found at +[Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-browser-verification-flow.ParamsDetails.json b/docs/reference/openapi/create-browser-verification-flow.ParamsDetails.json new file mode 100644 index 0000000000..cb748d23ad --- /dev/null +++ b/docs/reference/openapi/create-browser-verification-flow.ParamsDetails.json @@ -0,0 +1,10 @@ +{ + "parameters": [ + { + "description": "The URL to return the browser to after the flow was completed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-browser-verification-flow.RequestSchema.json b/docs/reference/openapi/create-browser-verification-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-browser-verification-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-browser-verification-flow.StatusCodes.json b/docs/reference/openapi/create-browser-verification-flow.StatusCodes.json new file mode 100644 index 0000000000..f29dc6ead8 --- /dev/null +++ b/docs/reference/openapi/create-browser-verification-flow.StatusCodes.json @@ -0,0 +1,1015 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Used to verify an out-of-band communication\nchannel such as an email address or a phone number.\n\nFor more information head over to: https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation", + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.", + "type": "string" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,\na new request has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the request's unique ID. When performing the verification flow, this\nrepresents the id in the verify ui's query parameter: http://?request=\n\ntype: string\nformat: uuid", + "format": "uuid", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the request occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. verify your email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the verification challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the verification flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": ["id", "type", "ui", "state"], + "title": "A Verification Flow", + "type": "object" + } + } + }, + "description": "verificationFlow" + }, + "303": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-browser-verification-flow.api.mdx b/docs/reference/openapi/create-browser-verification-flow.api.mdx new file mode 100644 index 0000000000..23d1743605 --- /dev/null +++ b/docs/reference/openapi/create-browser-verification-flow.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-browser-verification-flow +title: "Create Verification Flow for Browser Clients" +description: + "This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to" +sidebar_label: "Create Verification Flow for Browser Clients" +hide_title: true +hide_table_of_contents: true +api: eJztPWFz2zayfwXHzk2sGYnKtX3vg9r0zrWdVm1i+8XO9W7CjAWRKwk1CbAAaFmX+r+/2QVIkSLlOo3T3vXoD7YJAovFYnex2F0Q74IETKxFboWSwSS4XAnDQCa5EtIyIYUVPBX/AsM4m2u1NqBHc24gYTyOVSEtuwEtFiLmCIAtUrUO2ZmModY2GTK7grI5W4s0ZXNgGhKhIbaQMKsiOTOQLgzoGxFDiHBMWAcdFuKq0OmMrYVdETysw6bHzIBl3FDRTwXoDcu55hlY0Gz2V6z0bBZGMpLTBbPN0RkW8zSFhN0Izrhkh98d/oNp+KkAYx3OGkyupAEWK2m5kMaXxuoGeyIUECFVWMblphqToR4vd7s7Pbtk09PLk9Pjk2O2UJodnk9ZnAqQ1jAuE6ZkumFrpa+NG6enmWEHRyutMhiy50LDQt0OWRiGA+rlpdJI7YXSmZuEmEuk70IVMmHcsjdnesO+19wqw04yLlLq6nylJLC/12fvWMVFBtLS09uDlbW5mYzH6/U6VHoTxiobJyo242uCNcYJG/kZG9OMjWnGNiPAXkaeQ0Y8tuKGYA7CYBioHDQ9TZNgEsQauIWv3Tjr2DxP1ToYBtVkmmDy5l2LW4G9fvWCWcU02ELLBqNZxfgC2aDiljU3LFZZnoKFBHERCIW4JhgGkmcQTAIH6cqqYBiYeAUZDybvArvJ8aWxWshlcHf3dhiUzGHw/adPn+If5BOQFv/leZ76sYx/NIjvuxq85kBeG5ICJ0wb5EVV2JFajOY4VbHKskJ6WJGMV1xKSJkp4hVyPpcM3LQmiQZjmNKMs5zmVxbZHDTxyXOlWbbLKyvgCUNmZlZN2OPPOM6gxhm3wtGJXkGbAodUPmRigQI93BW4pTDWcQ3LwK5UwuyKk0zNQcglKwwkIZtSidc86SaSUlkEh1O9M4HDAG5zocFccdvG5sS9OyR4iIEVGbCD15dHA7ZegfRYkaZgHlDISMMA4qKZsajm1sKswNRmFt/7aRpGkjMJ6wrOilPNeak7PY+6yQomQcItjBCRrtGIpD2K6THTkGswpF9qKD8xrJDipwLY9DhkP+CActDYEdISK7a0+pCUZyR3AIqECbltsWGFeGJ29bBjrMl4/OWDdPxXf/VoPvtSJF8h6+JoJ8wNNvLcO2FFIZI6ffxzmzTGFJB0zvOUXj1smlUcF1q/z5z4ljimdtev3EtUX75zz7dOoyF3o7ryMCBhC60ytlXlxO1e1SP3R9IqXFPWXCfN5cBJElQz9frViyeG5dyuUFO4ucLFCG45qsZOYdkqxY6B4KtLtSuyJd5VU+y4E7ix3HaohAss3uVgqsuUX8t9L5OI1KJSBq6cepgwbq630mgVc68ZL/XHAYTLsOTajSq0U6KDSGJnV/QwIQhOuaJ0zgEkw9cIsAQeyZwbA8lVvEJrQi5h0uAbnEVTxDEYsyjc2tuSsKop1XbwQiSN1VwatA+ucr5JFe+Q8suyyrmrgexU+PUEIbGEW+64p1Oysd5KqWtngbjBWsjylFsw2+lS8x8htoQTFXStxQ7cJgdiTBB2BRr5c8ZzMUNmm/m1eUZ8IGyKkC+xgZeBCkInoxSi3e+RZ29d5xTOvr18+YI9VzoLGWIWV7UQM7SwvIGl7Ip9e3l5TnWJAt9dnJ2Wk2c61y+3lrfXLyWZWakiTUqZLO3SBcF2NVC6Z1/WSp5Fwbt3LPQA7u6iwLPosyjIlbFR8NWskxoZGMOXDi1hIaN/mtiSOXLbofiQJr79E8N8tZC9NoA8SrovLoxVmfgXLgllV2EXP7ilp1KJQtr//XxbT0gLS9C1+Z4eExf9El7MofSDFtaCROXFM9CCOEsuU2FWnVTZz50VXGSvSKKOZFO5UJEErZVmJ/g7kl5W2YX7GwwDkEUWTN4E2AIfsR4ah77C210shsHtaKlG2GyEaBAVHtbZnV82hIaEuqQVDUnlO3m7OwFbuhbiEitWNAi41nzTqmAc7yCHten00ilHUePbhr48P7u4HHSRXapkhxObgE/xPeO6ptCdfJCgQgoZCa4ia11oJjnag+z1lCE1bniKr0OU0nKdcvaTSqBcBblksy9FtvxqxixfDskMpiKZF7bs4qsZm+NmLTWKzYzKgOUpx4URbi2J2Y64W6vFvLDuKRE4pExIbpXGgoznORIAa7alb6Vh0c2KqZDXTwzDCuwgAWMRJG6QaI3E1awycrR4qLl3WBp1IgFpxUI4qeuaqatuKcFJIm3cWHSFITI/MSQ5pjSzOcsEsbJasBlWCPH1DHVoJIVhuRYZ1yLdVKsRT1G74waMWzEXqbAbp4XPcpC4Ff4sfBoyNpWuU2N1EVsmLLMQr3D/k6YbxtM13xhEIAp4FIQRqS6GnI0yjVM9xd+RFNmSTTO+BGSUQ7QPUOBouOyC/kQyETfsWNwI4/YqpaTzBwn1o3V8V8lor8B7Bb4LgtRIWWvoIG6F+O22vWO1w0pl7drOW2WGMssl49SApLuTMRJx056JkmuZATJZnFYnGcddBLKLdrt8thbJEqhzbpkfEuNkbZabkeOzl2zMbgSs28o3TrnpWEoOGb1Ad42DvDW6NMgENG11vIV+fPayk8vQKCa1nSQC4fL0vNF3u0GTCGhTOyXIc6TmNWxGNzwtgOVcaD9kJIwz5ssNQ+KJ5/2DsGEZ31TmItJvhpiNwjCc1ebrHrH9PdaAj70EPHwFcJh/rGUA+f+3XQi6tEenrJdNuqSd8YrPSiHtZqBs2WG0gFiuOhT7t1Tudt7ABI6q7gjZs2j0popnVJEtPxaX4jT+1uaK0XH3Gk2M8cQwowodw0PN2bVI7KoN8Acsfm+W25EhRNWvmq6bYcnje0SLaPEeqyghtn8RJVp3uB6x+H16oSnDXtqblMKqMqzRPSv1GlvQtN44z2Ne2DCSzvnTxOyw1pSiR8jD91W6hDSShb6vymudRpK8qdKOcIFcK53cU//IVT33NSMpYf2Qdqew3rZR0nlqRzHuGfc3OpNwKTI4UglEEh18ZGisYc4Lu5L3jcrX/cFXrYkoEZYMQfyN/uBhsDt+ZMfasDBSVscY2+0i8yCx7yf1USeVzGLD5yl0rGsXUMZFEOATw8qqbCEgdVagLgBdEwuemrrCmCuVAif4KZ9D2u8F+70gzUjGbzE00LU+vuS3L+gV7SK8j7vBfxm/FVmRMQchfJjF5gLhnau7B+udaQxrdk7cH8lyIyvpY9luZBz81tabknEq4uv23JzJI3zRYKcf+Q338NYrEa9q2224hbhAPy6GsLAhBlsE0a2aGFK3bmv7A8wPUYeSRXiMsx9jkHvCXhvUS2XnXmRMGWHDuYcbnh4MPALEFwbiQuPkamGuSdmVAC61WC4BPRHGAk86+dNTwFfdS4gSVJ0evBoHs/71L9PFb/erFhnPKdjP2Xf8hrt5YotCuiBQrtWNSCBh8w1GfIe+A9/Y+MCRqTJAcD38HjbNPAmlWaqWAqmt9KbE+VW9Slnoh2m6KjVav0CAe5vRW6qPCF3Dprt6/WWrdn3tnUph7229W7kO7d6BdtSpt70Aa4VcmofA6KpbE/A9pEfrboesrqg+vHbJ7oAbNdrw70PxITqn55vfmG9IM3WH+c/kCwzu/wrNjPA+UDFT1x+gl7H9w9Ryuq25jwaPoJSJJL1O/q+SrV4n93zza3UyKaCOUBT51nDDgUnkGP0xTZ/aNouwwMBUukF1SglGLhM4kgkshARK4p3hNM/KfEy3NRpW6eFekbkIl8vOIJcCJgBjzloKsR0nWuWJWkumOeVe2RVG+dhCA4womYN2Ec7d5/rhc+omkmU/qFGFLMAlVVNnvJYj4RoPmVFu/+SQwMzQOY+vKfmw3Hul4DZer6c+HJYohgm5KYb/MHmX8nL35Iu8qidz4SqUAnODRH+KIzbRunKNrleY39dB3KROXJwx1xhXK7fN48zEPOXaNab8tQMngEOfQD1EjmLeRTNgBrQ/2oDpdHNuRbZNsHOd75nGSLbnMefoB/Oj4G4NbcxmOzJKI+hmRzc4lz/qT1qYYp6h3yUp2VEY5liaDAIRXwOuhm7Hfe/YatT1FGUgLa6GRuEeGvmgk6gOq12qshpRw5a7xA3yXh8J+hJ2HOlneSm1jSyoOzxKYC3ojty9umfDV9qTBFsi13bE6GtHVzeLlWiWTbodffvdW7uOFu/mIglsDhhdKc4tsMd3ihVqTlaifEeVU3qBabQQX8/VbUeVI/8qkiuRJLDrNsUq39KL7kgCvt/rbHbDSNGJhsza8faCXkRyXliruvr+ml5EEnOyySecqph39XPMLXmDX+B7V39PrS6fN757/Wpasye8S6/uyCdiopPfkwyDTkQabNYIBrjxBsPAjSug1IQa/r7Ahw0e7CnqmeTfgknuhvfp6lLKqUpIfJOmuL4FEwwT7CpE8st6BqhFIXbDmO+jLSmWS1i14w3cbOSeKK/fdVIN5vFpq7dYK2OUFmg23weG6jFXkeUqFfHmkXMeybmNu9L78HhiWFUP0/1X/4mO7X+X1BnPVL+1Z1sqGXdODR5JRXPx6OIc9/2HjGriwQ/yI6y5O9SBbg2rmMhwuw/uXMiRO9PHLkrPxjmxaBjJf6qiNGpX/AYqADgBzuLBXGOxoG7KLpqwER1ieQGmwgaBCBsyhI8hMspW9gdYfB/UGi19Nw7q7U/dRssCtAbt5eo+OSyr3iODe/M+PAiX9vF+oTzf9OX05cmOLqlOW3ZldDj11BpgU+3URb/SnD6rShKinSkgjr06c6s8tpTv7n1AdOpm64zrjKuWEdKmiu1zo1ATIW0+lh4iuv/mydydk93H7/8L4/c7IHzr/Xmd2OrBWWHOI7Mn8+yuchpsTt3J9m2H5GqHs0XHmfo+L+0Pn8LU56X9ASe1z0vr17U+L63PS+vz0vq8tD4vrY9l9zkQPd/0eWl9Xlqvk//NZavXyT3f9HlpfV5an5fW56X1eWl9ylGfl9YzSZ+XdjfscyX6XIk+pvTfFFP6/XIlWsqm/wpW/xWs/itYj/cVrP7TuP2ncftP4/Ymwh/l07j9WZn+rEx/VqY/K9OflXn8szL9B8f7D473Hxz/431wvG6OdRpinKXCkHOlZo65e2dmaOk9i4KFUlEwI77FjaIZ0C1ZS62KvM1Z32AxMznEyJelBqLKHmwVdcAceuTfGG92GWz5j80hVXKJ+TchxW15kVp27P4S/FroogxU+HIlkpjYbHp8pKSEuGqg1UKkwM7dX1+K42EvhLz2z3RyAA8G+GerbM4uzy7Py/pKXRf5lYFYg2Uv6Mm/qs4PlPkENUyvYcN8WoEv3Uru1UJoY9m0KniOzyU+PLfxirMj99eXGp6l7OLw5Qv/nABe7ud6P6b/twjUGd1RsBmdQoI5nYxkCYYBkgQXKXfMBAmAhfVxoztje6zFj4+WreaYEIrDGzc3PKPw1RZV7Bz/+fQqVnT/24OksGeHD2OH/g6zfp//YXeYdVylS/mkGXnphYzTIkEDkE4uuRuWKf+ofj8mGU44Iy71xF0cWxpI22Sj11PTNhj7E1E9y9ZcU5V5w06d7foSLKf+PbN1fhlgL+VqBvDHi/eWF1S462CGAS2QziEx/P3tUb8LXXrzoXYdX23t8KqgZl8i+ZuWJV4s+sTZdPdcatqhbujiwhZe/hrQ6iLF8gLEe/mkuqp0D7+5sRYY1XBX4tYt5uZV7f529J1h3LW2jTe7N6rfDYPPnn7W5reTLMfc+PJKc9pJkmmPSmlYvx94iLXIdeFqJeCuU6cURrpKFZEvUL0lzo8EO7AxG89ucr+7+vTpX0K333Um4a+/Rf3S3Q8sE8z2xJuSKcUPN3lO+J0YtrW40yxtklCjEu1WqwTmxbLd6hiLt3chU636erM98VCYggiALjF+wwVl2NAitb0JHCTl0iDOnvx+nLhpn3O80DjhOV5yjxcHF1Qbmy6Ev2bYJ+p1qew9w8aPBZQXgDq6lacpmxjUb3j2cc6Y3CI4njnOfCE77+MmoFeNTttErJ62pFwUurV4K+fUkdwWGsoYKXXQRPiMJMTt/KfH7C+ffvb5/7BEgSFs4VaYThLtuVWdPBHe7+FIND0OI7kAQuNKKnu1ndATrZ+7F6fKHpbFkfypUJZfwW0MgMc3TrT+Pyw58QU1Pd0JNxgGTQgPUtSPi+LWgO9IPfXLfuNWcEcs32bvXeCFuaItX8ddz0nrQnAHsq5yDj5/+vmQff70M/z1lyELw3DQ4AZ8/6AA+j5VvgSJJhEpCO/xbql0J101DV4pI6dXXm31yi9qcYL1jevUIcaXhjhDU+8097cjpTcjzS2kIhN2NC/ia8ABXtN98aO8mKciHmWQiCIj3kBqXRBNDH0IJOV4lS3dx31RWgDewg3+pvRm7JLFcXlyrutJILJcacveRZIxxp57dA5zMXQlR0ouxLIojz/cuZTtJzVoT76gy9uVNBZ5ZVubPWMS1k0IB4Mvyro8F1OJ2j4GX7PW+0ED0oC6SMH6u+gv1YQ5jvuCjceoy/BSbjL18TWxlb+onFyIC1uebEBfIira8kBIErKDctswwHQF5xDAuEOZ5D/YDu+dZ9Ohu5L9jj1jfM1FYyxhrIFb+Np1//ed5fvAUbUcRiQHX5DD3M/cN6o2Y+4G5fpk5Ty+RpHMOB6KQeuMJu8gkpGNyk1LFLjHRVb9q4z7T+UgeS7cvLEoWAq7KuZhrLLxdj5HS4W1adh4SI16Oxggi0S2RJxNnrEoKJ+uvGRGARuP/cywn9mjTQyiEtkmc02escZwwlNY77AaNuK5OHLD7WpweD51b3f4zQ3V5EOmh6igsHEFKaz49HwaHt072+UG8WseX6MJLJODwSB85cl2UNJvEJ64M4QOZ7GgPv/0jEmROrpHdpHZ8HmuhbSLA2XCC5uA1kMWeSvHbT15miLpZw/GcDabsD/fRJGMAhro4Bc6e16kqbMRS7Oq1t61vsNf43FVwWmM2f1oTNhuEUJpo6HwiFAUvGrCfvhw69iCyQeRvKvL3/nGrmhXUMogauS9SlPpzZV7GUlCZFsQZiqB1IR18/2KmNy3bQ93F4IGY8vah7nANTt3Sphq5kSXsoJ7Qjn5BL2ZQiIboGCtlKHASylLZJ56NUc26sra3EzG4zzlG8eiYa4VLmQmVHrDc2FQQSDgC4Cmhg/zjTsqtfX7pykzRY44QbKzHORc8wwsaBOSQm2sFLWBN6XYKUwaBqqch6JbajDE+wQDjIyX7hpnRNLxLr/8eLMT1/ZyPqlODanDUvp3NAWdq8qFrzZx2H7CHBfu74Qb46piW7FdBms91lfDbQ+D+gJyZRV7xp5UD6UefsI+QS382CoYO7Z64wfZGGhrb0t84aWQHZVn1Mp2OJ5KPzxrEMGvn1cex6uWBB1Uw31W/TfYgiZBOIj8Dsd3oRZ142L01S/1MSEdUYfqwNbx9m+B5JJV4okMAZM2PtsKDVX9fmixPxvCjP2ZwYACcrcjk1yPEhXTlrZm+eE2WyzdviqYBPdbJQOKvWieOTvSfaenWt5bZv6uefthXBbU7W76ehUOzHfu+t1FmGKGaneMv7AW29vaOvsfOODcLU6dE3uPuNw31CvbHOvvP9CD3YIwSwa0ZYJbC9K449Jv3gUYJpzs2zNVh6O690644pftK/GpHajqxagXoz+mGGFD7/FGL4iL3+OZhWBsIF2MDGiM8Y7r4x97PNECBn0D2lEAT41OKnvsnbfCrkxaLO86bbIxiZgW6Joqw8RVE+cr8g7kYGvdtUj5T8wFRN/wKdi10tcYdSfXIELZZhGS/xQPjjtSv6m3OFLSqBTeHpTIx64AkQ3NalwiP/YfnRwvwY6M5WjT0nFypGL5OZoL9GW78cy5EXHl36b8YCqpWAP7QxacA9fuMzTbmq6oVdVlNVCgMFXr8qusK6XFv2hyjryfrVH4ujE1q02ieZhApsoBOqBj/E3BIpW7AajFIhXSRSuotDpm7owW7zFGu0XDQoNZMauuQRp2wFPB3TcqZh7KFafQ3AwFp1n0/vARRA4SvbnBK1cJbWuXjMF8Ngb6hS+xOoWD8J8H0sG6RjV/oSP6HX1X5ZBwdoDbEYtaEizIJFe4J8PMVgnu8xANxkPb/xo2W8Zbr9eEC0oHLkLIiWgmmnEO2qDhPXIkGxGO5AX9ZZbRmx+UvjY5j+EwF99DVyLs/XizdQlglMINpL/9MCiPfaHKYBKPaSl2J9wngd9i/s3NY1B+WTJAzC7cu3YG5idsKq1WSRG7bfSxigsMrbhNC+1j05Q5S4G2yTzJhPTfa7kBUjqH51MTssPmCyx0CQgypdRMN1hI/DaSY8aySNi5JwZzLOWYNWTnrkeCgvG4TBlbJkAKWa4ShhJAP/mEXRx/bzATVBiW+BEwN9C5/4SWg1QFB7wKrM2gC/VVHdZiV4bAV9+aWSjMvkR5RAdJgcHaCaLxM3vhn/0u52d2rNb0jS0EwH7ND4KoT8gj/fyM2I4aP2y34P1/HgFEN1jE9phr2yDMm7yYhwncbCXOF4y9R9iMt46DQSdt37w6OTx+ebKFsOP7Ncn1eJ6q+TjjxoL2vmDj/44Tru3YgUBLok7b8PTkstmVLJZgQ6WXTQ1RFW+xPtOb0DkHxoPHxFZZCS18CduTVNwKXe9qBbdhnm27cs8PpewjYAuEUie236jdrrag93ZXufE/CicsVZsPPLb4dbtmVxm/AdnkBANcx6uwejPm2ooFj+3YrHARGW9droMPxxYPKuzh29q3+Eq+zbMfTZO0xLdlcckT41r0a/CYtKVDU4RSHeddbA9+wEVlATZeDX4t2iPf/KMg74A3hsBwDOffnu+wosNMmB1t0ShuSOIO1T8Y6XyVd7AzUdzFAhrYbnKxg6gvKbcMNeYdt6Xvw7EllDo1xativml2pYv5ZgmZaWJcLx3jPw15e1Rssas9sveqMDsrXIw+HBMKVduVlUX+v72YPhK2pnuFozT2GDDSP6n2/Yc5j1fAPg2f+u8nbbcZKHucXhONfVszfjE9Ojm9OBl9Gj4NVzZLXTKnzszZ4sLtunEXbpWp5SmUJifunEEbZ8emSAyyb3NlbMZlDa/3ccfvbq1raVsuCbfaGAgprPt2G+bNeIN0hNlLCdq6qpCW1T0G5MQI2RnGNLZtk2HD61F+RE5DIjTElpJ1IzlDP4R3Q4S0520E0cJCXBU6nbkgTuUwmR4zA/SROyz6qQC92cab2OyvWOnZjEzo6WJn2yMMeePxu3SC457t8LvDf5R7UYdzFUhoJMNoiNUN9uR8NsKuFH5oT26qMRl/amunu9OzSzY9vTw5PT45ppnZRp6MS3LGjQTtwdw4yz0AOzhaaZXBkD0XGhbq1ifHYC8vlYZGahXuSMo0LvwsIu3hvid/KKMvYVFX5ysldximYYffs8tzvtWm44hmzLmPNiParo08h4zoiJ+LmtUyhzAiN6bPQCJHkyi98z6pN0EdtJOBCkv8sJn3S70dBhgfxAbv3iFXvtbp3R0WEyO4O3KqqzXIgXYv63+gr65zYM7dXHcXlh5qCuOUfrFg8ubtHX7ZgyfoIKr83LhjzOt+7VZaZcOz983JZXB39/9iKBbe +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to +`selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. + +If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. + +This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). + +More information can be found at +[Ory Kratos Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-event-stream.ParamsDetails.json b/docs/reference/openapi/create-event-stream.ParamsDetails.json new file mode 100644 index 0000000000..6d2900b86b --- /dev/null +++ b/docs/reference/openapi/create-event-stream.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-event-stream.RequestSchema.json b/docs/reference/openapi/create-event-stream.RequestSchema.json new file mode 100644 index 0000000000..35f4e44a61 --- /dev/null +++ b/docs/reference/openapi/create-event-stream.RequestSchema.json @@ -0,0 +1,36 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create Event Stream Request Body", + "properties": { + "https_endpoint": { + "description": "The HTTPS endpoint URL to send events to. Required if type is https.", + "type": "string" + }, + "role_arn": { + "description": "The AWS IAM role ARN to assume when publishing to the SNS topic. Required if type is sns.", + "type": "string" + }, + "topic_arn": { + "description": "The AWS SNS topic ARN. Required if type is sns.", + "type": "string" + }, + "type": { + "description": "The type of the event stream (AWS SNS or HTTPS webhook).", + "enum": ["sns", "https"], + "type": "string" + } + }, + "required": ["type"], + "type": "object", + "title": "createEventStreamBody" + } + } + }, + "required": true, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-event-stream.StatusCodes.json b/docs/reference/openapi/create-event-stream.StatusCodes.json new file mode 100644 index 0000000000..04889ed5a8 --- /dev/null +++ b/docs/reference/openapi/create-event-stream.StatusCodes.json @@ -0,0 +1,241 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Event Stream", + "properties": { + "created_at": { "format": "date-time", "type": "string" }, + "https_endpoint": { + "nullable": true, + "type": "string", + "title": "NullString" + }, + "id": { "format": "uuid", "type": "string" }, + "role_arn": { "type": "string" }, + "topic_arn": { "type": "string" }, + "type": { "type": "string" }, + "updated_at": { "format": "date-time", "type": "string" } + }, + "type": "object", + "title": "eventStream" + } + } + }, + "description": "eventStream" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-event-stream.api.mdx b/docs/reference/openapi/create-event-stream.api.mdx new file mode 100644 index 0000000000..e0c1dcdd25 --- /dev/null +++ b/docs/reference/openapi/create-event-stream.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-event-stream +title: "Create an event stream for your project." +description: "Create an event stream for your project." +sidebar_label: "Create an event stream for your project." +hide_title: true +hide_table_of_contents: true +api: eJztW21z27gR/itbZm4idSQyl0s7U2XSqRL77nQvtmv55j5YHgUiVxJiEmAA0LLq6L93FuCrSDnJJdd+UT44IgjsGxYPFrvggydTVMxwKSaRN/JChczg6R0KMzUKWeINvJQplqBBpb3R9YMXoQ4VT2mIN/IulHyHoYHJyUzMxNUaIXUtTzVMTnxv4HHqljKz9gaeYAnSk+sy55E38BS+z7jCyBsZleHA0+EaE+aNHjyzTam3NoqLlbfb3bjOqM1rGW2pRyiFQWHoJ0vTmIdWk+CdJtkeaqSaQr+xWoJVE5yecOkogyU9IBFTVIajpuFrY1I9RxGlkjt2TYKk949XVxdTKPrAb5e/gJGgUUSAxEiDkb5lQ9oCXwLpB1yDpU6m2lN44CkZ45wp0c1x/PsUJuNfgXrB+PKM+DGtswRhs0YBabaIuV5zsaI3Zo0wPZuCkSkPuwXRolsMO+RxOUrKJMhnUrcNXYTtSLm0olsbgnaT1StYSpXbfYOLtZS3feKAIku80bWnhfYGbu68mxbjXd31rt3bqpdckIeSuNzE2LUyrKPsmmScB98PpeIrLlh8QUvnzDm960+9dSqFdo71/Nm3X+DHdQdu+awTOJozS3YpVUK/vIgZHBqeYNdUtP1cZHHMFmQBp1tzSGWesyyOpyUdHjV4Zpld6Y+69+NOd9BpWi+yNPpMtXeHJx1rQGinumn/xuuB9+LZsy+YTHJ4bZiImIrgXG3hp+n5GYwvJoBKSQVOFb81z/Zth2/YQYWztUZFuMhW7VEn1AykAeNCg+0FXDjeXAofrtZc02rOdMbieAtCGmB3jFsvASYiWDOCOlggoKDGyK7Je5ak1qakZ8QMWzCNwCKWGlSwYRoy25uGLrmI3KKPMSFTdvjOAbVpsZF4drQ1Ae05bQnyjQQjMpHMVIgQyiyOrD4LhKXMRKfPWqLzBtO2EcunypTLTJk1qroxQQorp2AmUxXQEYOmwOfWL2HDzRomJ/Dt8+9e/A0iidpKi/dcd5rIrcKmbJMTsg6DTPD3WWGiyYk/E0u0YsyFNPNqQk+V+t69OJNmXDTPxPtMGjbH+xAxwoi6/ZtaTvOGGgp30vUGXpNCG6AJR1dySGSGpIM36ib1h0XcDbwEtWarjt3nV/eimr7Kn/IxnVuZNsxkeh7KqIPmGxmR36UKtQsHSpJuGNAw6L149mIAL559R3++HYDv+/2GN9D7Cte4MH9/UYnChcEVqkdBbYUCFQ8tQLzJsWp/N3Sr66YaVIKRw5XLCleabLpQkkb84Jg6mPzuCJNHmDzC5BEmjzD5GEz+4wiTR5g8wuQRJo8weRgmI1yyLDZHqDxC5REqj1B5hMpDUElWwjBT3GxtHUeq7e9S3eqUhThO+c9IzTdUZNGo7rqrPbSACSHP0GykurWzpGQMacwEWik3ax6uHUxhRJCSMEHzuZWZagzNa0DaItemEMRWCDIVeyOXix4FAUu5H0qhZYy+VFtfrz0S0rCVtgaztRWyGKXdt0PFDMY84Wa4yMJbpKlasPBWLpc8xCGLEi6GsdxYL6d5n9rZdcrGTKxIy22KU6u1N/BitkAS519SbYMw5g4VHXLRvCepVAYeZgIAXEVJj1M+cM9vpFjyVeYKbEVbVyFhJnawVDKBpzU+T19STY10N2TpihK8AoGbJvVe/2XRl6V8ImhHCzHvWcrVa9DpWwYxmmI2JtEI3KJ6CUFQ1fYAapW92czV9qCX7700zZmIcMkFRn1HsLNcMupWnnhVmj7kq3JgNyvYwStgG8Ybavkt8j1n3FKP3NidYsxE/6W3G5Tz/YOszbNght9hfYpTFt6SCyeMCxIzn/LeTMzMzAUd92bmucdlUv6U2v2SKQqWcjenMPNW3KyzhR/KJKjmeriS1LtPDJaZCC23Xp8ca2ZKrWD0CmZe+TjPsWnmQRDkEwcf4MC8uVkjep1WIdp/bcjqn+Gmc8J6M7tGKvZ94t/ZFT4AqTQzTQcevYI2q6Y70yCW8jfObF0DxhcT93bPq2kkxV8DUAMCehpcUvLztXAx8VsC9/LJ9F+z8HalKBLp9QeVU/XbQ6w5Ou3Z90/vMcwMOlX40oryl1cgeOymdWaWifG/TxUXZtmT2p+aCJUawCwPIm0VN2RxTPP69hHB374dwTd3s5mYeVbj/kfIf5/FsS2clnFqbbwbvaM/QVB2cPD0ts16BLUnGtTmKjNDXC+bpB7Tpy4O6rQ/E7v6ir3YmrUUtVVLyH8QnKXazt3LmbCsqwY/kRHGOseTud1M5q7IPF+Q++YkDoD2AWp1MgWFhpH2xym6eZB3HKecIiW75eY9U2vNooN7olX1BE4IdG2Bf42wlkRFg7RjWWy31hyj7cmg2FLTmG2de/vFNkxbK0u5JlgiwlPE5p7jp1s6CQGDmGtDMTOLY9BZSjJhtLdBVXdGfIvrjb2rpnhzzTvMtmoQzn2quAVuPrFol+NsktV2TbT2YZlZozD5udBah5qk4v/Zl5qIcQEsDKWK7EZqzwBEhaIcFyFBEU9BKmMebn0adeowUVtjIQvXlgckaNYyAqYsHN9xCowXGMvNgCIlF5K6kWDWzBAlzQzXS47aBU+WDPUNmUbf6fum1O81MoWqqc8I2jHeZ88GC0PUem7kLdre2kdxx5UU1zPv9en48vRyfnX+8+nZzLspp+FU0NGSQQ6nznZMAC+ikvzERaYsFqbtU5NlXAD2HrgD0wTmebeRE/JJvkAPM2Fa5/qkfM6r6KjGsQqSKvr9Rlgx5xG8gqfVU7EDPoUntP1+fO+tYpIOrGnORedO0y9V7d5nib5R29ws+6Zp3KEh/7SOlYvoV2NI/xL3XzVM1oWUvcogg4Pa9SvyFr8ohrDpgJyNXFZR6vCfHVRGdj+ok3F06sLmb9HiJ5QwSj6Do7YAVYfGTvsROeAbbUWBbwD79ixyP9TR7TCSoc3w1I4PlHXiK5dm6LpD1OsX9+vcASS/H9d916g88XU6gLd/+mtdraP9s3kBb9JOtOxT+cgZoM3EXtIzmRJXjm79LuFu4K3kvlE6ojBzXwueOi30xQocEn/wJ07CksX6owZKXWjT6TnNVfeoZeZ7N66+tl3aC/wjpul1tvpJ1P8Ez33EZr3ab0utnQf5VAC0yR6DQnMpnE1vKSlyKLEw8O5YnOGhBAOZrBhfwkM55ggTR5g4wsT/FSaouwvLyR7SpvLtPfWRFxTnjOChMtQucLlGS4OWchH+T6mw5Ko7C6Z5WBabHDZQS6k0nWlo/hY2Xm/2dE2trpKC+uf2NmssN5ZNI8x/kye9G42/NXKo622kmB9hIvMUauCIBvSXNAll6hSQy2XMBbEfg22FwsYuRsrLNxQmKVwq1GuwRwMNPRZz5o49b3Mqc3d4eEtz12z6fPpEIkVBpRWvuKvPBJynKCYndBASuZteUXd3gfgWP9UOxg2qJe+d0cn8aju2MjvC7fKhzE9wXFe3/7cyA4EYkYjX9bQ3nUZucXvTK0TabDZWFkoH0hYRhFJQVKqDFJWmY/zQmWxoZbQliY+7TEdu/zPlrnLywxjvMP7fq7EbeFS6vaw++TgtSjHtLzIqXK8uldduqVd3yWuNOeoJbWt2YimLIjIL7Z6MCePkPXmS41959aH8jIWMMHXvvFbQ8QQmVBuJstAlck5kmFFJ1R27bSYljt0nGqFLRVDkwLVRNgFtayXji4n2Ydx8QY0QMipixluqmDq7YpSfoRncsZhHcJHbHZz3unXhw4XjaKlQNiKR2sRbV67hAhZKbrRL28zEkycwPflZ03c9XEOUawBO0QXq4nyta4Vo7kqrNWfx7cZRMqzVrLUlb41BY5YyjuWGlj6l+TK2Qj0iMT7AL/lzfn77ACdyI2LJIiIAf+QfkahPyFf694GkHTb+wX7D5//7CiS6yZK0J0yZhmGu02zhR3hXLe68IcgrITqo8hT9TtteX56OT349rSjs1Tx0dBssYrkIEqYNqrwGovP/g4gpEzgStFfXbeufnV41WYlshcaXatUEo7K5kvpcbX2XUwr6X1NaaQS25LXSnsb8nqs6qzXe+2lSsXLPn2rZryAtWpE6pf1B7rOqSB9kV5av/hRPWMm2H+TS/sTuWJNVwu5QND1BI1Ph2i/fBEwZvmShCfSa9qugKhz0v1zad+yOHfBbktad9kq/TZN3umla67dFc+ETQa0i3P+atqX9z+1YdZn3pe39TpvKEk247v9RsYf58D9FeEe8oQKQDhc/Xuy5opOM6z20aDQ3VuKe1b9Y6HSddriztbiraDWk3aZ8T9C8pTid1Jw3aK++L5fWitSJFJfZYttkpbLFdoWJbkpcbw3oR2O9fVVpidWBtXdJpaAGq5CSOdrnsuJWNuW/Dkr6laTV3Tsc1TR5iHTDZ1SepccpC9cIz/1nrdsxtPaYfW1tnI/VwS+TN6dn09Phc/+ZvzZJbA9EqBJ9vpyiuuO2PhoYqWv3k4qQk7JUqLSLY2Myho1v6YicMFGT6zMSa3v39vLYm6pDVN7j9sBmNXvIz+DXRYqCxBk10hWNY/jNwKOCIQ14eKCrjb+peLej5vcZKnuniZJuiruvWOlKE9f2dmSeaWnJVl4j9XrFZ8x9+Ph37p0q5Y1MbGvpQm+QJwZrWu1u6PNbZBElBcrMY35LbGjzGRWB1u3WKtdIwX5qHu1bT3tcnE+vvIG3yL+nT2wqwVOM7kfRXyusqyfb9IBtc2X4zN7f8xxNOqzZXEI1t+Whrkh1XD90m+PhwfWwB5TdrrROfia/2e12/wX7s1BS +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Create an event stream for your project. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-fedcm-flow.RequestSchema.json b/docs/reference/openapi/create-fedcm-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-fedcm-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-fedcm-flow.StatusCodes.json b/docs/reference/openapi/create-fedcm-flow.StatusCodes.json new file mode 100644 index 0000000000..870f08ade7 --- /dev/null +++ b/docs/reference/openapi/create-fedcm-flow.StatusCodes.json @@ -0,0 +1,164 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Contains a list of all available FedCM providers.", + "properties": { + "csrf_token": { "type": "string" }, + "providers": { + "items": { + "properties": { + "client_id": { + "description": "The RP's client identifier, issued by the IdP.", + "type": "string" + }, + "config_url": { + "description": "A full path of the IdP config file.", + "type": "string" + }, + "domain_hint": { + "description": "By specifying one of domain_hints values provided by the accounts endpoints,\nthe FedCM dialog selectively shows the specified account.", + "type": "string" + }, + "fields": { + "description": "Array of strings that specifies the user information (\"name\", \" email\",\n\"picture\") that RP needs IdP to share with them.\n\nNote: Field API is supported by Chrome 132 and later.", + "items": { "type": "string" }, + "type": "array" + }, + "login_hint": { + "description": "By specifying one of login_hints values provided by the accounts endpoints,\nthe FedCM dialog selectively shows the specified account.", + "type": "string" + }, + "nonce": { + "description": "A random string to ensure the response is issued for this specific request.\nPrevents replay attacks.", + "type": "string" + }, + "parameters": { + "additionalProperties": { "type": "string" }, + "description": "Custom object that allows to specify additional key-value parameters:\nscope: A string value containing additional permissions that RP needs to\nrequest, for example \" drive.readonly calendar.readonly\"\nnonce: A random string to ensure the response is issued for this specific\nrequest. Prevents replay attacks.\n\nOther custom key-value parameters.\n\nNote: parameters is supported from Chrome 132.", + "type": "object" + } + }, + "type": "object", + "title": "Provider" + }, + "type": "array" + } + }, + "title": "CreateFedcmFlowResponse", + "type": "object" + } + } + }, + "description": "createFedcmFlowResponse" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-fedcm-flow.api.mdx b/docs/reference/openapi/create-fedcm-flow.api.mdx new file mode 100644 index 0000000000..83bb03de41 --- /dev/null +++ b/docs/reference/openapi/create-fedcm-flow.api.mdx @@ -0,0 +1,33 @@ +--- +id: create-fedcm-flow +title: "Get FedCM Parameters" +description: "This endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network." +sidebar_label: "Get FedCM Parameters" +hide_title: true +hide_table_of_contents: true +api: eJztWltz2zYW/itYZDqVZigyTbP7oE526vqSqhdHa7vT6YQZBSIPRdQkwACgZa6r/75zAFAkdWmbxO2+RA+2BALnfDg4d/CBpqATxSvDpaBTepNzTUCkleTCEAWmVkITRgquDZEZYUVB2B3jBVsWQC4gPf2RVEre8RSUDsnMEK6JFEVDdF1VUhlIiRTE5EBeqYZcgllLdRvSgMoKFEOus5ROaaKAGbiANCkvCrmmAVWgKyk0aDp9oM+ePsV/iRQGhMGvrKoKnlgC0a8asT9QneRQMvw23NSpFIbx99gHDWilEKDhjn+iVbYw8hYsH9NUQKdUG8XFim7sZLcSn3IDpf2yQ6LgIMyCp/v4bnIgV/PPNXFzCE9BGJ5xUAHhWteQkmVjZThL5whuD0AiRcZXi1oV+9RPSFYXBamYyXHnngxxS0jGCzhIMpUl42KRcyfvIc1vGqIrSHjWcLEiUgBS7q3Q5I4VNehWptsNsCSRNT5vdUwHscAH7ghSzgq5IhoKSAy/A9SjXK61Xes4ckhbKgdxZxyKVB8Qg1KsQZhuKpJkZkvTcag1KMJFJlVpNYuMYipYCTENSEwJlIwXMQ1iEdOKJ6ZWENOxI3Q1JwIg1Va2RhKdMwVkzU2OlMswFrG4lAam5AIBkpP5DE2ls5JlQ05zJUsgX3z5jDCRkoIZULjHrUbtbdYPMNwb/i7k6v3OrFvwfzwyIUUChxRXMZHK0p8YShWErhVY0q1/QCl6I8mkIgYdmGebEAXvatAmjMVcwR3gLhRUBWsIM4Ylt/ognoopVoLx9szSlCMiVswHBr1vMUOnU2sjSyKXv0JinI6worCCke1BkI42uYVmYk+AdOynsdCJrGBKTlohuCmJ82g40CNRgSq51lwKvaOURsbCyyKwYoJ7VlYFoFanit9BqICl1m8nrACRMrUdiWks7Akhio89kS2MkBw7EbSUVyYHRRInwkOS6dlTNzg0qEzJsmdSvZN2Z0I3m92RgBpuChyYe4++b2SbbtLpMGhd+f0fYLSnHcmRpZuAPv+oWIexRBuGJ5jakPvd9atL621AKamI8237Ec4+3Sd3bhepbmfDVSks69X+qjMcbpVUEzur71dDYvMMrkmta1YUDRHS9OIxer+cWUtZAgGBgyli9mrr95kyw5ZMA2Epqwwosmaa1HY2Ls24SK1iQgElivKAqR/Z9iUrrRrb1VYEGAb2EXhlhhRFJGuVoGnWRWr3swSSyVqkR/kuBkz3hbj91Ykyq5U1jX6Q8vmVYBiQ2hBvGQwBv3KuyMak2Rn54tmXz/9JUgnaooV7rg+K6FDGMjtD6TBSC/6ubkU0OwtjkYGFsRDSLLoDPVfqwj24lOakHY7Fu1oatoD7BAAjzrlS/8GRcz+A8EVd0ulrepAuDeiQAn2zu4GA3k9WcoJkJrgHOj1M6oMhbgJagtZsdSCC/egedMfX6ZNfczD+aMNMrReJTA/QPJUp6l2lQFvv2ZF0ywguI6PnT58H5PnTL/HPFwEJw3A80AZ8Tp0O0SnlwvzreQeFCwMrdH6/4yFXIEDxxDqIU++rcD6aBFeQ4qE563rTLdo6I+dX3sdjWlovHVMXbTNWF+aTq/zkKj+5yk+u8pOrPOYqERhbaasZynK3Z38/kaqZKGag4CU3k2Wd3AJu8FYxI/WkqpcFTyY5X+VWM1BW11YiSOqBFkys0LSbCq4tbxrQgi2hoFP6tVRN5JoZNKDO2lFWJabm5CEWhBBy4cGcVDxwI6e2JVG7tlAsNi6F/7xH7fOvMO9PpNDGNzD8bPKCCFgPKYzGX7VzWcVnAn19An5mj/toQGncY/HgFSWw/pNsyAvC1owP6IU7qfxo/BXdBFv5vJQ9uQiGFXJfJBVLblHtsXOCfL2IRrGITewC273BCgx/ZuX2q9Tum6xAsIr7xlFMV9zk9TJMZBl1UpusJM4eI4OsFonlNhrjQSCNoSCnL8iAaHgJ6x2x4iJW8VPH9NCCk/nMPd2RLa7ECBkQFaAp4uItpXB7JvNZuFNbjbwowm9YcrtSGCtG43F4fg9JbcBB4pkl+Y8XRPDCbs7EJitNeFEpLkw2kjq8Nikohd0cZ1brHASWvAWWs29/B8Dbt1Py2V2MrR+LfPwH5C+w5/btzc18mxH01rvVG/wTRV3dbNX97S7jKTlSZ+Lyff6yNsj/akj093bWBwa6Gsdi09fgeWNyKXpajH7jqHFL1Szcw1hY1t1AWMoUCu0NZpEhgEVWyPWi6xw4Ikc3vEtRgTbtopOKY6SpnPOwMysrmXaC+4U6/4ScQebaJxgTcqld37ryjRRMqnx+aTOr3JhKT6MI+xRO+cJKSXS/OpSqYRXXaHJI+Bpg6JnCqrFtkGHvuWtTDK1v0OHY9XC9jQ8t0rlPu40XJKZ/Fm7rExD3ucCskBFvZy71YYLw1m36ZAkjUnu+dk4P1ElryTtWT5hGK/fTpg7tE3/Kx5kwrd1UXMs7993j2PfiHQe7KVxoVOO5OY4vwfiu5Xwr5+45Ethq4osB132dRZfTLrR6NYp9musJyKwfYyb/3qMwtTbXJ+Po9GH4p2D1mmzVGwUK030A3YSBX/sDHOQzbaGQzwiM6cbmBjq9naQysZVLL8RjNcVXLn3e72KNxtQ3TzFFeIMJDt4f3bh85Vi3bBPQldylvOf+zX3P238gm8p5soObGBztB9AfHRkPy3RsczC4NyBsb9amT7fQ0OmxJCygtt95OBlD19yu3h7TdsWn43qM40IjKMHkMrXpu7EcTE6nNNJQZBMN6o4nEGWQTpIy6l0YBBSf2auD1w/UXsht/fGD98ILXdSrzUGfHNmTVBwLqvYScbvEVTi+7UE77053C4BfZK36961k7qgQpBKSX2RNEiZc1c8N4a4qft1fcSqFlgW8GbXgEzeAYEOdRy34KKmVAmGiFZiJNgxj2jj0ItSQ1Iqb5ho7MG4/S6Z5su3K4Am5kW1Zg/zw9JfAFKjhTDe0N1Wy2uTPcCrqg7u0qU0uFf+vDUCnvjocDP40OJq8SRULUyhlu0FHNMK/eKh4DWMpyywruAB7P2VHSVvGOafr+xzodxVkCnRO7MWxJiNWcKZtMvDWU1mwJAGt36IKD4fen767UxfYg6BXbhLG1lcViNkZnqdADZidkRt7j41lIX75k3Jwl9/9KtcJHcWvmhOL+aa9IN/ps0m8WHX3QNtXCxpZ27sphDhQPIz9t9B0irdery0WtA70daiJGOZ0VIHSmK9NnMgmFqOt3f9YZVTzs1S3umIJnFT8e/Sn74mbrFsCkwLuoPj7t4EdJ5HJtgXKEuvx7S01Nklcivm1O0ca2JtsVKv5jFy7Z/u3lk/ITBgl0zpxafSZTGpsCLoU1Oax+C6BDUc2TWZpyQXXRtnS1jqdk/lMh+Rk+AAHrdOxl4xLe60MWkPq00iGN5s8JXMvDOJUyilrSOaOo6WCF+ul1KZo8HxSdF9LJde6vRZ88oRcn32vY2E7p6nfAXEbXfqrfkdp29Li+++okJvtNAX9jqu25P3dJjYu8VoX7RELppqtAO9tY/Eb+cH/9lnab+RMrkUhWYoEyId8kET/QB7p8xuinQw+ZHfg/T+PQOIwWUR7xpQZCOZ1VS/DFO46i/MDke+x6KgrHMYHZfv66vzk7MfzjsJON0Wnt9GykMuoZNqA8t0V7f9HKVMmciQwjejLNrw8vxmyEvUKTCjVaughtsMd6leqCV1ZFY0fE600AvbwWrTnBb/nqs8qh/uwKjtW7veflewjoAUL6SDal3KXVUf6KLttY+wv0YSV3NcDj/Y7dseGrEp2B2KoCRqYSvJw+yRiyvCMJSbSOQaRqGvBjD8e7a/sjh3RW0Traomt3lblr3ooWqu37XCrE1Gvazt+TNliBHQRq495F+3oZwwqGZgkH38o7Ilf/peAd8QHWyC4h/m38x1VdMi43vEWg+GBJe5I/aNBV3l1QJ2txF1vcIC2qfgOUD/Slgw95Y32re/j0VpIBz3FVb1shqxUvWxWUOoh4v5ohF8G9vaoaJHVEdu7qvVOhEuwUaBDLntVWTvkvx1F+kho9eEIh91hngAW7tOHbaJZsSQH8ix8SoOdShhtj9nHVsZ+rY5+mJ2eX16fT56FT8PclIWtUkCV+lV27UpuLMGN1L3btTblxMoZlHZ5LL47qW1+W0ltSiZ6uA51AXdL6N5LBX/jO9E+u8cGLDZvua3S/Eu9rv/wmvb7DzSgrgNBBy8tvgko9oJx9sMD3vr/pIrNBoff1aAa1yVpuwz4axPQHBi+7ta1pjD/rvqtqL1XKwZNkpfnN3Sz+R8rmvDK +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network. + + + + + + diff --git a/docs/reference/openapi/create-identity.RequestSchema.json b/docs/reference/openapi/create-identity.RequestSchema.json new file mode 100644 index 0000000000..6781d081fd --- /dev/null +++ b/docs/reference/openapi/create-identity.RequestSchema.json @@ -0,0 +1,563 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create Identity Body", + "properties": { + "credentials": { + "description": "Create Identity and Import Credentials", + "properties": { + "lookup_secret": { + "description": "Create Identity and Import Lookup Secret Credentials", + "properties": { + "config": { + "description": "Create Identity and Import Lookup Secret Credentials Configuration", + "properties": { + "codes": { + "description": "Codes is a list of \"lookup secret\" codes configured for the user.", + "items": { + "description": "Recovery codes can be used once and are invalidated after use.", + "properties": { + "code": { + "description": "A recovery code", + "type": "string" + }, + "used_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + } + }, + "title": "RecoveryCode represents one recovery code associated with a lookup_secret credential.", + "type": "object" + }, + "type": "array" + } + }, + "type": "object", + "title": "AdminIdentityImportCredentialsLookupSecretConfig" + } + }, + "type": "object", + "title": "AdminIdentityImportCredentialsLookupSecret" + }, + "oidc": { + "description": "Create Identity and Import Social Sign In Credentials", + "properties": { + "config": { + "properties": { + "providers": { + "description": "A list of OpenID Connect Providers", + "items": { + "description": "Create Identity and Import Social Sign In Credentials Configuration", + "properties": { + "organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "provider": { + "description": "The OpenID Connect provider to link the subject to. Usually something like `google` or `github`.", + "type": "string" + }, + "subject": { + "description": "The subject (`sub`) of the OpenID Connect connection. Usually the `sub` field of the ID Token.", + "type": "string" + }, + "use_auto_link": { + "description": "If set, this credential allows the user to sign in using the OpenID Connect provider without setting the subject first.", + "type": "boolean" + } + }, + "required": ["subject", "provider"], + "type": "object", + "title": "identityWithCredentialsOidcConfigProvider" + }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsOidcConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsOidc" + }, + "passkey": { + "description": "Create Identity and Import Passkey Credentials", + "properties": { + "config": { + "description": "Create Identity and Import Passkey Credentials Configuration", + "properties": { + "credentials": { + "items": { + "properties": { + "added_at": { + "format": "date-time", + "type": "string" + }, + "attestation": { + "properties": { + "authenticator_data": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_dataJSON": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_data_hash": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "object": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "public_key_algorithm": { + "format": "int64", + "type": "integer" + } + }, + "title": "CredentialWebAuthnAttestation contains information about attestation of a webauthn credential.", + "type": "object" + }, + "attestation_type": { "type": "string" }, + "authenticator": { + "properties": { + "aaguid": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "clone_warning": { "type": "boolean" }, + "sign_count": { + "format": "uint32", + "type": "integer" + } + }, + "title": "AuthenticatorWebAuthn contains information about the authenticator of a webauthn credential.", + "type": "object" + }, + "display_name": { "type": "string" }, + "flags": { + "properties": { + "backup_eligible": { "type": "boolean" }, + "backup_state": { "type": "boolean" }, + "user_present": { "type": "boolean" }, + "user_verified": { "type": "boolean" } + }, + "title": "CredentialWebAuthnFlags contains information about the flags of a webauthn credential.", + "type": "object" + }, + "id": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "is_passwordless": { "type": "boolean" }, + "public_key": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "transport": { + "items": { + "description": "Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to\nhow clients might communicate with a particular authenticator in order to obtain an assertion for a specific\ncredential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may\nbe reached. A Relying Party will typically learn of the supported transports for a public key credential via\ngetTransports().\n\nSpecification: §5.8.4. Authenticator Transport Enumeration (https://www.w3.org/TR/webauthn/#enumdef-authenticatortransport)", + "title": "AuthenticatorTransport represents the IDL enum with the same name.", + "type": "string" + }, + "type": "array" + } + }, + "title": "CredentialWebAuthn contains information about a webauthn credential.", + "type": "object" + }, + "type": "array", + "title": "identityCredentialsWebAuthnList" + }, + "user_handle": { + "description": "UserHandle is the user handle of the webauthn credential.", + "items": { "format": "uint8", "type": "integer" }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsPasskeyConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsPasskey" + }, + "password": { + "description": "Create Identity and Import Password Credentials", + "properties": { + "config": { + "description": "Create Identity and Import Password Credentials Configuration", + "properties": { + "hashed_password": { + "description": "The hashed password in [PHC format](https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities#hashed-passwords)", + "type": "string" + }, + "password": { + "description": "The password in plain text if no hash is available.", + "type": "string" + }, + "use_password_migration_hook": { + "description": "If set to true, the password will be migrated using the password migration hook.", + "type": "boolean" + } + }, + "type": "object", + "title": "identityWithCredentialsPasswordConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsPassword" + }, + "saml": { + "description": "Payload to import SAML credentials", + "properties": { + "config": { + "description": "Payload of SAML providers", + "properties": { + "providers": { + "description": "A list of SAML Providers", + "items": { + "description": "Payload of specific SAML provider", + "properties": { + "organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "provider": { + "description": "The SAML provider to link the subject to.", + "type": "string" + }, + "subject": { + "description": "The unique subject of the SAML connection. This value must be immutable at the source.", + "type": "string" + } + }, + "required": ["subject", "provider"], + "type": "object", + "title": "identityWithCredentialsSamlConfigProvider" + }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsSamlConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsSaml" + }, + "totp": { + "description": "Create Identity and Import TOTP 2FA Credentials", + "properties": { + "config": { + "description": "Create Identity and Import TOTP 2FA Credentials Configuration", + "properties": { + "totp_url": { + "description": "TOTPURL is the TOTP URL\n\nFor more details see: https://github.com/google/google-authenticator/wiki/Key-Uri-Format", + "type": "string" + } + }, + "type": "object", + "title": "identityWithCredentialsTotpConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsTotp" + }, + "webauthn": { + "description": "Create Identity and Import WebAuthn Credentials", + "properties": { + "config": { + "description": "Create Identity and Import WebAuthn Credentials Configuration", + "properties": { + "credentials": { + "items": { + "properties": { + "added_at": { + "format": "date-time", + "type": "string" + }, + "attestation": { + "properties": { + "authenticator_data": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_dataJSON": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "client_data_hash": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "object": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "public_key_algorithm": { + "format": "int64", + "type": "integer" + } + }, + "title": "CredentialWebAuthnAttestation contains information about attestation of a webauthn credential.", + "type": "object" + }, + "attestation_type": { "type": "string" }, + "authenticator": { + "properties": { + "aaguid": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "clone_warning": { "type": "boolean" }, + "sign_count": { + "format": "uint32", + "type": "integer" + } + }, + "title": "AuthenticatorWebAuthn contains information about the authenticator of a webauthn credential.", + "type": "object" + }, + "display_name": { "type": "string" }, + "flags": { + "properties": { + "backup_eligible": { "type": "boolean" }, + "backup_state": { "type": "boolean" }, + "user_present": { "type": "boolean" }, + "user_verified": { "type": "boolean" } + }, + "title": "CredentialWebAuthnFlags contains information about the flags of a webauthn credential.", + "type": "object" + }, + "id": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "is_passwordless": { "type": "boolean" }, + "public_key": { + "items": { + "format": "uint8", + "type": "integer" + }, + "type": "array" + }, + "transport": { + "items": { + "description": "Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to\nhow clients might communicate with a particular authenticator in order to obtain an assertion for a specific\ncredential. Note that these hints represent the WebAuthn Relying Party's best belief as to how an authenticator may\nbe reached. A Relying Party will typically learn of the supported transports for a public key credential via\ngetTransports().\n\nSpecification: §5.8.4. Authenticator Transport Enumeration (https://www.w3.org/TR/webauthn/#enumdef-authenticatortransport)", + "title": "AuthenticatorTransport represents the IDL enum with the same name.", + "type": "string" + }, + "type": "array" + } + }, + "title": "CredentialWebAuthn contains information about a webauthn credential.", + "type": "object" + }, + "type": "array", + "title": "identityCredentialsWebAuthnList" + }, + "user_handle": { + "description": "UserHandle is the user handle of the webauthn credential.", + "items": { "format": "uint8", "type": "integer" }, + "type": "array" + } + }, + "type": "object", + "title": "identityWithCredentialsWebAuthnConfig" + } + }, + "type": "object", + "title": "identityWithCredentialsWebAuthn" + } + }, + "type": "object", + "title": "identityWithCredentials" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "metadata_admin": { + "description": "Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/`." + }, + "metadata_public": { + "description": "Store metadata about the identity which the identity itself can see when calling for example the\nsession endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field." + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.\n\nUse this structure to import recovery addresses for an identity. Please keep in mind\nthat the address needs to be represented in the Identity Schema or this field will be overwritten\non the next identity update.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array" + }, + "region": { + "description": "Region is the Ory Network region this identity will be created in.\nOptional; defaults to the project home region if omitted. Only effective\non the Ory Network.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "type": "object" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.\n\nUse this structure to import verified addresses for an identity. Please keep in mind\nthat the address needs to be represented in the Identity Schema or this field will be overwritten\non the next identity update.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array" + } + }, + "required": ["schema_id", "traits"], + "type": "object", + "title": "createIdentityBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-identity.StatusCodes.json b/docs/reference/openapi/create-identity.StatusCodes.json new file mode 100644 index 0000000000..2fca773d44 --- /dev/null +++ b/docs/reference/openapi/create-identity.StatusCodes.json @@ -0,0 +1,394 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + } + } + }, + "description": "identity" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-identity.api.mdx b/docs/reference/openapi/create-identity.api.mdx new file mode 100644 index 0000000000..ad9ee6fb97 --- /dev/null +++ b/docs/reference/openapi/create-identity.api.mdx @@ -0,0 +1,40 @@ +--- +id: create-identity +title: "Create an Identity" +description: + "Create an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model). This endpoint can also be used to" +sidebar_label: "Create an Identity" +hide_title: true +hide_table_of_contents: true +api: eJztPe1yGzeSr4Ib11bEK3Ioyx/JMpetVSw50cZray1pU7uiiwJnQBLRDDABMKJ5jp7n3uOe7KobwAyGM9SHLSe7F+aHQ2GARqPRaDS6G40PUcp0onhhuBTRKHqhGDWMUEHOecqE4Wb1bmdhTKFHw+FyuYylWsWJzIepTPTwUlEj9TCRImGF0UPfZFBqpga5TFnWiwk5XXBNmEgLyYUhCRWEZlqSKSOlZikxcizOeV5IZUiiGMKgmb6935wKOmcD1ytnemih2O5pkshSGB18743FTCrChTZUJIwUVOulVKnuEy0TTjOi+VwQLkgixYzPS0WBLrpPpCJ5mRk+o4mB38wsZKrjqB/JgtlaR2k0ihKk35GjQ9SPFPu5ZNp8K9NVNPoQJVIYJgz8pEWR8QSbDn/SQP0PkU4WLKfwq3NaPFyC4PpRoaB3GBnCrml3OwQqUnJkaf4iaLcOM5PysiwmmiWKmXtBfYUtyQm2vLEPS+uHAU5ehBPX0VXKuogDxYRrQknGtSFyRsZu6MQOfRwRbFsxBksJsJJZIBMr4ARuWN4B/C1L5BVTKw+AiorzYd3gsKhihIsrmvGUGpYSOjNMQZ24cwjtTvaJCruJ+pFZFSwaRdooLubRdT+CHicUJ3EmVQ6/IuhtYHiODbjJoMXrMstOec4Iz4uM5UwYTfTPWVyVz0qRQLc042YVt7u6rmH5sQOBiWKFYhrhScGaCBOqcQXC4JfcLGAmQtYLBEPQo5z+xBIDg3MFVCm6shg0atQY7ac5F56lLDcF7GP5yrKV5aQHAgY4Sp4m9+LyEyuTTkAmHYk7rqFmeaHkFU+Z6uDL/YrX3xRMHB3A0hEsMeS4arORpz8K6VvWplRzKvh/248hk5YlT59G/UiUWUanQHijSrbOdk0GPjs7OgCa+/G3h3C6YOsD95WJkSTj4hJXty5x1omRMTnTJc2yFdESNgAu5iTjl4xczKWcZ+wCdomLOTeLcnrRsS76kYPVjYzvaOdCl9OLHkyMaeOY2P9zKWp0oBo2IjPOstS3PDogp/KSiU5USs0mtDRyAgNtI3Q0I5qZPjGwdddrj9Ask0tdiT2glN8ySw0E6UC5IissbFkagGx8XT/qGVfaBJhOpcwYFbj8YA/liqXR6LwiYTC17zYvUK+Q/MjNIuDENzxNLDN6Xr+XDLkV6se2Ro6lWl+y1b3W3LFt89C7bAfY2/bXpgpSSY9mLZqmt2xF69xKjWHaVKJhDVxpFtBpQo1Uk5Qa2ui7liNcmK9q6FwYNu+a+X6UZJwJg6D+cvLm9QOCmyyoXnwqPFlJkU+BUpTTjCeTS7aa0GwuFTeLvAGKC/P8aQeoYH+vOeNHNt0vzULs1zMFsspQLjThwgKFQjoFERBMKIgrSpZsCvMobtvog4YT+/FDB7uEHNHBMHRe8vTTZ1UKNllSJaDXGo1KcvUjEI0TPIW0+niydzNl98MheOLeRFEQpo1x34+uKddFRlcTQfNums4yOu9Yy1OagJbGMj7nuDd30cFVgnnbUAM2k4lTD2+occUUn3GWdlW5kS1fAva3kQ+HeD+yfTobcT3xx9CMad09+Hqtfmp3RlGhQbo3AK1phiEbaZLTVX0WIFdUcVlqUgHSeBBKZJ6XAs+zYm5VeCv2dOzP/2XuTsokZTMumCYLDocBqtEEsJBL34TkfL4wAUzmDwUFVYYnZUbVGrNzQaRyupucwiyDEYNqDawqBeJIiS5Ywmc8GYtgXslraRgxC4pcoJlDqzquIG9US/Aty1YwxGOqzOoLTaZMGzJlGWczOxICA4G+G/jldDUWUzj10GTB0pjsNyGRJc8yYlYFT1CnyxhVwmtyuiyA0mAraVKdEssZBLbpQE274nQs5sycVtV3evFYjMWJIwDOw4j87/88i7+Kn8akMeWkakYOg1lr2GOWT2Kp5sPTt0O/VIaPYIpTNhs0Rl5h3Is2SLe6t+CEaBXYV8g2dvKREDRnBERUp07bVuA2yoMb96Y7r/5Gh20NL9CbfL+vuDaVNFtQkWYdh/kzzdT3+A1sEpWubat7ntiA48fLhvurrE4//Hid1wHwai/IwHsrqNDocyi+63Bv0XxBr2PpZPMw4IhnK1VmRxBa58ffvyB2rj6DwfOR7XFQGTp7XevmZqRDbIsMBKth7w3hMyIkjggNZ1eU4+F842HTg5nkfG5pOFlIufHoCYIUj/nI7BUOKCWnjFggLA1OnVWdqgMCHWw4U34EpwLwT+N1JDLohTTP2gM/pqtMUrCHE2cNP9n/66vQJH5n3vag5MzCKAKTzkcYiBDGHcxCQbd+p232/69g9GkgtMnUc2/rTSn4z2UNwglpO4GByQZVoSualYzkJSoOhOd5aWCIxCogRMtSJV0L6XOYQk5onj28KaSG+rGtEQtpinvJ7dM3p8dk7+X+Q+8HXXBv2Q8A90mpOpY5ADt7+8pv7Qj77O0r0M5egqIoFSMpM5RnmmjGRsTvCtayiJuCNTi6/zX1reGSX/LhD2w1OFN88NKup04b/f0m5VSa4uOnFFrDlHqt5V7kr5S2B57WLrhbA9fWwLU1cG0NXFsD19bAtTVwbQ1cWwPX79jA5Qf18Xqvh/AxbWEE7L1hStBswjusM4fu49EBmmAEkYWNyyG+GcQAOHL6Tpy04toH3+H5dyzCOlBKRQ1Fr7RheUzqqADW6MIfZe0heCxooqTWECxAaltUJ0fnzFBUGymE0rSHeGLgOORrBVsZMsxywRM0P0mRrQhNEqY1bNLELJQs5wuCUMn+8ZEmukwWIL8uvjs8JUP8MAwMaf/F0z9dxA2UrOS5B04V+SxejSJuNMtmGP2lGSPLBRMEBCHIRxB07D2FHQgajYWGcUhRxUzG5EASIQ3R2LVmQnPDr1hjbe+weB7jYuGG6EQq1uvCDex3wAAYKoIDDm0wjs8exAzjA7wmNE0V07or8s4HiO37KrXcAu5Bna/6hDtYGD9npI8iA3atOBz2gTPN7Di1UWViSsUCu1oVelbDxs0mgEGOM0Y1I5eMFUCznIsUFomz0biGRDCW4p44DeLbWGqpHJw6TzCwk2DEoCd+ZcwEXJaKG8PEWEjbUqCN1TcvCzg9NsTfmpaqGL2czDOq9WQm1eSz2NVscKs/2HYds9N9Y8MoFywrmHLEd8MFEs/ltJzNaCbjQhYwnrsdjzu4stPOjGTqRvDMfvtMCKJJr/NYccVpR/maKc82t5VvsOF5vvVs5VZNlxqs2NxN/fqCg3K/7b5RK/KamaVUl8S2sPxZSzLHom7qCRfxWLxx28zXoOfSMjO4AtAGrySaPxcyZx4gnxGZA3OnMXkDcprNZmAOvWIVswdoxGPBykHChFE0I4dnL+yvsaCa04GQyiwY1Ybsa05fw1+HVJuxKPUAi89Oqr+XDP/+kcHfrCSHZxYINoUa5OxkLOaZnNKMfIf/i/oRqGMwIzUSUT9q9h2BdjOof0FH0LJ0NbE06kcWdDCf1eJ6P5jLAfQ0gMmJRtFvOGQ4xaNw6lQxrNyyCoaLKXT6BNiNvFgzdTA/rCEXx+wdM56ZvsAzFTfdmkB1dl7fbOFw5HoPIGH1GFQN3Aix2r7jKt4oPXJ/BZNbFfiad5qke3Rlz6HcdOx4p1geHL6CXaemEDlt7NmaoIPASLcQ+ySXKZ+t+mjOTFnG4ICHTQEnOAiybDbQTF3xhJGcCsGUAyqK0th1TbMlXcEBjwSR53PYfE1riu2JNkXoF45hSpVddB4brBUDUL5p7/97Veveu783k5Dpqg7Bv3Xbr1r9G2/7t5DQHQQChqrnwmPfZdTeuG3+CIqqsfYNo1ZkSbXfDGBBWa01GkV7u4+fDnYfD3Yfn+49Ge19NXr2PP7yq71/3nOLbzvWjg5CEJt2fhAH5V0IdIIV7YkFNGr2PmEsJY+fk2RBFU0MU9ZgA1PuxE7Gc+5MuW6CT/72ys1tC5n2sW4DDrcpLF2Uz0Dgu0YPS/5KgWnPgGd6rAKLzJ9VZlL+GVdeIvNOmIExc83HL1K0emnQDsKFtaCw9BWj6YpMGRPVmg1H29BYAyOir/ur3HKpNLs2wVKWcTxe2GtioVaRUw4Khc41bDn1/PkPd1QTa6Jcob7h2P8G1bEWA7cqj+tu5ko7qDa1G/ppXoDDe2rXAPH9QCo+54Jmx1TR/DVa4SP7HfrThRRul9jbfRx9/FW5/Ye7uhia6yjZWZQ5FT1reeAClNaO21m/2RFpzTNJ05Rb9j1uINhCqXJ8NgZbhW8ENlfscrPb1XMAaA1v6fKvTGs6Z02wMHlx8BGlLKj9mixZllk7KADog4i12s3Jks7n9oZdS9H4LU+kQJUZ74ycOao/hopeFU/jgkUCGK2LNtAhyalJFtZyVikAtxiF/d8tuQTwUg5FORcoeqfMLEHEpnw2Ywr9AKuCoX8oYKZ4LIqOcDiA50OaxgKutq1/fXN08GIsIA5i/QuEPIxF837fWhV7d24sKiPw2ndvVx0LvD249hWuG8Jni/raFRaP+SVbjUWh5IxnLQDHtngsIFJr/SME9YxFykC17kTuAD85/OpJnuAdp/XKNa+8hM9jAebYSWWhWqvt7WWvIGbpxo+8WsY0azEW9GHtZ1a/EZewMKhh8xXZqfqeZXIJ97ePcAmBtoRHPFikTg8K+ITYVekMnbGdmFvH8cJeVvX7YxWJ6G5Luhig/to95CCOpB+5+67+3hQKKJi8yMXZ9aNgqqJw5doJAeghyR3I+u+7nA23S2S7RD7nEvltjZtM6U5j4t/tB6LYDPcwSytX3RuKQkf0mWazMnPejwUVc28jsmoEsUpdA7ObgnRu8aet+dLupvpkWWPKWj4HtBjU3l07gMBk2qmn/H9343UNqzYaBtaIluaDVpvT0GZydID0hrUEhmfgEjDZiLRZLDUTVeSFLhUYc0ow+MCyygtq+JRnPuAPKJo7dwjOYMoB+WkJRht0qtUOwhcyuVSSJouDb+O7mB5uc2HCifIz6cT4m2vy+uzVKzjaDTY7dlqLBOr9RUtR93wn5+e/1Wj+33k2tw7ArQPwLg5AtLfkwCqFWdkZfjifINfo30NnIDlhhkxXdt/BDEkD16YALUAbpr4miAWRgrw5OcFFDnd2MuZrpqzI5ApNcFvv3+/V+1d5lDZhEVyZgJ8Ojyqr2HLBFOvu0GmVXr7OGBhVUjJTMkftwy7wEYHOH84xCVpNddcHzNpJqcDIkq3g3pz1gf8r+y9xHBOnfv1KFvXfk8907axih/ibn/N+A7ft1ru59W5uvZtb7+av493s0ozX8MA1GHo9A+Wk4QJ1nVeWi/AgjP5B8gN6GSuB1TYNXbfsUlXd6370dHf3EzyhmFTOUJFSlSI2uDftHx8RppRULutA24eJXzvMVNjIe2pbrVI2LTuuXx5Acb0/YK0wbDm0Y9lsdiC3qnQCuFcvqI+1YQIK07ghHZApqaFTCNyhKS0gdybIk1J4DWDGRWr1Rbsauhh+w7DBU+1FpaWbv57RxMAlemUpkAhvcJNEllnqLVYzWYpO4Y5AJ41O20Ss/qpJOSvhaKAaMeA+iohi5JPXkaGDJsJvrCEajTFHB+Tx3pOnz0gqmXa7BtedJNps5qPesmdJdHQQj8WMIRoTIc2kntBDpV7aD6+l2ffFY/FzKQ2d2A2LpVDtb1By6AoCMdMJN+pHTQh3UokfFkW0n1njU4tM3h5WTV/NT67NxqjIUk+6k76uZ1WtQdpmNrPqztPdp33ydPcJ/PO4T+I47jW4Ab5/kr19zgRTPEEB8cLJqnWhaldXIDUrYWTlyttartwqIhHWd7ZTKyb/uBWTWzG5FZNbMbkVk5vFpLussRWVW1G5FZVbUbkVlZtEJVCJJaWCU/joHJKUrfbxbjGmU49G5++uoVtMF3JeH9jf2Sjn1QCihNCqNpiWySW8mxHZcOMBhggMMrlE1gFiniDJNPaTUcizgqGaJ4gchKbRKcuiUfRnqVZDmz0CLBIoDoCY9mbLh7EghFQxFPsF79uSRjYjX9YK0R6La3SHkC+Cbr74eoyxY2DZbjyHQr4hgi2boHd6X/u6tOBH/oEVWzNAa6cBqYddZPZ5hzWcRh14fk2GQ7Ljw2N6NX4fHH/2UWyTa/INoUvKG8jEzT52LDHaHY9F7+voul9Nx3cymAZBneelmoGCJpewDHPKBSDkZmRnLMZmbDfa92Yc2T9nefVTavtLFkzQgluak3EUZPmq52Iwl1AbRwymO+xtpwfzPjbtIZDRN+Q/G4Dj12zZpufO2Lv40olbvOOoT3JanFuB8Q4Wq5rRhH243nm896TXgxloAyK/kLV5GZsmz4y+IW2EmhwEjWjBX1hKdDXYPz6yX9fYCFqCGtEnqg/yChpXkOKK/Y6P4ibqO2564m9pcjlXsJ/u9HpxB6HaNO7Fh+9ZUhpmEecz7Pg/viGCZ3ZexmaWm/hlobgwsx2p4xOTMqX6ZOw0n0YSgIvNaF5cjMgfrsZjAZPDlOrdAv1lmWXk+9PT40q3Ctrb1tfwz3BYVbDL/2Kt31G1dKF6uz9ZGujvbRPIDQMJ8WC66I3FdbjUjldmgUnX/HIDabpR6Em1mtiPY4E91wUxXuDQbslPvIieTIFXefXsUWvlbwBTOxVt05oq6w0U+OBdrf2Cw0aOq8LVLJB8voL9C1bLI3IAvkLvM19Ije6ZKhDQeizru9b+WgtktLJ8G7ur1xquudCCa5AgAPiEsab4jouVS63jryOA067OwNNctwXc1mHgN8J41eY2EAy8uZatbMVhfEPG0V3R9SLuEXpdnUhEZ1b17NJ6GjDMagMvKJVmIZUP8auxBmDg3E0SqVLck6pcO6AqgLcXPKhuuyeFzHgCGSQekUMrEO0dUUhqhH04rwe+2OTSbqaQHUku++DOdDGVPpcHNQBJU8P1jDNNVrK00aNYN6HaRgo8qjZTRr5lVDHVHM+INFWQe8+ETY0yMdAYauuYiSuupDgfR98e7r89fDs5ffPD4etx9K6agkMQ/YQSJyNdgipRv57mDgNARr8MsU6Ay74XwmsCG3yQtOCu2sgi+YjUr891d0K1duMp+ITXSkbQY6hr1D30ws1+TRw0idcW/b0KsZt3POjAqJUbzPqAapHhvwJ2lfj9pjGkdbm104X4N12FvRo+CpedsTtKun7kLNTGBn9agzFC4RwCsVBCXN1XhqKNVBIOppSN2t3XFRrb3Y1YkD9oRIT8gbBedI2KtU4vB3BzDw4tgYYM1go+t8fT1vXDnR5eDFE0twq2zf3XdUexOiO0ZzpaPyxE4TkEHYjvoMSUSpxaINX7f9f9aC7XcVzXQcz7QJf47AjPaKZvxriwu3AnZWuWvAnTJk/ehOtOuyjO015rCOd+qb27O/V3/A+EeO3C8AXcTbA4Y7bBTWe2KmigfXYDjcW3rdgyCDLYsueWPe/PnlDRhVSMokKivaygZhGNola6MtCGUXOxo8OwyUrL+uB0q4nOyvl1p6Y1RHZVGDHhg8mrJtYs5GzFUa2ztUb9D9BmwnDhY5f+B6DE5B+yxMAvNJVy46OLzsMWL6TQMmP1Re3EFuBlbb0YeuSHLnpyOGdmoA0FTbUXO6p57Q3Psj5rq7a3F9CUjZE0WFLNNfSHmVtR3WrWtEWtqhJ0sj2MvYFH8CKXmbnS0l44k1qj8KwxNYtVqmicslz6AVqgQ/gXI01k4RLjz2YZFwzT8GMp8Wxl91FnHIatVLGZYnpBULvTZIdmnFqt9cJBmVj97wIYt1l0f/j2yVsBhtvora2E0S7NN//824M2jfsluysdjG0UmAYt0fEyR9MK13JOSKeAh48Nr2SJyVrwReOQ8UChvGQ3ZQioUgNAJDus7YEl2QBxRIPn7SyjVj/C3ZeCJmy/4D90vet3C9728gwAGGTsimW//jCu+xE4ht7WLxkfekNvKyF6673gOj+Ae3v33D9hWxvRq5dpo73dvaeD3S8He388ffxs9OzxaO+rePfLx/+Mrt9dBy+oNl479c9XnK+/JlF3UD8IUZdVrzk08AjfxLTS+7r5JmMwnnDk52HS983DaCV670rtfr77riND+3qpS7SOxT5fOv7RnfZ8tzO1eD32VkZxn0Pc9dtIBW5DFMPk37utDNs16CqxdiuVtoXTTJ5ty5rpsoOyOurSXWqpcGzlmbatwszSWC9IEH3ukUSDfiNl7fluNfP+aZx66luP/QSs1lF24/M3PgLRvwnzWXjbsrF/TyPI2VG9UhEGZYaPNGz5/XfE7+s3lesxtW5S1p+6LkOe33YhsW4ehuffxEjY6ZMZ/erZ7PnTwbMvH385ePrs+d5g+mSWDPaSPz5/Mnv+nM7o86gZeH4TTH/Cq5DBoOd60dRX5po3woIrU8Gis/NZX86pbrNsvFpx/mF9+Bvj3O8zfH9dIJBATYJs7KVNkAb7rQWh30hapKQN/L5+B3wrZtKHnlD7uIf9Ooqc7fnPVhWEu6l2RYFyc2K/te/vPyJHwiiZlom1rx/IpIRAjPqON5i1XfZ4tBDDGYpjDge48ARaFCSGjsl+8wNmi4ZzCyaVnjJnPIV7PC5HP978IcdOnyJWK3VvbZNj2yNCASNxLjXc+cLrcVyQqZJLba3pY/HoETk5+EG7q2KpGwGxA50y7U2fwftq/hQVpkxFa3nVYRDpohE8EgOff5Dwejc+W07FvKRzpkeAxi/klfvb2e5+IQdyKfApr5ODH8jH/Acgwgl5oP9+AWwHjf/IesH9/3sAEN1gAdsDqkyDMOdFOY1TdlUr7a5g6HzJelhbpHudtD1/e7h/8NfDGsKa11inl8NpJqfDnMIVXOdF1u7/w5QqM7QgwPgQ0jZ+fXja7EqUc2bgLYTmIaMqrrGGjGjW3D/sPSS20gjWwhexPcz4e67CrhbsfVzkdVf277tS9gGwZYhSJ7bfyfWuatAbu6sCAD4LJ8xlmw8ctn+hV7TZVU6vmGhygmZUJYu4+jKE50tmNDFDvYBz6LD24PY+Hduf6BXdwLeArbW5Vnxb5D/pJmmRb32x54lhEPPSe0jaYjY1RCnEeR3bHXj1wV5K7n0s2gPX/LMgb4E3hkBgDMffH6+xosWM6zVp0ShurMQ1qn8y0sWi6GBnpLgNLWhguyr4GqKuxFsdA+Ydtlffp2OLKHVKirfldNXsSpXT1ZzluolxWDqEH4319qDYQlcb1t5b8NA3ukrAnaJjLgPDri9yvzZi+kDY6u4dDrO9JQziAkeVW2C/gDeLyF68C7pyw1IJa4/iZ6Sxa6uHr45eHL4+ORzsxbvxwrj3KpnK9ZvZib1BDnZ7I3UQ1ehVzihIqRVlQAzUb8Hmn1MR4NV2H6/b4INQ7qD2QyVAjYlPsOTMkqAW00zLIE/NWJy7cJbAQPAZnjLuYaKGOjCgetK4T7TEDG5wPgf1uBFqoPuQfRszk8C2hMGx4GMJ01BAeMMQnzbGW8s2B4V1vZxHNquTTxuIzpd3/QhCW+Drhw8QI36msutrKP65hISBo/N3tXsFw0X70YJRNNJUbkcX1jo4tVlV/cmrFY5fOxvhnFGYG+uGLqTjNyenUT9CF9foQ5Rbo6uiEHsK/6Ljzfqt0FqBZTYUq8SA48jCvHbvDQZJbCo7sfeenFefqFgFGH74YGvg2ej6Ouq7oTgzP5gc/g9HRusw +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Create an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model). This endpoint can also be used to +[import credentials](https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities) for instance passwords, +social sign in configurations, or multifactor methods. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-json-web-key-set.ParamsDetails.json b/docs/reference/openapi/create-json-web-key-set.ParamsDetails.json new file mode 100644 index 0000000000..2e17749423 --- /dev/null +++ b/docs/reference/openapi/create-json-web-key-set.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The JSON Web Key Set ID", + "in": "path", + "name": "set", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-json-web-key-set.RequestSchema.json b/docs/reference/openapi/create-json-web-key-set.RequestSchema.json new file mode 100644 index 0000000000..dbc9ef96d5 --- /dev/null +++ b/docs/reference/openapi/create-json-web-key-set.RequestSchema.json @@ -0,0 +1,31 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create JSON Web Key Set Request Body", + "properties": { + "alg": { + "description": "JSON Web Key Algorithm\n\nThe algorithm to be used for creating the key. Supports `RS256`, `ES256`, `ES512`, `HS512`, and `HS256`.", + "type": "string" + }, + "kid": { + "description": "JSON Web Key ID\n\nThe Key ID of the key to be created.", + "type": "string" + }, + "use": { + "description": "JSON Web Key Use\n\nThe \"use\" (public key use) parameter identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Valid values are \"enc\" and \"sig\".", + "type": "string" + } + }, + "required": ["alg", "use", "kid"], + "type": "object", + "title": "createJsonWebKeySet" + } + } + }, + "required": true, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-json-web-key-set.StatusCodes.json b/docs/reference/openapi/create-json-web-key-set.StatusCodes.json new file mode 100644 index 0000000000..59fd94e021 --- /dev/null +++ b/docs/reference/openapi/create-json-web-key-set.StatusCodes.json @@ -0,0 +1,130 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + } + } + }, + "description": "jsonWebKeySet" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/create-json-web-key-set.api.mdx b/docs/reference/openapi/create-json-web-key-set.api.mdx new file mode 100644 index 0000000000..3075434a75 --- /dev/null +++ b/docs/reference/openapi/create-json-web-key-set.api.mdx @@ -0,0 +1,47 @@ +--- +id: create-json-web-key-set +title: "Create JSON Web Key" +description: + "This endpoint is capable of generating JSON Web Key Sets for you. There are different strategies available, such as symmetric + cryptographic keys (HS256, HS512) and asymmetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not + exist, it will be created." +sidebar_label: "Create JSON Web Key" +hide_title: true +hide_table_of_contents: true +api: eJztPPlz4ria/4qWqVcvbAXCHcir2VrOcN8ESNNFC1tggS0ZScaYnvzvW5LNlZCefjszW7VVkx+6QZY+ffruQ+Z7SEdcY9gWmJLQU2hoYA4Q0W2KiQCYAw3acGEiQJdghQhiUGCyAvVBpw3GaAEayAMDJDhYUgY86kTB0EAMAcgQ0PFyiRgiAnDBoEArjDiAO4hNCfEecEczAOSAe5aFBMMa0JhnC7pi0DawBjbI4+CuOkikM/egOkjHE2EAiQ7gjxf0/QXlYmmQD0dBbQmEgQC3kYaXGOkfcAc6RRwQKgDaYy7uARbAxaYJFghoDEGB9OiMzEj+euVdfdwISwpBUIc7OFBEBJ3FGmkCtKmAkqLgTq4JAx0KKKngaMJhCAgDCsCQzRBHREgQHw4SBXlQHzcUgv4mcvPfhcORkKyqjxtcQbjEGHOAdUSET4aFB7DgaoEk6kZO0KOg05+CqqczCByOOBBSHpYO0eRpoImFBwQFXFCGbhHf4UhXojBsDhTYEwJDukGEg7sj0zs2IrUSKFJCJMFqJSDUjPC9z2PTpC5XG0l5czhiER0tMUG6vxPkwEWmGQ3dh6itxJKSmh56Cvksq3NKxmjRQN4AidB9yIYMWkggxkNPX75/EHr0USpqpdB9CMvHNhRG6D5EoIVCTyGu4DG0dTBDeuhJMAfdh7hmIAuGnr6HhGeraUIiHnp7++pPRlwUqO7JGRolAhEhP0LbNrGmkH9Yc4nM9wtQ11gW1cE+Itr3oQMF/j5kM0kPgRFXG5irj5CuQOTNFWVYGJaUcUkJeByQnF6gM08VZSU3pD4pER04tk2Z4OCbUrpv9+Bb+fwhHU/ID9Xgg2TrN6XN3yTX3tHpPrTB+u+gWisdcfS/SUkPcAlwPerrLfgOR78Df8TRcYOZnD4LgTvbWZi+dEtChMFJkM66xBUSWDJVR7qcBuhyRuTgebUyjCewF1A4QJZtUg/p8gyY6FIeEHANJAzEZgReAJGzT+xARCmgZIgyC5SBHWJ46R1ZxPGKQGknZoQSNScKXqCJdbCDpiNtMZMYIaLNQoo7sxDHq1noBvXeLiX+i5Iqn6A+276eFlBl/yQALEz0iTq+XcPzNWgfoQyvMIFmVxKn7WubEmo1m9uUcF+oE7H4H9Cj9wr0QWekffm4rIm5b1ovlvOjuCiCHsVxpiC85zIkADIGvfcwfEcyIz5PoqDgAR0toWOKewWNMh2xI2jpEQLmuVgYmKhRH650YzMi/Ri2bNOTG57W2gwpV6whAC3qy4d1D6ApDOqsDHBBPz4jvgPx/boGCdAMSjmS4gm5FCoAgYUgUXJGL5CUUikMhNmM2A6zKUf8HuAl0BGXnJZyhQWyFHF/wkz5CgPNldTDk1X6gQqeLddJGZeUzYjUSEmus+ECJ6YFCsUN6pg6QFgqnbQkDK0wF4ghHfhUnpFavp0Hs7P8DI76pZSnHKgjJWeTKoXAB8S8GUFcwIWJueF73y/1cf6r1NoFAjCQIOXQpVxDTKQ7L1LTxBxTEpmRPuKYC0gEkLohiYn20LKVlinze8voaWwnCXue2Y18MlO/nject7O1SKaKkq0sfJzEd2ORGT7X9ql9Yf7cTbYWqQF/HeRTuwhlu/rh0Mc9o2n2+9k4gePpftnLT0Ua81ItMy8mmrmFPqapSqW7fu5Vdm3an0TmvFD3CrU5MyPDwoq/TunIzK+T9VxibE0TmCzyka7r1Zcc1molDU0LxQiaRPa46GS2re3mFSdbbi9faWYWLb1bbsUOqXpBcyvD5IuOx/laf+Tki+OeyyatbeYxsX9cthxYg1X8OCk9r0QcCyORLDaXsF+26hsn1+1pmrEQc6c8jRhbVplmiBiKQcqG43Fvnc3sm81cahAZLjO7zH7TzMWz3WVz0BluM5PiYb8zK+6hUN/mbZI3Fu62uba7xmr0HEuVS322ZYOClp7GC020I5manTbieQNxXrCTbnPTWx3mjCJtIyLeYndoDNflQcuBK2Jvm7vO8HGa26Gas0q03G79tZZ4WWuHvhbfHVo8kZ6wSi9bskdeZNHW7WxuaO3yE1cToxau66uqSetuIlncxZKr2ii/KRE+3L5aG3tRW0Y0Zq/ajYrV687LpQZFWXvenby+rpaLPsPJNi2/PHcfW5uMV3ayzXXdKJrGKyy0187YTUQaZmHZySdXjznLWBbIpkYQSjc6Oeu5n45tu5v4S6RF2WjaHlZarzUrtqmUM2j6Mq4U3Hq12Zga1VEyVaK4EX/pRvju1S4mnHyr0s7PR/Wy28oVe4lFdotSkTTKQc9t7VzNybP+Jl9IW4XasgM7dUiT1tLZNPLlm9JsX4vzc4p3JxstM4U5L0vr49y81lyn9o5tOzHzgOfVx5fhZpDdr9MDfZLUaDlGsTV19zWcQNYw76DYqAPTur2qPHuFekrLil7ipZKKJSZ9Z9UoDbtZuJkaFZoW+fzjYw/N25Zwpq9aspi0krVE6jnxvOun+aC0H3n5duKwzTaXJFceWTzDpsnOIjtFuLEZ4sI6dvM42+vj8JyZr+aWq1WB00o/24Faoj8vJ1ZuIptgw8TmuZM3djXTLA/LcbRk+YzhjEa71rKgtWySNbdonNkdDmQ6TQ8Gvcqj3dKLc7iqJclztraw44XRIlYfYQb77e1o2TS03mKu554rqZLxiB5T40Wf00WfEmc9nLbj+yLsZoadTHy9G7NJpBnPiv3ETeVSvbm22tw6Dro+Tb6XL9yMCN/xELqrlVPxntm4AXeP+UnqpTFa/XQo6buTDdalO9moADJ87aKVJxAUWFDIJOWYM2onn4H5jATz7pW3w0RaZA3dy2WBm/Qd7CkVU9lK4Kzh0a/OiO6oxEbiwahp0h1igVs6p3fneEIh7bsIiYNDTulsFICxgcj1JD+0U8d5v/P9OS2fkUvcjuGFTCkG1c6oWVKRrI65wEQT7zaIAnDXIWhGAvZIJ+kaWDMusn4F3cIrQyhIKiSF1sfzAOxHyx4w4O6ybDALbYR35JZkcvh4vIUj1BE1SjjWlZdWCcCMyKhyB025HJoCMQIF3skVnh8inAMd4PAgUraiYQAuxCMIxvy8W4McRTgiHEtAwBeya+8bz8SS+hLF4DK7TKVzN93rRnifiuT7Q34a4Fxn3PCcuS2hhU3vzPFjpHMussxC/UF+FpLxxixULs5C0dPOAU39EGhGfhADgfchkIxfh56N/spA58SaM7I/zZn+IH+LGeTasOyGW7Yfeb2uOU/E4HaZ3kyqbumVITPSoLuaneWPyK1TPVGeVM2sGJv9QnLeR1Yy1XALy63Z6D3bcbKFRiQdr6bqB+ZsUUyrdNNZo1uuicx4y3bEqhcne9J2aoV0Ek/mzmg0mVRL1QKC3eKgT9v1Q9vja1pPxoa1EW8UMGZGAT4uE8l0d7Jo4KruaE20e8l0tca+ntam2UMnkc1s683CeNC1Ip0a2rlbXuODWjWV6gkrxzGt4I2xWTRdunXHnf5zfhojZmaye+mYRr6kN9eFwXaQR8N4pesUS0UycQ/FUj/bztUqhXltrQ9EZVOMsBeRaKQL02VXj2lJr2LPd9V+PI36euxQz056jy4tFLMvhEMtUxZxuzFI5+xJJpHOlLpjJzsq6eUONRv57krT56tE284/ZrQ8rMzX2jAbW+carHxws8NdjNQLz4g7xXW3vX7m88ZB34yHo4lIJKsk16tzXYu3Xh04juHtpIDs6nQ5pds2Mg8vAsXjjyJVcF/s2GbUyrgoVtt6k6IJX1edWnYQGZcKbmLe2elWFqXbljHNL8zyC/VW2iQ7TWVoNbNoYFjsLRvFSqml9VdFw0KPeVqOe6+vU95dwOd5srbusmKqWWhVe26WtXL6eF3P1qw11navcTtvxfR9pFEtdpNeuvvSYPtCaRk/DDq80N90ButCdtjtlEi9dchE1nraGIrXvf3adbu0phchGb4mX0sZp1+wh1bJFXb/2cokRz0et9KVcdddxIaJWuVmcPAu1Mm0F5uJWxqPDBxB/XS6uFosE4+VTa9UGteg1YElFmPr+Da2jC8r5UN8nM7PY7np7jmWq+BdPN9JRErZvpldDeIvm0MCxw7FwZZ4XjYfS6QnHa2/w51W45HU9uVUpzrvlvmGZnVRY4vk0ConjNFkV9xYBzdX5sNKvNkrdJ6LGezw5nCC7Foxvs85m2Kj8trb6StR7ix66c1Bz7WNbUTTt9YAtV6adN9t6vGFucMvw9yLlY148URRTG1Ur3ZgrSReuk2zYNRxgXYb41Vytx9Yqcm+ZuJ2By23aFUzuTWswWTLHmTGY7PYSHpVA4pYL8L6+9Je9/CL/jx3D/WdHau584Rr8UcbRbqrdne6G42rubptjLvpRjI73ZYLuF6Z9G4R/l1QFsvHK5bdGfdz8Xk/P7a3DI0HcNeGr4scmaAGLtBYqfdcOCQTpcW2se1lBylYqFuLvlHXNLEuNtcQkwjeOSL1+Cjyo5Z1qLsv9VJpm2i9VtxirhdJvUxfrcooVa1j4fWcwaE6RZlUf92OlOftXiwxHBvPyd7zOMPoNqOlH7VcjrERLw/deh27g2wrbcfTLewc0skS7Kx3EWe7reQrS89tp8ebfXXBYEFbV0UL9xyvt+htN8WKEaGQVDfutI08wdvG0ElYPcvtp0v9BKOvCdLFlXUxQ7i+ieQfy8lB0m0dptOK+7jeLcZjOh3T3K6Qis1b08Q0Vpn2BlutdNAKNW07jwlCIF8mX8apir7PWNlY/9BZJCqcmORx15jkbxMev4sMvdbcztTZxBvgQ1zQyqqxGL9E6notue6lPNvJsUVrvE+yXr2wtESsQqeH1aj2Wn6plLXO1kVWv52NH2gpD2GksIk1xu3n0rpefS3pJatijJP59qNZi9jOfjO3qq/P9Xic7b1+tpNOT5oDlBx0rf6y4b7WMt4okXrd73qNyrQmdFMfNZ4PnUwNZg7DhpF/6Y9+ujI54gjczULX9cdZKPz/tu54DEs1almUmN6x3AjuTgvCfnjiVyTv0KmiEr726hzfjPr310KxzCY79WQpsa/EC6vszlnkRBPFV9XW4eUxg7JDh+ecbnXXfynfZMo+rX0WsO3TCr9JNB3LAU1WsZY+8TQDYnIZv11EOOqZDOmpDJspA5bsoXQbtcklCA6+9CvFdCIb+xoEPh/gqwzg1PRBsh92bA+dCoyXi/yIyT+YjNvLUDNmxP8OriqIKqpaQI4yqQgiGpVSdTdAqvcDUhKuRC6VSWW/gkjErzX60x1mHleEQancB19qw1F0ksnFovFcLvX1wzl9rKJ+9fTDw4BsF72G4BSt0WAow0g5usSMixm5WHdVYPzA0GBAHVV+967FZT+vlA99J2clM9Vmey4clEnnmm17Ms7YRW8g8Ga6btTGtTS84YTf1ceDyrjwgvr4vSpw/qBKvj7Vxz9i+vYzy05l9Wt5fTdBPlal5T9QPi8zRtmHmjlSo59O/lgBkA/mOlo4Nwq/ahUoyYegRpaUWQo1WWzvSMNx6iFL8dXRDlhURzd7PsdtLqB/ttl57FM4BvbJdQtAFcuEekaqyLR9wyx7lkdj7SefCgrQoMPflW+lEjCkYyZboaN+U2qiVC7VBf2kncUFFA6fS537iFN1OOyCgZoBinLGxW6pWPw+5BM19BTCRGRSZ/jSm6wQ+6HUqWN08o4wErdk7vrxfYgjzWFYpr9fvoco8/KahjhX/eDQ05evskEq4Er2ZUNrdyO1RLaCvIi8MmBiC4vIwtE2SCJryMZ0BOoWJhGTuiE5VRJgoI7mt3ZNSFaSpJ6N/J586D5kwgUyQ0+h/6bMe9BMLMX+PsSpwzR1aEt2McH3GQEAgLq7ydv43v9SpGSJV47fXz6OfWxpzcgbWDJqgX9ebPHPf0mBkCUKleqe4YBfAUHuNey78L+Oc6GNa0FdKZjpo3R3BSSsoJtIyELTU2Df/wUeHj7pZoO7QPelu3dI0EwP+yBudOmebp1Twj8f6jvwhfDeDwTewK8AuhBfnSB6A/SdT0eOREDRG3NmJPyv0Nv9iZ/P9IKPflHnkoU21DZwhYAFsbITAUvvZmQmZr6p2wtZ2ZFfl9bpI+X+J2ojAm3sMw7MQissDGcR1aj1cGZoZEXl7LDcQN6JULvdhaXgzIQs9z39KoMaJOaBss1C4OEhYA34DXzCGbn6BgUktP+8wivaRu4NptzNQnlzdd7zHsxCDaxfD4w4Og+EJVo3IIHfgDzbTFyL69Ov4CMe18IrF0EbF3363VqQ79b8p+/EWK6U3d17wO6lhZSLT5CiUvK7teitUwdMjRagtlkx6hD9LnwvhSp8e/rHsXC0vEeaI5CPP16q/f/jV0Cw6TN1JpaWiFZsholY3lEeHQgdMSYJ6pt9V9ZeNWiaksPfPsf227cn8I/dbEYkNxBj4d+BXnFMEygrfux8X6z3V7/Jfx4eThN8A/Tt1uZP4J1u3dqZOkLu3L8G94MjXWKEuB2ekbdLje16wlDe9Ki10qh/anwp8+b+wxlRO58HotK9mzywJHMZoMxdtJhvkDeXWhdAuGmWPwH1GYzfWc3kPZtgat7G5b2GbD8yUTNtRc/jBP+b1KdfQEla22M4a1Cu7nRR279UpdrHgXHm0jobQtj86eHBNqHnS3bUZlR6YR6lzIM25tIyScADhK59S9T2VJYGgRlcWICmCbh/UQfp7xzR+VpUVBn1Kx91cfBrbfeNtjqGNHg/i+7RdP7i5zW+qbCcC+/oB/bQEYaMmoIyvboO5giDMnx4j7UEJrsbmkaZrhzmqfqd79YAR2yHGDhGIMCmJta8qFxV9m2hf3ERQVkkd4QBLCQMqqs81WZ0h2UKtEAmde9PPYxjx0OWsCUkDgXmKh33qMN8MHKuLE9H/fMWT+crIMgQuz7PE7iOiv5tTkC1dq4u0MnZPIrIDjNKvsxChXK+X+7Ph51GuT0LfT2xoExkfgpBYEV9ukFy6mgdm0+SjEe9VHMucMkfzfQ7k64yUhsH0558JH8JFPTzTSDnwXlsPMfnCOhixyAQOgMPn0IJ8Cv454Xr/Sf4RTreH3ndc+Tx0aZc0/yGOwmfDnTLg0rQgnnB0a+Of4nK+bE80cmQ/3pFgc/s3p2Mnz47QPgMWpmhu1mQZARbyCs+ipaR//oEwpMy7ZdwfECXmAZPkbKD4GQOJf/R00cMzhOu3ObvIQL+wRUu4B8AhUNvKkGQtUadair3vAj1Zd56LCbdvnx2Fz7eBvXTheBW5+1bo0EGdIPPofdZz4c7odITXl0Zvc7g3q///A7qO7DqPqlwGBn68OrvU/wVfU+Gm+GQ2F+EPzdp8qeiff8XkXoJTf4TRLH9YOSmfHzUrJ+jx59HjA8Y/JAgdzfGopYe/gmZ/CGd7j5ClPk72gvZY6XEJ8YGebJadjtFvw+pOt2NVF2e+bj0pLyn6X8r8d9K/LcS/2VKLJf4ka0slVDuvxEhjNBT6EGp6IO8q/PwnSPxJnMzFTb7ZHOYTN2OIf73ILCfc9NZvd0M8x+UVjMs67PHm76nJX6lMihBh84Jw4dTT2Uo3WEeaCPhUrYBXR8KkFCiYEoddTN5iYku39cJ2hhfLlcUKeHURF/vjshr/oBENsqNhyPyD5rD5HWjhxUSES6gTJPC0YBqx9RhIKvh/nkWkGPtVCGXDPBHTtyW+0lxXahY/3qmP/RhKoWqXPr0PbSU772omvxlilAMqrxXg6Mr1iiDG9WRRY8H9IE+yH8lUzVq+wegy6WJibp4B9QoOAqYH5cFr6vI0IyhJUPcCN7NkbewMfRTpm8BlLmffHyTgns99O/D99/lIfLyXuj4VgskN14V8ovHskQtP/wkHYS/6KKw7RNdkv9dVfpD248G2d/ly3EedQBBsv9GrgVPZjMb5J0Fz3VdhYvUDun3pCTKSJg/2IhxWQKI+CSLKBxVt/P3RYZ5Y8o23IYayttYto7+XbyBewQQMdEOmf/3x3i7Vy2q/vkFqfKxTRG8FHD2WepS5/mrappf9EMwWdJjWwtqKopAFsRSNILqx3/78nB+lUueMHiFKfShjfELqBHBqO5ofoWnRDXHQiR4r0+VWEzz2CNXNQppSLF61VFeR5OkzHdr8jW86wdyUBkv1QSXd+IU0ZAeJNjqihzWQTcgKvBF0xf6KOj6OyooskxhUS6OV/8wAQtGXe7Xc2bkl1/AoNTgssuKOdCDEwD/oIvgAoEP6bKlJkcvJMG/QnDa8DwVcgX++N4HWMqLrK7Ua1kCdOAK8SeJxm+gGXwPEsLfQIm6xKRQlwDA/+ZPgrhkyJ/095vENnL1B94P/Pt/fwKI22AltiXIxBVhvtjOIqqj3Vlzg4GHoEvCH87FjfBN2n7pl/OlVvkM4V0/hOubh4VJFw8WlBdEg/4ID/5/0CETDz4IGYFc0jbaLg+vtyLOCokoZatrS3MaPmPdYV7ULzg9hP9MbKkg6AO+CtuyifeYXW5loH3Uts5b+d9/lrJ/ArZIoXQT22f6fqsz6E+3O7W2/hJJWNGPchBgK9+avt7KgjtEriWBI8g0I3p68gDlbQ+oiQduSGf0cG4qhP84tmu4g5/I7cU73ke5ta01vyatktvj8FEmHi5awuE/k7bSk/oe6xLn99jejaVTWSKhGeH/LdqRYPlfgrwP/OoIQJ6hW+2+E0UfM8zfWYur4StNfEf1P4y0bdg3xFlR3O92XWHr2fgdosHIMfW4EN6Hj9r3x7FVKN20FH1n4V1vxZyFt0IWv8b4cvRBfrjStz8VW7nVJ7rXlz2iq600WXniUUwvsrvjUPDpU0z/JGz5bQ8n+51YQ8S/0nkMNG2oGQgkovLq2HVGLXUPqseKxsFa/tCsFcvtQTmSiMaihrBMle0gZvHOcoDYDqve6YOg/OJizjHklBk4YtyPY01JDL98QrmwILnA60ZL4n0mfnFP7O8fB/n7x0H+3/04SJBuyh6nbFBjVTZQKvg9KIF9CanMTWaY8sX/+9CTrN19vQ/JBrd8/P27vOQ6YubbmxzeOojJy2xfz3Uu/zdFMJefj+XMH+jRXT+oh4Q/a05+hvjxZijxLkrtPuZBbfPt69t9yEBQl5WnU7m+6O8dURXD88oP9z7PVXqZdNrih3Mvi4rdzmAYug8tgp84sVS9KsSgvKMn/1VY+hceVA1KjflXRWReGFxV9a8TqoLV+QbvqXJwrKd9+X6bDt+/+zOUNL29ncgSFH6+vr29/Q8bPNGl +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint is capable of generating JSON Web Key Sets for you. There are different strategies available, such as symmetric +cryptographic keys (HS256, HS512) and asymmetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not +exist, it will be created. + +A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a +JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this +functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing +user-defined keys as well. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-native-login-flow.ParamsDetails.json b/docs/reference/openapi/create-native-login-flow.ParamsDetails.json new file mode 100644 index 0000000000..cc80abb4af --- /dev/null +++ b/docs/reference/openapi/create-native-login-flow.ParamsDetails.json @@ -0,0 +1,52 @@ +{ + "parameters": [ + { + "description": "Refresh a login session\n\nIf set to true, this will refresh an existing login session by\nasking the user to sign in again. This will reset the\nauthenticated_at time of the session.", + "in": "query", + "name": "refresh", + "schema": { "type": "boolean" } + }, + { + "description": "Request a Specific AuthenticationMethod Assurance Level\n\nUse this parameter to upgrade an existing session's authenticator assurance level (AAL). This\nallows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password,\nthe AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ...\nyou would set this to \"aal2\".", + "in": "query", + "name": "aal", + "schema": { "type": "string" } + }, + { + "description": "The Session Token of the Identity performing the settings flow.", + "in": "header", + "name": "X-Session-Token", + "schema": { "type": "string" } + }, + { + "description": "EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token\nafter the login flow has been completed.", + "in": "query", + "name": "return_session_token_exchange_code", + "schema": { "type": "boolean" } + }, + { + "description": "The URL to return the browser to after the flow was completed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + }, + { + "description": "An optional organization ID that should be used for logging this user in.\nThis parameter is only effective in the Ory Network.", + "in": "query", + "name": "organization", + "schema": { "type": "string" } + }, + { + "description": "Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows.\n\nDEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice\nof MFA credentials to choose from to perform the second factor instead.", + "in": "query", + "name": "via", + "schema": { "type": "string" } + }, + { + "description": "An optional identity schema to use for the login flow.", + "in": "query", + "name": "identity_schema", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-native-login-flow.RequestSchema.json b/docs/reference/openapi/create-native-login-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-native-login-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-native-login-flow.StatusCodes.json b/docs/reference/openapi/create-native-login-flow.StatusCodes.json new file mode 100644 index 0000000000..ddaccb37a7 --- /dev/null +++ b/docs/reference/openapi/create-native-login-flow.StatusCodes.json @@ -0,0 +1,1618 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This object represents a login flow. A login flow is initiated at the \"Initiate Login API / Browser Flow\"\nendpoint by a client.\n\nOnce a login flow is completed successfully, a session cookie or session token will be issued.", + "properties": { + "active": { + "description": "The active login method\n\nIf set contains the login method used. If the flow is new, it is unset.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the login flow, this\nrepresents the id in the login UI's query parameter: http:///?flow=", + "format": "uuid", + "type": "string" + }, + "identity_schema": { + "description": "IdentitySchema optionally holds the ID of the identity schema that is used\nfor this flow. This value can be set by the user when creating the flow and\nshould be retained when the flow is saved or converted to another flow.", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow started.", + "format": "date-time", + "type": "string" + }, + "oauth2_login_challenge": { + "description": "Ory OAuth 2.0 Login Challenge.\n\nThis value is set using the `login_challenge` query parameter of the registration and login endpoints.\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.", + "type": "string" + }, + "oauth2_login_request": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "refresh": { + "description": "Refresh stores whether this login flow should enforce re-authentication.", + "type": "boolean" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "requested_aal": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "session_token_exchange_code": { + "description": "SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed.\nThis is only set if the client has requested a session token exchange code, and if the flow is of type \"api\",\nand only on creating the login flow.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method to sign in with\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the login challenge was passed." + }, + "test_context": { + "description": "Admin-test extension of a login flow. Populated only for flows created by\nthe admin test endpoint; included in the flow's API response so the admin\nUI can render the pre-scoped provider and (once captured) the debug\nround-trip result.", + "properties": { + "debug_payload": { + "description": "Contains the parsed claims, the Jsonnet mapper input and output, and any\nschema validation errors. Bearer tokens (id_token, access_token,\nrefresh_token) are intentionally excluded to limit the blast radius of\nthe debug payload leaking through audit logs or admin browsers.", + "properties": { + "error": { + "description": "Populated when any step (token exchange, claims decode, Jsonnet\nevaluation, schema validation) cannot complete.", + "properties": { + "message": { + "description": "Human-readable message describing the failure.", + "type": "string" + }, + "reason": { + "description": "Short classification of the failure cause (for example,\n\"access_denied\" or \"traits_invalid\").", + "type": "string" + }, + "step": { + "description": "Machine-readable identifier of the failed step (for example,\n\"token_exchange\" or \"schema_validate\").", + "type": "string" + } + }, + "title": "Classified failure of a step in an OIDC test round-trip.", + "type": "object" + }, + "id_token_claims": { + "additionalProperties": {}, + "description": "Claims extracted from the ID token.", + "type": "object" + }, + "jsonnet_input": { + "additionalProperties": {}, + "description": "Input JSON that was fed into the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_mapper_url": { + "description": "URL of the Jsonnet mapper that was executed on the claims.", + "type": "string" + }, + "jsonnet_output": { + "additionalProperties": {}, + "description": "Output JSON returned by the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_stderr": { + "description": "Anything the Jsonnet mapper wrote to standard error.", + "type": "string" + }, + "schema_validation_errors": { + "description": "Identity-schema validation errors produced from the mapped traits.", + "items": { + "description": "One identity-schema validation failure recorded while evaluating the\ntraits produced by the Jsonnet mapper.", + "properties": { + "message": { + "description": "Human-readable description of the validation failure.", + "type": "string" + }, + "path": { + "description": "JSON pointer to the field that failed validation.", + "type": "string" + } + }, + "type": "object", + "title": "loginFlowTestSchemaValidationError" + }, + "type": "array" + }, + "userinfo": { + "additionalProperties": {}, + "description": "Claims returned from the provider's userinfo endpoint, if any.", + "type": "object" + } + }, + "title": "Diagnostic payload captured during a test-mode OIDC round-trip.", + "type": "object" + }, + "provider_id": { + "description": "The ID of the OIDC provider this test flow targets.", + "type": "string" + } + }, + "required": ["provider_id"], + "type": "object", + "title": "loginFlowTestContext" + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the login to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "title": "Login Flow", + "type": "object" + } + } + }, + "description": "loginFlow" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-native-login-flow.api.mdx b/docs/reference/openapi/create-native-login-flow.api.mdx new file mode 100644 index 0000000000..a9bfc64594 --- /dev/null +++ b/docs/reference/openapi/create-native-login-flow.api.mdx @@ -0,0 +1,57 @@ +--- +id: create-native-login-flow +title: "Create Login Flow for Native Apps" +description: + "This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on." +sidebar_label: "Create Login Flow for Native Apps" +hide_title: true +hide_table_of_contents: true +api: eJztvXl74ji2OPxVdJn3PpU8A2RPJZmpuZdAUiErAVJJqumXCFuAgi07lg0hPfXdf885kryASaWqq5fpS//RFWxZOtrOvvxSsJm0Au6H3BOFg0J7yCVhwvY9LkLCBQ85DZkklDjegAvSd7wJ6XsBETTkY0ao70sSDmlIbI8ILySRZISSXuBNJAuKREbWkFBJXK/HHUZsNuYWk0UiXRqEpP1JFgkVNpEe8US5Izqi3ieUjKnDbeIH3pjbzCaSSck9QSzPG3FGvCB+EnojJgiXcdsioWR7fZ0cUps02VPEZEhYEHhBR0y445AeIwELo0Awm0TCYRKgZ+SmeU6eIhZMiU8D6rKQBeThfwLWD5gcfgiDiD3AKJKFCGTbI30WwswEYc9chlwM0gtkUcchD2uSOf2SZAHMeQ1fr8Fr+T/w/w//hP93uf2vB+zz3ovIxU2rTS6v2riK4cxWEMvhTIQlyW1GVlpcDBxGGnTASMX3ZZE0GbXC01aRVMQgcmhw2lolAtcqGLNAf3ZKx5S08ElHwMeySC49m8F3jZNGkXz0HCoGRVIul1fNNsIuO9yicEZkmdxImO4ceOGQSZZpSnDJXTpiHTH1IjKOHMEC2nMYCT3c5oCzcEq8Pqm2mseEhiG1RrJIuLCcyIZR8LlaWf1WnRIcjlhUMvgatgE2uYhPH/DvMrcf4B08OW1dXZKASd8TkpGeZ0+JRQUcBk9ABwfQ54M+VF3qBIza0y4dU+4AtA8HpD1ksCkBnAL9nkg+gGPE4eAmH1Nnoxuwp4gHzH44IBeRE/JSn1qhFxAahUOywsqDMtns01UyoZIE6pQym/SiEKHFcYZUEuHFB32KJ+9BMisKeDjtWjLod8fcc3ClHw7IjTDrqk4mdIRnsccsqi4lrmX8DfEsKwoCZqsTndlNPIdXl+f3sESRxEkSaTFBA+7J+FJrHKDvNqKCFTyF5BLfFMlV75FZ2KhaJK0J74dFAkdQnS8c+cILGOGi7wWugkvvTN+LhE1oSH66CqbkLKChJ8kNLM05HIefV4Zh6MuDtbXJZFL2gmnZ8tw127Pk2gjbZm8f3rs1WNkSnqZVRDs/YX9NNuAyDNToNc+KXCZC/PX9gwSpPlfLhWLB85n6VbcLBwUrYDRkapVwOseONykUCzH2kYWDn36Zwc1NhY5iXKzPhsaakoWw+4Criupy4u0LzEdzmMocrd60I6gcqTutT1/o4emGbacDykWZtFM94lBD1hFwnpkI4b4zu0tDEnKXmUun+4fJcwAf8WuhWBDUZYWDggasUCxIa8hcWjj4pRBOfXjV8zyHUVH48qU4vwYKp1PS8pnF+9wilQQI7okLFg49m1SkjAIqLEbO2Zg5sEY3BqcmKD70SOQPAmqzzPpoyN9JkpogXN+4Uwc6JSuVyvmqWpqOoA7sPgE8B8hNjpBMurPXP4G0TG6HTMDA3Ian4TRe8wgxLOIJ2A5Ysb/7VMqJF9jFjoDVrVTOARdtlEm9j4NOuBzCyJ2CnlKnkN6Gd0C9FPIgvSnJ2XCfBXAJSfuq3SBr5Jb1YGXX4KYq9D3xIsdW5wyWEcei1NnsFBbtMaVO3v7KMOBikLe9gGZb+ly2kbbrw1Q3S6ShNMBLFsKWScR1MRhDRm0WJHDclXSnJez022A6QsyqO8Dvj56tIRUDVvVsZvC34iNSPEDoaTIGqNeClsgmaeyGSDX0gBkJOBuz9FYprqYjaB/PaLZboAs9xoAZcn2HhcxefMGAz+kawoSddpkGvQsQfePda2tGSYEdBYoGGx4BDn0MMIIK1O2tUIbet21KRRAP/6YO8YIBFfxF4e96Ta2zHOJpNUsNd9HxBoOYc1HEHEh3O4sTuCSecKaE9fuadCnehgAZumThxAtGiyaThuTb5vOJUwOy5YmQ6jENZngniRUw/EEdxfrAiUomKZkA9F8mVwB7wBw2pootgxuK+6E4p9pRo3lUrbSPagcKp/c5c2yYtc38gCEmL5OGw4C1CpjrwQKEpB94LqCZID7v5YQnQrIgvAmRDA/70OMW6wivTy6OKynAEWdYQ8+TTHWYwjrq/FuesInGllzIkNGFB2fM6fcfmQTj4vdICAAob/a+LRrddNDVALwGyc/FguE9JbzfXF+Hf2CfmQjhzxTTvPYoAdpfUv3lSGge8lUkgC2Drc8KaGVSSaMMLmNBDhkqmGGnUNePFDtFKo06WSOH+jIDO9IpdETMEQLJ0AIIHqMroIJ0ZpT4sgOHaDEp+5HjTEEk+5oEZ2QzLmWkcIUfAMcUcrVkFG9i3mIwot5pUFwk/ymWSN+mNHpWbRAvIPWMERaXRLBJEc47YAihxD1DeEk1Ocjtqc8a+nlHeNy2Zt9e1WvVjgi90J99A/S1IxzPG0V+VzIrYOFsk3N82RET1gOeQcy+17RZdASigZm3QJbgtQJ9xKZ5kI/YtCP8wOsD6z77Xj3uCEldZ/Zlq3Jx3hFKkM8FroavNHzqnvQ5C7p9Hsi5mdbj98fwuiMcLkbdgFneGKTxmdZN/fycixF59SWIaUQCi0idDOqc+ozAGIr84qGA9sirs8GUrMRjw5FYLRNSx9OgdRs2mfBwqLFzGrPpG8lDkAjKamO+Oo+qIsJMRG7h4KeCOWkgLnDbKhQLcH4KxULmsBSKBXMuCsWCpuN6p9XFgc0DjERdYL9SWwXIbGZDoPf0kusuk98/F2cQWrHwXBp4JQC6BLexcFBYXpHlFfktr8iXopaYQcicpwJV9a4SqjkNmeOzAOCNrFDzN0DZB14v6vep45V9zwcao3QOhYOCTUNWAtm1MHvYvxQL7NnnAZO5Ix+pd2pkmC8KwCs37eoqmYB0F9MW3UtMcJBxkiHQPZDcGPJGjjcgXBQ7ggIhShj+0EPiaIj422Hn9jzM9VqabzAAvgOCx58iRuo1LZnOiFoJrVf6hY6Y6YbbhlVWTW/q7+SsVvWAgEblYG3tn3AItOKkrNhT/Koc8W4UOP9am1GSpqccRdzOn22WKZufum7QUlyfYQedKRl6jq1mUa8ZmXOOSQS5QokOdkcoXpFryVPx0mPqRMyIeMB99KbJZuN5wGNsVhT3lwq7IxJGPmDArsAlyhwfUD7TMbOBdbI8MWZBqK4nFV44ZEHMrM4vCrJUuae3jq/ecHhlSINvOnceoL3NLu5o1xpSx2FikMO/gUx1BXiQbJbXNSdaNc0TxaRaV6WA18oRVPTO9P8wp8PXO5nWxqHiTx1Qw92CZKTZRWRELU9p6xhiMhIDuYnfXvlMgJTpAecJalAqzGulaidrpk1DWSWC3I3JrJGWqmCFspzvK4tXr5mNS0iImbGaoO41d3jFzOdsSbwdVWwhCQ0SfYUR15JWqSWpekIAhlfXmdzIiCL/nzS2ki47YsAErrLCzlnDwZBbQzKhKNTCgZeRy5T8mXTmBbMDW9SnPe5wWLw8IQJkEq0IMdTstQWo4AdaEdXSH8ChVC/wuXlstiKmkmbFzCyJGl4JPHDiPqGRS+EgtcgPj5PwARf0wfPpU8QeyvoZ0rUetWGnaRHl7IWaaXWuSsBxrT1OwpIat6SVSi2lMMvCOmQBI0BuA24zNY+B4/WoY/RrgNgfdHNY2/RSPuQeL1SHMrtreYHsegEfcCG/fthIRX1GqlfNFrlSnyl5E6VGF4wFN81zSVYQKbODtbWhJ8OfDnwvCH9e1QcHFlMDAFsAFijVo1FeANuJ01SrtaakUIMPNJGGRQ8CilvLXD+cFrWWAi75O6l6VFODI9rng0ijmJUHeNetnJ9f3R7VulfN+sf6ZethNTFCaqOK0nDMDydZqAYzs9ArqGbm+0zYCXf2dYDKHXHICJ3A10jFmBjzwBNg6EArHNqOFNBHl5XD86PagzICaToWeuRBWUFjshd6JFaFhcyVOZqP+FjgvPBURDZnwsqjBHMnQTfF+ybUQpQcLkNisz4X5gybHqWCSiEYZaWL91/vur56MIUygS71p8ThLsczMYztl4hFptq2uAAjhF4Rl4M9U9B7FInFAtTcgS4loS2oJ4spGCUwB1SOwTkuq9McG36N8m8y5CGTPrUUItNDgGpbX3t3ansuWGbg3lOfo9lJFsnC974nQ/mNmxUOvUCrM1Fh3B0EVITdDCJ1eB8ARZ2ViBw0mBYO0AxV8GkYsgC29///ab20//PfV4T8dyT/7cp/y3+7/x6u/n9zqKNYCHmIM72MHKemD/Cr4HD7TwOKNmr93vD0qDUCvb5gDvATXhTGan9jis65cVnaeUitUamqOgFOzIvC2BTT1J3AXTxUBgJ9olF+7E/hNk6GDDlRuEXNBtEDa+8QSiS3yYrR+tVrq6TqUO4quQbNJLH0oAbvCHPLDHszNV2bXpA7Q9V8I2FYc9YiCrjh2xWn57k8DMFZBD6wWZ9GTphc0T51JEsRtdgkkrvQUcC/a21vmnVYzmZD2VRgkRTzSZXzB87UyIQoMhP4DOeJ2n5qelLrpEWNq8Yr3F43JY7/oXdZg5Mnns4RgnpNyQEomoEu23WjECBDuik8/TjtAXRzU69tx0rlmM98bWWUXv+rwFxSlxlwhpFLRQl8QZB8Qg+G/dZkSMntWkiOCTaq1UsoE9oRgEEy+OQ1KLUG8OtwtrChgVSr0GIt+8yFU7qVmEyC2c5hIPE9h8o9C8zWHSEYCDexP0DcLZdkxHw0Ng2pHCp+3oVLL2yjF9JqHlwoD2mu96pcomfafU35smDSRCtlSCWef2zjQo8XETpTBEpGPrCNYBUBSMOUoEmdCZ1Ksp4RebkId7cTmLkI2YAFKaDzccEsmPrmq183zbpiCwALqFVAroNMWI/44N2lDrZiwhMvGdrztLtQbJWp981RSzOqpHVydXNeIzaXvkOnik3SZlxoFZ9FDiZn6M0a4Tb1qRwuPI7ApljhWzj6qmpq2DjkcL2+nqpMVFFIQmDNlcAH3xCfeb7DjOcW74HCNWZA1byLoK/kFipxmEu5Q6htB0zKOcaJOf7/6p9lLxh8Eyv0mvZxfsao4wFfIhoiskj0k8ranWhbZEhdP4s0lKk3xgRv07coXXM3y5f8kQj+FYB+f3btFWD+IIatH3gi/LUc2zF08tuxbFxKsoLaw0B5y81xcDPaNnBM6YiYuHwr45a3Jj+Oc1vQ+/ct8q/h3QKQ3QNFfMH3qw+rl+LeQDLNLD2uMhiqjFIT9iKHn57VfV5U7jPEPh4CIGPaXTQGFV2ugQtABiVmBQTuow0dulwwrV/RCMv3QsVMOlPl6AbIWoMkCTd2C/C7ARVGFP6D8D5hHM8cGBAMbEXS88Kh0TjkUhx1XeHxW4jOR2hNwI4kZwlP0ha7RHOXTDNtWd1BJFmZVGNnYRDcDxLqnbZaqUEPyMM8r/3QEZU08iHoOWbaz0uTDx0xcwzrLqgluJnZSuKs81+rB+SB69cPHWG8RJVUYMbI4DnoPl4F1c64tB2QhygQB5yF/QM8SvIANWQHuFglWKwDUCr2GA1YkOlIGTWzU/tqXxo146S/iSKbGf+hVG4GiN+fsj1ORjnXAd3db1mPnLEpaaHHQFYTPmLTnM/OQbnm9Un6c2lYaIVj9cXvYA+dQtZtjqZuWQaEldPbs9WOwC5kmRxODeZWaNwL7MRwcXp7psaSaTOy6tf24DoD5w4LP4UB42/9gPVZgOo86npKOegWCXXCoRcNhhnzAmrfYKAWCyWa67RTGjruohMuJS6jSsnopYDUDmI86Ag/CnxPQvwE7xObSSC2GWXojPHBGeS7L3XgVadAVqgz8AIeDt3V9LIay47U6mDdhoDwgUrgPsS2ANmJieqITcsk0Toq8ml8BTX27RmjmCFFiPbrlcsK6STnp8UHgoYR6JyFTY6EFUwRdFIxcMAh0Na1aUcAP9tzOMqAvSn56fS28jOo7XtMBfVExgnWOGVRUvUch6NrLqAuyWVItZidZd+brc2d3VxRJBjDwiYtG6UFLe1su3b3cq9e2j1hWxd79P3dxvg23G1/rD9vPx92Pza2LnrbLfm5Vdkel7xgfPry0uTXw3On2dzbEPT2/rl/XbkPd7is1Xe71c3z/Z59620fHzceP14fjy+95l2pKw9Pp4f1buCU2ocD+fneu3Eqj1un+5u37v0mF71KqTGZnvYlrddrFrs/rJbYXemZV6Pdp4un0We+dTG5rhyf7/Yu7MbRxfrL9umhNTlub32y+W2l3ryJKtXb60lwd/G0+37z+X3/IqJ1esLf39U+DsINHg43t6rnfdo8ck9H0X7j2rKGvbAbHd2Xhk/B8f2uCNtha9unt7fXj3u7z+fn+9utUru/O959Hp3vb+w1+uetq/bT7l315XnsHE9eDk+fKr6oDHuTp/NHvzEc3Hxc3z6qNYOnoHVo7dxvHJ6zsdit+zvDjcqQSXnob03OR9eDl27gMWsUlqa98ctZ+/GodRHRgfCfzsdX7ff3+2NWjwabF5PG6ef65qdH66VpbYxfLuTmzl1wfL1X82+mpd6l7e/tt91x5W5ihTcX/NQenDje6WRzqzpe3xrUbyqjmpDtp8/uyO/V+yUr8AeXZ8fudaN7VDvz2J7fbdx9/jzo95oB37r0jj59bLy/GO1Oj6K988fTYdUZfqaHl4/R7WSzdOYc9q8qW4P3++6wfyhGdcHYztnVvvuxubP+1BhtfCpdeMHN/WX7+OJz3V0fHR/tsvtPt8eHk9OT87P74cnN1nbN42cbnxolOf7sVzejysXxZaV7c3o0udivXm/29p7YdmmH7dPp5GI8saJK0BxVDnfcw3r/il6dUm/L7Uejs8pR7mn2s8f547Zs3I2s3Xu6P93zTm/3u/Xzx+3nyPejdeeFd0/ef2qPWnvPjzst+27L8o7WPe7eT57rfJO57UrE1m+u6I7tD44/Tg9Pt6298Hrz0/H2+uZdMxqc1dqNPTq6Hx57O2Gl8v79NeteumF0/9naqm65W/XN7Y+bH8fNHdmqPd9MK5ebL097532xf3Tjyt3gfuuqt3fP+NmozQ8f13On85Sdjtx3Kif7/cHgUHrHzb0ram02u0ebg8nm3mbQ3hx9vKoMx3XHOWofbbB+UNkdRjc344v+oXXhiz3nid3ujl9exP39Tqt1ffzev7CrXTqob4mPe/Wev3F401s/veEBbV4+3fTPh9Z1r2vvfzzerg3fs/fbt72m9HpNT0SP7fvLjecqbey2r3Y3Hse3wV3pfGMvfL6bbO9vX3etwSjXaSg7m8p15TCv2WhmD+lkMIiOpx+D2zM6fl+52/50djPI/TBPdarIyYjbQE7AqQ3EggyJNkZpl2L0opYFuRXTDOTKVTtl3AIbJYS8FFO+24rAUrQMen34NibW1NDVjtC6TYAj8BwH1H+aLCnPLCArCT+BQBtBriMioUEDH13ljpRplPJKmB25SGzeR14g7Ig0bIa9aLHQKMWAbtoY9WOFMwOUCVm5AoZfbw9RVjlrmHSvZu7ywTAkRvCTIM3NzofwPloXp2RIxyzVQacwCqdmt2CTV830IBgQpgi+D1wJjChNdQQI6WPqoAnAAVYSo8ikke9SjE7iKuOWV9XSa8g0M6Y0jxBFWZJMSI6O1OqQZanvxu76lt1n67S/19/e2c8lr6Mwx5lCjzk7yYUMDnIY3iCg/pBbCbvTEX3qcmea7LjhdJIQ406h2ap0CsBvdApH1U6hHI+s11SxQB3xCg9EZlkg4F+VHPnbMTrx1iTAvnlnmq1K3maILGIZt5+C55vpdcPpbq7Tp/7O6O5kUvscMKd05o3r/p58zyannr15dHfi7IW3TvNwq9tk7tb22eSw/+ScXX/0N8QTHZZ2Nk62T1+C6ImtW8eNnb1h46ge7t4+BWPhnlbvnsVlVD/c2eJ33ejm5u7upHZyyGij2mp6l6cvl1P56J1urbfrN/LskPNgeEjf9ze3dhp3vTN+YkfWORt/2m1YZ8+nO9b93svV5t7u0+n54W2r4Zau6mw8eZJ12aqfbG9fh+6+5N4xHw1HvfOJ9zS5vWp+rNyvC2f3bvzpyhlWavb542HrqVVh7Y3jRlStVcXd5KVaa+5d7tePD7v1R7sVHo+qpeBTuHm2c3jfb9jr1tb02O+OT5obO6xpr7+c7t1dv594h9W9T0JSa/co3PDPWjv7/t3u5s5urXEb7d3U7KMrzzmrNAaW3R1sXvqV97tWhR53H6323vrj/llw9DLZa4/XxenhRyaj6mPj8vGj7J692KPb9s1duLl1IvavT6VtbVx8jujtOn+6O2T+yX3/3nu6ZM7Lp5BtbLwPtw8nn/z10c3F7oSt15+md1WHfh5c1fdapdva4WSzezW23T22c+kO7ys95+iTNx1Yd3v327veyW7vjNPqdf+sely7sJqD6tBl7yve0cb08+d72ejRj92t+mMjqG6fH16cXE/2got9+/bxdK/uPnJr/HnDr7jr9nPp7KTa2JruND6dBc+Htf7GS+tKHjZHV63Hw71246omTi9edkuP9s6wHX5+9j83Jg2vblepaH/e+lzbjZqHftutTUK/+dHd3bq5lhvuzvFtY9Jbb2/Wj3OZgxlWZ/eyN7qb1G5vhrzEmjs71UGvv/n+eHRdq93WqXtFa8F68LjxtN7f6B8fvWzc7lS66/v344/r+8d8vFG52izV9prO3qC18Wn0ssnXX6qtJzGd7lXWN3furqzmmF9dnL0X9eej7auTbuNIjrw9O6wHva22e7Q5vLkbV0fuy2T/SLaPN86vD68+Vnd5JM/bd8yvVzee96NR9ez48/XYHoRHV73rndGLvX85fCpZ9pPbYhefzr3nxrm90XPG/FN7/5O7V5pubFbDe5+dnlzRei381Dh3Doen/NBrnN0OtsbPLXf77rnu8Msr1n9ig7oj3Xadbl34rd3bW6d6tjU9GdJw/boUNJ9rz/aUf7I/dicvp2N/vT7pbk5c+d5npcbgsnE/vrk92T/1h7eNnbOtvfuno0N+enx3nbfwM0zZemXj2PWvbpv7G91m5dZ/Cthti44v6efevrhjZ/zQW69dfzx82dqs9Z7Onq73Wtv08NTtNYenlhU+Vs8fKRclPo7C7ffvw8rNhftyOvl0Wqs9bV58Pp5U969L25/uP7vHN9snpzycXketl5N7trvdfLwsHXUvr9c327fDj1vXH293A+9p19p5b+3vB8GNPGpPTk/5pLV3seNv7Fzw6GVnq0avHsel6OnpuHLcn04ud25Hzye9gB5ajyfhBb+Opte966dR9XhY8qg4GU3uL9k0lJfDdrTpXruT5k6tuRl4nzdFgx8/VneFtEelyvujrdbW5OLl/v548v5x3Lu99e5vvf3x4fZ69+J+8379+P669WTVXqzDuvXUXQ+FoLK/9el2+9h+3nX31psvV73NYykc8X58dlfJX3g+wxlOL7r+7mlwN23xl43QOx6c9W4/lU7t+tbj9fbUj/aD3sXt81ZwfXrYd8P1Y+/+ZXBT/3z06fjIunqaMLd5ubfx4tUqlJYOR+tnt5cfa4+nJ59rds09Ht5uVS7fO/WSHz2Puu7J54+nGxvB87S5d7Wzc3feYluthtvsn00+13enN5vbn5/H12fH9/XQduybs48vV7t1uvvSPhtWPjVv8qYTyRzjOgRkr3QKftRzFAcK1L1TWJ3lCWJVR4TZHpSfVvJVWVNP/DjL7jLXd7yptkUIG+PUjdEDjJ2poQ1zjA5dWtEhBsSmIQXCPmaBtpkgk2f0Ih3hCWxTJp8SttTyXBdjSDsFyVG3E3+wqtgTJix4zGKNymqWqkuey/U/Zw9Ff2/r6nSrtvl8vHE42BtHvf3wnG0MTi5ePr3fZXvtSO5HjZNx89NR7qY871iLGLbnHYTvrryzvo9ubSAkwOJZQwrJE5JVTnE4+A5YeqUn196ajbP6XboLSX5qHld3NvfWf9aMz1z/JBNcAOZ56B5ZsljBmP5I27WURblMyBG1hh2hjekZDaL2o5Vsd7vEMADFJistiPP1BNmGfgG47d3tvZ9JqaR0jap5FDjmi1VSO2qSn+rtm/Ld7v56eWN/f/vnuXkqqMpKezr3Ui+bOVBwAtUsjNclWsRUvE/qu2/ztpxmj8tz9/jopRntu1u7J+eX3TBiuzv755f+3e2uX522Qj66fzyr39Z3aA4R/gJBrMYw+RNeaMXyK1m0iArOJFZMxfqkNNcQ1nrLemdsOg/pl7d8BnpsrfF+o5/FrBocjHWYCKJ5Hkf6Vo3Nfa7xT6e3Zz8TW6cDieN2dN9woWUq9l8piVViHQwgNfdCYStoroXhFbmaagtIR2bsbzGqkDpGOh5UITojwYJ5jzrSS8eLG7PUO0kS1IJS6opcLaacoxHVaYFRA4JGQfwmzpQTz8uMj3I4mur0hDoCFMMzY+EILibVMBl0wCkLsPcKrO6NzEiAsbzTPLq+qTePaiocwHFUZ/r+xup9uyPMEqSxOqPWED54J9P0gg5YmVSMDUB6bkqFrs18idSO4qmXSRkAc+2I1JZkp1sktocJQzyAH/x3m0fVq4uLo8vaUa0IaEuFEmOeKUy/wZJNfN6x5q21KrYIAi2UOxtRKDhGhjo+wmhdjNOb3hqltlFekEEKq2gHYxVulnik4WzgTUcohVA4BPWO8QrLop05bPM4CbvKDPiH2uDAlv9GhADWe2O7r6QdrszhMug49sSBznMn77KQAt1HPKwhAxTSpJMLJuHcZYPzAY+VUy+Vz4AXjCSZMIwBDIeIg4qkdX2uvO5aEzoYZIKHNHqE4KGJYMEbpnwF7TCAAv7QMZ+aMGrnDDNp7NJo5GY7yl0E33O4NX3j4jewsVl+9SvP+Q1XRrnOqyxhM26WfsDH1JoSNXiMoAHPQhY6BKLHJBnqq20z4AEx0iGTKMTyHIdZoSwiCi4Cw4EIW629zaXlgHkPIp4k5oxANi9/GWRoXEoCZvOAWehbkmNiNeEtDU+GpaZum/IqUd4KhsfB0ABwUnR4gq6Vu4ZC5VyRgTi+YaizOxwJuwSprd7pjFmVAUwf9V1qSESOeuM7YtEEUuhJpXbBhA8AapyFRseDzZg+v8qZfGWZ5g5PvFRmjcwD+D1rezbeG2YQEgWOjCm+FZ/nbFBFKmZCBwWBUyE4fH/jzNIOZX8kYsyD5Pf3UMiD4g9yuktHgWb25KtOYLWpoC63ktOYCidNhwSpk5m8TMUJziZ+inzg9opkAAYLLyA2g8wpCe7djJkuFVyP9DobQmwSsoD5H36/AmUu3sqsx6sezG9fDc1ip59l/JxNss1vXob8CSDe6yqy2NU8aTfX1WJmDiaPnEpQiI4OsISVxOAAbGYLpIDWz8AzplwvlLYfka2R1mKG0TD62f6lyc+UOPk5zmybjtD8PpdmaU33AXtEpI2+Jui5rlJPakMIeqxp6F5dqAXYNn9p5shRqhfDVqrYngA5ylLKmJLQKlgUTD8ZxnNXAodE0mVRa6h9DnU+JGlYEMivIVN8v+5UMoQMqbSKLEgyqLlmGIxkR4NbLO2gidAERHfEVUN5/mihVs0kZ4ZKUpqbYGyC0t93U5920xerI4CVUCkuYnL6rcRSiWNv9n5smkynuQ6QWfYuzoqKaT+MV37MSWifSIsK5WSkH2dcFlNxs9W5rKqXjGkvpdlg7axL4wEgDeUcX6/FAZYJDb9p1sHP0Y49GE3rSiqsera5aZsC4hU/zG93QpSW578laqgF7WA18I8MF55SBIE5nlpg8IODAjyaoz3ycBxzIleohOQyis/Fc20UWFvlrayHKyizdt9v7/+8OrujHQGHH93GlFMynl6EIhOmntVKAhgbCprSpvq3vKX+PdjOQzySQSq3birFzVsITAu/IkniGyM1KMphBBYMdVXJOVhacIfoZ+pYkaPIZEOyyPbE1PUimepTpn2uTWrDGNtIQjsCE//gTQd3a8y3nFVCZphl7TaQuwwj7nfBkp+bcaE14n5VvSTQUlvCzRMrAEZ7JuylnE7eB1sJ+uaO0OHaseKI2q6KR853ike4NOP/KnhKQpkHUosDvwuskaLy6s3XTpBqjAjQeLA+pHuQ3Tj464HU5jF0Sq8NCZfUNURNURwzlu7O3M145ir2Cq0C3NY+5iYd6INPeTDhkulcD8oKkZ9GQWft1AgWQ1i6Kn+dWgN0o4WEwpmouR6V3MLUX/loSft8m+R+2Qy65CLOodeMc1PHQfmZljqTnhGtst2qW5XKb6GybOdA+nAADu04lVXSYrAmcYCoXqPMVw+gWXtIJ018Lk0mkxJIoqUocLSe/oEYFb/WaJ20240ZAqAyxZbn4AKR+OHghwKTBgJSkMOgqMwIWXfEpl1I9HEA8nqii26rhAWgBkllWs5G/T0ITzD1odoJbdQyqVZWUpn6i+lc3SZZBtxIYKTQNUnNKR+L5Z3F13nuRQcul93+2mEzrHXCiC84d/mwv9Vq0GaBizxoSyWnylUY4kDaO3xOQxWaHnR6q44wSqoZJQSZUVlRxDoBtcKIQp5tlahdDrkP2DKcMB0pFYds6tjcTHfZBpbF/FAikVfpuuHoZ9Wcueul5LI3BjyeUxAX8Is45lH9/GrMowOfqsHeHu0IU4NY2K4Sg7oxg/wtkt+N7gQPI7MTpnlOBsyT/jK2CnMyocs6dGn6kklqF6AJxqOxqCUHPaAJyz69bXfET6e37Z/h5HDq8BcMZ8fQO4RR8T6nty2FW+MoCp4KjOOJqmsOnpnUzZiBAVKXowq2fVzaizEmoiCdsC/huGbz1BIts2EsT845+pIoY2YPTa5Sm9tWF7t8zsmERa2gq8hsjl612tT2d61jmMEdGaRfVSPA9KUkzThuJKnEYDI+J3lfMkQjkSLrOuVgwjdgcholrM4cPDQdPfsqNlnjXpVHHnSWWXh1jYjjyir0bwyvKvNutlc1HhqaKOw8ZqE/6Ih/kQSffs9iGCfY1oxIktbSmwOtY1MsbcuTWhdv9iFZOG1q5KA8VnYXA2IqAbMfeCCBxJm6Z6DX0yrGIrgJLMK8SNTY/HMCg9SleftiSBpy2U+p3rOb1BGx8lttki4rQ5PlUClO8GSiNTDGAGmpbVPBlbTn6aIgFDnQT54TiZBCmkyVNWU6U8rg2zQKOhfA/D2q6SQBaQk15c6abLixruTur+5e5iwa3gIjLui0AyEL+tRimO0gNjkbE4Z2oDDXKnH+PoCQWAhYbC8CYy7xwavA3NSVr7UMUdOqpD5IYJ02oWBChjFnk9gfwPSe8TtCFV0a2/MYMZmYZfOd69ngJOJ7fuT/tnPBIdKTmXBhq9SVbNHLVIZ5lQqL+oCUA648FV7UjdV5wEt9z0IB3OYUIp+RcKnvYUG8ngQDuGZQQlC66UFUuDmiUt/zfTh0kY/56MpgC4+s4W+7MioIVYEBGDnAgwhZ4cG1PD6g5Y6Y0N94kzqFPlMRd/4Q3KgKSi+nuywbWTZ3+NgjBIwmrh+ayG1LK35SyREN+5XacAAt8QvIbLQZPT/nqjbjDEEmsJCjQGpt2zzE7KqNNBX/MiuU1mvIvZ9wESp2hNDASDj40xQAMUpBP2Bj7kXSmeps8QY7566JojOQ5Nm4kQGcSfaUjkjZSnV2GLBD+MCXZsrbzCcvmLNMJJyMSuoJQ+WE2cI7mC+CIlOZXFTSzlQyzzQiTMeZmEzBZAXsAQzIJQ2mq6aYBU4xbW/qYaxsswGMIhRzwDTTVI5kdoQ4upWwUjqVClnxAqLSzCbArSrfH1ghTNSJmBsWWt0jRTWSFddo3SjDYTcy+2VSAacT6cYHGsIqOgJvBBGR20OyoYwEKtNQQlgN74uNu7oxnqy4YIU6UnNFP3Qy4HxxiHcdz6JOHu95Uz9XrwyKj08U1rAD7gOmC2XVIoVYAC9iBwmrniWFRTLr/dgRi3TDh9XG9nvlU7m7vftzPA4Jqabdsqi4IXUQ0vzQcTbAy0QMd0Sn0A9K1QrpgzMsRr6kfFlSodYA/jH8OVTsjSrHJ8AOQG1aVKdDN1iBiwNHnWIgDTjOMuVZBf6vRcjsow33vSk5EgMIr/nKR5gsA6u9GdwLPlgBk0BheV85fGlnsjgVsOasIL+82jZAONl0UEYzPJ/F9608VkryqRpNYlJ9JDeP0wxjP5+7N0EvibHJmT+PmkEGbYU+kColKHUWCjRK9R3XoZvOSD9WxhJtTLgowUAOD1Mj8jWRCQ0tXjp7b2z+SeXPNjDHGZ1gWwQab4oQEdcRCglasK+YbkzYU9hoLE+lswXbjGp/qoQGxS4ySbKa1wyloPhI+2wsTlsaC1kmXWm24EjamJLkG81W/Ztd7YSsfIuJ0MC9wCQVw6ksUBkgk6HVyx8Mm8lrlBexqrMVJZmss6XpIBV9Kl9+iSKnEjB0mp0pg0dWxpyaAjNrULqIIe7vO3SwChIpR8uiLmHnmgpLEgPw5gexuZ1oRdPF4WY4unh0lNjjUU0yIjOy0fGoxP4BFbbnag9xkk1xHslEhoT4ATsb1CCy3BAmrhMESmnoVEVrmGyyI3SuI22igcv7Lp2gXiVFhDuWckqhUnoW1/7p4K+aqqwT+zqrUkA61S2s2EKTV74tCdVVqkwh5k9h8+bmYeaGxA66eLZTbtH4EClnwhSqNFGqe8AKMFeAJa/inU4AlKYKegyjdcM0I30vmNDAznyqPoqNzedJrnrDv2frASoVJ1lDk5c5Myk68KrNK2cdtX1L3xqEKilcEKt/lXtGmostk0tVvwGTQNvqS8CwMlkQdMMR6upLZbl+C3HQTFUmVz+aS2D5MYV5sivo2GLsYcpgpmcUosUOjdJKeZ0tPxEY7Y/mmwxex/vVpzyPfZsJXUgy6utTmqxznBU/S2J/ziHmaRqOgh3xxMBLqmu+Rr7TfqgaLWZqW4ApfdYT7jUnN0h3mvK1y8P+KieUDL0AdY8m7RuX6RJeJkUMTA31oaWZipW5h/QbmRHFLzipzGmZy46XO6n4ikxHSpRB33hzITNVY9XGJMrbm+b5O2DxwyGcFZUcLZWt+2vkn+ZMpp0V6HMqgmaqCqvymBudQjEulFlU4V+UOlsQn14hQz6AndByCuQckml1yJAC466SXlJTAllhICi2Fngu13kHqGV5kS7O9tHg9mIMQhbVAnwzdEwX3YPNUDH2Q7ATVirnmzNYeuLptlLRvFSBtL9j7dBVRTPRPVgn7sOK2ZBSVqiYsJjplXrhJPFVxUGwx6Lmh4TeQW6NA114F0sdWJBK1g/lWirXWqqeFqUORDLBCqh/NtU/W+kbXcls6EzdWFXiNf+omLqVOWceXrW9LJeVHPH4UyQc+W4zi2t2LuKh5iuTJjVtdKLepApp1rXLKBViVzo6U57vrZVINQk0JTSBAvD+YsI+O4yZKAKqSDDPlucDAgf6sE6B+rxTKCodBA7mzRTXydZwnF/ikIZ5ixmqTMiZwkbYNtYaaPjRm0ElRNEeGQdY9TfNJZh8KcZRIlVWGQSUDioCu5i29kBRblS7xCub9hqFPtVdg6oahoYdZKkglanSi7F5WC1F/A02Ux2VkWEH7J0yu82Y1sAtpwRtCHsOIReFJ1SG4nTByYbng78V05sB+AqrwOjc0jZWmU68fFR32mD/j7mE1LogFdRRiK2k0ku8hDoClKfUJNNUCp+AlZBbsU1UlLKPr2C6aYv6wJXZq1oJ34sGHRFAifFSGHBf6wzma8Zgy65Pp45Hc+SXavqG+zQAzKn0lkqdcipBmg+JC7Yp4N79SDFFXhT6kc6uTcW0I3SNKR0GiF6VoNeAdHkYY2WKV6wYhWuRpEVUjF9JedWvolYDI+FCU+OKPSeZWbHkBYLYQxN8QG0eyTi6GqdN9LQBc2veOVC59CKbh7D9EpUruKO6DHBO2R2cx/zSJSdGMXtiSmTIfLKSxQVFowe2mcIKekk7ggGnSVUY3tzqrcLxAPnNIKd5uFwVijUP2UnWnUO3M34acfEuyh2I58snDlRXcZ3BLkMvCGFCUqrIOn2XUv3pHLIr6cIioI/Tm20zwZltstyEAeWh7HKBE+8UVhegOpYjil1Qa8gFS+Y5X0QKQEKTL2zLLEBZ2mQgUhvRNdGs+SCllWN6LYDz0wuAuAXHVBlyUbZFhJHc11y2OjZFfLsVQpse2DN63xg2VEva2GnuiI/qLHbxXn+T1QMRATpZxDxwH/GfxvZZxPHq4KpJPvsNTLZJrJlFRfGw7BnkfETcKbNLfsSnHlEhr2+Z7xV+oSYcG8q1KPkNU5WhzYIcXFIRU8jwNcib6CTwQuRuQM1tg9iACCn/pmROL3BgCgkvriRYWoS3gQjZkZU+SgiQTdSlzejQZhZLJLUHc/o39wRKKgR2zKobdGiC+tQwCRgLV/v7sGLqpTlh8zDmh0vSMEdExaOB7ECiYFEew3hSNSpKhliAVhakEUBWBYpat5kMVfXHT3FXR0igcjSXxs/sOzBJfMjj3TdMyTtVex5dzwwHhCoxKqY5hz+FK2ucDoQnQ27FlNmwNXEhEUSUJXAqUHjzKyjTAJWrnG1nqmFidzFnpUqAAVJG1jykwSDfbXRG+ZIe8JVsEZn90l45uEMBFRKdbxeyZG3TpKHXKJX2EM2TmNIl3hbFxIYeGXreSMf3IxMOJnTgT2TeuuU7obeNpIIyCvCnSaa5B+rzB6CRD5pTUv7eer7gp24UJHEPCyyRC7lQFmTtdCfti3Mw8WnLpxW3Asgg9lxZSTCfA3olQ1tcAY2nlcI3txh7HndTUf5MictIWpWNVSPVl6j6efhn6smHTuGXX0hZd/DlS6egJaYPHYyu7hT+le8er7EVgrUg8fJCwQbWRH8Ptn/VDKpWMpCdVKhlJEPPVQ6zZqgFrEdGibegUEyy30pf91W4iALpNgDfThQbqcsCjidLGUjznZ0Xns64XzheYLvrewQ8RDtCWVERFXaEliFJS/2bUqkgOixqnh4Up6rBW4qEv3WwWZShav3CUulBXsEbEW8bTJHG5bMNpE7hEIdRZBhjJavz1LnV4ruy8TSuWu1clZDw7JmTmO34Et6jXDZj3ceLyhzmqvBH44ShHfdv6iRJ+SmV0T5hxCmBYY3ikQry8E/uDv71AOZ/1DaqR8hv6iH+9aCyi4JnxQOayH0HzWHsOXzIKZsahgHvRaEWiDlMyeUC1GXIMFD02MKW87dvGLB+/lGEmuLvJIEGEP0BxjUtuRlzirpOBwT89t9Y27piilgnwsyinVoQSASbhNg4owNCnz4b8ASG8hhTOCUux6Ps9ckDNCjD6wdV0xlrknGXBnHeUrCwYcoZEEppyHWRSVVk2GcC9B1b5XUoqC60VUTVMAdRnVlDoa3iujgVh5yntFMAJznwWoWTDXcathoFjI7g7oDUXTpgcFAqoK6CC4fTJS38B+JTx6TGx5ibNK08fdOl/mEDJ3zOEoEvEfhsF4hGTKui6jG5xGltPh61SoyyZlW5CTIzDq34Ad7u3INh83Gem7Q6taBYj8PbkiQAKMQAZzMGF1cbOOMkvhz8Xilym0bbWbu6IGvKq3gO+aKuKA/P4QssOag8s1MF5OP6QlqMql1d5J4yk79ogWiTV2UsswjARyskSH2dkaqkrL8Q4JhODqDcL2MXQLV4xpl1Slw6zSRReADISuVy+SG1X69c2z+CBvzWJODtFEBB/luRATj/vy8hyMMeuXfdfJJ328Gre+aS5h8gd5DDtDDwMstRgeBzIxBzmNXbykMuWRU4qNwd/FanFLbx92ZXZLAgfSoejHeSSC8KMH70TezshNt5erFbePzNR27mDgGommqqYYrmjC+4WrgW30BFEbDFRDTWj+dowb9lFNwyGGVeSIlCz5h6FjpuxC2SrmMHbOy73BFK+ZOFrJL69Ajewxl+rVGbOR0RBa81uQmcjtABB6XYg2Jx+6pq2tAtoRrv5C3fXbJJ8o0nVFBtCT0BFn90JVibu+hFgGlfAmQ0JqwHTiPitVnptre6aeqK4sIiIwj/B2tFsTA7fziOqWkVioUMxAWlks0A86Zrv9zUH7qpKoIQzAC5Lr2hTG7UO0lMU6PO99APEFQTr5TrdGiPOUtZcCkL4o649Bk8V/Lo4wV9PsdXKEWkciHH58+lz9yNXKJ6eGNB7/xy8O1Ut1qZhmXfczfur8S5IZf0W/FuyBz83tybJ7DSeZ71tQovMsfpkY6p7k/F7Sfidtp8jj1qf/70xiC6VaLtLeuBw6ESfmtxEVdI3wJ4yQyeqsQch6yBgXfFJG1RAdqQURo2N+ByhMjOdNAOOKQOxuAuRu3c86lXQDdduBCmq/R60HgeJNSvv74uJnY1jDv0dYbfUzqmap9IPxLKCGQyW2MihWBqkpfrj6U2HMm4+hPQQ0guns69BzQG7XtlKEcwNTBnElaah3qaMq9R5msM31z4Gb7F9gDQiE3zm6dfzrVO09664OGrX882Tvf26kRz2qS/bbEQfAnkW/rIa5u64AuWHri7mWVVj9LTm38yO+FMi/n+XwPxLThneW5+53ODmCnftH8lzsGg/x2YGfr7lYgZh/4VeBm+fxtadpKWi9bgByBlXJIlTv4/dbeWOHl5br4XJ6s8jgt0azpwP5MFU4tKSvhGfAmGKQfrTaCDkXJthFy2KoUVeCrANj/oaiZaNCrGqQw1Iks5/SuVgk6QwKCew5odeL7tTQQJqA5yAysf6QeMYU5GFMO1uk+NQ3s4TEeYcQCjchHpmBgcjKZ8JNTHRRWRECc2hZpVUC0AI9OM7GXyx97UtTnM9jCq2AHzH0Z5veIH2kw7c+n8s2qS6IGpTG06MswstWfSR2YX104vblwZHqmVEvMokRZ1aKB9kkE2XVEXsKiD04pY0kuraFZTGeqgNlqPhtxNBebi4Au2sSPm99GnmHhFx0coGprZzXnLKM4g/zimMlaZuGsZ9VSCPHMc44wfyBBwa4ThSybX/itzS62uXlHIZgTUEKoAhXgOchdVQTW7qiS1qOU5dYma5Ks6EtAlzCjSr3xza2c9WuN6Cq9pNnSjhRGSCrh5RUww0pmucBfjqxlnr8tV9C1Wb80qWrSaC29gdsKgSlFqgQW6U2iQUrKqYMv5Jpf4AqK6mDXqec85Tar6VUcMuW2zWbUpNDnBF/mWBHi/UNmspuGAEg0Oa87bFr7oiF4Uhl7e2If4oiMg9gJ1wpjjJKchpOkEbTCmrlHtF7TK03nDu5tmPcVPaJVeWpGPiwlKfr1kYHTCpYHPMsYANd9CsaDmVUDXhBT8+oE2G7xZU7Q8JH+KQ/Kl+BquNrdc5cKYC3yfRYiol9UHIGWFmDVjfgu2VIEfAFVOzlE5FQusvFrqxBZEwzOP3qzAk1Ll33m1G2ynE/Xo0lY/2OcRldsglb4Gh66eh+0gDHX4n6jY/rO4zuhD9XtrtoWXm6no0jMJu6qthkpojS0xHwfoEUz+JB0MziG9wBhfB6Sq8vxCzlKl2VD128odce9FhqnFsH/TQZIKBHyNZ1I0ZfsGcPDIQ5IBAw10wsMyudc5XFSpSxVPrcfAr4HTV/PA0f4rn2nBHGyBvlev3UPT9JU7uNDvQ3eh3D6+zZSnP72oXxzN4JIFcTTKo0Ohp7kJZtFO+urHmFN7VQkENNcFRB2vXN8qDS36u5tExqAdS5RxuXbV/LTOS98owESwNr8VHsJ1/92duXM3e2m//z9ov5/pQn+92K8TvnqzV5jSyCzwPPsSKw2ml2jQTw2IqnZ21S8c/LT0S/s/58K09Ev7C27q0i9tSdeWfmlLv7SlX9rSL23pl7a0ZS99IJbnZumXtvRLW+LkP/ndWuLk5blZ+qUt/dKWfmlLv7SlX9rS5Wjpl7Y8JEu/tC/Fpa/E0ldiaVP6v2RT+uN8JeaQzTIL1jIL1jIL1o/LgrVMjbtMjbtMjbtkEf4qqXGXsTLLWJllrMwyVmYZK/PjY2WWCceXCceXCcf/egnH0+xYLiNGicMlKldS7JiqO/MAnN6HTqHveZ3CA55bEBTlKhZxHQRelFPl8SM8JtJnFpxLg4Gwse42tjpkKluvJueP9JjjiQH435TRbksjJyQ19S/2nzJdGEOFfu5x28JjVq9Voe6cFX8QeH2oWtdQ/+qnMB9yzsVI/8bIAQgM0L9DL/SxxrRp73mjyO/q8sbn+Eu/iuMHjD9BCtIRmxLtVqCfJje32+eBDEk9fnAMvw081A+tISVV9a9+KqnrkFbl4lz/ttmYW0yNXsO/EwDSB12tYNY6BQumcDIsS6FYgCUBIqXCTGAB4GF63qDOSMJa9PyQbGXnBL0ouEG4oS6arxJQYXD4YxNKAcNhfNMtXB6HX3ccljXMlnL+r6thRvNWiUviopZeV9YGugKRS6r2NPofca1ExPLrwDjBjijXE6D4HWEYpMTZ6KaeU955GRG1PLIp1VTM3pBLxbtesJDi+Pqw5WYGWLhyKQb4t7P3mgIVqhxMsYAEUikkin88P6ql0IFmH1Ll+FK0Q6OCFH8Jy5/lLKGw6DvF071S1DQH3WDhwjm4dBnQuJCiKYD46jmJS5ViLVMfXDfsLs25jjfqXUXLPEPmQDFnLZwoHy7ggAdeL+r3qeOVfc/PxNDB5xh/+lX9gDrpapXZsw9+9ABSscCljBR46gMmw64KEI7A7CJDcP5JLbnyw4WytTmh6HPibFzjFpZie309xppCldb2fUeXiF971NXklXvfArWIKW99FUyVYx+IdurKq0WZx90Kn8x1hxiCBEz6wAnOfWWzXjSY/6oGj43XvyTYKk1lkjiHSEYoVIIijI4pR78aJE1Dim7+EBIg0IOmjHuCxS71PEFU71HJCLWpD8WioYh5hK3h0z4XNkr92j0vD1EvmDakCDBlP9W6mRjKLAT6KDDwFNXWTQuVITCfHugNI2EvHLebGXR+EeNfyVL2o2COZOtq7YJC/WdjGY0rmycAX+H5U/J+vUY2Nre2d4jtMYnQsmcuc5coT89Rr6m7qLUdaonqtXJH9BmC0RVe2E029CgIjtWLSy+smMcd8RR5Ie2yZ4sxCNo4CoJreHKkH6Swc26/hWIh28Ob0POPBTFh23McTjWxj7cvOU/6m/za8yENI9lFQS+nwrPNZu01qkv1GUHRaGV7fbtItte34H8bRVIul1czpwHev8lsvgiBD5gARggRhNZzz6FTdbtSaDFGRgqvNBO88lUciX19VIMqhaCSmZeocokql6hyiSqXqHIBqgTA6EDiyQhwdNz755IXTEsBDZnDXR6WepE1YjDBUUBDT5b8qOdwq+Qym0cung1YrRauicRMSQ6FWt8FdOg2IpJWART+1wumayqaBthjZds7KHDX94KQ/NIRhBByrMGp+LyonlQ90eeDyMSHfVExLe9Svb37B5huQC8ZwllJWpMPRLBJtoeV1X+YttTndQHY3mK6ZWr0lUxPqziEw9CsGTA5PDDhL/8ga2tN9QzUKMjjSyZR00/qfSJZaJLHFJXWHIN7AvOJUKgDlBnZj3tTQuUInuuo3QD6kXygVA4Dyg0h0B3iSCpllNHUo3hCQMwxiE33XiYrRpmzCk5kSk0L1mATerWqpkupc0DU3VIzRYxNKGkpo4FFKslw3BMXKO2RipRRgAt7zsbMIRhNjLP3aUBdFqrZRP4goDbLrIKGsNN5J7NGB0LjTh3sdKVSOV/Va4BWLGXzBpuWHKH850ZOyEt9auHnGUBNFJ3QdrlwGq9thLHTaP4wCYf+bnTWRVzFSuUcMPhGGXYYzfFcDmHgTqdT0JOCP9NLjhOKY6zzd9dnAQb7gdaarBlt9BrgHzUMUke10VyaASl1NuHfN2/qc0uB1PZGTKS3F4iyfkfwpTk2dbNGGkIDuNRxl6g9ePP4AQujQKSBOHq2hlQMMM1T5modIT+yqKnhIBQeV/cHIEHPiFi3iSg9VmJmFJdhwBm4WiTbREKcN+2HOsgv1SswVT0GKkgd7mp/45Tb3uxq3zTPNSRRoBiRXuBN9HFIgMDhgT/79pG9YEAFf8FDnx69kuhzM22AuZmx4ceWcMcbDNTWI/OJnJS+gMm9hhhF4UwJ6/eZcjrQjgXAT1+ycOIFozdDP+Y0DfQnTg1cmaRJ+njiHbMChj+pg+9w95O5oDU29MrkCmAMmMPGFGM4AdVt4kLLMiG1o0bzqFppH9UO1PxMuCyx4ywLZdJwGDDQAXPBB4eHijahN405mSpwFdcK8bTwJkQyPJZDj1uImC+OKymo8V5r/xwVv5kgBnVQLU/YRGM1k5ThrQtqlqqFEtCiA5HgRBUyqv2ETIh0cifeNK4huL9oJquIsgf5Qj4QOqE8Q4nLVsBoyC4pnJxzowRbUbyAppqaM6DU0X9lEFrRtH0NyWQatT39M30P9KMxp/qv7Mp1xOo/0BVHszwfvRSrIxD6NJfjU2sEvKxLIdwe9L7I9ax0RCfsGHNIp6B+9t34T0+qvzyfCepzxfCQTmHAw2HUK1ueu5YwQqWBB61xxSH9BY62sgq8VSc0HMfBB5XJbm0N8Sz5N/nPZl9gbpQ6MC8khV3NpHcKMEV1vHGSvxfn8hfjW35PrgX2MnOX1a5mHi3Y3x/HuqjL8hryyLlD/0F8SjK/tqfW1/x6ZWl/CJ+CiCzNauDo6ScLIPjT8CowgzGnCvAxpwvg/QqbsmRS1EpmKapa1OyzN5yH72JVgEJ2wqyy4OADyVDZ8iWbzKgOkNb4vKqocN4HlUZdvZ3RH6hLJ/0iCYqgcIKP457Ksd6hUS9Xc/kf4wlxSK0R2HqFvbK6WtaUe0WT49VyhTorlDqr5bs0KlrJIFD47DXstvI68jOft70VgzdWy1epS7mSvqGr5U+crow5XS3XMzu7kt3o1fKRyvKlFpn3cZH+6wMR3FH8Syfsu2H52A+4CPsrniy3QpsFQZF0tJpdOYdQx4Ez8vDVJX14OCD/Pe50RKeAO7L6lUGOI8chJ+12I9bnp75XX3+B/62txQ3UzXjIH/6AxH/DZ/PjepCtp1NoZjv7+rzSYDHpr3bElzSj2piGQzTMG2YVdH4L1XJeMO2qlx2BACQPyq5nM0eW8YZ1EfPrj1ITm/0mAB5MN6v4HPTAvlLsYUsfV8A0UL/grv4NXAi5MLR76Em0/MdIAEweWvhAzDQMQ18erK35Dp2q61L2Aw+Uo7LsBVPqcwm8M3TcYiyrNSz7U5WfKHG2dRwiIx9gYvaMijGmJbKMYk5G+5iaeBaTKIkCpwFI763gGuYe4D4Cr37kGpTnCxomMKeSVmlq/gf0xWYHsU0KqIrBQDPYCpMZ+Vw3O1DQ/o2o87Z4ECqllsx83uWJajU1YlrDmoywmhHvyAfSBu7qb38VAUULq+QDeZcSUN6RvwFFW8om/ymyCWoaunroruK/P5B3M4/mt/dHiiaJ0mJuVEWi0e41d4P+o8ST1BxDD1Y4/pG/tj9INplVAMHIebJJMvifSCzRqiqAOSWWJKAuJZI3SCRpLV9XixMfyLuZR6+fg+8WR2DwMJhqYpshuInnIPajGD5S8X2ZNAZiGvOdHzIUWKtUu0or2U34NSM3fDB6VdjMD6BWncVzH2Z+F9+AhD58vUkxuecf4r+Kmbv0IaOThTP+AVSys/v0Yeb3arIyyESudLTHiV4hr5829pb+tWiJDpCTTvemuksvt37LkJclMUsLTBQ7mIcjaZCRWN4GDvlviRCR/yZsFSPGnkvSHpVsz0KXopTlHdyc+ED5tRQOCvl69VUMCgqoq+z3qoBEQZ+H+Tj8WbeC/0DOrJB2ssBaLiAc6YlTTNs36wMzO+elDfzPawN/dXszepCvbvSv5NteheR1HcvXL96fnaF7w+Tb3pt24Pu5u1dhSJOVr8LxxzJ6r85jzOlXwV9azRexf68ubVZD+U2H5O1cYA4EPxfNDVHjxdQaI7m9WcK+QGEcPqd0qm+n8ksS/7uS+L8YgV+S928n70vavqTtvxltX1L2/xjK7ivDXK7YnqO7WdL0xTR9SdD/IgQ9qzx8fY9/e3r+mirzr0/Tu6H39Q34vSn6fzI5X9LyH0nLteL/7afjt6HkK/FfZddexVA79hwyIVUdsp9+KUD+rYNFsXZx1ZH8mDuYt/k+VvunKpUs1f9/Id3AUv2/1A8s1f9LFcFS/b9UEizV/39JEv8XI/BL8r5U/y9p+5+Iti8p+38MZV+q/5fq/yVBX6r//6w0fan+X6r//8S0/M+q/oemOgU2ZP1TBT2giGlhTTKnX5IsgKIPazjeGvUxdTQLxixQhB0ySh/EAaK/6LDQrnSiwZfcINE1tAcEHBCOKRYRf6ISIuosqYUk3HRupe5ho1NHG2pvYP5L6CWpJYZJQnlo7sJP6S+qnpCew35eMcBb6gEAW5bDNQP8mhUFARPh2oCFJRlSCLKFqjW4dIb6IKum5tOjkltxEldEufgk3nkYDziqHqMBC7It1aO5pqq2CZYLgFuCaWOjcOgFGn1UdTLJzMObzNYMp3ZAyzZzPTNB1eka/B9Txnu+moDX7ztcMEyDj09NIS5bRYTo+wUoybBdiM0lWaEOp1IVpdK9dCkm6H8AfjD76Nv7hy58JiBlacIyCV2SheiaLIBJlYQNWSThjzeug6Lh6aSYatFh+YNpBWFWHc+n5U2VwmPC9j0IEgfuQjBmA4iZgwfByCM2TQ7eZDJBWOB2gMUMTiLE4Mg1nwUSsEFJLVkpVAkScLu+dmSC6a0XjKRPLVbx+RnLK4f3OtxkYjooKebwd58GVrPseyZjMrXQbshcymFLdcz7/6p9hBT+CucCZC31br4O299IXYSBZ0eWiuuveVYE+YMVGcbAeschyqyJcfvUdrngMgxUWBssQaVRl2VSyb6Ah6oMCZC3HiNqsszWce0U6hZymzT0YhB1pNRhLZOGGhF7gSpwridDUwaNC8OnSCwD97e/kVbtTEI9OCCLegZETbTHpIl5l6msy3kRmu24GVTZSxI0S+w+pjV9DwQBFKmoGERQsuEAwPg3Ode/dQjZv0nNmwisENiqnZHv+Q+6SG/ID/rv3wBtKfMfmX3w7f/9gC7yuwVoazQIMwvzkx/1yjYbJzdOP1jT2dvkWpLJYDV3bX9qHlVqF0dJDzN52qQ9Wus5Xm/NpTJkgc7bJvW/azYNwjXVBbAP6bUtXx61s0OJaMDCshcMshgifpxAfRVMyyrPw9rqj4TWCwWbgxehPXL4Mw/SQw3Zc9l3k6HU77eu7A+AliFIudB+9GaHSrpeOFyccu83OQkDb/4caGhP6Zhmh3LpmInsSZCMBtawHL9Zo0HIga9ek0MgImtJ1pfVXw8tlCtdcG4BWuWREp9b332U2aXFc2semzOxlkrxvPoj1xZLJyNIaZhnoV25BaLSZ6E1XP1esEv6898EeNV5ZgoE5tA4acwcRQUZlzPYIvM4cxNnVv1XA+0P/ZzjjCuu0hFloJ36fAZQ/cSIDKnDuzZ/+349tAhSLqZoRr1pdqgg6k0HzJVZiNNP1+CPzH37odDCUAvuXjOSMxTOAoczWeZeSiozj/RfCyH9QdDKfAqHxSwtBunsD2LhvuJTa8jIZnkdqiplxAy4exRf4xrrb+Xaeb16dNk6Km2W18vD0HVUSbfAlVf9lhK1QfQOPZlKxm9YTpCcWSB1ASZYDORvfU+GLhUpuL6al2FWnk4VJFH192JpgAsechgq1sb3TX9K6U+o7+vixbo6OIgU1DCsRSIjawgspev1oEimKigpi0S6wOC0P8kistnSI7rIcb0f88pQPJxDYQajNrQ8b8QZgXoIGUUilg5WbYuEku31dXJI7ThzEVNV41ANhEWfQTfCbBIJB1jwUKsGnyIWTFNKtYf/MRkowN7wAKNIFqpKzJ7CvTkWB1wgSJtAHvJ0KCjB/w/8/8M/4f9dbv/rAfsErcXFTatNLq/aOYIZFzpRVklyKALR4mIAVUeB/4ZNLZImo1Z42iqSihhEDg1OW6tE4FqBwkZ/hvS5hU86Aj6WRax2B981ThpF8tEDNl9VlYj1o6kqNRLqHcYKyTR44ZBJlmmqNG8uHbGOAMFyHDmCBaaGC2xzwFk4BVVctdU8hrrB1BrJotYrwyj4XK2sfqtOiZJnLKqyZcA2wCYrW8KDKpDC7QejZcfaFHF6jZ5nT42a2hPQAQo0D0aDTp2AUXuaFBB5OEiUiWgZwfdo3UD5rJz+mDobXaPSeDggF7MGE127eLNPV1HLnNSZ6UVhYr0APbjw4oM+xZP3YDROXUsG/e6Yew6u9MMBuUlq4+DJjDXZPWZRdSlxLeNviGehbsvWtcXTu4nn8Ory/D5WRYMtzWKCBtyT8aXWOEDfbUQFK3gKNbYpElWXBhpVi6Q14f2wiGyMrloCI194AcvUvNE7g/V1CA2V3uEMHY7B5BUozPaK5kE5J2dvH967NVjZEp6mVUQ7P2F/TTbQgrwnsgLo9w8SpPpcTVWCgWx4kEmPo4YKqcYvWuf6UyHdGZZKHnAgPaB3/blYgIR80OqXX6Aw0k3gfPkCjxFtoTbW5hKrKWk98CtYfoGNVePfX2Fl7YjvMrN2xFvtrLnLqJzOE/Oy8VJHj/RvWZXvMsTCqv2mptiO+N1ssR3xujE2NsX+OEOsIg05llhlhy18ZdeVef07d/wPsnx2xDeYPl898W+w/H7n0vxqg+nX4Uab7XeC98NMqZr0fbst9ZX5zViEv3OKv4vFFZDX72Zz7YgfZ3R9ZfmVLfsHHKxvssK+AtC8GTgB7ufEIFo4+OnnL8XCkFEbLIPfRNF/vYPJK/DflXTXJeO9mllc1QgMGn46RmyutGXG2vzxqF348uX/AUkl3Fs= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. + +If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query +parameter `?refresh=true` is set. + +To fetch an existing login flow call `/self-service/login/flows?flow=`. + +You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, +PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF +attacks, including CSRF login attacks. + +In the case of an error, the `error.id` of the JSON response body can be one of: + +`session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested +but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. + +This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). + +More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and +[User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-native-recovery-flow.RequestSchema.json b/docs/reference/openapi/create-native-recovery-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-native-recovery-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-native-recovery-flow.StatusCodes.json b/docs/reference/openapi/create-native-recovery-flow.StatusCodes.json new file mode 100644 index 0000000000..2ffa1a282c --- /dev/null +++ b/docs/reference/openapi/create-native-recovery-flow.StatusCodes.json @@ -0,0 +1,1348 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This request is used when an identity wants to recover their account.\n\nWe recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)", + "properties": { + "active": { + "description": "Active, if set, contains the recovery method that is being used. It is initially\nnot set.", + "type": "string" + }, + "continue_with": { + "description": "Contains possible actions that could follow this flow", + "items": { + "discriminator": { + "mapping": { + "redirect_browser_to": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + }, + "set_ory_session_token": { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + "show_recovery_ui": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + "show_settings_ui": { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + "show_verification_ui": { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + } + }, + "propertyName": "action" + }, + "oneOf": [ + { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + }, + { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + } + ], + "type": "object", + "title": "continueWith" + }, + "type": "array" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting,\na new request has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the request's unique ID. When performing the recovery flow, this\nrepresents the id in the recovery ui's query parameter: http://?request=", + "format": "uuid", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the request occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. recover account via email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the recovery challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the recovery flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "title": "A Recovery Flow", + "type": "object" + } + } + }, + "description": "recoveryFlow" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-native-recovery-flow.api.mdx b/docs/reference/openapi/create-native-recovery-flow.api.mdx new file mode 100644 index 0000000000..00f2347d2a --- /dev/null +++ b/docs/reference/openapi/create-native-recovery-flow.api.mdx @@ -0,0 +1,45 @@ +--- +id: create-native-recovery-flow +title: "Create Recovery Flow for Native Apps" +description: "This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on." +sidebar_label: "Create Recovery Flow for Native Apps" +hide_title: true +hide_table_of_contents: true +api: eJztPWFz2zayf2WPnZvYMzKV1+t7H3yXvnPtpHWbxH6Wc5mbqGND5EpCTQIsAFrW5fzf3+wCpEiJcpXG6eV6zIfYBoHFYrG72F0sgPdRijYxsnBSq+gwupxLC6jSQkvlQCrppHBoQYDBRN+iWcI00wuYagNH56eQZBKVs2DLZA7CQq4nMkNI8VYmaAdgc2EcXP7NDkCoFKwGreKxGqvTKQi4FZlMoTD6VqaYgkVrpVaQaH0jEbSpS5y+QQXS1nUHIOCrp0/hG5HCBf5conWAxmjDwM8UCAV4J62TatZGfQClRXBzhOsZuovw6UWmF9c8omrwDOjvuoRXb0aX8PrsMrRr0ycQ4MDKFGFvJNUsQzgXM4SjorADuECRuO9HAzhSszIT5vvRPigemLlFE5p9L24FjLhkrKixHcBrnSK1O//ufADf6kyo2QDiON6HidELiwZEUWQyETRxNoY3lka6gZ6bo8VWVVjILINc3OBYLXUJt2Wm0IhJhuA0z4mR6Jagp3A8ungBwjmR3FgmR5s7mDBnr1/+HSZIxEmpQ5ugEkbqFUso4eQtVpwhisLCHpMFXvOXAZxNfsKEKx0PYLSQUzcAookfMPf8ShsEqaba5DwMSISibqe6VCkIB+/OzBJ+MMJpC0dJokvloJpcONFJmaNy3PTHvTgeWsymBzQJMsEhsYUdCt/qoOKW/TgaRLpAw61O0+gwSgwKhx7tJudEg8igLbSyaKPD99GXT5/Sj0Qrh8rRr40ZGP5kSdTeRzaZYy7otw4ZNIGppfWkXcyRmVqmqJx0S1gIkjunK+6mqZYGwiiYaG+RP+Y5qhQMitSzCMK7X0ehQli70CY9MGjRHWwQLBpEhSGKOenpIHhWN0d4lPiJl1Ow6AZAhBJSWUaultYc3Vyn4OaCyTBBQp+IEcMpl3j1lGXLsVLaESiaMrcsMDqMrDNSzaL7AU+DVCVeLaSbbyJzXHVeaGslyQGhrRkb4SDRZZbCVGek9li+pn7GpcOcR5lKApdLJZw2VJCLoqC+D99HBlNpMHFXQWqvnN7E4FSlxBsk9twlUeHNqVe0vvsJQjWKFCZLsHO9IGo01HIpO8nvWW2T/Fp5RSCyhVgSceG6A9frseooheOAy1vp5h7YRaj1ja90qUee/IMIVZlHh+86KfHj+mwNoruDmT6gNgeEc3TY1e4D+r8f7DYFl0Tyi5dennx9noZK2Tq9yVkM++dSGkxpgIHa3R2uRqpZ2RE06TIqSBqD2RgGDcCiu9JmeRUWwyteDB/gIs9Eol48F8KCtLbkVVOlPK6GPiJmIh6rlze/2NIKL0o3J3VDYNNKJdmP5bPO8VyPVWd5x1yP0J2Z5cjXuqRKG8zWTbJd2O2jkbgfRDtM1mVl0NBk+D70lP8IDXdnt4fG+SCzbQ6BuW2uF1eVVrkq5WerrtYRJQ5aK+qat7leVKvem9NNxlkf/U488yu7vR9EvJYcvl+jhEy7NdTpScUlLZM2GkTeMIoOo7KUadciWJpsu9brAhqMdNYItyIrkbiVV+uWgiwtmie2oSd9izcXL2O4bLV1y0ImtFpDSaLOCibYhpUXMWQLnI2NjpV8TQBkurtWDYSXbKxtlSSm5QfDrIXGoiN3wz660FSAH0toGohWQtMo2sK9o1Bjm9A0R7+z0PyKbj9CaGo6PqbQtID+joSmJvwjCs0KZi00t2jkNFgijy44TeCPJTxrCFcCtFa8hZv/1qi1TZDWKbKzMH0ECh8hVC0aP6ZgbQD+/IRrEHkkKXpyJdLUoLXd4wofPQsHg3tSjdFHTpq+5S8KcWfPO0phiwMeUbrbcBlmYKbla5FT7QCWTGSFZ9Po8F0v7b2099L+e5D2QR+P6OMRjx+P6P2o3o/6HJT/5+tH9eG5Pjz3by0hnzw895lKSL/f9jnut+3YkkYa6gljxJL+xrtCGrRXwm0O+Ln/duRqI0vmCHtvLo/3/d6+l/CQyeIrx3A6raUYrCP+WUg7R973L4tUOGyunYOxEqBwUcOZC645wTqTJ42b2ogAHBAiXSqpS8udnoDBgrb/OflghfITC6WSP5ekBGN4SwMq0FBHVc7BWhIOqSFi9hYwGVwjbIrZEws/l/RrIYzI0aE5hLlzxeFw+BdKUgg5CrHXS1XDuJRXpcm+/t+A4LO/yPTrXTSx90w65/CUP+02hTpJSmM+hN6h5VXnUhBynEhkQuch+cFLEWkxcqsCDExhanQOq5wYTpkIOTOUQjFWTpOKXwiTtvNqfDYE1jPx5uLlEwuFcHNKyPIzQWsD3om8yLDTTzboSqM6Bf+CP13q9ZyPCu+6Ka9RXcCtE64jp2RExevcyXX9+rnKqTmktTOZa23xyueYHIKwNytJcxr8ZxBVEsoexrO4TrUJmS9wKwVgLmS2T96iclf8xyFD4l9ZAieICuizX359J2NF2TSYXiVzkWWoZnjY4h+aTVsmCVo7LbPaT67lom7GNT2smJWSEcrSen1ViGWmRZetUlU59zXqJCOnGRKkwgnPQRuSS3XmWt9YRskP0mFeZLSeRuu6s1aSXfrfg1sWyIyJ0s3R8MIoCnlNzHYdFPp13FDCl9QgyEANoZNRunYTQrIPmianCPju8tVLeKFNTlYR1kJgGLOFNjdAuUMw0W4O311ennNdpsD3o7PXvzoSsQoNMflFGBXD9jVIuq//0ih5No7ev4c4ALi/H0eBRZ+No0JbN46+vu6kRo7WUmohG7BV6lIbW85Xu+tQfEST0P6JhVCNcg6ReJN1X1Jap3P5D1L3VVdxFz/4ZaVWiVK5//lqVU8qhzM0jfk+PWEu+iW8wKP01kjnKJKhQORoJHOWmmXSzjupsp07a7jEXmNFOhJO1VSPFeeZwnP6f6yCjMLI/2wYYNSC/qR60SAKFXeywXbtrDNUyKQKnTxgzJTykiqumzHrFaznHeKwTTq98spRNvi2pS/Pz0aX+11kVzpd48Q2YMp+tSBMQ6F7+WBBxQxzFlxdZT0GR+XNKRA1bkVGn2OS0mqd8raRTrFaBYWC67/IfPb1NTgxGxAsX6SK0lVdfH0Nk9KByKyGa6tzhCITtDDinWMxWxN354yclA5/MS9QbErf3OC0mxUzqW6eWKAKsJciJTXzYr3PayStZl6cDqE0cldT7qgy2HxG6VR6qeuaqatuKaFJYm3cWnSlZTI/YY8SbZWrKSCXzMp6CtdUIabP16RDx4oTu2UujCT3M6xEIvP+WF4IJycy46RX0sJnBSpyRP8UP40BTkMs3TpTJg6kA4fJXAVfNrhb0sI4EuMoHrPqAuJskmma6lP6f6xkPoPTXMyQGOWI7AMSOB4ujPjHWKXyFk7krQwB0UrSxU5C/Wgd39cy2ivwXoGvg2A1UtUaeIgrIf5x1d6z2lGtstZt55UyI5kVlH1ODVi6OxkjlbebM1FxLVgMWdWk1VnGyYsgdjE+TRwWMp2hC9tFYUgg2NqsnJGTs1cwhFuJi03lm2Siaz/uCPiDEjmu78cZVCkadnWCZX5y9qqTy8ggZrWdppLgiuy81fdmgzYRyJ72SlAURM0bXB74yFshpKl2yAwGQ75yFNJAvHD4ApeQi2VtLhL9rgmzgziOrxvz9YDY/ivWgE+9BOy+AnjMP9UyQPz/2y4EXdqjU9arJl3SDqLms0pIuxkon3UYLShn8w7F/h2XV5FrSaNqBkK2LBq9qRIYVeazT8WlNI2/tbliTdK9RjNjPLFgdWkS3NWcXci06yDPWyr+YJZbkyFCNayavptBxeNbRItp8QGrKCO2fRFlWndlQRal+5BeeMqol00npXSaWDXDrjAap680aqxA83rjI49FSQfMfPCnjdlRo+lz+k48/FClS8zGqjQPVXljsrHiaKpyB9UZtAfqH/uq56HmWClc7NLuNS5WbbTykdqDhHzG7Y3OFF7KHI91imNFgT02NBY4oVwV9dCoQt23oWpDRJmwbAjS/xQPHkTr4yd2bAwr4pS6FcbUbh2ZncS+n9RHnVQ2iy3lbXWsayOs9j0I4BMLVVWYSsy8FWhKPgg9FZltKoyJ1hkKhp+JCWa9L9j7gjwjubijbYGu9fGVuHvJn9iLCDHuFv/l4k7mZQ4eQrybxaY4t7dzdQ9gQzANqGbnxP2eLDe2kj6V7cbGwW9tvWmVZDK52ZybM3VMH1rs9JO4FQHeYi6TecPdxjtMSorjar42IbkJKSjNiWF1613btzg5Ih3KFuEJzT6nfR6Gqw6qzoPI2GpnjeYeb0W2tx8QYL6wmJSGJtdIe8PKrgJwaeRshhSJsA5F2smfgQKh6lZCVKCa9BD1OMCFz79Ml+Du1y1yUVh/OwNdi+DnCaal8ptA9f0ZkyXt+A5CB6GxrY+zVxcy0Hr4Ay7B4Exa5683oDUm0zNJ1NZmWeF80axSFYZh2q5KrdYvCeDWZvyV6xNCN7jsrt78uFG7ufaeKukebL1euQntwYF21Gm2rbLxdoHRVbch4FtI77NqW4TzRc3hbZasD7hVYxP+QyjuonN6vvmN+YY1U/cW/5l6SRv7v0IzE7yPVMzc9UfoZWq/m1rOVjW30eARlDKTpNfJ/1Gy1evknm9+rU5mBbTtaBg5HJj6vGvbjqmtsghL2pjKlqROOcHIXxU1VilOpaLMCAXXNM3XVa6ld40Gq/vYvCLzO1w+O4NDCsKCoFy1DBM3TI0uUr1QYATnXrk57fLB1CAecDIHexE+3Of7ERPuZqyqfqqUWJ/Iy52JRo6Ebzyge9/8gTdGgjI/JyK54eTDyvfK0Dteb07DdliqgW51ymj7j26A4sudtuSLXDSTuay/hc0Pki8281ttU5/iUZGa8vs6iJs2iUszVmfIBzdPgE1EJoxvzPlre14AB6DKfIJmQBwFIUSzT3e9SZHJf9Cso5kIJ/NVcp3vfMs08pGJtXksBMXBwiiEX0Nbs7m5M8oj6GZHPzifP0rpxRMEW05yirukFTtKC56l2SCQyQ3Saug97gfH1qBuoCigcrQaWk0+NPFBJ1E9VutUhQZR441wiR/kgzESiiWsBdLPikpq15O5C+Ecmq6jco3IRqi0JQm2Qm4zEGNuPF39LNaiWTXpDvRtD2+tB1pCmIslsD1gCqX4sMCW2ClVaARZmfIdVV7zB0qjxeRmou86qhyHT2M1l2mK62FTqvIdf+jeSaDvW4PNfhgZBdGIWTu+jvjDWE1K53RX39/wh7GinGyOCWc6EV39nAjH0eCX9N3X31KrK+ZN395cnDbsiRDSawbymZgU5A8ko00nJg01a20G+PFGg8iPK+LUhAb+oSBsG+wcKeqZ5LNgEjpivl1XV1LOVWLmmyyj9S06pG2CdYXIcdnAAI1diPVtzA/RlryXy1ht7jcIu1RbdnmD18k1IOCzqd4So63VRpLZ/BAYrge+IhQ6k8nykXMeObhNXulDeDyxUNejNP/5v2Ng+3NJnQlM9VtHtpVWSefUqMSbi8ejc/L7j4BrAt2XS3EEunuVj2BZNnxlTu4+fzZ8Vo7W4FEV2ThnFo39ZcLBqJ2LW6wBrI5hUq6xnHI3VRdt2IQOs7xEW2NDQKSLgeDTFhlnK4cDLKEPbk2Wvh8H9/aHbqNlisagCXL1kBxWVR+Qwa15HwGET/v4sK280PTV6avna7pkyzlBn9Hh1dPGANtqpyn6teYMWVWKEe1MAfHs1ZlbFbDlfPcQA+ITN6tgXOe+arVD+svnjv/zcqOINp9KDzHdf/Nk7s7J7vfv/wP379dAhNbb8zqp1c5ZYT4isyXzbPOyrlWHD97X1eel/c5TmPq8tN/hpPZ5af261uel9XlpfV5an5fW56X1e9l9DkTPN31eWp+X1uvkz1y2ep3c802fl9bnpfV5aX1eWp+X1qcc9XlpPZP0eWl0x3efK9HnSvR7Sv85e0r/ulyJDWXT34LV34LV34L1eLdg9Vfj9lfj9lfj9ibC7+Vq3P6sTH9Wpj8r05+V6c/KPP5Zmf7C8f7C8f7C8d/fheNNc6zTEBOQScvBlYY55t+duSZL79k4mmo9jq6Zb8lRtPv8QtbM6LLY5KxvqRhsgQnxZaWBuHIAW+86NN6h1mZ/xX8wwUzTG7ZOx7xvK8rMwYn/yfAbWxfVRkUo1zJNmM1OT461UpjUDYyeygzh3P8MpTQeeCnVTfibTw7QwYDwt9OugMuzy/OqvtY3ZXFlMTHo4CX/FT7V5weqfIIGpje4hJBWEEpXkns1lcY6OK0LXtDfFT6icMlcwLH/GUqtyDMYHb16Gf5OkZ7u872f8O8rBJqM7inY3p0ignmdTGSJBhGRhBYpf8yECECFzXFTOGN1rCWMj5et9pgIisebnBuR8/bVClXqnH758irR/O7bTlLYs8PHsUP/hlnv53/cG2aii0rSQs5ReqmSrEzJAOSTS/y6n+b8o+b7mGw40Yz41BNa8ceqMpBWyUZvTu2mwdifiOpZthGaqs0beO1t11foBPcfmK3zZoCtlGsYwJ9uv7d6oMI/BzOIeIH0AYnBv94eDV7oLJgPjef4GmtHUAUN+5LI37Ys6WHRJ96me+BR0w51ww8Xbn+qOjykWD2A+CCf1E+VbuE3P9bGm9PNt4vbzwnzW6jVy7lNwxqqd9LhhX+ofm2k9xueZfUYrH+qfRB99fRprcMU6wpRFBlZxlKr4U/Wv37qk+22BCmcUCllXNJrxZxmR46WF0AvCpua1Ev35iPb3MigLcgu22iV4qScbbY6oeLVe8Rcq6nzV6cOSluyi0dhKXErJGe58EKxemkbFeezxDw3/PRkGCc5zhNBjwqnonCU2i/o0WwGQY8xy/DEb0iW61KbW4ZNB/arRzg93aoTjW0Mmq8sh71G/9w9jWdCUbxSdb6JzUCvWp1uErH+a0XKaWk2FlDtAytKuNJgtU/JHbQRPmMW9N736Qn815d/+uq/IdVoGVu8k7aTRFteLedoQIg9eBKdnsRjNUVG40ppd7Wa0OfGvPAfXmt3VBWP1c+lduIK7xJEOkLx3Jj/o5LnoaChKzvhRoOoDWEnZfm4KK6M6I70z7D0tl7m9sQKbba+x13aK3a7Ot5bTjce5fYgfTNgR2Xvq6dfDeCrp3+i//5rAHEc77e4gb7vtIm9TZ3OUJFZwgoiRJ031KqXroZ6rJWR1ysXK73yi2qSYX3rO/XhOe/B9qqyV5W9quxVZa8qt6hKQkzMLHOG4d557u8OtFkeGOEwk7l0B5MyuUEa4I0RTtuDopxkMjnIMZVlzrxB1BoxTSzfW5QJenk74vTqymEJDnn0V22WQ3+2hcxkv9N2GMm80MbB+7ECAHgR0Dkq5MCXHGs1lbOyOq1170+YPGlAe/Jn2kihKKEjXlnVhmegcNGGsLf/56quKOSpIm2fYKjZ6H2vBWm/0cX7wCoD1qBwD89ALIRswYsTg8Lha34x/aJhze/t/5m30wKhvtUNAvn31Zu0KURyQxKQCzoyR74b02pvrMZuXIU0xpH/c5rXv2rrf9MFKlFITyYYRzPp5uUkTnQ+XJHvYKap9j7ncZUq4d729mlGCEaboofPoAU0fo2LNfpSI1HIY99pV4Oj81P/dY3I1JIWywGYAUklNa4hxfXknJ/Gx9vIW8VvvhHJDXmoKt3b34+f+/O8Hjc5Zdh/eAZKZjxKN3bT3MUvCiOVm+5pG49cisYMYByWcB8GEllGIaDrXTC5vj6EP96Ox2oc8Vj2f6GfF2WWwXeXl+e1udBo71vf03/DYV3BS8L1VgwOofknNd7sXdMBvXF00Qa50wCb+KEt9sfqvsna50s3Z3e8Ym/SLVvFX5vllf84VozDqiDOdYqZjSun+IriBhDatUe43tKgdVXNo0LSqlN4NcI1CyZFVcH/RUz/BW0fSEVzTevDXFve6ayCkWxgBVuTray5c4U9HA6LTCw908WF0aSKbazNUhTSkswR4BFiW0fFxdKfTVxttGUZ2LIgnDBdU2iFMCJHh8bGrI5auq4x8LZIekXKw3gG42hXdCulQHg/px19EFV81JtBfJ4yKNBgONHqVM0j12kgdVSJ8prY80HGQoZqhx7bL8Az3vZOhLW+KrWVK0Xe6LGpz1c98KCooTPL0Furx1a4hifHcz8cFYVd1SeAtSg+a2ER1P+V1+hXLc4lJVSBYI7bGwdjOIDS0+Y6dPD1A7AOWf6aAD3EJmrhKzLvQy0CRHQ83ERlVaGl83bGCP5oGSn4I+A+bzDfHdj05iDVCfs8DdOA/DA584Z3dBhtXzJ5G9EI2ol69yPZSK406tKbPBdrobKZXoe7fa1wd42l4UM6Kbxu6xzAlknfFfxe8484T/fZWsM7h8r6g+Xv3ke0oXq4zVyrj5F1m22koqv29cQ0jp71E/ThE0RsHqLOZNr7PXQ6NxANLWbTA4uG9lmHVZdDUXCoGM0tGj+lFEE+rFXz+6CQr2xWzu471fOQJ81I8rOqLdq6iXd8QjQkWin6aN0v+Dvl4VGg4zW6hTY3tOPNfi5BWWXwcTCADm17Z/lds8WxVlZn+ONehXziCwjZ2M6HFfLDcOHjcIbuwDpByxsf5SbqVVfBjCgw48czEVYmdbCGc3O5pPZ2qD+a7AkK46+AWdX0RRtVfUYBb9JlelHdiDrXRv6D16Lj4DS2Ct+0pma+TI2IU8x1NUAPdEj/80aNLvwA9HSaSeW3ALi0PuLtdWsIf5B6NTg1aOfg9A0qC3sik8LfD3EdoFwJ3ha7Jj5tF304fAJRoKLQRHThK9Ey6xMhIGRCUJDjkqrzVgz9siMdnG/UcH490e/5TpMjxtkD3gy/NRJQUaWFJvOMskoV+qsZWoxHZsANLleMt1gsGBeSDlJrxIm0mtlhgcaS6XbgSXbAOLJL/8ssY5ZvtbmxhUjwqJA/YFcS6sN4w6ICcJDhLWa//TA4h3yqq8ioSFi5+9Plh1GwNv/q5zGqbnWMCLOR/7aZ/fgFnCpndFom3qI+0UlJcUJvjbJJm2Xg1x62mEWaSxXuSrlFVjpH56c2hqP2Byr0m/8q47RIP1hMg0UpKFtYpnAeiAGepTyzxnDue2QolHuZa+uq5EOpYGL0wnr7eay++AJGJz9YysKUFtIwAvADnYTrqzykOtIVVGBjBv1NIXWHjUCsZfD1PS9TTZmPJI/kI5W0UXpIaPwTXoa/gzH2TzjRC77figDAr/lHIJoT8kj//knYHrT+wXrBh/97BBDdYAnbE2FcizDvinISp3i7krhQMAzxFjtc+RD7nbR9d/H86OTV8xWEtciKTW+Gk0xPhrmwDk2ItNjwc5gK44YeBFkQTdrGr59ftrtS5QxdrM2srSHq4hXWZ2YZew9ruP+Y2GqncANfxvZ5Ju+kaXY1x7u4yFdd+b93pewjYIuMUie23+r1rlagt3ZXB8k+CSfM9CYfBGzpZrl2V7m4RdXmBIvCJPO4/jIUxsmpSNzQzmkRGa6iLvsfjy0dEtjCt4178Cq+LfKfbJu0zLdVccUTw0Yod/8xacsHlhilJs7r2O69pUVlii6Z7/9atA9C80+CvAfeGgLQGM6/O19jRY+ZtGvaolXcksQ1qn800sW86GBnprgPB7awXRZyDdFQUrkMDeYdbkrfx2PLKHVqiotysmx3ZcrJcoa5bWPcLB3SLy15e1RsqastsndR2rUVLqGogI2lbnhlVVH4bSumj4St7V7hOIU8Qdq2OnxfG5qFSOYIX8ZPw91FKzeDZE/wZ6ZxaGuHL0+Pn78ePT/4Mn4az12e+URKk9uz6ch72+R9O20bm26VyUmeMxrr7diMiMH2baGty4Vq4LVLQHDdpW7kHvjE19ohkEo6Sb2BgCoSwElwDHIVOV1dDJrrCWWh+4xtOwCbky1z+Tc7YIvaaginiE6ntVlcXz5q0Vq/+61vJL8jUJWw2+AvePV1ByDgq6dP4RuRQuUQ+i1wAn5GR2/9Drf3JRuoD4Ljg3A9Q9faH/BpE2HwDIiiCa/ejC7h9dllh8MkVSDAgZW0CTvyV/mdk11MlB7ABYrEfT8awJGalZkw34/2QfHAKJASmvG6OeKSsaLGdsC5n9Tu/LvzAXyryfz2u7qVPwCNLBEbh8tsN9Bzc6R8iUZVf3FeLm5wrMjhuy0zhabKoaA5MRLdkoK6x6OLF3SKRiQ3Nhz9aoJnwpy9fvn3+iSYVGATVMJIvWIJH7yqOEMUhYU9JkvgyQH4RAWqdDyA0UJO3YDXu7CNTT2/0gZbSRDkblUJF3TfIjuoP3D4kNwrXarVVkvbsfhxL47bQS6OrAyFb3VQcct+Y6+edhCGfE8kiR3L+/sQMHsXNWFxhqVvT5mmhaRdatrHoIrv31P2yhuT3d9T8c8l1eLYXRUWo7/u6VINkVJ8qA6cksNYNAOlGylCrYDet88vo/v7/wfyN8Fg +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. + +If a valid provided session cookie or session token is provided, a 400 Bad Request error. + +On an existing recovery flow, use the `getRecoveryFlow` API endpoint. + +You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, +PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF +attacks. + +This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). + +More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery). + + + + + + diff --git a/docs/reference/openapi/create-native-registration-flow.ParamsDetails.json b/docs/reference/openapi/create-native-registration-flow.ParamsDetails.json new file mode 100644 index 0000000000..ec0b83d205 --- /dev/null +++ b/docs/reference/openapi/create-native-registration-flow.ParamsDetails.json @@ -0,0 +1,28 @@ +{ + "parameters": [ + { + "description": "EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token\nafter the login flow has been completed.", + "in": "query", + "name": "return_session_token_exchange_code", + "schema": { "type": "boolean" } + }, + { + "description": "The URL to return the browser to after the flow was completed.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + }, + { + "description": "An optional organization ID that should be used to register this user.\nThis parameter is only effective in the Ory Network.", + "in": "query", + "name": "organization", + "schema": { "type": "string" } + }, + { + "description": "An optional identity schema to use for the registration flow.", + "in": "query", + "name": "identity_schema", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-native-registration-flow.RequestSchema.json b/docs/reference/openapi/create-native-registration-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-native-registration-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-native-registration-flow.StatusCodes.json b/docs/reference/openapi/create-native-registration-flow.StatusCodes.json new file mode 100644 index 0000000000..8604bfc7a0 --- /dev/null +++ b/docs/reference/openapi/create-native-registration-flow.StatusCodes.json @@ -0,0 +1,1512 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the registration flow, this\nrepresents the id in the registration ui's query parameter: http:///?flow=", + "format": "uuid", + "type": "string" + }, + "identity_schema": { + "description": "IdentitySchema optionally holds the ID of the identity schema that is used\nfor this flow. This value can be set by the user when creating the flow and\nshould be retained when the flow is saved or converted to another flow.", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow occurred.", + "format": "date-time", + "type": "string" + }, + "oauth2_login_challenge": { + "description": "Ory OAuth 2.0 Login Challenge.\n\nThis value is set using the `login_challenge` query parameter of the registration and login endpoints.\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.", + "type": "string" + }, + "oauth2_login_request": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "session_token_exchange_code": { + "description": "SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed.\nThis is only set if the client has requested a session token exchange code, and if the flow is of type \"api\",\nand only on creating the flow.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. registration with email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the registration challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the registration to a webhook", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "type": "object", + "title": "registrationFlow" + } + } + }, + "description": "registrationFlow" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-native-registration-flow.api.mdx b/docs/reference/openapi/create-native-registration-flow.api.mdx new file mode 100644 index 0000000000..5a2a57c792 --- /dev/null +++ b/docs/reference/openapi/create-native-registration-flow.api.mdx @@ -0,0 +1,56 @@ +--- +id: create-native-registration-flow +title: "Create Registration Flow for Native Apps" +description: "This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on." +sidebar_label: "Create Registration Flow for Native Apps" +hide_title: true +hide_table_of_contents: true +api: eJztfft74jiy6L+iw97zTfJdIO90kt3ecwgkHfIkQDpJN32JsAUo2LJj2RAy0//7/aok+QEmnZ7peewu80NPsGWpVCqV6q2fCzaTVsD9kHuicFBoD7kkTNi+x0VIuOAhpyGThJKADbgMAwoNSd/xJqTvBaTSqBPL4UyEksjIGhIqiev1uMOIzcbcYrJIpEuDkLQ/yiKhwibSI54od0RH1PuEkjF1uE38wBtzm9lEMilhBMvzRpwRL4ifhN6ICcJl3LZIKNleXyeH1CZN9hQxGRIWBF7QERPuOKTHSMDCKBDMJpFwmJQkHDJy0zwnTxELpsSnAXVZyALy8D8B6wdMDt+HQcQeYBTJQgSy7ZE+C2FmgrBnLkMuBjnIsKjjkIc1yZx+SbIApr6WbrUGreT/wL/v/wH/drn9zwcc4d6LyMVNq00ur9okkoyEM4ugMVyS3GZkpcXFwGGkQQeMVHxfFkmTUSs8bRVJRQwihwanrVUiEHPBmAX6s1M6pqSFTzoCPpZFcunZDL5rnDSK5IPnUDEoknK5vEp6gTeRLCDU9x1u4QxkmdxImPwceOGQSZZpSnABXDpiHTH1IjKOHMEC2nMYCT1c9ICzcEq8Pqm2mseEhiG1RlJRBXZILCoZvAe0w6IW8ekD/l3m9gO8gyenratLEjDpe0Iy0vPsKbGogMX3BHRwAH0+aCLqUidg1J526ZhyB+B5OCDtIQO0B7Dq+j2RfABkw4FQHySzooCH064lg353zD0HZ/lwQG6EmZOiEQAIyaHHLApLSdX84m+IZ1lREDBb0VYGk0gDV5fn9wB8JHF4Ii0maMC9ZHsJGvIxM7uM+r4kK0gB5BLfFMlV75FZ2KhaJK0J74dFAsuv1hZHvvACRrjoe4Gr4NI463uRsAkNyeerYErOAhp6ktwAcs69ARdfVoZh6MuDtbXJZFL2gmnZ8tw127Pk2gjbZjcA0vwa4LbkwOeryAA+Y3/N9BaqeVbkMhHir18/SHrDrZYLxYLnM/WrbhcOClbAaMgUltLDHzvepFAsxOxAFg4+/zzDGI9wpVuKjNrAio6erSEVA1b1bGA0yH8Uh8G5KjoIPcKF5UQ2kIIFLcMhDQ22cZFDD9hUwNmY4dcZftcRtA8MaqbbIZWkxxiwSdd3WMhsmC0HQJG1FYoFQV1WOCgoDtg19I+ddpkGvQsQFYoFaQ2ZSwsHPxfCqQ9f9TzPYVQUvn4tziKirVmoAjsK1G41/AJ2dwwwgjqh8s1Qhl4eMDIMuBjkwVIRxMO/qUO8YEAFf1H0VK8pPMuhFzl2FtWw7gggl7jty3ofJqcBl8QTzpSwfl/vI8XkCOyJSxZOvGC0aCZpMH79ZLjNRMjDKVHfA+DATeDEBTjmjp9F0Jh+uhqO1wD6UiwYNirh/eb6OvzP8kTIRAh/pjj82qMEoH9O9ecHsNtCrr6miDj4a2aWluJRvA8nbJFA95QLOT8vl4VDz1bryIHc4eyBZSyTOj5R0onjTDtCeKE+sH0q5cQLbFINGE6eOrI99VlDP+8Ij9vW7Nureq3aEaEX+rNv2lftRkc4njeK/K5kVsDC2Sbn+LIjJqxHo3AoZt/fsl4FnncEMoCZt8A+4LUCfcSmeZCP2LQj/MDrA8uffa8ed4SkrjP7slW5OO8IJYrlAlfDVxo+RS59zoJunwdybqb1+P0xvO4Ih4tRN2CWNwZ5aqZ1Uz8/52JEXn0JBy+RPrM4dYgVNyRAogTGUHsXmSC0RxphgylZiceGXbBaJpo0gB5wx094ONSbN+lXEg9PSMJDOEnKamG+OY+qYpZMRG7h4HPBUBocM9y2CsUC0E+hWMgQS6FYMHRRKBY0v9UrDX+pxYONSV2nUCyklgr29MyCQO9plOsuk99fijP7ulh4Lg28EgBdgp1YOCgst8hyi/yeW+RrscCefR4w2aXh/AlwpN5VEAoYNeQuIys37eoqmQyZSEQH3UuZ1JWoj0K6DEG1mHA5ZBJm7HgDwkWxIygRbJKIR6EHx77RYFHyUNJu4aBg05CVYNjC7Hb5CntuHuZ6jQTMD5hERdcA+JMkkeBPESP1WpncAuw+C2AUpSblHNRFlDs6YqY3bhsRI/NFxH+Ss7rqAQHp+GBt7R+wMFoILqMQXE5/XI54Nwqcf65pnZPb/0yjIIq4nT/7rMQwjwrdoKUkEyOyOFMy9BxbTadeM9rZnCCjT3OgvI5Q8gyXSoYhKIaNqRMxIyBLFpLeNFl8pA8U4w2Gcb2psDsikfUCBiIFkHaGnECpp2Nmg1HB8sSYBaHaNFR44ZAFsSQ1jxQpI2bnUnMdX72BmGPF782E6AE32uyi2N+1htRxmBjkiFQglV4BeyKb5XWlp5GqaZ7omQqxyrJBImkQ+DDT/8OccUQvZYYyQY9T+ohRX0F5r6NQp5R/y1PKF0MGQ2IgN/HbK58JENI9AoorlaDm69fKakHWTJuGMvcEuSuTwZFWwuaF0VeQV6+ZlUs4u5mxmqDuNXd4ZZjJWZJ4OaraOEaDRAfRTCK1aCmUVD0hgPGqHU1uZASbq5hqbCVddsSACcSyjcpB1gYz5NaQTKgIYVDLEzJyGZl6UZDqzAtmB7aoT3vc4YC8shJRMnK9xaTUeqQ5ZF5DQAU/IKgyk5b+AIhSvcDn5rFZivjwMhgzsyRqeKUbA8V9ROuhYkIKyQ+Pk/ABEfrg+fQpYg9l/QyP0B61YaVpkUjGyEJDg6KrEghCa4+TsKTGLWmdvMXCmAHFsA5ZwAicggG3mZrHwPF61IE9gc25IA+6OeA2jcqHXPKijuNNmN21vEB2vYAPuJDfJjZSUZ+R6lWzRa7UZ4DxK4EGVRdsPzfNc0lWkCuzg7W1oSfDzwe+F4RfVjXhADI1ALAEYMxTPRpbB0iDOE2FrTVloDX8QJ/agPQgoLi0zPXDaVEbOWCT/yRVj2pqQKJ9Pog0i1l5gHfdyvn51e1RrXvVrH+oX7YeVhPrrraRyZBRO2c41C9hMDMLjUE1M99nwk6Epm8DVO6IQ0boBL7GY4yJMQ88AXYrNGiiKVABfXRZOTw/qj0om54+yEKPPCjzcnzuhR6JjQkhc2WOXh6TBc4LqSKyORNW3kkwRwm6Ke43oRBRcrgMic36XBgaNj1KBZViMMocGq+/XnW99WAKZQJd6k+Jw12ONDGMTcHIRabaiLuAI4ReEdHBninYiIrEYgGc3uhZSM4WNNLGJxglMIeO8PpIx2VFzbENXdsUgI5DJn1qKUamhygcFMy2d6e251IucN9Tn6MVURbJwve+J0P5nYsVDr1AG4TQ3tYdBFSE3QwjdXgfAEWLiogctEwXDoBYQFkMQxbA8v6/z+ul/S//d0XIXyL5iyt/kb+4vwxX/88c6ygWQh7iTC8jx6lpAn4VHG7/ZUDRrpg/Gp4etUZgFhXMAXnCi8LYagq0zwOWoxjMnJ2H1BqVqqoTkMS8KCTaZowuKugE9uKhsq9qika1rj+F3TgZMhRFYRc1G0QPLBXDoURym6wYA3G9tkqqDuWuUnTQyhzrEWrwjjC7zIg3U9O16QWlMzRuNhKJNQcXUcCN4K4kPc/lYQheOPjAZn0aOWGyRfvUkSx1qMUW5VxERwH/Vbi9adYBnc2GMkkDkpTwSZUfDWdqlETUZAl8hvME7YtQ05PCk9Y1rhqvSHvdlJb8p+5lDU6evjp3ENRrSg9A3Qxsp64bhQAZnpvC04/TrtWbm3ptm5izNpYzX8OMsjp/E5hL6jIDzjByqSiB0w2PT+jBiN/6GFKKvFaX4wO7I5iwS6gU2hGAQTL85DUotWHu23C2sKGBVFu2DEJmN5xyLsXHJHg9HEaDkD2Hyu8dDkF0FAyUGzqAU4WkuuWSjJiP7tQhlUMlz7uw6YVtzDXa+oKI8vDM9V7VS/RMu69ZYxZMmmgrDanE8+9z5iAoqMeK0JkiUDLyQWxktoI0TCma1JnQqSTrGZWXi3B3O4GZi5ANWJACOp8XzIKpd776ddOsK7EAuIDCAkodZMJ6xAdHuSJsJYQnTk/ag62f0JpibJrU0oIqaZ1c3ZzXiM2l79CpEpO0FwxaxbTIwWMHvVkjXKY+lcOF5AhiihW+RaKvqqZGjEMJ1+vrqcrENoVHCOBcKXzwDfGZ5zvMuMh5D+ygsQCq5l0EMyK30IrDXModQm07YFLOCU7M8f9X/yx7weC7RCG1Q/LNKPMzRiMPuIZpiMyiqr6uhNrtmJhbZEhdP8s0fpLaSqRQ/zZ7izIBd7NyyZ/J4F8B6I8X114B5k8S2PqBJ8LfKrEdQye/n8jGpSQraD4MVPDDnAQ3Y20DR2dHxIfL9wpueTj5cZLbgt5/HZJ/i+wWgO4eqMOXCsL7gL2U9AaaaQb1iGXwHxmjJqxFjjw9a/u8qNxnDvt4CICM6eifGFSMZQMpAAWUWBQQuI42dOhywbR9RTMs3wuVMOlMiRs5IQdmrUGShBtHhuMNBmDCiMK/g++ccaQ5cCUY2Iqk54VDY3HIPXHUdoXHbzl0PkBrAu4dOXvwJG2xS/RCybTQlrUdRJKVSTWOygLF/SA5vdPOJDXoAXmYl7UfOqKSZj4EA29M+3lt8qEjZsiw7oJZgpuZrdhwbFpwqvzX6gF54Pr1Q0c0FUfTWoEZI8PnoPsYC6qdiQg6IA9RIA44C/sHSEryAC1kB4isEiDrAIyKPUYDFmQ6Ur7G7NS+2ZdmzTjp7zqRzYz/1FNuBog//mR7nIxytgPGFd6yHjljU9JCR37WEj5i05zPzsG45vVJ+nNpRGjFY/XG72APnUI28IimdlkGhJXT27PVjsAuZJkcTg3nVmzcC+zEcXF6e6bGkmnvrurX9mA7g+QOiJ/CgPG3fsD6LEBzHnU9ZRx0i4Q64dCLBsOMewGtbzBQi4US/XXW0POkCvCUED9JKHEZVUZGLwWkjmLiQUf4UeB7EkJReZ/YTHLtIItJeMb54AzmMd5GXFJn0CmQFeoMvICHQ3c1jVbj2ZHaHKzbEFA+0Ajch6BhOHbiQ3XEpmWSWB3V8WniyTT37bE4nCzWAzuiXrmskE5CPy0+EDSMwOYsbHIkrGCKoJOKgQOIQHvXph0B8mzP4agD9qbk8+lt5QuY7XtMRUtHJobQRE5RUvUch8OBUQLWJbkMqVazs+J7s7W5s5urigRjQGzSslFa0NLOtmt3L/fqpd0TtnWxR9/dbYxvw932h/rz9vNh90Nj66K33ZKfWpXtcckLxqcvL01+PTx3ms29DUFv75/715X7cIfLWn23W9083+/Zt9728XHj8cP18fjSa96VuvLwdHpY7wZOqX04kJ/uvRun8rh1ur95695vctGrlBqT6Wlf0nq9ZrH7w2qJ3ZWeeTXafbp4Gn3iWxeT68rx+W7vwm4cXay/bJ8eWpPj9tZHm99W6s2bqFK9vZ4EdxdPu+82n9/1LyJapyf83V3twyDc4OFwc6t63qfNI/d0FO03ri1r2Au70dF9afgUHN/virAdtrZ9ent7/bi3+3x+vr/dKrX7u+Pd59H5/sZeo3/eumo/7d5VX57HzvHk5fD0qeKLyrA3eTp/9BvDwc2H9e2jWjN4ClqH1s79xuE5G4vdur8z3KgMmZSH/tbkfHQ9eOkGHrNGYWnaG7+ctR+PWhcRHQj/6Xx81X53vz9m9WiweTFpnH6qb358tF6a1sb45UJu7twFx9d7Nf9mWupd2v7eftsdV+4mVnhzwU/twYnjnU42t6rj9a1B/aYyqgnZfvrkjvxevV+yAn9weXbsXje6R7Uzj+353cbdp0+Dfq8Z8K1L7+jjh8a7i9Hu9CjaO388HVad4Sd6ePkY3U42S2fOYf+qsjV4t+8O+4diVBeM7Zxd7bsfmjvrT43RxsfShRfc3F+2jy8+1d310fHRLrv/eHt8ODk9OT+7H57cbG3XPH628bFRkuNPfnUzqlwcX1a6N6dHk4v96vVmb++JbZd22D6dTi7GEyuqBM1R5XDHPaz3r+jVKfW23H40Oqsc5VKznyXnD9uycTeydu/p/nTPO73d79bPH7efI9+P1p0X3j1597E9au09P+607Lstyzta97h7P3mu803mtisRW7+5oju2Pzj+MD083bb2wuvNj8fb65t3zWhwVms39ujofnjs7YSVyrt316x76YbR/Sdrq7rlbtU3tz9sfhg3d2Sr9nwzrVxuvjztnffF/tGNK3eD+62r3t4942ejNj98XM+dzlN2OnLfqZzs9weDQ+kdN/euqLXZ7B5tDiabe5tBe3P04aoyHNcd56h9tMH6QWV3GN3cjC/6h9aFL/acJ3a7O355Eff3O63W9fE7/8KudumgviU+7NV7/sbhTW/99IYHtHn5dNM/H1rXva69/+F4uzZ8x95t3/aa0us1PRE9tu8vN56rtLHbvtrdeBzfBnel84298Plusr2/fd21BqO86bDsbCrXlcO8ZqOZNaSTwSA6nn4Ibs/o+F3lbvvj2c0g98M806k6TkbchuMEYs1ALcgc0cYp7VJMC9G6ILfiMwOlctVOObfAR0mFxYpol1HHpDpgKXoGvT58Gx/W1JyrHaFtmwBH4DkOmP/0sSTDILLwWEnkCQTaKHIdEQkNGsTMqvikTKNUVMLsyEVi8z7KAmFHpGEz4kWLhcYoBuemjYkxVjgzQJmQlSsQ+PXyEOWVs4ZJ92rmLh8MQ2IUPwna3Ox8CO+jd3FKhnTMUh10CqNwalYLFnnVTK8XhThFiH3gSmFEbaojQEkfUwddAA6IkpgUII1+lxJ0klAZt7yqUK8h08KYsjxCukpJMiE5BowrIsuevhu761t2n63T/l5/e2c/93gdhTnBFHrM2UkuFHBQwvAGAfWH3ErEnY7oU5c702TFjaRTjJNLOoVmq9IpgLzRKRxVO4VyPLLGqRKBOuIVGYjMikAgvyo98vcTdOKlSYB988o0W5W8xRBZxjJuPwXPN9PrhtPdXKdP/Z3R3cmk9ilgTunMG9f9PfmOTU49e/Po7sTZC2+d5uFWt8ncre2zyWH/yTm7/uBviCc6LO1snGyfvgTRE1u3jhs7e8PGUT3cvX0KxsI9rd49i8uofrizxe+60c3N3d1J7eSQ0Ua11fQuT18up/LRO91ab9dv5Nkh58HwkL7rb27tNO56Z/zEjqxzNv6427DOnk93rPu9l6vNvd2n0/PD21bDLV3V2XjyJOuyVT/Z3r4O3X3JvWM+Go565xPvaXJ71fxQuV8Xzu7d+OOVM6zU7PPHw9ZTq8LaG8eNqFqrirvJS7XW3Lvcrx8fduuPdis8HlVLwcdw82zn8L7fsNetremx3x2fNDd2WNNefzndu7t+N/EOq3sfhaTW7lG44Z+1dvb9u93Nnd1a4zbau6nZR1eec1ZpDCy7O9i89Cvvdq0KPe4+Wu299cf9s+DoZbLXHq+L08MPTEbVx8bl4wfZPXuxR7ftm7twc+tE7F+fStvauPgU0dt1/nR3yPyT+/6993TJnJePIdvYeBduH04++uujm4vdCVuvP03vqg79NLiq77VKt7XDyWb3amy7e2zn0h3eV3rO0UdvOrDu9u63d72T3d4Zp9Xr/ln1uHZhNQfVocveVbyjjemnT/ey0aMfulv1x0ZQ3T4/vDi5nuwFF/v27ePpXt195Nb404Zfcdft59LZSbWxNd1pfDwLng9r/Y2X1pU8bI6uWo+He+3GVU2cXrzslh7tnWE7/PTsf2pMGl7drlLR/rT1qbYbNQ/9tlubhH7zg7u7dXMtN9yd49vGpLfe3qwf5woHM6LO7mVvdDep3d4MeYk1d3aqg15/893x6LpWu61T94rWgvXgceNpvb/RPz562bjdqXTX9+/HH9b3j/l4o3K1WartNZ29QWvj4+hlk6+/VFtPYjrdq6xv7txdWc0xv7o4eyfqz0fbVyfdxpEceXt2WA96W233aHN4czeujtyXyf6RbB9vnF8fXn2o7vJInrfvmF+vbjzvR6Pq2fGn67E9CI+uetc7oxd7/3L4VLLsJ7fFLj6ee8+Nc3uj54z5x/b+R3evNN3YrIb3Pjs9uaL1Wvixce4cDk/5odc4ux1sjZ9b7vbdc93hl1es/8QGdUe67TrduvBbu7e3TvVsa3oypOH6dSloPtee7Sn/aH/oTl5Ox/56fdLdnLjync9KjcFl4358c3uyf+oPbxs7Z1t7909Hh/z0+O46D/EzQtl6ZePY9a9um/sb3Wbl1n8K2G2Lji/pp96+uGNn/NBbr11/OHzZ2qz1ns6ervda2/Tw1O01h6eWFT5Wzx8pFyU+jsLtd+/Cys2F+3I6+Xhaqz1tXnw6nlT3r0vbH+8/ucc32yenPJxeR62Xk3u2u918vCwddS+v1zfbt8MPW9cfbncD72nX2nln7e8HwY08ak9OT/mktXex42/sXPDoZWerRq8ex6Xo6em4ctyfTi53bkfPJ72AHlqPJ+EFv46m173rp1H1eFjyqDgZTe4v2TSUl8N2tOleu5PmTq25GXifNkWDHz9Wd4W0R6XKu6Ot1tbk4uX+/njy7nHcu7317m+9/fHh9nr34n7zfv34/rr1ZNVerMO69dRdD4Wgsr/18Xb72H7edffWmy9Xvc1jKRzxbnx2V8lHPJ+RDKcXXX/3NLibtvjLRugdD856tx9Lp3Z96/F6e+pH+0Hv4vZ5K7g+Pey74fqxd/8yuKl/Ovp4fGRdPU2Y27zc23jxahVKS4ej9bPbyw+1x9OTTzW75h4Pb7cql++cesmPnkdd9+TTh9ONjeB52ty72tm5O2+xrVbDbfbPJp/qu9Obze1Pz+Prs+P7emg79s3Zh5er3TrdfWmfDSsfmzd504lkjnP9RjKy0in4Uc9REiic7p3C6qxMEJs6IkyrVXFayVdlfXrix1lxl7m+4021L0LYIBYx4/QAZ2dqaCMcY0CXNnSIAbFpSOFgH7NA+0xQyDN2kY7wBLYpk4+JWGp5rotZeJ2C5GjbiT9YVeIJExY8ZrFFZTV7qkueK/U/Z4miv7d1dbpV23w+3jgc7I2j3n54zjYGJxcvH9/tsr12JPejxsm4+fEod1Ged6xFAtvzDsJ3V95Z38ewNlASAHnWkEIubILllISD70CkV3ZyHa3ZOKvfpbuQ5HPzuLqzubf+RQs+c/2TTJoBuOehexTJYgNj+iPt11Ie5TIhR9QadoR2pmcsiDqOVrLd7RLDvBCbrLQgU9ITZBv6BeC2d7f3vpBSSdkaVfMocMwXq6R21CSf6+2b8t3u/np5Y39/+8vcPBVUZWU9nXup0WYICihQzcJEXaJHTKXhpL77vmjLaZZcnrvHRy/NaN/d2j05v+yGEdvd2T+/9O9ud/3qtBXy0f3jWf22vkNzDuGvkGJpHJOfcUMrkV/pokU0cCYpXCoFJ2W5hqTLW9Y7Y9N5SL++5TOwY2uL9xvjLGbN4OCsA3M2+OxMOmrV+NznGn8+vT37Qmyd3R0n8ui+YUPLVOq0MhKrGgVFwhPJX3EraK6V4RW5mmoLTEdm/G8xq5DgEXVTgypGZzRYcO9RR3pxyChacOP5JKwFtdQVuVpMBUcjq9MKowYEnYL4TVySIJ6XGR/1cHTV6Ql1BBiGZ8bCEVwKeeOmVAEEZQH3XgHs3siMBhjrO82j65t686im0gEcR3UWJxdp877dEQYFaa7OqDWED36S6fOCDliZVIwPQHpuyoSu3XyJ1o7qqRdHZwMUMNeOSC1JdrpFYnuwrNID+CF+t3lUvbq4OLqsHdWKwLY4+hOxgAeWYmDJIj7vWPPeWpVcBIkWKpyNKBYcM0OdH2GsLiboTS+NMtuoKMggxVV0gLHKP0si0nA28KYjlEEoHIJ5x0SFZdnOHLd5nIRd5Qb8U31w4Mt/I0MA773x3VfSAVeGuAw7jiNxoPPcybsspHDuIx/WkAELadLJBZNAd+msO0qAj5VTL1XMgBeMJJkwTAoMh8iDiqR1fa6i7loTOhhkkoc0e4TkoYlgwRumfAXtMIEC/tCpmPpg1MEZZtLYpbHIzXaUiwTfc7g1fSPyG9jYoF/9ygt+Q8yo0HlVcGUmzNIP+JhaU6IGjxk08FkKuQEARI9JMtRb22YgA2KmQ6bOguU5DrNCWUQWXASBAxm2wr3NpeWAew8yniQWNkAxLx8NMjQhJQGzecAsjC3JcbGa9JaGJ8NSU7dNRZWoaAUj42BqAAQpOjxh1ypcQ7Fyro6BOL8BMABtjoRdgkolP+kCKJUBTB/tXWpIZI564Tti0QRS7ElVxqBEtUqKeOh8sBnX5zclk2+gaY54YlQZHJkH8HvW92yiN8wgJAocGZ/4VkzP2aSKVM6ETgqCoEII+P7OmaUDyv5MxpgHyR8foZAHxZ8UdJfOAs2syTeDwGpTQV1uJdSYSidNpwQpykxepvIEZ+vmRD5Ie0UyAIeFFxCbQZWZhPduxkKXynnH8zqbQ0w1LYP7H36/AmUu38rg49UI5rdjQ4vY6WeZOGdTxey70ZA/AeR7XXUsdrVM2s0NtZiZgym6pupNYaADoLCSOBxAzGyBFtD6AjJjKvRCWfuR2RptLRYYjaCf7V8vn5amMcjPcWbbdISW97k0qDXdB+wRmTbGmmDkuqrxpR0hGLGmoXsVUQu4bT5q5o6jVC9GrFS5PQFKlKWUMyU5qwApWE0sjOeuFA6JR5dFraGOOdTVeqQRQaDshUzJ/bpTyRAyPKVVZkFSgMo1w2AqOzrcYm0HXYQmIbojrhoq8kcrtWomOTNUmtLcBGMXlP6+m/q0m95YHQGihKo8ER+n33tYKnXszdGPTVNSLjcAMivexeXnsBqHicqPJQkdE2lRoYKM9ONMyGIqb7Y6V77ukjEdpTSbrJ0NaTwApqGC4+u1OMEyOcNvmnWIc7TjCEbTupJKq55tbtqmgHglDvP7gxCl5flvyRpqQTvABv6RkcJThiBwx1MLHH5AKCCjOToiD8cxFLlCJdR8UXIu0rUxYG2Vt7IRrmDM2n23vf9ldXZFOwKIH8PGVFAyUi9CkUlTz1olAYwNBU1pU/2/vKX+f7Cdx3gks0Iv6KYqz7zlgGnhVySpR2O0BnVyGIUFU11VdQ6WVtwh+5k6VuSoY7IhWWR7Yup6kUz1KdMx16YyXMxtJKEdgfV4cKdDuDWWrswaITPCsg4byEXDiPtd8OTnVlxojbhfVS8JtNSecPPECkDQnkl70RVHVGITLCXYmztCp2vHhiNquyofOT8oHuHSgv+r4CkNZR5IrQ78IbBG6pRXb75FQaoxMkATwfqQ7kF24+SvB1Kb59ApuzbUQVLbEC1Fcc5YujuzN+OZq9wr9ApwW8eYm2qKDz7lwYRLpms9KC9EfhkFXfRQM1hMYemq6nIKBxhGC/UhM1lzPSq5hRW58tmSjvk21TvhOWwLHTVygf0rMQ7ZAtRjMEn5mZa6zp1RrbLdql2Vqm+hypnmQPpwAAHtOJVV0mKAkzhBVOMo89UDWNYe0iX9nkuTyaQEmmgpChxtp38gxsSvLVon7XZj5gAYMmpjHcUZuEAlfjj4ocCkgYBarzAoGjNC1h2xaRcKfRyAvp7YotuqYAGYQRLEs2zW34PwBFMfqpXQTi1TamVFF12lWG83VXrVFMuAHQmCFIYmqTnlc7E8Wnxd5l5EcLni9reIzYjWiSC+gO7yYX+r16DNAhdl0JaqT5VrMMSBdHT4nIUqND3oClcdYYxUM0YIMmOyosh1AmqFEXVIwFTdXTnkPnDLcMJ0plScsqlzczPdZRtYFvNDiYd8RxipLWvmzMWX0svemPB4TkFdwC/inEf185s5jw58qgZ7e7YjTA1yYbtKDerGAvL3aH43uhMkRmYnQvOcDpin/WV8FYYyocs6dGn6kklpFzgTTERjUWsOekCTln162+6Iz6e37S9AOZw6/AXT2TH1DmFUss/pbUvx1jiLgqcS43hi6pqDZ6byLVZgkB2B7tWb9nFpL+aYyIJ0Hb1E4pqtokq0zoa5PDl09DUxxswSTa5Rm9tWF7t8zqmERa2gq47ZHLtqtan979rGMMM7Mky/qkaA6UtJmnHeSBAzIFMzN6n7kjk0Ei1S2WZoSm7A4jRKWZ0hPHQdPfsqN1nzXoeNmYM2yyy8K6w8KJPN48oq9G8cr1gQbaZXNR46miisPNg+5UFH/JMk/PTXIMMEwbZmVJK0ld4QtM5NsbQvT2pbvFmHBHHa1RiXxE0wnqoS7AceaCBxufYZ6PW0irEKbhKLsC4SNT7/nMQgtWnejgxJQy77KdN7dpE6IjZ+q0XS9fppgg5V4gQpE72BMQdIa22bCq6kPZcpxFCUQD96TiRCCtUrVdUUncf/Ky0KuhbA/D6q6SIBaQ01Fc6aLLjxruSur+5e5iANd4FRF3TZgZAFfWoxrHYQu5yNC0MHUJhtlQR/H0BKLCQstheBMVf44FVgbuoq1lqGaGlVWl8/cpy0CwULMow5m8TxAKb3TNwRmujS3J7HjMnkLJvvXM+GIBHf8yP/950LDpGezIQLW9WuZItepqqQq1JY1AemHHAVqfCidixV5QZLfc9CBdzmFDKf8eBS3wNCvJ4EB7gWUEIwuulBVLo5slLf830slu1jPboy+MIja/j7YkYloSowgCMHSIhQuhxCy2MCLXfEhP7Oi9Qp9JnKuPOHEEZVUHY53WXZ6LK5w8cRIeA0cf3QZG5b2vCTKo5oxK/UggNoSVxAZqHN6PlFV7UbZwg6gYUSBZ7Wts1DLK/aSJ/iX2eV0noNpfcTLkIljhAaGA0Hf2pIY6OgH7Ax9yLpAJeCAqaGO+fiRJ0zUHvZhJEBnEn1lI5I+Up1dRjwQ/ggl6aVLnu+eMGcZyKRZFRRTxgqJ80W3sF8ERSZquSiinaminmmGWE6z8SUDiYr4A9gcFzSYLpqrgPAKab9TT3MlW02QFDkoYorI1SOZHaEOLuVsFK6lApZ8QKi6swmwK2q2B/AEBbqRM4NiFb7SJ0aCcY1WzfGcFiNzHqZasDpSroxQUNaRUfgjiAicnt4bCgngao0lBysRvbFxl3dGCmrbG5LUSQ1d22Crgacrw7xruNZ1MmTPW/q5+qVYfExReHlQCB9wHThhppIMRbgi9hBIqpnj8IimY1+7IhFtuHDamP7nYqp3N3e/RKPQ0Kqz25ZVNKQIoS0PHScTfAyGcMd0Sn0g1K1QvoQDIuZL6lYllSqNYB/DH8OlXij7jkS4AegNi0q6tANVmDjAKmrC5kgcJapyCqIfy1CZR/tuO9NyZEYQHrNNz7CYhl4rY7hvRCDFTAJJyxc0wABXzqYLC4FrCUrKPuulg0YTrYclLEMz1fxfauMldJ8qsaSmFyRkVvHaUawn6/dm7CXxNnkzNOjFpDBWqEJUpUEpc5ChUaZvo3IaWY/U7XXeKKNCxc1GKjhYS7aek1lQkeLl67eG7t/UgW0DcxxRSdYFoHOmyJkxHWEYoIWrCuWGxP2FBYaLmoy1YJtRnU8VXIGxSEySbGa1xylYPhIx2wsLlsaK1mmXGn2VpC0MyWpN0rla9hOjpXvcREauBe4pGI4lQcqA2QytHr5g2EzdY3yMlZ1taKkkrU6ApOyNpkC+iWKkkrAMGiWzjReGXNq7l5bIwFzGfL+vkMHq6CRcvQsorElgEphIo78zBvE5nZiFU3fnzYj0cWjo8Yej2qKEZmRjY1HVfoPqLA9V0eIk2yJ80gmOiTkD9jZpAaRlYawcJ0gcMOFLlW0hsUmO0LXOtIuGti8P6Ur1KuiiLDHUkEpVErP4jo+HeJV0XKcqSWObjMal7rFW4gWubzyfUlorsLwHizjwdm8u3mY2SFxgC7SdiosGh/iyZkIhapMlOoeuALMFWABcceYsSJ93ZMuAJQ+FfQYxuqGZUb6XjChgZ35VH0UO5vPk1r1Rn7HKDSJMMRxLmQNXV6GZlLnwKs+rxw8av+W3jUIVXJzQWz+VeEZaSm2TC7VTQ5YBNpWXwKHlQlCMAxHqK0vlef6LYeDFqoytfrRXQLoxxLmyapgYIvxhymHmZ5RiB47dEor47VZtAwVYqxQauHU/upTnie+zaQuJBX1NZUmeI6r4meP2C85h3n6DEfFjnhigMHgi0rvp+ycqThUzRYzl1uAK302Eu61IDcod/orxAJ9CVWqhllm2+E2S67Sw+M/pVRglLrZGpnr+BSKEjPqTfP8JxC2wyGsmipTlqqbveAgNreq5UwEXrU9MnP/loE7/hT3ZX5UwuIb5RYdUfP35iV3hug6qMkdednIGaOzxZFKdOZi0Jlr53JuyNO8xdzuBluL9xdzzNkBzBQRRMXb9OfmdhHgHGBo6BSozzuFolLucDAv59qSfLSGNMxDYKiKy2ZujcG2sSKmIUcHsaoxoZ3cB8C2M4zXlKAwvmdz7qZiEFH2w1qgqx00tXTxx4HijajYxihOx+XBEOqeJri3wHCJgyyfoXibJUh1/ciJHXCZ8eNPsbXqr4ySUUCFRNexT6eOR/NKeJgmDdUiXbQDlWtMSIxPwMy46IucsN7Q80Z5bCc/cqJtqADXH8g1KY/wQH3+AJv2QV+SqIIUNOuB4ArDS+IeFqjP8+NqTsqCrHJ50r44B71Uq+tW3Aogg4QJtbyYhISudGiL66BvU1VSSs7lH2rcvEv9QIzL3rao5S+86kR9iVzy4R+pJ+87hZ9/JmXdwdevnYKmyfcdTAnoFP6ZH9PhqhwQBGtBtbCUE2x+tfT3YLBSzeCqFQbkqOKDIxl6rvLymqFyj6GZk2dBdeNkvdUh8024iALpNgCHJFoDqMsCjpSltPp8D/1C6oz7BfIChbPvEXBrdoRS/Y/Uxcl6W5KW+n/qujv4An5COzztVYO3XDj31sFmhQx1QxWgSg/ySmpkxNvQcFZ1mm0gdd5RHPuTxpOK2Yl3I1BphkE2rlrt1dxCIZ49Q4nZjuGeZWUimTFJ4UZlDnNVzK6xHOpok5s6SerUSGVpMvdk4H1ncFZqaYIK8vAP7g7++QA2KxTt1CPhR6EZ4p8PqiQOmAMf0K7jO6jDsefwIeeunzAMeC8KtcGOw5RcLmjoYdaUS9HNgC3nd98wYP18UoT76X6SBBpAyBJohMoSFesAajsdEAg2eeMNbRVzFVtiXF20Ugui32CRkBtnTll0RNnAJzD+zNhvKHE5krLXJw/QoAyvH9RNZFhIn7s0iIvtwKmCeZIgjdCQ65tR1M1YPhNw2clWeR0u5xNalMfyTmBoDpk1FNqUoyuqcyjUQzsF8OyAqxUoG/Y0LHUd/u0I7g5I3aUDBoRSAYEANhxOl7TwfxBUPSY1PsaCOqmdTt+0qX/YwImVb8nAlwx8tgtkI6ZVUfWYbOKUUqlIrRKzrFlhOWFmxguLH+DuziUMm4/zfPuKakFdiWMyk8wVdD6oq4/JhNsDFsokKQKctZSAYGmUutrVBVlTrvA55mtB+EQen8MXeE/GzBXXqaLYWhivXV3kUplJul3gX8wrjZ9BAojPiglSX6dRl5TJAqJy0xktymcY+60U8owHdkpcOs1k/jwAZKVyufyQWq9Xtu2fcQb83kfA208ABfnvdQwA/f+xB0Ee98jd6+aTvN0OoQgzmzSfgNxBjtDCwDUyTxcn+Dy+1BRm9bY7TZaiChAqdwe/F5XCMv7R4ooMFtT8QcL4SRLpRQEGPb9JnJ1wOxzOd3gLj7+b5Gb2EICqT001TNHQ+IKthbj4jlMUAVt8iCKu5+eGyP+eUXDJhL49PaukRKFnbHz5q5JukXQdRw1g3+WOUEatLGSV1KdH8B5o+LVGbeZ0RBS81uQmcDpCR8mU4rvYF7evqqbJ7eyCTd7y3SWbpG50FyoSvIT21cUfXQnW5i7aZjFXMUBBI762/ZVZ6ba3yWX3ZosiYlEQhH/Brl4szM4fyDE1rUKxkIG4oOLVM8C8adsvF/WHLqoKewWXSq4f2txmDh3+JIlpqrPWQAoMIoxgeOWOGYf2mLPUBZe6IK6IS5/BC5B3Pl7Q53N8hVpEqoBXTH8ufeZu5BLVwxtvocu/w7Cd6lYb0/CuwtyF+3eS3FBK+r1kNxQO/mjpzRN4PV9OjhNU2bBGGXJ6pGOq+1PJJom6zZ4htgPuZBLqwj8dhJJeGGS3SrW9ZT1w9yvltxbfPAQ5h8CXzOCp68PiOEs2ps6KyTRUWQVQBg0WN+ByhMzOdNAOONS7iq/FzqNPjQHddCEiTFdpfNB4HiTUr7+NFxNwHcYd+ros1SkdU7VOpB8J5QQy5dgw+yeYmop7+mOpHUcyLlkO5yFUxMu48bxAhRCUoYbm1MCcqbJiHuppyrxGma8x5njhZ/gW2wNAIzbNb55+Odc6ffbWBQ9f/Xq2cbq3Vyea0yb9rb7cXr6lj7y2qQ2+APUg3c2gVT1KT2/+yeyEMy3m+38NxLfwnCXd/MF0g5wp36N/Jc7Bj/8rODP09xsZMw79G/gyfP82tuwkLRfh4AcwZUTJkif/R+2tJU9e0s2v5cmq+MgC25rONsmUbtGqUnIrbQSOKQeLpGKAEZYbolCASeVdQ6QCLPODLsEb38Bt6m9oRqY8XCo6A00KOquHQRHSNTvwfNubCBJQfSEvePlIP2AMC4mgGq7NfWoc2sNhOsKMAxyVi0hHGuJgNBUjoT4uQqniMKnGA4XWocQlBnEa3csUPbqpa3eY7WEovAPuP8zUzCQAzEZnpoK5dNEkNUmsjaFcbX0V4mFQ7ZmaJ1nk2mnkJndQJrezUyIt6tBAfYzxaytqAxZ1mlgR69BrE81qqqwCFPTv0ZC7qWhyHHzBMnbE/Dr6FLMF1SyoOkMzqznvGcUZ5JNjKs3aJAvIqKeqOhhyjNPUUCDg1khdi6wLRL4ytxR2NUYhBRdOQyhdHSId5CJVQTWLVZJCannOXKIm+aqNBGwJM4b0K9/s2tkEkrgI6GuWDd1oYVZP/o3aFzQY6fRsXMV4a8YlF3INfYvNW7OGFm3mwh2YnTCYUpRZYIHtFBqkjKwqk3G+ySW+gLhZZo163nNOk6p+1RFDbtts1mwKTU7wRb4nAd4vNDaraThgRANizXnbwhcd0YvC0Msb+xBfdARkSKBNGBPzchpCbRmwBmO+pWq/oFWezRve3TTrKXlCm/TShnxEJhj5NcrA6YSogc8yzgA130KxoOZVwNCEFPz6gXYbvNlStCSSvwSRfC2+xqvNLlcJXHPZGrMMEe2ymgBSXohZN+b3cEtVfRKgyimUI6digZdXa53Ygmh45tmbFXhSqqTRV7vBdjq7VNdj/8Exj2jcBq30NTj0lQ/YDiL7h/+Khu2/SuiMJqo/2rItvNz02kvPZJlXWw1VhQ1bYhIZ2BFM0q9OseEuqPv4OiBVVZwKCu0oy4a6dKDcEfdeZIRazO80HST5axBrPJNXnO0bwEGSh/xFAw10wsMyudeJh+p+lvhucXiNX4Okr+aBo/1XvtCChQMCva9e24em6St7cGHch+5ChX18nytPf3pRvzia4SULMu9URIdiT3MTzLKd9NaPOaeOqhIIaG4IiCKv3NgqDS3Gu5vqW2AdS4xxuX7V/Fpky9go4ESAm9+LDyHe//Bg7tzFXvrv/wP99zNd6K8Xx3XCV2+OClMWmQWRZ19jo8H0Eh36qQHR1M6u+oWDz8u4tP+4EKZlXNq/4aIu49KW59oyLm0Zl7aMS1vGpS3j0pa+7GUMxJJulnFpy7i0JU/+i++tJU9e0s0yLm0Zl7aMS1vGpS3j0pYhR8u4tCWRLOPSvhaXsRLLWImlT+k/yaf058VKzDGbZRWsZRWsZRWsH1cFa1kad1kad1kadyki/LuUxl3myixzZZa5MstcmWWuzI/PlVkWHF8WHF8WHP/3KzieFsdyBTEaX0acEsfUvTMPIOm97xT6ntcpPCDdgqIoV/FCrEHgRTm3RH6Ax/GdzoYDYWPdbex1SF1u6AWrCf2RHnM8MYD4mzL6bSlcCVxT/8f+U64L46jQzz1uW/o2Xn0Zr/kg8PrcYXAhMPxfP4X5kHMuRvo3Zg5AYoD+HXqhT9pX7YZp73mjyO/qS+PO8Zd+FecPmHiCFKQjNiU6rEA/TXZuV93oXY8fHMNvAw/1Q2tISVX9Xz+V1HVIq3Jxrn/bDK7fVqPX8O8EgDShKwxmvVOAMMWTAS2FYgFQAoeUSjMBBMDD9LzBnJGktej54bGVnRP0ouAG5Ya66L5KQIXB4Y/NLl5YKt4mjC3J4beRw/IOs6We/9vuMKN5WOKSqOu9zcWwlGDmEt7u52H8UfqeURScYEXMveoQgpq6zFhHxNzU5bzAuMyIWpJsyjQVizfkUsmuFyykOL4mttzKAAsxlxKAfz9/r7mgQl0HUyzgAakMEsU/Xx7VWuhAiw+p6/hSZ4dmBSn5EtCflSzhYtGflEwnF69CDrvBiwvn4NLXgMYXKZoLEF+lk/iq0gX0pubKnn2IZu9SXBMpI2arv9PXMuNdqOaq3FcGTUd5HzvepPD165xqOd+mWNheX48ZmUCGQX3f0ZfVrz1KdQWqirhbYKkIqbAh7BKufsZYO9C21C5U+2GenaotPtcdbloSMOmDcDb3lc160WD+qxo8Ti53xlaZq9Lj1INIRqjngW2KjinHUBc8LeB+39DDKH2BQS1lXCC8f1LPE7TnHoWrhG3qw/3LcFlvhK3h0z7XV/vqiLk83rlg2pC1b27iVHgzaY1ZCNJXVmuHo4X2CZhPD0x5kbAXjtvNDDqPxPhXgsp+FMydop6yrgh1ab25QB4GyAJ8pa5nRxW8XiMbm1vbO8T2mERo2TOXuSjKMz3Ua8okoA0QCkX1Wrkj+gzB6Aov7CYLehQEx+rFpRdWzOOOeIq8kML13YxBHsVREFzDkyP9IMUwc/stFAvZHt7EMX8siIkknRMDqs/fzDXnCln6m4W3cEdywWXm1Rn+mnSpPlN3mK9sr28Xyfb6FvyzUSTlcnk1Qw3w/k2e7EXsbcAEyCbIILTpeY63qt2VOhxiZqT4SjPhKzOnwjyrxL4+qEGVjU6psUtWuWSVS1a5ZJVLVrmAVQJgdCCRMgIcHdf+ueQF01JAQ+Zwl4elXmSNGExwFNDQkyU/6jncKrnM5pGLtAHYaiFOJBYvcihcv13AGGujtWitvPC/XjBdUwkuICsrd9tBgbu+F4Tk544ghJBjDU7F50X1pOqJPh9EJmXrq0oz+SnV209/B28KmApDoJWkNXlPBJtke1hZ/btpS31eF8DtLaZbpkZfyfS0ikM4DNxYYRSIFpOgILW9ERNHz9aQigFWjTkwiSp/J2trR8hLFzU13E/RIOZ7olqEjtbYVILkGNtEMnaQMOAMPLdwZKkxSAiDENoPdc5Qqlc4EHoMLBo6e84ukxVjY1mF2C5lPQUnrcmIWk1Pue0dELXJYG7Avm+a5xqSKFBMtBd4EwljeykgcHg4W75/ZC8YUMFfcAnSo1cS81CmDTDmGZdggi9QqxAkPDhZoI9RnwbUZfAG8p2EMyWs32fKgamdlCAIXLJw4gWjN4Ou7LbhtIWSxiLgTSuTLaVd5CY7MJMVDHh80/CGvn/WPK2IRz35St4TOqE8Q/hlK2A0ZJcU5tucUT1X1A58neSL6UZtT/9Mr4p+lMVIR6z+Hb3LmmV88FKsQiA4aS7hU2sEZ4FLIYMUTBnINVY6ohN2jIWvU1A/+278pyfVX57PBPW5YhikUxjwcBj1ypbnriWMpDTwoDWiEDK6cbSVVeBNnfB1LJCD96pm09oasgDyC/kX2v7J/NoezKRTML+6+sjrFGBmiojJL+SHbX9cm/QOxtHTTxZA8NdgAQB+lq7VBLLP3jCF38IIgFw7YfbkO3hPMiRfvmSTmXMQPqI+r6otkfdBpVFXb2cOQ0Uu0i+SoAjSE3wc91SOD9FGvVx9jbsYg/shtUZgUhT2yupqufnqPlt5fRuaz9veiqHg1fJVijxW0rSyWq5n1mklu2yr5SNVDELhivdxrv/1ngjuKJ7QCftuWD72Ay7C/oony63QZkFQJB2t+ikfAnUcWPGHt2Lm4eGA/Pe40xGdAuJ39RtjHUeOQ07a7Uasaqa+V19/hX/W1uIGSop6eBWKAzL7CDqZh8KDTO9OoZnt+s2TTcPKpL/aEV/TB0NjGg7RtmsOB5BRF4qRXjDtqpcdgXAkD8quZzNHltN7qYvcSX87P9vZHgImQ9O64nPQYnwllmJLH9FiGqhfsDn/Bj5pLoAGYDMPPYnhM/HmB4Vdn+WotQ/D0JcHa2u+Q6dqY5T9wAPRXpa9YEp9LuHkgo5bjGVl3rI/VQnvSfSG4xAZ+QATs2cE5JjzyTJKDRnZOTXxLOtQ5zlOA5jdW8E1RyvAfQRhYnjAKVcKqtWYpK8Fcq2Ig7Zj1hPbpICqGJYzw54wO97nutmBgvZvRBHh4kGolKopfMsTxSA1Ylo/SEZYTUtAXX0Yd/EwBs0XmROqo+Q9aYOM8Ld/SREhNcfQI+/JT/EPc779RP4Gp9uPlQ9mpUkYOU8+SAb/q4gGaaG3q8/19+SnmUevw/9b5QKAIQymehNkNkKm1AnwO+xVMWlS8X2ZfAO0Hp8c7zMbRCsQXSWyd+eY68q3t8X7bzcpJpT3Pv6rmFnd9xmVYxbx72d+ryaTQza90tEWST1Jr582BpT++Y1ZHuABlu5U9ZpGnH7L8NAg8dkB3IodzIOTNMgIEd8FFflviYCR/yZsFUP+nkvSHpVsz0IDdMpOA0ZxPlBW0MJB4VW1cBWDuwLqKqOPKgRaeF0ym0+zmDVR/dWZYSFtncO6vCClZCbf9uYMkrOz/G2c8VUY0hvgm3D8iUzy1UlkRfDvmsZ388ocQL4UzVKqYWdpH+Nbvdnd8rqaEz6nNInfvHWW+2a5b/41942vNLnck2ax/PDajnlNZPj33zXdMLtt/hJ75l9uw2iB8O2T+CO2y8rsg7Jrr6Lfjj2HTEhVZ/DzzwWIrz9Y5LiLqwrlO/AAGeb7WCpMVSJaSofLU+4vumn/wqfcUjpc7pvlvllKh3/2rllKh/9x0iF8qDMgIMJM5XNCDavCmmROvyRZADl/a2kg1qiPqQssGLNAbSLIaDiIvTo/a19OVzrR4GuuZ2cNpcaAw54xKYPxJyoGTwfmFhIf0RwW76EuRGqBIAMTQy6hl6SiBMalQhFhtaKf019UPSE9h31ZMcBb6gEAW5bDNQP8mr6AbG3AwpIMKXjGsLQwYNBcTYC8Us2nRyW34rhh5Br4JKYKGA+YWI/RQF1JkLRUj+aaqgxXTBpzvIm5oW/oBXoHVHX8YubhTWZphlM7oGWbuZ6ZoOp0Df7FxCHPVxPw+n2HC5UMhU/jksPKuqwZGhiYA9YPmBwqhiTJCnU4VfXKH3QvXYppWg/Ae7OPvr9/6MJnAqJkC03VCDx0KjGX6MxcYAbIhDE1CP54Ix5C9VEqDlMh/SvW2K8gzKrj+UjwVEEUJmzfA88uVDkRTJUKzxAeeBBHbJoQ3mQyQVhgd4BeBZQI9ny55rNAAqcoKZSVEEaMLv02yQTTWy8YSZ9arOLzM5ZXFOV1uMnEdFBy2Jg5f/w0sKZR3zNB+tRC7VJVOz4oaEf1/6p1LJhbxgoAWUu9m6/G8TdSF2Hg2ZGlnPE1z4ogZF1zWfCGOw5Ryi8626ntcqFZ4FidCpVGXZZJJfsCHqpkVDhNeoyoyTJbO6MpVK/hNmloZBBFUopYy6ShRsReoBaI68nQFMPgwhy1EouB/O1vpFU7k1AVhEti6xkQNdGevk5F9RQHXec5INtxM6i1kuQESOw+Pof6HlTigP0IYRYRJO4dABi/kHP9W7ujfiE1b4L3rUAH5Nf8B12kF+QH/fcLQFvK/EdmH3z/fz+gi/xuAdoaDcIMYj77Ua9ss3Gy4/SDNR3wKNeS8IPVXNx+bh5VahdHSQ8zoY3SHq31HK+35lKQmnSoo9T/X7NpEK6pLkCKSOO2fHnUzg4logELy14wyHKI+HEC9VUwLavgjLXVHwmtFwo2By9Ce+TwZx6khxqy57LvJkOp32/F7A+AliFIudB+8GaHSrpeOFwcpfq7UMLAm6cDDS3cdJQdyqVjJrKUIBkNrGE5frNGg5D3qRWuySEcImtJ4Nbqb4cWilYtoNvUvUyGbn33UWZRi3RrHhuaWEtlFaz+SNxiAT0EKQ3zLLQrt3Co9FloDVd/Ldgl/fnvArzqPDMFAnNonDRmSFFBxuUMt8g8zuzEGaz/ZqD9oZ9DzohxFVGYgXbq8xlA9ROjMqSId21+9/12aBGkXE7RjHrT7FBB1JsOmCuzEKefrsEfmf32Q6GFoRbsvWYkZ044C9wSssy9lFZmHum/FkL6g6CV+SccljSyGGRQHcSKf8Wn1pCRzfK6vksjUTNg71F8jTjW38q183r16LJ1VNosr5eHoeuowh6BK6/6LaVxgwYeejKV/2VETtCcWSCVHOsAMlC+9T0ZulSk4Hpr0NasWp1KhVXFWGKlgAsechiR0HmzBHabBF8mF9a5Xg+qI6lKQrJIpAsyTfujLKJkLT2iq9vV+7F4HF+KZ4xdlueNON5vnTV/Yc041bZIKNleXyeH1CZGMWSqXIi5sEjZSJhNIuGA1B1qg9ZTxIJpyhr08D9a53wPGRoP6vqiUJXg8xS7BYUOUziVhjqLDAi+Ig+vGFFQhf8f+Pf9P+DfLrf/+YAjgNni4qbVJpdX7RzNjAuN4ZLkkHjYUndYNUAAh+UskiajVnjaKpKKGEQODU5bq0Qg5sBioz/DA7qFTzoCPpZFLHoC3zVOGkXywQM5X2Uyxja+VGa0LOtbHOfAC4cMcoRTTdWNUS4dsY4AzXIcOYIFJm8YFj3gLJxCDF211TyG8nHUGik1p65UFouqGDtAOyxqEZ8+qLRbbj+YyFzMeIyD8nqePTXGVE9AB6izPBg7L3UCRu1pkpb6cID6ENgI1UVe+J6AgRlVsDJ+rMw9XUsG/e6Yew7O8uGA3CS50EgjsSW0xywKS0nV/OJviGehYclcGpnGJNLA1eX5fWzK5IJIiwkacC/ZXsrQbXYZ9X1JVpAC9B4vEpWHDI2qRdKa8H5YRBlCZ6nCyBdewDI5zhpnmE8Nd6qh0n+GPmGodhQQvFvvFbVf+Y+zGwBpfg1wW0Jj9SoygM/YX4ZNZbS/Xz9IesOtpjJ/IX58Da+eA86JLPtnbff8XEh3hpbWzEWLYPv8UixAJDs0/vlnyIe/CZyvX+Ex8hG0iMaX6CgD7Sss9k9yHHTEd3gOcvGmAgHe5DgxQQWqOOybUfOb/Q3fhhtdHr8SvB/jidDb/vtdEa9Mbsab8gPm92ucFK8AOO8sSWD8krgGCgefv3yFiy6oDTbyOHoFjGZ+OlplrmJHxrHx4ahd+Pr1/wNCW/+j +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. + +If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query +parameter `?refresh=true` is set. + +To fetch an existing registration flow call `/self-service/registration/flows?flow=`. + +You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, +PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF +attacks. + +In the case of an error, the `error.id` of the JSON response body can be one of: + +`session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF +violation occurred. + +This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). + +More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and +[User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-native-settings-flow.ParamsDetails.json b/docs/reference/openapi/create-native-settings-flow.ParamsDetails.json new file mode 100644 index 0000000000..eb9435caeb --- /dev/null +++ b/docs/reference/openapi/create-native-settings-flow.ParamsDetails.json @@ -0,0 +1,10 @@ +{ + "parameters": [ + { + "description": "The Session Token of the Identity performing the settings flow.", + "in": "header", + "name": "X-Session-Token", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-native-settings-flow.RequestSchema.json b/docs/reference/openapi/create-native-settings-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-native-settings-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-native-settings-flow.StatusCodes.json b/docs/reference/openapi/create-native-settings-flow.StatusCodes.json new file mode 100644 index 0000000000..3984cbf05d --- /dev/null +++ b/docs/reference/openapi/create-native-settings-flow.StatusCodes.json @@ -0,0 +1,1573 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This flow is used when an identity wants to update settings\n(e.g. profile data, passwords, ...) in a selfservice manner.\n\nWe recommend reading the [User Settings Documentation](../self-service/flows/user-settings)", + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.", + "type": "string" + }, + "continue_with": { + "description": "Contains a list of actions, that could follow this flow\n\nIt can, for example, contain a reference to the verification flow, created as part of the user's\nregistration.", + "items": { + "discriminator": { + "mapping": { + "redirect_browser_to": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + }, + "set_ory_session_token": { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + "show_recovery_ui": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + "show_settings_ui": { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + "show_verification_ui": { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + } + }, + "propertyName": "action" + }, + "oneOf": [ + { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + }, + { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + } + ], + "type": "object", + "title": "continueWith" + }, + "type": "array" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the settings flow, this\nrepresents the id in the settings ui's query parameter: http://?flow=", + "format": "uuid", + "type": "string" + }, + "identity": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this flow. It knows two states:\n\nshow_form: No user data has been collected, or it is invalid, and thus the form should be shown.\nsuccess: Indicates that the settings flow has been updated successfully with the provided data.\nDone will stay true when repeatedly checking. If set to true, done will revert back to false only\nwhen a flow with invalid (e.g. \"please use a valid phone number\") data was sent." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the settings flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "identity", + "state" + ], + "title": "Flow represents a Settings Flow", + "type": "object" + } + } + }, + "description": "settingsFlow" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-native-settings-flow.api.mdx b/docs/reference/openapi/create-native-settings-flow.api.mdx new file mode 100644 index 0000000000..4b6d2226fc --- /dev/null +++ b/docs/reference/openapi/create-native-settings-flow.api.mdx @@ -0,0 +1,59 @@ +--- +id: create-native-settings-flow +title: "Create Settings Flow for Native Apps" +description: "This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on." +sidebar_label: "Create Settings Flow for Native Apps" +hide_title: true +hide_table_of_contents: true +api: eJztfW13G7ex8F/B3ZxeS+eSS8fN7XOPWudWlexEiSypolS3j5lDgbsgiWoX2ABYUayr/37PzAD7Qi4VOpaTNGU+OCIWL4PBzGAwmBm8j1JhEyMLJ7WKDqKrubRMqLTQUjkmlXSSO2EZZ1Y4J9XMsmmmF2yqDTu8OGFJJoVyltkymTNuWa4nMhMsFXcyEbbHbM6NY1d/sT3GVcqsZlrFI/U3XbK8tI4VRt/JVDDO7ngmU3Zuluxbw522bCislVqxK30rFA7oWsA5zYywhVYpW0g3Z19fXV2wF8+fs/Nv45EaqSvNpsIBWIqJe2kB+pVZJDzL2M3Aimzat8IAzINQYwA17P/Cvy//AP+OZfrlDfYM0L+5Hl6xs/MrVlqxAphUHi19C1PbG0o1ywS74DPBDovC9til4In7Zthjh2pWZtx8M9xnShsGMAjjm33D7zgbYslIQWPbY2c6FdDu4uuLHvtKZ1zNeiyO4302MXphhWG8KDKZcFhOG7NrC5NeA8/NhRWtqmwhs4zl/FaM1FKX7K7MlDB8kgnAM6yOkcItmZ6yo+Hla8ad48mtRXQci0KoFAbSii11aVii1VTOSoN9rwyfy9ncMSNcaRTj7Ivnv2XCGG2YnAJczPpln3OgukwvhGGHpZsL5QBYbUbq0NrScJUIdiruRMb2Dg9P95mbc8WkZYW2VgLgRDKCyRTaumXMkLoTDp0XhVBhyFABxyy4tQttUvZfbCEmvHRzNVKJEViHZ5btLeYymbOFLrMUKLDMEKeHh6cv9tmkdGuz0CpbwufPY3Yy9djAGeskKQ1whr3FRqWFpXaaWTlT0CfSNXWXAJ1PeeKgnWHJnKuZwG8tZOOCnCj6wK2ABQP6h/F6WHqDf8cyvYFvUPLN8PzMs5IVbKLTJeJoIphW0MEB9HljRVIa6ZbjxJrp+E7qDAe8OWDXKtAJ8Rv0iew1EQkH9uBEM1UbmrgRaYz9IqbGUvHEyTtxc8DONMqBIAAW3LKpLlXK+hVmOCKLTaWxjri9RWTInednp3+DWZRWpNDGJkJxI3UtrRSHEYPQ4kVh2R7yJjvDLz12Pvm7QLDYUY8NF3LqegwYk7gOR36jjWBSTbXJaXYeeQQyd+xdQ6hdA9TDIIT+k10YPYWx33DFZyIXyrFjnZTwB3b23V4ct+UTiqUBzL4fRNV+HPUiXQgigZM0OogSI7gTNIsw3OtML6JeVHDDc+GEsdHBu/dr8l+sCF5PJCeBRwphYKokV0RboAIcErqZC54KE/UixXMRHUR/7ftO+9hp1ItsMhc5jw7eR25ZQBXrjFSz6OHhu14UiNHC9xfPn8P/Eq2cUA7+bAiuwd8twP2+0V/HhobUKC1RwmIuFPBExfULDjuY06wsUu7qKY3UnohnMexRuEYpd7xXyQfrBS8SI6yQXyCWc6WEQdJ4K5gRic5zoUBU8DRg7V2bDn7EksNCGlhzJwlNxD3rCDhMiJLlFCbWA3HhuFQW4TBiJq3zcjoXbq5TkKMOkDURAC2gLGYnWELqQJYtR0ppB93Bgq+sXw9XSqpSjEF8rQN0FADgLJPWoYRKcBPq0dgJStapzmDVXFg/FGwOmKuHkl3c87zIRDUhxpkRU2EE7AtO4/TuhJFTTynYSY8RY6QMJb1xgbwBuc/sSDURgtTsRI7oTSXMIZcKtiAoyHlRwIQP3kdGpNKIxI39Jjx2en3aJyoFSESYJYx6feL1EJzxBGU5oi5lkyWzc72AJeBIRHfCLFkpO9edWGB93UF4wr7OswVfwoqymw5Yb2Daa6XsyMPyVro5dXbpa/2JKl3pIa15LxKqzKODd52Y+G6VRHrRfX+m+9CmDzBHB13tPmD8h952SwDC7frylDRHqo/LEHQnp9fJGfv+vpRGpDBBj+3uAeuZatw2oDfpMihIGpNZmwZMwAo31mY5DtuhQzm5mYqIiHilaMAmKa0tRUqaNsyrISeBmIDGKm3VVVo1r5UrAVLq+1JYZz+WzjrnczNSneUdaz0U7tws/a6Bm8YasXWjbBty+2ggHnrRFotFG6gkUeuau6lvuD25PTbPR4ltfQpIbXO9GAepMi7lL1ZcrQIKFLRS1LVuc7249DWuT9YJZ3X2W9HMjxz2oRcB0mDGbUzItFtCnRwHKqnwOCXNjVTM6CAqS5l27bylyTZLva5OcVP1Z5I7npUCqBXVhJaApN2xISepxfXlqT9TVW3dspBwql6yElgdBYzXsoOpYICGA9RpOtSHFQaQ6fZS1SNeop67kZMQlx/cZ8U0QQF7cqapFOknYpoGoIFpGkUbqDdopJuYpjn7rZnmRwz7EUzTOpA8FdO0Ov0VMU2F+CdkmrrPimmaeviTM05LyX8i5lkBODDQSvEGav5Lo9YmRlrFyNbM9BEgfARTrR2knoqx1jr+5TFXLyIgwcg15mlqhLXd8/IfiYS9wj0JcyQbVHWc3YaJO0fekgtbFPCE3N3uF/v0xLQ8I1uP7xZUZCXOpx1Gph2377h9x+3/itze29kjdvaIp7dH7M5Ru3PUL0H4/3LPUTvz3M489y/NIZ/cPPcL5ZDdfdsv8b5ty5YwU1+PG8OX8FvcF9IIO+ZufcKv6Nuhq5QsmQu2d311tE9uB5VrjO/FewQRCzPrgHgW0s5F0x+hsXH2RoozJRbUCTgXOQ1kFhz10rgph6B1H0DoEkZd8u3kmBlRGGFREgRgn1lWKvl9CbIvZm9hHo85gfRQ+gCNt3qS/kQkmhraM8u+L4HRKqeUAzZ3rjgYDP7Q8KmISRyFhnEpx6XJvvTOeTL9chvpG/w9OlhXsXfh63d7ML49GAwWi0WszTJOdD5IdWIHt+jCM0i0SkTh7CA06aNnRq5Tke038cfZ3rzMudqn1ZUKvJriNYHiPRI6CeqIvhFBcTYXWYF0YsrEsakU6Cdh2ExPyumUZzoudLE9CTS82lCypamEcXl20QJwDaTKFa41WVuIBA6LrO6W4ZBrE0aHNXT98TwHHmiXfPFGWAtOkq1uwcEnbnxEYb7Q5tayhUB2cXN0Yeux4Z9P6bA5XPDZTJjG/uXZnCb9M6Gb6GUq0fNqjfXqj/X8Gy4yngMbfdAmv4JslnOXzIVt+a6sQbIq0+j3mviG/hp+LwJ2NLcQQrFUTtHVxuGgFgBsEFM8UpUXZYNcoL8LXz5SWqbJ6tfzk+MjcIB0xeqXq/Ori5HKtL4ti7EViRFutcopfhyp4LW5+v2tmBx6b06ditWvRzoV8JlAvxXLLshvxXKkgjvY6ncqHinL82z14/DwzelIkVd0J3DH+MnDVy/yGB0cVyvXtPIaPo9UJtVtpfyu1g5a0qlUt+zRj7JiY56tERaMIdLgWQW/GDpKidmS7bW01v2YeYcx8BIjnzvp5l76N11piSuZdCDrY1qYH5wHrFRDBQqUBkYJmSbAeNoVUS9qEUvUiwJdROChhl34lSYBBYsHfok8z6Je1FiqqMm5tCDQexPlvsv69zY62I5FdizyKVkEDpyoQHbvddf07RPtdXfC2M5j0l/oA/lq2oajJpb6Q3CNAAhhENMyI/UZvd6D0klqBCPH3xZkUrnffVFDJZUTM2HwbLFJ6w+6XAOhMI3tVJ8say0ZObGSEzgu7YpVuwrJqAITuvQUce+EUTwbdynqr/zHk2NcPcV0QZobC80adoqV+IfgB+00kuhItUIgINpD1b3YpXUix2MK2h2gbnMIDOKBeaJ6MlI8MdoSSnyXUnRfs2w4f0jbgrk+e9Qc7/39Gz7pJ8eIb+AlONRjbESKmmCrWFuhPBKEsqURlk1LVxoBbJUX3MmJzKA/aAkYzeU//F2VNqAJOSMnJdxKWKehdYgjONLJrdE8mR//Kd7mKJILx8GbfMzTXHYwyVmZZZ9IJ8a/pWVn16encNPUByf9Msvg7+jAmVJsZhKo943Vqh65NZminGQy+RefjTYzrvyye9ZrLecXm0eotvowAkz8+vrkmAwm3jTpb/a6jlZBfB+GKrWzPjCUqy8dRYeUQSsLdtCMbmgdBNrnsIkR/HY8y7i146k24+bUn2zeP+dxa20SnUbZn2+PBKts5/nsTnZGxrRNY9ScKj9izwqEF4SlJ661YyBoqDoHUinARgIrjAPOOrfxSywP0hoCnM6EA55l1KK9wUG9uc7xUjyGsBc2WdK+k5eZk33fpgAtwDphfs8QCognPB8OKXIUgyhDzVQUmV5CyAwcNkXZT4Ryhmfs1fUR/TVS3EreV9q4ueDWsUMr+Rn8esVBHyxtH4uvh9XvhcDfbwX8FiV7dU2dYFOowa6HIzXL9IRn7Cv8X+McUgMR9aL22FEv8sPRXzAQtCx9TSyNehF1vdXh4Wec8kMI3urUTIb4qd7IazUEwwzps7daVsoRxv4Gxai1+TvDpetWIDwQnZcqNAzYnj0YjRuWKkhwMRdGdA/otcoqlA/iGgFWo3PUPojBDxgM3gWa467DoDKE4g4NB6vXUYx0WwPGXYySVC5bMqWZmE5FAsGOFOnFsDeK7hop2So98b8a5FkVhJpbkdkHDBWmPfbqlxeo3aKwsVFcgYlcQihXTpHk32dxVT4tVUKKbVtNbpiycL06jFe0jg1TmuqgK3bV1H1ByPtIVtq2eizXqZwuSedIRSbAHI9NAQ8+8K+/EvlHnaqidKu3QZ7OQTedwbbu1hgjFVOpRIq939QUfhN3nFVoij/7OW/FZalLsflLVeuDVZvKnWqyrC5K2oF5j4/kz0eNpa9BDkN+kEn+Ld3j4BnCmSU6Ovn6wG4UlRgdRC+ef/5F//nn/eefX7347cGL/zn479/F/+9/Xvz/j7qgoQvobY4YwIvlNggaYkU6yMFJSdwnQqTs89/BOcrwBAKF4YwTwkLJtJFLClYNdzrDP596El4DZp1wN8DwQ5TchfkMNjTf6GnRX2lnmz3/sAqIbT8sm2r9RyTQROebuUV0nXwrPzqfkyCMgWkQMogdXrIJmN6rPhqzbanjE60zwVVzvJ9IFnu1dR1hqcgk2qsoxLipNeVcwhZqc/R1rNcvfNhSB66Rcof6lCf/R/TiWgz8GM24y32z1opaykm1R31XD15ZLpoHYdXMflLdVnaYhsivspNHTvDTFhfQVQqGrRnCe2J2K1yX9LGhcflgcXIAwBM9t8Gb06tSjfliiHnjNItpMKbaLLhJ28kVaNsQ1W3y9eXpM4jldnPIi0G3yY348E5CpewjnT4Ll/jpSq/GyQe4q6boXvPByt/KpTjWJcXUewojIm6VXljmFpoqWMzAgR5OgAhMkIFXymB2QQmBkiHRWSYSBx63kE7Fh+yjzhF8cEt/q69N3nBZhp4hc4gtk0RYe8BWvHrXrvjrMb3oZb7ptATfoiptic/ukyKg8UgdQ0IR1Ims40sGnERkaUSBO2i2ZMlcJLdSzYLNEU3EIN9YWrU24k4YxyY8ucW0IzyDTCcKEhNQdgeCEuHwGGCUy2EUFZmAvCiUl4Q+FXPoWZX5RJhRtE9oBXKFhYq9lqks+EeNC77MNO/amkOVC6rRtLPCfQn1imS/jk+n2VzrW4vLhKKPgbjJYA26JMCGC9vA3HgbAdwkpJsLg45IvJA3QBc33oGmpVLiVa+sXT6wh07q7ore8hkdhGnb9b6+enPKXmuTk0acVLUAMrQV4AJNdEjeBHURAz4jzY/z/K7pGtHPGyRPLVEk3fyhUfJyFL1/z2LfwcPDKPI71ctRVGjrRtGXN53YyMlwSA6D3VY2zFty3yGqASe+/TNSh8W9W7nvKK3TufwHHIzDUJ2XBSu2rg0XII39B21zPwgXI5DeGumcoLw7uTASKUvNMmnn3WeyjdRZ9QvkBYecqWYnaqpHijIivYJ/K0HEhvT/hr4ALeAn1INt1lfY5iy77WCdezuiyg/yiFJRyiuouK5BtCtYbzcHXWgNT28oDYts0K3PzEIi7OJ8eLXfhXal0xVKXLHDw3fGTWMXIv5ARhVB6aOsWbJyDL0+YYCNO56huQ24tEq+gu5ocFXst26u2M0fZD778oY5PsN9iIrwNOyH+PIG02TxzGp2Y3UuWJFBAhfA8c26fxR3/trlB/Ow8HXumxsx7SZFuPt6ZhlUYHupgPRwqGHs48beNvLIbc9nh+u3VZtWatzNJbBIKI1bmgJeFKcgJ9DfJiTk4SyXlElsym6gQgyfb0CGjhSkQjMy50aCu6/fiXhG/q/N2y6UwueFUOD4+9v4OdxN+4OWNxNIx5xI5sr7DnuDhrRsFPFRFI9QdDGgbOBpWOoT+HekZD5jJzmfwc0gO1TJHBkOp8uG+L+RSuUdO5Z30gegVAarrZj6yQZ+qHh0J8B3Any1CxQjoVaPeqyZuHGwI1I7rETWqsJfCzOfmY9jA+TuTsJI5d36SgSqhbyADtM3glSvzOlALsYbaRcynQnnFXk/JTADan0bTlDH52/YgN1JsehwToXbwS45hx8gu9tq/KMRKhUGz2feueP4/E0nlYFC/Jjf6XqDNhJAnyYhyAvA5q1Y9sl2XnBpQkSiEah+1345qUdecCNYspwvW9cRNwBZP47jm8Z6PcK2P8ce8Km3gO13AIL8U20DQP8/7UbQJT06eT006eJ2xis6C0zaTUD5rENpEZAjdZ0uvsbyyq0HZrWN29NOVSFClfnsU1EpLONPra5Y0+FrcxUIA64VdWkSsa06u5BpV7bGt1D8wSS3wkMAqt81aZheoPENrIW4+IBdFAHbvIkirruM7kXpPmQUXDLlnYfbh5TSaSBVuCHccGnQqFF3XScphr7BlwGNP23IDhtNX8F3oOHHKl2JbKRK81iVa5ONlL9f7leuyJvrH1HV2jlZicU27c7EouHQrMi83Ef34s2NzpWAKwdwYwUnBPA2zEWVjvmxWfm6b2tf79WbBifgXzLMr84fyLExrQhTmNQQo5/GCjDbeWvsFvUpFxXVYgtXN10OKCIEnEGHzywLVf1ltzcng2kC7cYNgdG4Ocv4RGS7s+DuLIgrkvP7TKhZ1/74ht+f4ic8RYRcxE36y/m9zMucUQ9bOaqHvNmdu7vv1hvTGNTsXLhfk+aGWtKn0t1QOfiptTetkkwmt+trc66O4EOLnP7O77jvjx4fqI/b4l4k6JKu8dWJ5Lb28q8WBsUtHW1DhE94uMEITLNz4F+KCIN7lrHB5QbWXtzxbG/fA0BxMP5JAGakvUVhFzq4MhLds8HHSfC0kz49BnzVjYgIXTXxwat5MOc//zBeQtSAqzosLD1uAQn9aZ0qJ4f66nKyhGvqnh/AN7YhZXkVAgD74bdi2c6org3L9EwCtrVZBpgvm1VCoZ+m7arUan0KHW5shl+xvg/G6q7e/LhWu7n3nijpHm29WrnZ26MT7ajTbBuyn2zTR1fdBoNvQD1lMWohjoqa01svWZ1wq8Z6/4+BuI3M2dHNT0w3KJm6r/jP1Slc7P8IyQz9faRgxqE/Qi5D++3EclbX3ISDJxDKiJKdTP634q2dTN7RzY+VySiANqXihAOHSMkh17ZtarXfYwkXU9kSxCk6GJGPJsScg889OmDewDLfhCQ3dDTq1Y/czf2bX9AReWegSQFcdCGTJHjfDVKji1QvFDMcfa/wWTJw/BKij84ceIogcx+Nwyc4zEiFcUIKIgrpw8F4w0eCGvfgMT1yG0QgIOUOOMShx2Q4e2WCDl7XJ/46LNXo5A1ZAuBpKuke8aW/bGV3oUfsaJLoPE9XbVNy8Qio1lZ0ITdtIhdWrMpI5o95nNmEZ9xQY/Rf2yMG7HnHvB5QFPMmmn14Kk/yTP4DVl2YCXcybzjXUUx49zKiJ+XKOhYck5nQLDjtoa3VXL8ZfcQ/nCZHTq/grgguluUkB7tLGshRWh+zjQqBTG7xNTQ6cT86twZ2PUbJHR7pAZ0+R6oTqQTVKlZZA6nxBv/qR20kYEtYMaSfF4FrVxPNFNxB7Pjjlg1faYPnbgBu3RBjbn3UIa5ixZqhSbehb7N5a9XQ4s1cyIHtCWP2DTQLbLCdttN6EOY7qpyRB6pCF9iJvu+ocuQ/jdRcpqlYNZtCla/xQ/dNAnzfaGymaWRgRANi7fg6xA8jNSmd011j/wk/jBQ4BaNNONMJ7xrnmDu0Bp/Cd6q/oVaXzRu+XV+eNPQJb9JrGvIRmWDk9yiDSydEDTRrXQbQfKNeRPOK0DWhAb8v8NcGW1uKdkTyiyCSx2N5ApdjlXgtyH1VIKJd1hNA4xZi9RrzQ6QlxbICVOv3Ddwu1YZbXn/qxBohz9q6eMN0HNrIWVeaiUY3lLaDKrJCZzJZdonfj3AkQOO26cy/V8PxzLKqHgQZzP8VDdu/FNcZT1Q/tWVbQX7ErqWBhxlBXTwaXsC5/5BhTXgxGO0I8AwnZr20qPjKHI77gh4UPqLHP9kwWDYukET9S9JeqZ3zO1F1UAdSg6+xnOIwYYh23wAOkrwUtoIGOpEuZtA/XJGht3Iy19pWY2Br0PRpHjjaf3QrLVNhjDCerx7jw1D1ER7c6PfhuyC3jw+7yvNN35y8ebUiSzYE3pFHB4mntQm2xU6T9SvJ6b2qFALa6QJC5NXpW+WhRX93bwPCiJvaGNd5rxpuSH84z/O/n28U4OZTySHE+0/uzN252Lv7+3/D+/uVLnzrzX6d0GprrzCyyGzwPFt/HKke8NH3kXZ+ab9yF6adX9qvcFF3fmm7fW3nl7bzS9v5pe380nZ+abu77J0PxI5udn5pO7+0nUz+hfPWTibv6Gbnl7bzS9v5pe380nZ+aTuXo51f2o5Idn5p8Kbyzldi5yuxu1P697lT+vl8JdaEzS4L1i4L1i4L1tNlwdqlxt2lxt2lxt2pCL+W1Li7WJldrMwuVmYXK7OLlXn6WJldwvFdwvFdwvFfX8LxpjrWqYhxlkmLxpWGOkbvztyApvdyFE21HkU3SLdwULT7+ELWzOiyWKesr6CY2UIkQJdBAmFl32116wA+9EC/Cbzssl/TH5uITMNLWU7HeG/Ly8yxY/o/9t+4uggXFb5cyzRBMjs5PtJKiaRqYPRUZoJd0P99KcyHnUp1639j5AAEBvjfTruCXZ1fXYT6Wt+WxdiKxAjHTvGX/1TFDwR/ggakt2LJvFuBL605dzyVxjp2UhW8ht8BHl64ZM7ZEf3fl1qeZ2x4+ObU/04FvEZLox/j3zUATUInDLZvpwBhJJMBLVEvApTAJkVhJoAAKGzOG8wZdViLnx9uW+05QS8ENxxueI7XVzWoMDj88WKcaAXEuBUX7sjh48hh94bZ7pz/cW+YdT75Ki3L0UovVZKVKSiAGLmEr/tp9D9qPupZPfhMriew449UUJBqZ6PrE7uuMO4ionYk2zBNVeoNOyPd9Y1wHMf3xNaZGWAj5hoK8Ke77w0PVNBzML0IN0gySPR+fn3Un0JnXn1oPMfX2Du8KGjol4D+tmYJD4s+I53ukUdNO8QNPly4Bpd/BrR6SDE8gPgonVRPlW6gN5qruC/Amx1eWG6+ttx+AxnfQu1FjYea6eXfBg5ew8GnhYPgRsrgU0fA+NqhM7wTi/UfetEXz59X4k2hGOFFkYHSLLUa/N3Sw6jkh7fBfuG4SsEZE15fRg88OIMRbxKXrAtZYvy17pCVmRG2AJVtrVUqJuVsvdUxFNfvK2Ot5nZQBySUtsTTH1is+B2X6ACDewg8QOw0+u4rdHWJW6+/46Pj3PEJPPXLU1448PrnlpVYGx8Nlvgisgh+dF0SdcO0IZY/vM9JeAvBjm0Imq9G+2vIBK0WMJ8JGPhKlW4cd9wadB2J1a8aldPSrO2tmmwuirvSiHCFiQO0AT5HEqSD+ckx+/zFb7/4b5ZqYRFacS9tJ4q6DBInx2Qo8GYJQtHJcTxSU4FgjJV243pBXxnzmj6caXcYikfq+1I7Phb3iRAQXfHKmD9DyStf0BCjnf1Gvajdw1Zy9GlBrPXrDs9Qvyu3XhonZPk2G98XL+0YT2QdTzGna4+MU5fUjOEZZu+L51/02BfPfwv/fN5jcRzvt6gBvm91v71J0s6EAo0FBYQ3SK9JXOKuhrishBHJlctarvygmMS+vqJByXJHh9udqNyJyp2o3InKnajcICoBMD6zSBkGR8e1v+9rs+wb7kQmc+n6kzK5FTDBW8Odtv2inGQy6ecilWWOtAHYGiJOLKY0yjg8yh2h53U4y/izevRHbZYDCnsBtZku4Q4imRfaOPZ+pBhj7LUH57CQPSo50moqZ2UI5Hqg4JNnjd6e/R7uWMCA6IBW6trsJVNi0e5hb//3oS4v5IkCaZ8IX7Mx+l6rp30cIhOO3Q+FhRPTlb4V6oAR2f2eDQYg0Pw3hh+DLDnxZwVWCAMkAwYGjAsKpwI4IsVsL5hB9sH9igyccI8agpb260m+98TaQxnOHthLxhdctmYUJ0ZwJ87wOfdh4zyxR2htzWOk9n+PF4B+/b7SjXWjF+GbS1bw5BYYM+cQ5AenTVzCvZEauVEwwowi+jnNqz+1pb90IRQvJK0eG0Uz6eblJE50PqhXtT/TUBunDUG3ONrePhDKyLWgZwcv2ShqFY09p44iNhj4RWL/ZE+3RgDVyLWp7eAla80sPhOLFdqDRryQRzTzrgaHFyf0dYUAoSUoEj1meiCxoHHVU1wR7sVJfLRp4YPZ6088uYWDvUr39vfjvzbxttfC4n78imKkCXA5xYH/4yVTMqN1GLlp7uLXhZHKTfe0jYcuFcb02MjrPmRa41kGGL3ZBsybmwP2m7vRSI0inOj+D4zzuswy9vXV1UWlZzXaU+sH+GcwqCqQCLnZCMEBa/6Exuujawh6HEWX7S63mmATPmGL/ZF6aDLfxdLN0cQRGBCE8ka5qc1yTB9HCmGoC+JcpyKzcSDiMRAx8+3aM1xtaYR1oeZhIWG7Lkj+Ys0CUREq0C/giM/gSkaqwD1zbfH2OHANaqZetqF6OneusAeDQZHxJVFkXBgNe5iNtVnyQlqQCtDxUIi2cI+LJcV71peXWcZsWQBMIl3ZCQpueC6cMDZGKdraJBoTb/MriUqcBoiYbcENYgvgfgVeEowHmzPpjxij6nceL4FgWw/riHUaQB0GPl+RCRgcWkhf7YCg/YwR4W0ehFtLVaGtrHfAxojNjbAeYd9vHWNLQmLsUIa+ZM9WioL4fcY+A+H75JIXoHBm6WfcmnXL1oYEQhzIDovC1vVhUpU4eNnChN85x7TvjVvcs7cy0Zcrv/frEZAp9kb+oONH0tOmjtH/8pGhDlBENDukHpuQ+68C2ZNVXAp0IQ7WQakrtMTy1hCx31gEiv2GiX30K7jv2/S2n+oEz7MNtQ/O2HJGh6roINqojOzj7bHhOemPlGmsvZev6firuu1H0lbU1LoxCx/MzAhXGnVFAw9X7LEzvTrBzZuuu29so/+Ssy1oQ+pc0m4u2TDPNq+0ZvozT3Ov+SPO0308I4l7J5SlTA/v3kfg4XCw6ZBUxXV2H5Zgfw/tK5ZpxILuWGfHOr8e1oEG/oIOTB3kbgQhVtHAimzat8KAS8ogDDzgBdyqQbEwNHG4bDuoNK73Xs8a26ycPXRqXQNkJyPB7hS8WaomZAjy1uGo1t/WcPc3cFkGw++ZcAttbsE5CO1+0Evt7IzGUchvQcbDd80WR1pZnYnv9gLwCRUAsLGdDwLwA58bdzATrm8dB60Vs14A9kLWrCEYqmk+E25lUhmvMYwBSypagPGA6CaCG8qWVdekorWq5HyF/gyZXoTk0XNt5D9QxTzyRrRW4XVraebL1PA4FbkOE6ROB/Av3mnrgiagp9NMKrqnx9IqGwbpI94cDFRpxNQIO2dI7Zbt8UxySqVz43sZc/QguAF+aRd9eP/QRSEUmGqjS6oE2jP5jDHvNAZGXxIzYD2DP7bEA3Fs0xhISH/A9E+HCDN1vH4d0fDVFyotNJy6wAFfCcpi0yI80O5vxbImvMVigbAAd8CGA5QIGqAdFMJY0Kb7hLI+Ka8xLtcPkYxZvtXm1hY8EYeF/FZ0+es/DjdbhA76mbgT2U8/DQy3mepwU8QT3HYpEcdB5A+Rf6R1jEIC3AggG9K3dUfxz9iJckanZUIH5WOdlHBvQodMPKlmGSOtAA/CPM2l8mml7gQKncOLExuzw/YHKCQ/KZWhBzlNVqT+oMghsEKm7MIjgxFJEbHG7IJGxF7ATT3X1gU/banYxOiFpWPxSH32GRsef2vBYV1alvoZMJroxGf6o54qy78XgY0VpKRK1YCNiymL3VcpsaYanMSBH8H0UYJPyQGA8U926n/7A8w/2bFeYCpA6ID9mP+gi+aCPNF//wRo+63/2GrBh//3BF10dwvQHnPjWoh5V5STOBV3Ncf5goE39NpBbRrY78Ttu8tXh8dvXtU9rJh0bXo7mGR6Msi5dcJ4E6/1/x+k3LgBdQEaRBO38dmrq/ZQqpwJF2sza0uIqriG+twsYzKcDPafElrtlFiDF6F9lcl7aZpDzcV9XOT1UPR7W8w+AbQCQeqE9iu9OlTd9cbhKuv8J6GEmV6nAw8tJOFsD5XzO6HalGAFN8k8rr4MuHFyyhM3sHPYRAa1MXX/46GFeKoNdNtIGRrotsj/btuoRboNxYEmBo2rrf2nxC3GdiJITZhXod17C5vKVLhkvv9jwe775p8EeOq8NQUGc7j4+mKFFAkyaVekRau4xYkrWP9ooIt50UHOiHGy8regXRZyBVBfEo4MDeIdrHPfx0OLIHVKistysmwPZcrJciZy24a4WTqAP1r89qTQwlAbeO+ytCs7XAL2GhtL3TiVhSL/10ZInwha273DYbRNIuAa/6A67h8WPJkL9iJ+7tO81ccM4D2OnxHHvq0dnJ4cvTobvuq/iJ/Hc5dn5HNucns+HdJpG07fTtuGE0JQOeHkLIwlPTYDZKB+W2jrcq4acG1jY189Ujd8sShGoDoQSCWdhNEww2XDBIFd1hcidQ7lXE8gYIeCW2yP2Rx0mau/2B5q1FYzDLiEU3oONOBzNFcqMkz4WzTPrRhISCNtAocBCGBlT+nKBm8YXzx/zs6/pZBOTTISTmHo/ANqbHsWYF9nNxssHnje/l/49+Uf4N+xTL+8wZ4B+jfXwyt2dn7VcYySyqOlb2Fqe0PKhXoB2jLgv8cuBU/cN8MeO1SzMuPmm+E+g3SlZF7xzXA3HWLJSEFj20PneWh38fVFj32lQSkn35dwSmANXzob+2zga+C5uQCvskZVyjya81sxUnAMvCszJUzwNIPVMVK4JdipjoaXryEMkSe3NqQfFyqFgbSiiPL29V17eApAIWMV4+DC49175NSbumjZ55hXFRL1GnbYjEEcqUNrS4NXYqd4ON07PDzdp8y5EOmqrcVUtlVeX29U8155cFCb86KAEI5pqwKOWQWp/Vf12NBIJUZgHZ5ZtkfBkgufFNaCG4hU7PDw9MU+RuqvzgJPhYeHp5/H7GTqsUGhuklSGuAMexsytBsIX2NgioQ+ka6puwToHNQkaGdYMucKIkfmq3eusCAndOBLON1nAf3DeD0svSHPOZneBKMjOi1VF2ATnS4RRxPBtIIO8MR3E+xd48Sa6fhO6gwHvDlg17VHIvIbHhyBvSYi4cAenGimakMTN5jC9iaYTaWiSPWbA3amUQ4EAbBAw1KpUtavMMMRWQzD8HwAd5PIkDvPz07/VsVzS8VsIhQ3UtfSiuy7QWjxorBsD3nTi8seI59CqHTUY8OFnLoeqmLe4wxGfqONaPkreuQRyNyR7cQLNXicqpbO/xkiG9kbrviMEse2TsHf7cVxWz6hWBrA7PtBVO03vOzgCnuAyZ9hg8Cd6b037b6Lmh2hNZfaQ/hIIcG/DC7SoeL79+B3em2yhwco/r4UZhkdvPuuNuDCrwfIlMVTsGTCY3nVG1tokn50k/lY83fnZOn25q9933U/XDmEa5/GFQ8YYIrmldCaC3LLQP7Vq6vo4eH/AJv5wbo= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory +Kratos Session Token for this endpoint to respond with HTTP 200 OK. + +To fetch an existing settings flow call `/self-service/settings/flows?flow=`. + +You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, +PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF +attacks. + +Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level +(AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result +in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the +configuration. + +In the case of an error, the `error.id` of the JSON response body can be one of: + +`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was +found - sign in a user first. + +This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). + +More information can be found at +[Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-native-verification-flow.ParamsDetails.json b/docs/reference/openapi/create-native-verification-flow.ParamsDetails.json new file mode 100644 index 0000000000..fba9f379d4 --- /dev/null +++ b/docs/reference/openapi/create-native-verification-flow.ParamsDetails.json @@ -0,0 +1,10 @@ +{ + "parameters": [ + { + "description": "A URL contained in the return_to key of the verification flow.\nThis piece of data has no effect on the actual logic of the flow and is purely informational.", + "in": "query", + "name": "return_to", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-native-verification-flow.RequestSchema.json b/docs/reference/openapi/create-native-verification-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/create-native-verification-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/create-native-verification-flow.StatusCodes.json b/docs/reference/openapi/create-native-verification-flow.StatusCodes.json new file mode 100644 index 0000000000..4a09e99929 --- /dev/null +++ b/docs/reference/openapi/create-native-verification-flow.StatusCodes.json @@ -0,0 +1,1065 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Used to verify an out-of-band communication\nchannel such as an email address or a phone number.\n\nFor more information head over to: https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation", + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.", + "type": "string" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,\na new request has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the request's unique ID. When performing the verification flow, this\nrepresents the id in the verify ui's query parameter: http://?request=\n\ntype: string\nformat: uuid", + "format": "uuid", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the request occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. verify your email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the verification challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the verification flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": ["id", "type", "ui", "state"], + "title": "A Verification Flow", + "type": "object" + } + } + }, + "description": "verificationFlow" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-native-verification-flow.api.mdx b/docs/reference/openapi/create-native-verification-flow.api.mdx new file mode 100644 index 0000000000..99bfb410db --- /dev/null +++ b/docs/reference/openapi/create-native-verification-flow.api.mdx @@ -0,0 +1,48 @@ +--- +id: create-native-verification-flow +title: "Create Verification Flow for Native Apps" +description: "This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on." +sidebar_label: "Create Verification Flow for Native Apps" +hide_title: true +hide_table_of_contents: true +api: eJztPWFz4zauf4Wnzk3iGVvutX3vg9vdu1yS7abNJnlx0k5n1UloCbZZS6RKUnF82/z3NwApWbLlNNvN9no95YNjSyQIggAIAiD5LkjAxFrkVigZjIKruTAMZJIrIS0TUljBLRjG2R1oMRUxx4JsmqolmyrNDi5OWJwKkNYwU8Rzxg3L1ESkwBK4EzGYPjMZ15ZdfWf6jMuEGcWUDCMZySvFpmCxkmRwL4wVctbSTszTlN0ODaTTgQGNUIf1UkMsZf6Ony++ws8bkby8pRZ+UAV7cz2+YmfnV6wwwOxG/zzyAyMSYPtjIWcpsAs+A3aQ56bPLoHH9ptxnx3IWZFy/c24x6TSDPEA7at9w+84G9OTSGJl02dnKgGsd/H6os++VimXsz4Lw7DHJlotDWjG8zz1PTAhuzbY+S307BwMNIqypUhTlvEFRHKlCnZXpBI0n6TArMJx4lqAXTE1ZYfjy1eMW8vjhXEEb4Anwpyfnf7AJoDESbBBE4PkWqj1cEpuxR2Uo8rz3LB9Igs7ozd9dj75CWIqdNhn46WY2j5DmrgOU8tvlAYm5FTpzI1szCU2O1WFTBi37O25XrHjjIuUmORiriSw7+q8cKTiIgNp6deP+3NrczMaDpfLZaj0KoxVNkxUbIYLza0yTXYhDnFMsxoAtjLgcawKaQccMSeYvTDoByoHTb9OkmAUxBq4BdfPOjKvUrUM+kHONc/AgjbB6O27DVE6YNeXpyxW0nIhHXHtHJgGW2h5YxVbAI0SPtxi+tAPVi4gBiyVcMvZHIdDMZhOIbZMOYA8tgVPWapmIi7hkdwgHRFEoSFd1YnPU+ypQCR/LkCvgn4geQbBKKiQC/qBieeQ8WD0LrCrHF8aq4WcBQ8PP/YDDSZX0oDB9599+in+w66CtPi1xrDDnwyS410NXpNO18h5VjkarFAXqMIO1HQwwQ7EKssK6WFFMp5zKSGtmBM1h2OaJNFgDFOacZYT98gim4Am9nulNMs2WXAOPGHqDjSzasSen5+QQTTykxWOTvQKtilwEDs5ElNmwPZLnjGeX2bCWMeTLAM7Vwmzc25xaCeASgNFN2Qn9MRp7DRdRVIqi+BwqDcGsB/AfS40mBtut7E5du8OCB5iYEUGbP/66rDHlnMoufjnAoxlHlDIThzjFajZjEUVtRRmDqY2ssSsbpj6keRMwrKCg5xtFWqEcs5JEHE3WMEoSLiFASLS1huRbPfi5IhpyDUYmppqKO8ZVkjxcwHs5Chk32OHctDYkFPALcLYJ70cyQ2AopJp38FC7BlGEsUqzeAYazQcfoUM5PknJP4J6w2FhbgpdPry7x7NF1+J5CWyLvZ2xFxnI8+9I1YUIqnTx//eJo0xBSSt43xCr542zCqOC63fZ0x8TezTdtOX7iXqR9+451tSmcTdS27K1iFhU60yhjPEtySMxO1+BkHuj6RVaI4suU6as8ym9r2+PN0zLOd2jprCjRXaMXDPszyFVmFZK8WWjuCrK7UpsiXea2V/fXnaCtxYbltUwhgfb3IwlXUqXlTUGUWkFpUycOPUw4hxs1hLo1XMvWa81B/7EM7CkmtXqtBOifYiiY3d0I8RQXDKFaVzAiAZvkaAJfBI5twYSG7iOU9TkDMYNfgGR9EUcQzGTAs3s29JWFWVSjt4IZLGai4NWmc3OV+lirdI+VVZ5MKVQHYq/HyCkNy0SdzTKtlYbq7UwhBqrrMWsjxFo3c9XIoMHMKJHmyhUU65+JoYE4Sdg0b+vOW5uEVmu/WG3y3xgbApQr7CCl4GKgitjFKI7XYPPXvrOqdw9vrqzSl7pXQWMsQsrkohZkulF2wp7JxNlJ2z11dXF1SWKPDN+PysHDzTOn+5uXx7/lKSmbkq0qQyJrnvFcF2JVC6b7+qPXkRBe/esdADeHiIAs+iL6IgV8ZGwcvbVmpkYAwa2oiMsJDRlya2ZI7ctyg+pImvv2eYL4YWOCCPku6LC2NVJv6FU0LZVNjGD27qqVSikPZ/v1iXE9LCDHRtvE+OiIt+DS/mUPpeC2tBovLiGWhBnCVnqTDzVqrs5s4KLrJXJFFHshM5VZEErZVmx/gZSS+rbOz+B/0AZJEFo7cB1sCfWA6NQ1/gx00s+sH9YKYGWG2AaBAVntbYg582hIaEmqQZDUnlG/lxcwDWdC3EFRasaBBwrflqq4BxvIMctk2nN045ihrfNvTlxfn4qtdGdqmSDU5sAsa1oGFc1xS6kw8SVEghI8FVGhsWulxxXZ8wpMYdT/F1iFJazlPOflIJlLMgl+z2K5HNXt4yy2d9MoPpkcwLWzbx8pZNCst4ahS7NSoDlqccJ0a4tyRmG+JurRaTwrpficAuZUJyqzQ+yHieIwGw5Lb0zTVM21kxFXKxZxgWYPsJ4KrfLb9ojsTZrDJytHiquXdQGnUiAWnFVDipaxupm3YpwUEibdyYdIUhMu8ZkhxTmtmcZYJYWU3ZLRYI8fUt6tBI4ppLi4xrka6q2Yin5MpQWc6tmIhU2JXTwuc5SPSifB5+GjJ2Il2jxuoitkxYZiGe4/onTVeMp0u+MohAFPAoCCNSXQw5G2Uah/oEPyMpshk7yfgMkFEO0D5AgaPusjH9i2Qi7tiRuBPGrVVKSedPEupna/ihktFOgXcKfBMEqZGyVN9BXAvxj+v6jtUOKpW1aTuvlRnKLJeMUwWS7lbGSMTd9kiUXMsMxM4bh1qdZBxXEcgu2q3y2VIkM6DGuWW+S4yTtVkuRo7O37AhuxOw3Fa+ccpNy1RywOgFumsc5LXRpUEmoGmp4y30o/M3rVyGRjGp7SQRzh900Wh7u0KTCGhTOyXIc6TmAlaDO54WwHIutO8yEsYZ8+WCIfHE865IWLGMrypzEel3i5gNwjC8rY3XI2L775gDPvYU8PQZwGH+saYB5P/fdyJo0x6tsl5WaZN2xis+K4W0nYGyWYvRAmI2b1Hsr+l56VwV2Ku6I2THpNGZKp5RRTb7WFyKw/h7mytGx+1zNDHGnmFGFTqGp5qzS5HY+TbA7/Hxe7Pchgwhqn7WdM30Sx7fIVpEi/eYRQmx3ZMo0brF9YiP36cVGjJsZXuRUliFrJpCmxsNR6VeYg2a5hvnecwLG0bSOX+amB3UqlJsCnn4sUJXkEay0I8VudZpJMmbKu0AJ8il0skj5Q9d0QtfMpISlk+pdwbLdR0lnad2EOOacXelcwlXIoNDlUAk0cFHhsYSJrywc/lYr3zZ733RmogSYckQxE/0B/eDzf4jO9a6hXG4OsZYbxOZJ4l9N6jPOqhkFhuMNbfMa2Mo4yIIcM+wsiibCkidFagLQNfElKemrjAmSqXACX7KJ5B2a8FuLUgjkvF7DA20zY9v+P0pvaJVhPdxN/gv4/ciKzLmIIRPs9hcILx1dvdgvTONYcnWgfszWW5kJX0s242Mg9/belMyTkW82B6bc3mILxrs9BO/4x7eci7ieW25DfcQF+jHVZREFC8w2CKIbtXAkLp1S9vvYXKAOpQswiMc/RiD3COf+FM27kXGlBE2HHu44+l+zyNAfGEgLjQOrhZmQcquBHClxWwG6IkwFnjSyp+eAr7oTkKUoOr04FU/mPWvf50ufrlf1ch4blyuEiYJuXFi00K6IFCu1Z1IIGGTFUZ8+74BX9n4wNE6PQnnw29h1cyTUJryYZDaSq9KnC/rRcqHvpumrVCj9ikC3FmN3lJ5RGgBq/bi9Zdbpetz74kU9tHam4Xr0B7taEuZet0xWMzDM0+B0Va2JuA7SI/W3QZZ3aN697afbHa4UWIb/mMoPkXndHzzO/MNaab2MP+5PMXg/m/QzAjvAxUzNf0BehnrP00tp+uSu2jwDEqZSNLp5P8q2ep0csc3v1UnkwJqCUWRbw0XHJAwiv6Ypk9tnUVYYGAqXaE6pQQjlwkcyQSmQgIl8d7iMN+W+ZhuadRf7yxwisxFuFx2BrkUMAEYc9ZSiO0w0SpP1FIyzSn3ys4xysemGmBAyRy0inDuPtcOn1AzkSzbQY0qZEGZ9L4xXsuRcJX7uIOB1k8OCcwMnfB4QcmH5dorBbfwuj7x4bBEMUzITTH8h8m7lJe7I1/ksp7MZdyeBNdJSvN3obapS/EoSY35fS3ETerExRFzlXG2css8zkzMU65dZcpf23cC2PcJ1H3kKOZdND3c+SB4Kv6Fow56wq3I1gl2rvEdwxjJ7XHMOfrBfC+4m0Mbo7kdGaUetLOj65zLH8UU5AkwU0wy9LskJTsKwxxLk0Eg4gXgbOhW3I/2rUZdT1EG0uJsaBSuoZEPWonqsNqkKqsRNdxyl7hOPuojQV/ChiP9PC+ltpEF9YA7FawF3ZK7V/ds+EI7kmBL5LYdMXrh6OpGsRLNskq7o2+3e2vT0eLdXCSBzQ6jK8W5BXb4TrFAzclKlG8pckYvMI0W4sVE3bcUOfSvIjkXSQKbblMs8ppetEcS8P1OZ7PrRopONGTWlrdjehHJSWGtamv7n/QikpiTTT7hVMW8rZ0jbskbfIrvXfkdpdp83vju+vKkZk94l17dkU/ERCe/JxkGnYg0WK0RDHD9DfqB61dAqQk1/P0DHzZ4sqeoY5I/BJM89B/T1aWUU5GQ+CZNcX4LRhgm2FSI5Jf1DFCLQmyGMd9HW1Isl7Dajjdws5I7orx+1UklmMdnW73FWhmjtECz+TEwVI65gixXqYhXz5zzSM5tXJU+hseeYVU5TPef/yc6tv8oqTOeqX5vz7ZUMm4dGhk7c/FwfIHr/gNGJXHjB/kRltxt6qD9sYqJDJf74PaFHLo9fWxcejYuiEVDt7XWG7VzfgcVABwAZ/FgrrGYUjNlE03YiA6xvABTYYNAhA0ZwscQGWUr+w0svg2qjZa+6we19pd2o2UKWoP2cvWYHJZFH5HBnXkfHoRL+3i/UJ6v+ubkzfGGLql2W7ZldDj1tNXBptqpi36lOX1WlSREW1NAHHu15lZ5bCnf3fuAaNfN2hnXGlctI6RNFdvlRqEmQtp8LD1EdP/dk7lbB7uL3/8Xxu83QPjau/M6sdaTs8KcR2ZH5tlD5TRYnbmd7esGydUO59OWLftdXtqfPoWpy0v7Ew5ql5fWzWtdXlqXl9blpXV5aV1eWhfL7nIgOr7p8tK6vLROJ//BZavTyR3fdHlpXV5al5fW5aV1eWldylGXl9YxSZeX9tDvciW6XIkupvTfFFP69+VKbCmb7hSs7hSs7hSs5zsFqzsatzsatzsatzMR/ixH43Z7Zbq9Mt1emW6vTLdX5vn3ynQHjncHjncHjv/5Dhyvm2OthhhnqTDkXKmZY+7emVu09F5EwVSpKLglvsWFounRLVkzrYp8m7O+xsfM5BAjX5YaiAp7sFXUAXPokX9jvNmlt+Y/NoFUyRnm34QUt+VFatmR+0/wa6GLMlDhnyuRxMRmJ0eHSkqIqwpaTfEe0Qv33z/F/rBTIRf+N+0cwI0B/rdVNmdX51cXZXmlFkV+YyDWYNkp/fKvqv0DZT5BDVO8cdOnFfina8m9mQptLDupHrzC3yU+PLfxnLND998/NTxL2fjgzan/7W68da0f0fc1AnVGdxRsRqeQYE4nI1mCfoAkwUnKbTNBAuDDer/RnbHe1uL7R9NWs08IxeGNixueUfhqjSo2jl8+u4kV3f/2JCns2OHD2KG7w6xb53/YHWYtV+lSPmlGXnoh47RI0ACknUt0u5+i/KP6/ZhkOOGIuNQTd3FsaSCtk42uT8y2wdjtiOpYtuaaqswbuvp8z7A3YDm175mt9WSAnZSrGcAfL95bXlDhroPpBzRBOodE/99vj/pV6MybD7Xr+Gpzh1cFNfsSyd+0LPFi0T1n0z1yqWmLuqGLC7fw8teAVhcplhcgPson1VWlO/jN9bXAqIa7ErduMTcvgveXr29042Fr2Xi3eWH7Qz/44oOuKr9yl/DKBFMq8TpiyqPDlZSTMMfr26rSie/2TdtUqbxKfatWApNitl3rCB+vLxymUnWlvt5WUJiC1nDod+J3XFAaC80E6+u2QVLCCuLs75b0/cSV8YTjrcEJzy3m7nO8OZtA4G3Lwt/l67Ph2vTijm7jjvzylk1Ht3LLYhOD+jXKPpgYk+8B+zNBN10hWy+9JqA3jUa3iVj9WpNyWuitGVI5z4nkttBQBiKpgSbC58SGbnl9csT+9tnnX/wPSxQYwhbuhWkl0Y6ry2m5750LjkQnR2Ekp0Bo3Ehlb9YDeqz1K/fiTNmD8nEkfy6U5TdwHwPgHoljrf8Pnxz7BzVl2Ao36AdNCE/Shs+L4tpKbsnv9HNr4+ptRyxfZ+eF24W5oXVVy4XKydat2w6kq8ZoJbL/xadf9NkXn36OH3/rszAMew1uwPdPilLv0pczkGh3kILwbuUtvemkq6YmK2Xk9MrlWq/8qqokWF+7Rp3/zS1RO1XZqcpOVXaqslOVO1QlIsZnhjhDU+s09vcDpVcDzS2kIhN2MCniBWAHF5pbZQZ5MUlFPMggEUVGvIHUGhNNDB1MlHK8Wjug/OlyReJX3ME/lF4N3eYVNJddKG0UiCxX2rJ3kWSMsVcenYNc9N2TQyWnYlaU27Ee3BaSvRq0vS8xUoJuQIu8si7NXjAJyyaE/d6XZVmeixOJ2j4GX7LW+n4DUo+aSAFDVLbQ8kqNmOO4L9lweICJTiWbUmSJ+MoVvbEKIz+lZqmb97TE8do8FxCT+kG1TOpbKgbTKeocr6J4bAue0rbPuASHEEjhI4hCQ7qqKzeehmy/dJL0MDnLuT8xylpuaeqtiffOC0HfIfHAXjC+5KJBqTDWwC2c0WXv322sVfbdkJU0imTvS4oOerb4WtXYwV0XX+eEnMcLlPeM4w5AXIoSZ+xHMrJR6aGJAvdzmlVflXHfVA6S58IxBYuCmbDzYhLGKhuumWUwU1iaeo07cqm1/R7yX2RLxNnoBYuC8teNF/soYMOhH3b2C/sPGXXsaGSbcjF6wRrECs9guSElWInn4tARs63CwcWJe7shKo6QJu8z3UfdipUrSGElYhcn4eFjrFS62v7J4wU6E2Sy3+uFl35M9svB6YXHbje2Q1lMqcm/vGBSpG5QIzvNbPgq10La6b4y4dgmoHWfRd4+c048nqY4rrdPRfD2dsT+ehdFMgqom71faetVkabs9dXVRWUP1uq72g/4MRxWBZyqu30UixHbfIRAtrFQuNUyCi6boJ/c2TquYPJeJB/qkn2xsnNyrpTSjRPJTl2v9OrGvYwk4bF+EGYqgdSEdYG5IXb3dbd7uwlBg7Fl6YNcoKmRu7mDSuZElrKA+4Uy8gkGhYREHkARmytD8etSjkjcvP4k03pubW5Gw2Ge8pXjzzDXCudfEyq94rkwqHoQ8BigOTGF+crtOF2HT9OUmSJHnCDZmMVyrnkGFrQJSVM3Jrhax5sS7FQxdQOV2VPRLXUj4n2MeRqMl15vZ/vSLlk/a3p1hCZJOZ5UpobUQSn5G1qCtqfmwhcbOWw/YY4JdzfCjXFFsa5Yz961FuuT+LqFXn1qQu38gu1VP0oNv8c+Qf3+n6XcsVtWrzwJG2TcckAS1zkRZwd5btZ1kFKV3nnRIK+f8m/cjH2zJZr7FVVeVN96a8gkYfuRX/H5FtS0bmwNXv5KEyPSPXWgDmoda/8WSN5ZJfbIaDDaRmddoKH/3wsr9ldDiLG/MuhRusT9wCSLQaJiWuDX7GB0OoiZW2UGo+BRK6pHgXHNM2dUu0PUKnNka82zaev/kXk3qC9x6OBCpJrvmuvVJjkoXURtEvBx28He1+yCjpob1MzdbN3Kkrul/DE63tgmIf/sVNzffBBmSY/W1XBvQRp3xsfbdwHmtox2LayrHb3tC2y0r8r6lVap7QLutEunXf6A1Oy0y8fSLljRR6/Rg+hy8XD/YTA0kE4HBjTmaw3rXRzynKLToO9AO9ri6Q+jakHwzi8DbkxazB5aFwVD0jpaoEu3TPeqqjgfqw+8BOvlxdYg/YA5/RhTOQO7VHqB2XPkUkco690AFHfAA2Aczd/WaxwqaVQKP+6XyMfuASIbmvmwRH7oD48ezsAOjOW4qKJjYZCC5bFyY4wBuf5MuBFxFReifT70pGI6bA95ewJcu+Pk1iXdo62iLjuREn5StSxPV58rLf5FA3Po/dONh9eNoZmvEs3DBDJVdtABHeInJX2o3HVATaepkC7rgJ5Wx8U469ZHWtDA1TDVYObMqgVIw/Z5Krg7a+rWQ7nhlGJziyLZfPT+8BFEDhKjIMGlK4SLO5dUyXxWJcZTrrA4pXXglyfSwbpKNT+7I/oDnY92QDg7wNuRvtpmFpBJrtApgDtUJLhjnhqMh4vPBazWjLdcLgkXlA6cl5ETcT1hhjlog4I/cCQbEI4UPfh1ltGr75VemJzHcJCLb6FtQ8vjeLNlCWCQwh2kv383aD/aVJVBWB6TdeJOqhkF3sfxDzeOQXlCdICYjd277Z0Un7ATabVKitj5cY5UXGBI0utwdKSkKXPGE+linmRC+nPX7oCUzsHFiQnZQfMFPnSJhDKlLRaus5B4PwbHnUciYReeGMyxlGPWkF24FgkK7uPIlLHlRgYh2USrpXFem0h+8gkbH31rcEeHMCzxPWCuoxN/FKaDVAXVvAqsjaA7daxqsBbzNQS+OjNuqnAXBcojeugKTLoaIRq/sFP/2y+Hf2FHaklnZSIA9lv+EER9QJ7p7xfEdtD4Y5sP3v/vGUC0g0Vsj7i2DcK8zYtJmMDdWuL8g6EPdpjh2nPVa6Xt28vjg6M3x2sIG2ENkyyGk1RNhhk3FrQPcxj/f5hwbYcOBFoRddqGZ8dXzaZkMQMbKj1raojq8Rrrc70KnV9v2HtObJWVsIUvYXucinuh603N4T7Ms3VT7vdTKfsM2AKh1Irt12qzqTXonc1VEaqPwgkztc0HHls8pbbZVMbvQDY5wQDX8Tys3gy5tmLKYzs0c5xEhmuff+/DscUNhzv4tnambsm3efaTaZKW+LZ8XPLEsBY17j0nbWnzM6FUx3kT2/3vcVKZgo3nvd+K9sBX/yjIO+CNLjDsw8Xriw1WdJgJs6EtGo8bkrhB9Q9GOp/nLexMFHfBqAa2q1xsIOqflEuGGvMOt6Xvw7EllFo1xWUxWTWb0sVkNYPMNDGuPx3il4a8PSu22NQO2bsszMYMF6Nby4RC1VZl5SP/bSemz4StaZ/haDtaDJghM6o8Cgc5j+fAPgs/9ecgrpcZKHucXhONfV0zPD05PD4bHw8+Cz8N5zZL3aYMnZnz6dituHEFbpWp5feUJieunEEbZ8emSAyyb3NlbMZlDa+nRmw2l9W1VEe3kaZaFAgprMAW0YzddHoQ2HXcbn3YeKYmuLPN7QIzfWYytGmuvjN9sqyNYuXOZOU0Ga6VKPsNjc3tdjCuwm4f8U/Q6vjv+PniK/y8EcnLW2oBPQJvrsdX7Oz8qmXRI6RHfmAE5myN3dG+F2jbIqX67BJ4bL8Z99mBnBUp19+MewxP33XOEF+N5r4xPYkkVjZ92guC9S5eX/TZ1wpNaJcEVtr0rJZUakJ/uP0WenYOmF5ZK+oO0s34AiKJi7a7IpWgy5RLXG5oAZZ8VYfjy1e4q5bHC+O3gtfBE2HOz05/qHaGC8lMDJJrodbD6fxt5ajyPDdsn8jiearPXF4jFjrss/FSTG2f5iyf9YYtv1EaGjmTuGQq8zPx/GVaZNJZm8QkF3MlN1i5sUJ4ZP3pHOFNdiEOcUyzGtBCEhelqpB2QIcIuIByLRcQg9VDOmgaZY2E/J33lL0N6qCddFZY4naVXGAmHIbNsfC7d5ghe63Thwd8/HMBeuVu4Ksu7iKX3iNC+WG+ST/sH9E52UozF3aoe1/LSAVFOUtnYDB6++MDHkvGE/SKVfEOXCbn9fjGVg52w5X59fFV8PDw/5PkfOo= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. + +To fetch an existing verification flow call `/self-service/verification/flows?flow=`. + +You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, +PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF +attacks. + +This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). + +More information can be found at +[Ory Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation). + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-o-auth-2-client.RequestSchema.json b/docs/reference/openapi/create-o-auth-2-client.RequestSchema.json new file mode 100644 index 0000000000..524479a76b --- /dev/null +++ b/docs/reference/openapi/create-o-auth-2-client.RequestSchema.json @@ -0,0 +1,346 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + } + } + }, + "description": "OAuth 2.0 Client Request Body", + "required": true, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-o-auth-2-client.StatusCodes.json b/docs/reference/openapi/create-o-auth-2-client.StatusCodes.json new file mode 100644 index 0000000000..82775a78f6 --- /dev/null +++ b/docs/reference/openapi/create-o-auth-2-client.StatusCodes.json @@ -0,0 +1,413 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + } + } + }, + "description": "oAuth2Client" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "Bad Request Error Response" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "Default Error Response" + } + } +} diff --git a/docs/reference/openapi/create-o-auth-2-client.api.mdx b/docs/reference/openapi/create-o-auth-2-client.api.mdx new file mode 100644 index 0000000000..8968a510d3 --- /dev/null +++ b/docs/reference/openapi/create-o-auth-2-client.api.mdx @@ -0,0 +1,38 @@ +--- +id: create-o-auth-2-client +title: "Create OAuth 2.0 Client" +description: "Create a new OAuth 2.0 client. If you pass `client_secret` the secret is used, otherwise a random secret" +sidebar_label: "Create OAuth 2.0 Client" +hide_title: true +hide_table_of_contents: true +api: eJztfXl34rqy71fRZb+zTnJfIMwhOWu/dRkTyABhCEmafkTYAhRs2Vg2Q3r3d3+rJNnYQNLps6d31qL/6G6MhlJZqirV8ONbTCdcc6jtUovFLmJlh2CXIIwYWaJm0XOnKJ1IIs2ghLkJVB+jteUhG3OOXuTDISeaQ9wX5E4Jkv9HlCOPE/0EWe6UOEvKYUQHM90yVZMBoxxNCCMOdomeQN1IZ6JNLaIjysSgDuG2xThJoLr4llkusi3O6cggyLWQQ1yHkgVB1EUGdomDLJaIncQsG0anFqvrsYuYJlYmlpQuC8pjJzGHzD3C3ZKlr2MX32KaxVz44uJbDNu2QTXR/fSVA2++xbg2JSaG/0WZtuGTHJgj7BDBASDPJs7YcswQNzHTUdMmrF5BZYsxorlobFhLnkA97mHDWJ/ssF4MOWABx9DYclCIRo6WU6pN0RIzFybVLMY9k8DbckKDWc72xBq28Yga1KWEA9NsB9gGnwQXNI1wPnStGWFD7sLUk/VHDCiKDqgLHVBHdRiwAZNfiOf+Y3iXYtP4n32O+atEcnokpueJAXvABtWRZcsVA5NfXpfui2Doi2XjuUdeEuoZ5QijEdYR1Qk+QZwQNHVdm1+cni6Xy4TlrBOaZZ7qlsZPLQy7Im5RXTt9XbpxOW9czDtgHeK6lE2itE6JQ5C1II5DdSLXMTGsETYQV80pQy+qOfA2zMoX4LS7tknsIsZdh7JJ7PtJDBuGtST6ULMcPrQcOqGM/3izoaLshsrNdgc1ZTfgeJMReN+m5RDUa99wdCT2L7k4PZ1a3P1yYVuO+/VYbRxgpiIAXoGJZ0SOqI4IHzDXEsuU3DoVC0GE6bZFlWhwp8B0x8Hi1RLTdtcnSiw4C+L8k8sR5dJgi47pxJNHFB29wHfD4s1Ns1+tDJvt+mX9rvNyPGBLahhopM4TZdwlWN8zHSeunMxfheKgXJltE6bLpX2OoMSAlQjCS+jtTrGLCFtQx2ImsHyBHYpB+kiiq3fF0k218oJue50ukMqJOIQvruORF3FUBa2uhZaWM4OXT11iipe7swvUA7EusSs8nRKmkc/sBNVUnDcmGRE3KHeRTsaU+XvYH5FLqqSAEedl8/7VW1dHD5aQQDCk6ooMalKxJ6bEF0NCiqyRNUaYoXckgmudCHaQFTZtg5wgjTgupgwVW/VgL3GpDhbY8Ig8xrCGAbPGYh8n5G4WvL5rduG1iSGWU+oSbmNNCjI1Rewi5h97c61bJqZMnHts01OPE4efoHe/ty3u8p98We7Ucuib2EJDzdLJcOJg5g4jgtSgYyBU6BTmGQZspdgFbJaTmI1dlzjwev/vl2T8/Ov/PmL8N4//ZvLf+G/mb9Pj/7UjOk5iLnXFSu88w6ioDfwhOVT//4YUh4wdwqd/NT0jrM20KWaMGEPDmlgeGDKcA3Gw96lD9D0nLqo7S1ibxctyEHQjBkEdOQhqq0HgLJYsyyCYqR3NbaLR8RpO43JKwEASp7LdQmpiLgUORpzq6EhRheqVY1Q2MDVBwFCmGZ6+MZHk5APmnzJQesyl47U/tD/KkrpT8azZgtll7z288BzqW3GJAauPkWVS1wWTDjroZIw9w90c0TE2OAkptZFc8TuM9hz6b/G2164DO9stkACSSUI5aNjjxF+payHDmiDqcmKMEXQT6+Qg47A/kuTTaK1YsVcdK/NWc4jgJTb433qWFTl037bcVgT1CvAJhGi9Aq+HmqbnAmVCbzJLPbYda0F1eKkY9Xr1Shb5unZjmX/AGYbNz2ilO2wSn5ypZ2IWdwjWhfqEEUBhwFtQasi1YH7bIfDCAoU9YITpcZDXSPeADBSRJx9RKW8Vn6Czoy4mklJ1GfEZsn3g5G0iUJMY1CjBjktW7okwR90pmI6MLIiD8AS0ytYdZ0ZsF0abYj6V9rwJh57p/hXHIRrYl4JRltC5Fnd/vNIhWdkgRIb484tGVdkHFYP1jykxBCma5ziEucZaEMU9G8xGoktKXR5S08YSrzlKAolyNbGLGGVuPruhmTKXTIgTInq/LNgmU518+anXrkuzAKSA5IKwOtCSjJCNJ0RtbGmES1JA9uERHP3NXpOCTW21sKGKOlfN3k0F6ZTbBl5LM0mIHGk9BnuRsgHDMJo2E69pjPn03e0IZormfsaiL8umvhknLFxrrJbKkUMUzUKFAM/lhQ/6IJtYthHcmeGKPGCBASrXfYLctU01uGgiYmJqIKzrDuF8x3Aihv0/6mPCciY/ZQrJE6J/bhsKtwO8owp2hbCQfgi9CMfA9Rwmb1guNQl3sWlHhcY/uTyPivXB5tOxS+LQZ9/70MmCamQYtUv+TgH/AUF/vbn2ATF/k8E2dizm/l6LrQaD/HkmG+UcHVHOPeIcCwG5Y8HNPeKskY0dbBKXOByNyIAFyuVnDbd9PPnjLLd3Rv/3mPx7bDcH7u6OVL6YIToG7oWsN7iZRlgvuDxgAZvFu9hjT2+9DXRbfIoo+2AKoIwwIeM3pC7AGwVWgDBQAlOAifeow4AmZUT5V5TAsi1XGpPGGpme4VIQ1ookjqSPYASqfjIBF4bn/gvRMSJU7DnKN3vlBI0sd+p7HPZqHHlc4fFnlM4ltEZdaL2teDZtxZBIDBk22qK+Aw9ctWXMYCEWI3Bxv9hob5D1vkEtJ70IXMkhW/tlwIph4YPKlk6C9ru3yZcB29qGdRPcEtRf2ZEOalMDrfJfxxfohaqvXwasLSWauhX4c0TkHAwfcEG2q67gbEzIBXrxHHZBiTu+EFuJXwgP2YVgVhyYdQFOxRHBDnEiA1WElI0u7YdjKdEsFv1TGtlf8d+q5baI+Os12+tytuc4NDrNO9QnI3RN1qhD3B1P+Iys93S7AeeaNUbh7tw3oaWMVQd/IEYYxELSBk5N6JRFSDhq9K+PB0wMwROotPYltxTjlqNDmEMO3ehfy7m40BLqhiLH1S04zmC5A+PXMGHQ13bImDjCnYdNSzoHzROEDXdqeZNpJLwgvG8wUYe4HGmYIW1qWVzEXzDndMIQRibB0slohYiUxiehzoDZnmNbnPATkGk64aBsI87QreCDMdnleFfwEhuTQQwdYWNiOdSdmsdhtkoNSpWICtoguHwIJ/DYcgYM1E6gVGdknUAbr6NUn4hPLc/Qfek7Aqt6QrnrqyIh9uvFuyIabPZPh04Ydj3wOTMdVZnmrAXpqOjTAZtADgQ6CuzZkUHFHXC0Rl8a/eJXcNuPIGQmd5BQlsrLCdeesmUYFBRGHEQXp9zF6podNd/bnXQuv/cq4iyAsZuWrfg7LfVou+7wrlCP569I5raAzx5Ti76b717WV9lVaXjZytyOsh3+3ClmF3HLWTTe3tr0fnpjtNuFFMP9p9X4vvjk5iiv1PPDcvrmfKT3rWyt1nq9vK8t7qz2Y3zIS411qT50jHi3NOHPT1bPKL5mGufpvvmUpmxUjLeW68aY43q9opGnUjlOHuMrWvby89v57Jlmbpf3xdpNfnSrt6q3ybdso6Qta93Mg077xXq75xXL/ful83g7z5+lV2fjWw/X8RU9e6xcTtwUdafpTPlmjNtVszHzzlv3mjYduUOv+hSfzp3aU565XbeTtXG/f/9ayK9ubs6znXh3nF/kV7Ob81ShNb7pNLvz/GP5bbUwasu3UmNetFlxOlrOb17t1nTSu0xmq5W2M3c6JS33lCrdkAXL1+3cNFWcEs5LdmZ5M7ufvA0di2gzN74eLd6uu6/Vzq2HJ8ye3yya3bOn8wWpe5P07bLVeK6nH161t7aWWrzd8nTu0andFyp2bx0f3el24bxrLoqPS83t3dKGPrkyrMYynSkvkplJvVecVRjvzp/NmT2qj+OaY0/urmvmfWtYrVxbpGAPW4/Pz5PxqO3QzJ1Vfbhsnd3O8uuqV7h5bUzLxvQZl+5evf4yHb82SuNmMTM5Ozen4xKb1RkhuevmuXnZziXnrVnqIX5rOb2nu27t9rluJme1ap48PfRrpWXj6ub6aXrVy2QrFr1OPbTifPFsl9Ne8bZ2Vxz2GtXl7Xn5Pj0qzEk2niPneL28XSw1r+i0Z8VSzizVx03cbGArY4692XWxunc329HtfJnlrceZln/C5+uC1eifD+s3r9mVZ9te0nijw6uzh+6sU1i95jr6Y0azqkmLmk/LVZ2midkteiTZa+Kcbk9ql+tSI6sV3Pv0Qy2bTD+2vcl1pdsq4NnTtGbl3GLx7OyeDO9M13t61jLljJmpp7OX6ctFO8c7lVVvXbxLv80LN2N2Xu2ZPO88ZZqjwhOh17MuLb0m9y5nHl0OPzeKV+fjyaTErVq70MRauj2spifLdCHtdNOzy2ZxuqgbRrVbTZGxU8xPvV5vcTsuabc2Kxhz0s8v3t7Y01Ou07mvndm3enmIJ/UMuyzUR3aq1BslGz3q4PbdvDe+mWr3o6F+flnLVqZn5CzbH7W5NWpbzHvtPt2lVmXcyneb+dTrou88xm9SBXf1uMyeZ++H2mS2bzkkuprifbG0r9ls6x3i5WTi1daXTv8aL86Kj9mH695kb8d9rlOpTmZUB3UyI2txLYioaD8obWIXwqTqLki1QGcIq9xPeABtBzFKzDRyIvwyUk1KBYtFZNAaQ99AWWNfrw6Y8m0CHY5lGOD+U2qJu46nCbWysScE0f5FbsA8pkiDfArUh4tTpFEoK2F75hOk07GwBdwBC9Pmmxcd4vpOMdCbOuUuZZq7NUECoaMmGPzq9SAZldOmm+Hlyk06mbrIv/hxuM1trwfRsYgurtEUL0hogEFs5q79twUv+dhf3shzxRIh94HKC6O4TQ0YXNIX2BAhAANMSezSBfSQ97uQoYM8rsKkZuJYsl5Rpowx6XnUMCdxThinMJDyzEW1byqfzOhjksTjwjibO9+rXmfunmQKNef2It81cISFYU0cbE+ptjF3BmyMTWqsN2/ct3ROEPdgK3M0iLU7xUEM7I1BrFoexBLBzIqn0gQasA9sILRtAoH9Ku+Rf56hE7yaDbGffjPtTnHfy2BRwbLozp1Vb33fMobpJJ6Pc7PHq2Xl2SFG/Npa1O0CPyPLhqWnq49XRsHtG+1SZtgmZiZ7vSyN58b1/aWdYnM8jedSV9nGm+PNSVKrtXKFaatad/P9ubNgZqP8uGJ3Xr2Uy9DHodfrPT5eVa5KBLfKnbZ113i7W/NXq5FJdus9fl2i1JmW8Nk4ncm1HkfX9Er3tBuyeMi3tOtVI6c9Fd6a6UJ+3rgp9TstM96sk8Vyzuu8U7/KZu9d85xTq0Zn09noZmnNl/1m+7L4lGRG/nHx0DSmxYp+81rqzDtF0k3VWl65UmaPy7dypV24O6/XSsP6q95xa7Ny3Hlw09e50tO4pSe1zLpmDxdX7VSOtPXkW6PweH+2tErlwgPjWMtX3ZR93cmd24/5dC5fafW9Qq+iV5uWcV1sTTR9OEnf2cWzvFbEteGr1i0kX8+vnerbstBdJFmjdEm4V35t3b1e8uH1mz7rd3uPbjpzxc7vG1zXUrfPHu4n6fyxROyrp/GTNb8jxtuDS1KpMzdbWj7YyVnvNr8kyfp8/Vg28POkWS904v1KaZkeNhe6WSC5O3P6VBwZ1QdrPdEeC0/ZvHWVH11TXL4fX5drlVutPSlPTXJWtKqp9fPzE2+N8OUwU39tOeXsTen26n5ZcG7P9f5ro1A3X6m2eE7ZRTOpr+LXV+VWZp1rPVw7q1JlnHrrNHmpPWt2XkuFbqtZYY3bt3z8Vc9Nu+7zyn5uLVtWXS9j1n3OPFfyXrtkd83K0rXbl2Y+07vnKTNX67eWo2Q3Xa/tNQ62TJ383Wj2uKz0e1MaJ+1crjwZjdNntdl9pdKvY7OJK07SeU3Nk+PUuFZ9S/VzxWHy/GlxmTyv0UWq2EzHK4W2UZh0Ug+ztzRNvpU7c7ZeF4rJdO6xqbUXtHl7fcbqq2q2eTVsVfnMKuhu3RllumY1Pe09Lsoz8215XuXdWurmvtS8LOepx2+6j8Sul1Orc29Wvq493y/0iVttju5zszf9/G46j2v63OyQ24cba9W60VMjY0EfuucPZiG+TqXL7pNNGldNXK+4D60bozRt0JLVuu5PMotVx8w+ruoGvWuS8ZxM6gY3u3WcubU7+X7fKF9n1ldT7Cbv4057VVnpa/qgXw6Xb42Fnawvh+mlyc9sEm9N7lpPi17/6rxhT/ut3HWm8DSvlmij9ni/j/FbRlmymKqZdrPfPk8N28W+PXdIv4MXd/h5dM4eyTUtWcnK/WXpLZOujObX8/tCJ4tLDXPUnjY0zX0t37xiyuJ04bnZszO32Ls13xrLh0alMk/fPteW5fP7ePbh6dms9bJXDequ773O29UTyWfbr3fx6vDuPpnu9qeXmfvLft6x5nktd6adnztOj1e7y0aDLjuF25ydyt1S7y2XqeDm6yLuzee1Ym28Xt7l+rPV1cjBJe31yr2l9976fnQ/n5Vr07iF2dVs+XRH1i6/m3a9tHlvLtu5SjvtWM9p1qK113KecX0WL55VM53M8vbt6am2PHtdjPp966lvnS9K2eTw9in9lKw93XfmWuVNK9W1+TDpMob5OPPQz9b0Vd4sJNtvzVG6xpnBzhbXj8X9jKdbluH6dmjnG87jukPfUq5Vm1yP+g/xhl7PvN5n17Z37oxu+6uMc98ojU03WbOe3ia9+nP1oVbVmvMlMdt3hdSbVSliHC/Nktf9u8vKa+PquaJXzNq0nynenRn1uO2tZkPz6vmykUo5q3W70MzlHm86JNNpme3x9fK5nl/30tnn1eL+uvZUd3VD711fvjXzdZx/615Piw/t3r7leHxPcL3HCToaxGxvZEgLFLT7IHa8bRMErg6wsSxpSaFNr4TSnqJz1Nwlpm1YaxWLYDqYRcQPekCwMzS1bxyLhC7l6GATpGMXg2JfEEfFTISR5/tFBsxiok0CPWzMUs0yTYsZazSIcSp8O0GHY2meEKbBYxJ4VI6jWp3TvVb/KropxoVMs5GppFe1VGlSWHijc/eGpCZXt28PZ3lS6Hr83GtdLdoP1b0vZZXT3jPYVjlB32MilzwXaW1wSQDmaVNMWdh+C1k44jsw6aWfXGVrtq7rj+EhOPrSrpVz6ULyqzJ8dsYXN4AgMAzheRhemGSBgzHcScW1ZEQ5gVAVa9MBU8H0iAdR5dFyks/GCQOvs46OOkQT1nIWxgXisvls4SuKx6WvUTb3HMPvcYwq1Tb6Uu/2Eo/582QidX6e/bqzTklVQnpPd75UbPM3FOxAuQo/61JExKgDqYKhfj+XbbmObpfVsFZ9a3vnZiZ/dXM3dD2Sz53f3NmP/bxdXndcOnt6va736zm8Rwl/l/nlMjD5RRxoafLLu+iJcHB+DbpZo1eiuSHPNaSd98nomqx3Kf3+mW7gx1Ye70/mWWy7wSFYB+5siNkpR65q+k++2/hLo3/9FemW5pkkSAn2OwgJwIN0Yt9J3BEZFyeQu++fCymtoLm6DB/x41BbEDo8En8LRAWHiKgZmlQKOv8GC+E9bHArSBkVHtxgPRvRIm6pR/z4JJQcLUSdujAqQkRQUPQJahSCdfnzi3u4CNWpBQ0YOIa35hIzmFgnCC8wFcEPSMoC6X0E3O3xyA0wuO+0q/e9ertakeUAhiEHC+omlHtfHzCfBWGpTrA2hQ7/5GF9gSckgYp+DIBbZsiFrsJ8m1u7uJ5aQXY2UAFrHbDQK4ku9wTpFrxWbgH9kL/brpabt7fVu0q1cgJii4p4ogFJw5xonkM2L3GV03ajtTCzSE5X6WxIiuBAGKr6CN/r4ie9qVcj3TYyC9IJSRWVYMxdlQCmBhOrgW8GTDqE3Cm4d/yssKjY2ZE2r0t3KMOAf2sMDmL5nxQIEL33Y/fFcMKVv7l8cRxk4sDgexdvEheD3hdyWFEGIqSNl7eEw77bvDPQOSDHEqEvZc6A5cw4WhLDkC4NGOAEde5vZNZdZ4knE+KE5lfi8ftJzFoy4nxiyU1oJwoo4D9S//mKUSVn+IsWQ/oeue2B9jLBtgyqrT/J/JZo7LNfftqX/CY4I1PnRTxuO83SdugCa2skJw8ENMhZDLUBQMSIcDRVR1snYAOKSgfLmWDmh+A1yzCI5vITIYJPwOAQAlvyXqdcMyC8BxVP3GLYkGbefjZw108pcYhOHaKJ3JI9IVa/vKVlcTfeVm1DWSUyW8G3cURpACQpGnQjrmW6hhTlVKqBoL4BOABtqkyP97ioCYF/UHECyxf+LjmlEI7qxQ/YewsIiSc8Fn8j2QryPNGIEObXg22FPn9omfyATTubJ2CVzyP/AXzejj372Rv+JMhzDB5ofC3Yz9GiilDNhCoKgqRCSPj+yZWFE8r+TsG4j5K/PkNhHxV/U9Kdct/KNJvwO/lhElhlzbBJtc1u3AwUKQmSO3PzZahOUKQZjDaFlJ4N1t4JmkDAwnKQTgwis6+k7E0HRpesExX6WiSQyexQEYCRexnC//D5Ayr3yq0IPz7MYP48N5SJHX4WyXOG9YGw/2k27F+AkHtDqRaHyiYd7k212FpDW4nMpugqEh2AhcVNwAHMzA7cAjpfwWYMpV5Ib78Qtv5tLTAYfUM/Or56fcqaFkl+hrHdZsCUvU+5z1p/eIe8CqEtck1E5jqdsE0gRGSsKeo+ZNQ70nY/a3bUUWgU36yUtT2OsCjjoWDKRlcBU8DyV5oJ1i4vHFyoLg1rU5VzqOqVuW+CjKlBeMjuV4NyIigTWlpWFqiCaQhz+dNAnjQSAbfgtiNChGoJiQFrtmTmj7rUypXsWaG8Ke0sMAhBqf7DUNdh+GANGJgSEPwM5Wb+rLKU17FPZz+2VYf9CZBR884fXATmgqz8wJJQOZEaZjLJSD2OpCyG6mY3iZJI5UneEaKylLaLtaMpjRcgNGRyfL0SFFhudHivXYc8Rz3IYPRbF0Nl1dvN/bYhIj7Iw/z5JESuWfZnqoY60A64If4TscJDjiAIx2MNAn6wUcBGM1RGnpjH35FHmA+Yb+eKfe07sDKJTDTDFZxZ+bPs+dfj7Tc6YLD5RdqYTEoWu1dQESlTj3olgYyUpCaelv8mMvLfi+w+wcOJ5lrOMHDoOp9SMB3RC9WDXv6tQWoO/8IiSl2RrAMPX9yh+hkbmmdINdnixNMttjYtj4fG5OGc665SS4G04QgPGEggedIh3ZpNDLLlhIwYyyptYC8bZtQeQiRf4TFEV9+ZUbssv0TQUkXC/SeaA4b2VtlLQuRqqMImeJXgbx4wVa4dOI6wbsp65P1J8YIuZfh/SJ68oewSqa4DfwmtntTy8psf7SDZWAhAP4P1JTwCHwbFXy+osiuhQ37tAfOPofAUBTVj4eH8sxmsXNZeiagA1VWOucp2Ry82pgJHRGE9yCjEfhgFaSL7AlaUsAxN4k4tlf4j0mgBECRSNTfCnGqxk3fFksr5VqMKmQjHQmWN3IrxpRknxALgMfhF+ZGWkpLgahUdVp6qEL6F0Acveyh9uYCEdrGUY9QhwJOgQFTxaAueBXP0EgY1WcWXy2UcbqJxzzGUn/4F+S5+5dG66nZbWwpgSrBOnMQOXXAlfrn4Q4kJEzGy9DVMKpwZLhnOyHoIQB8XcF/f+KK7ErAA3CAbxpNo1d8LsxiRHeWbUEEtH2rlSOYHQV4QP0GmNQKhBh98sAw4kWBIidQkuab9UmzfXvzY5n5vw+01t3+02XzTemOIv7Pv9tP+2ahBlzimsEHBTIWChn0OQzGRyg7f8VC5/ghcjjBgvpNqywmBtlxWWEgdB2uuhw3kEEN6e6fUBmnpLomqlApKNlVtbmS4aANNI7bLhZIfMN9qi7o59/JL3ss+WfB4g+G6IHoENY/y4w9rHg3oKif7fLUjLA1qYYfyGjQMDOSfufn11CBiMxJ9YzTv3AH33f4isQp/Z8KQdRjSH4tvoF1AJ/gZjScRJKigLLvR7w7Yl0a/+xV2DsUGfRPl7KL0TtAobZ9GvyNla1BFQUOFcXTj6tqhRwFMeQ5TYR1MTT5gIrza69bihUBiChEk79Uhi2sbRwqpO5uo5dmzj75vnDHbm2bXqf39+/sKK7jYyHcnIK7CAUnpLVrFJfgNNlqgx+9ESX9MNA5do4Rpn06mDhhZB4ysA0bWASPrgJF1wMg6YGQdMLIOGFkHjKwDRtYBI+uAkXXAyDpgZB0wsg4YWQeMrANG1gEj64CRdcDIOmBkHTCyDhhZB4ysA0bWASPrgJF1wMg6YGQdMLIOGFkHjKwDRtYBI+uAkXXAyDpgZB0wsg4YWQeMrANG1gEj64CRdcDIOmBkHTCyDhhZB4ysA0bWASPrgJF1wMg6YGQdMLIOGFkHjKwDRtYBI+uAkXXAyDpgZB0wsg4YWQeMrANG1gEj64CRdcDIOmBkHTCyDhhZB4ysn8fIsoQHQLX/fhLLJpO/A9iq6jiWs1MKQ8TTdxvvJvbCF0OdjLw9W030QhX4EtU3xdoSwAgKVvx4GCgDnSyQaen7gyv+NKHR35ts8+zdcaZ0n2EnB7iiTBRnXxFDGXWyGjxcuilGkdWN0RtBd0rCd64bv9xfuWD3G8Mudj0uSr52aRLasSNaiMtZeLZsMvWJYvwPgsliGdKttG+7lbAeSAfJG//cyCJiZWsdNuBhA/45G7Ci6pm3N5+8SHsOhQzrL99ilrMOeZZjF1++fofMCzzhkJohpSbkYgBm4DoOrgSBcBUfedoM0ENi07Xu4Li4cMUNaxmDpsCOjlgoF5MYmE2AwWubdASNsZOYgUfEiF3E/sdy1qeaL8e55TmaYIEJVyP0bcAQQsp/W7TpifxcDiOSnYTblJVL4ru8DP4zNPw//wVbA+6X7hbG2q+IkWV00KPjf/ltsU3rqnJBtQzIOYqMcywmMKCSIUTLRYSyf6HT0w/xGjc0fkNyd53IzLHv6FeAXaMRghISTSI8w5FkhxVhx/G/Yt9PghdxaYVegLTpw7y3sTaDwDLEr4Ac9S6OBmzgDqTEWrmQ+A8fx2bwX4vL/1k2YdimypIcxCbUnXojgR62eRvxiQWtj2GCscc0MdvRMbzxgRsmHl38iv47MmTijiwjKz5Gp6cRLqPfdqLOO0weuNFNcPEr2plla0tAJ2zTDV07HYqtuqIpujOgJxhpJ8g5AQkEnYOREmo/teqJ8u7rVPxOAPDTxLE8ph8dHyciTcLsOk5UV0TzXCLJhSJ5x0H/9Sti1JDMHbhj003UbIcyd3xk8UTH1YnjnECpg5AWMjSEDQNstZePiHt5uUD/WAwGbBATyzr+wfg1zzDkrdW3WEP9Ze/v8Nfp6cakFef4Zc/cF1tHft+8lufCvO3oYB8uKUwR4fbxgH0Pn53W2p0K9eSfH5CL78ovy1kPfS+pmHvzIAH60uAJS9x+00MfMkB2jC5tu6sDG1m1LNq0uoKrmVDOoqUteOA3kJ9gy/+CKmG8Q0C7BCUn/SrYkNkKUnEIT4EPAAhgP3LrJWzHEhEmwAnFNuVwqmHgDiFbOJH2WiZfBZ5nSMPauLyih28D/JEQ4i8inEMLjx5IKenEMn5Fg9hnyfXFzi8yZVTy3fRCaoEEkYmQ00BgZUQ8PhuqYTCICmma5ehCUwRRHUBwVPBJvuZVCScJ6FWVFoG8aYnMM5jDd4fJeJhMzEIjYljLk6A8zC8mg6s6jMSxS7nIdBbgtmIYaAuVPwm53nKwvpLItoqu5wJFrYGffhPhQDi05gkFDvplECtVi+1qe9htXlfvBrGvwSuoMpkNosSc8pGzoFjQv90DG/2TJNqEaCn6knRL6opkX5uqZheSyF8kqBJ5fxLMuVqPTYd0o/pDM24sgM34x0rxRs/znm6B1vrlp5UWTOA6a7WUyHK2+26aAImBOP01siplPwyjRB9FPx5vhhKi5GigbGU1pB8nAn7E/8/eES+ERA0PJEcKk6a+JUKYoUCmwUskF7skbBpE9NUPKUH/4IIY9A9EjmPfhW0LxRgAeAw2fMhKhQuYn68JjvFd5XwMdzCBRyIMXYn8F3U2BCZ8M/r092B4A9XS+dLdMzZA3FjbxO+zLNxVyFr461ciIJZ+uBRbKty972J7376ziEij/cs4Cn9ImPrxn/mGdieDexlZuVCeaTFJ/IysIdF+/73rJCaiRHvuX2Cq+F2DbR00P2zvw/b+W7Y3dPCDjSLLVSzFncYuYqdi86prIexVaS3JNXqOEUKq/qbsuSE3vMn3vdbdqdjsEobcx84JukQDnRs7cYcbT+LnAZw1uiMupFajlhwFwSgJ9GR5ItY1pgLs04/HfQn3gAi3ZZCvRz7xmnwgEPb59NQn/lQBiZ5OiBvnLmCl6scJxTLfYuyIzASxHhmQ9X2DIrKtQrTqvcN8AmBYmHjRlvLRTlOJ8w9Nxe8tCG9k2DIsK/9W5GEv8mqEHEroxLT8BcpBT+HvmMpvESNb47FBmYCyUNko/t7aSSBR2Z0+2voRNiiWlvKLGkUlX77Aho4++vnxYQibMIDDiLUD1LqdXCOVUhSEMT/JB5keGnbpSaYD+7eccDuFdJYy+qEO0Q98ri0PMSIAZ6MbD4zYGVlvNt7OzzpoAJtru/zUT0iP/LCDqB/88ZZx1n2oOYA0o6JNoRjrZ+mWRQsiT8kgC2L89cuA0hNu+eFikHRV30H77m98bJKD9/8uxRe/wdfwbxT8frD9n4XQD9H5E2j3n+j1Xsr1puunMORlVvZ7KOibwX4WbnynpzjP2w+V7tx+7INiv/NFBEM6GcVqDnUJEI33IQWH8X9j6WQ6G0+exdPn3VTuIpe6SBcSybPUc+zfweHdUPBzkLmf6vfjt/45IFr52t+FUN0MF0HpDB+qz8E1bgb6MbLipq0PgihRDb8orL0AMU4AxAWocPoB+e2A/PYfhfwGQG//YehuAOb2H4bgFkJpm32ExCaA1/bhYQn4KwXHxA6QSwfIpf8oyCX7AKv058EqzQ/QSX8edBIgJf2HwSMJNCSF8bP6aRwfAdsTtq3XP4nt8v1rBEclbEh/DtFh02MDvrB5FoJG2AAVbL4OgwaEn75bQx9e6tZXPy7c/oly7A0xn6yc/rjDj+9eH9Qjv9No/9X1ozLY3Vb7mBqtLwx/pyrcflz69U6l12b+aA2UvFHurT9SX0XKfULF3R8UxLxTBfPDuoXw6DuHIpwJ/9HV/+Ok9FD6ITTys0ixJiI64oeLoJHMtPgf6YQEQ1J6PMCt1pHfxXayBn9BdeY6lu5pMpukoooNZPzfx9JRVSEiHwJc92pTLYjwmBdbdZ5AxegX8DCo1xLQpmKPAkCNKooToEWo5SNkhEvhE6glZxSjCEQgi7s+gitlaORYSy5zRwbsl19Qp3LNoVCL8gDTI1QaoQL9PJrBKsr3Nu5HmRUfTLhpirkYPkiMHwMe8RKcyZAg5OEJ4aI46Td0oz6ruPVvqGItmWFhHQZA/84fGCL8Qv6gP78BtfHIH7T94Of//AFD7B8WqK1gx40w5ovtjRI6WWzcxerBqcpm5KebPIzjvbz90q4WK7fVzQhbeYtcn52ODGt0amKo3PYDVurfUx077qkcAmJeYd4m7qrd6FTMmxAXHIJR93bweEN101knZCTt9PiPpNZyGdmhV1BbNeiKOuGppmSVsM3NVPLzZzn7B1BLBEl7qb20tqfaDP3udEEK6p+yEybW7j5Q1DbwAkenMvGCsOhO4AQ72jQRfHOKAT0La+4pn0IE5HSTcnj8+6l9xQv8zr4FamWuQLBvbfOVR1kr9q3/2N8Tp6G86+M/krfCrhAkhWnepvaoD0plTFxtevzvkh1X3f8U4uXgkSUgWEPrqrW1FSVllG9Ji8jjyEnc4vrvJtqe2nu2s+C4zIWNULu26Rah6okf7w5t3tPd0/f7qRUk7ZUUbW+0jk7leKP1hJg8SnH46Sn8J3Le/lBqYap3zl4b8lEjU2kQgeQJaoVSCvxH6n/vUvoHUcv3azi4vVGNMInM6xuatsBjSSfAJxRN44Czh8XXgseqLz+9qZerd51qPJ1IJqauaYgQO1TANseqghbSRVyLh+pgfJMT0j6Iw6UdawAzXB9QzVSAUJKud9Ilt1NAQqVZfhe8Kf4QHX1IgvpYBLVtzPlOQbcb+W1bCapoAWYwFO0DigxmumWqJuL3MjY/Mbz1w7hEm1qbAnT/TuCDOkGlkm1x8cumqjZTYtlQFwE7HBSBboJcW0iUpiKPQbyebyoh50tMWPVB7JPD5Q2SrOGrb98Aw7bnGN+/w2PxQ4FQNbRJuhE1RCcxWQ0fymQrq/pOkTC0yV/bqXrbJLAVRcXxh23DWUWtZqcLwWfIV7r4FjNFzkrMwVCTBH9fxESChysz7L7JZzKvH8x0hRAri6lE0soGtiXIHvBzar4EX2G2DlH47ZtsIe4t37+DL18sRSV/fP3+/fv/AyyEIW8= +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Create a new OAuth 2.0 client. If you pass `client_secret` the secret is used, otherwise a random secret is generated. The secret +is echoed in the response. It is not possible to retrieve it later on. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-oidc-dynamic-client.RequestSchema.json b/docs/reference/openapi/create-oidc-dynamic-client.RequestSchema.json new file mode 100644 index 0000000000..de43361117 --- /dev/null +++ b/docs/reference/openapi/create-oidc-dynamic-client.RequestSchema.json @@ -0,0 +1,346 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + } + } + }, + "description": "Dynamic Client Registration Request Body", + "required": true, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-oidc-dynamic-client.StatusCodes.json b/docs/reference/openapi/create-oidc-dynamic-client.StatusCodes.json new file mode 100644 index 0000000000..82775a78f6 --- /dev/null +++ b/docs/reference/openapi/create-oidc-dynamic-client.StatusCodes.json @@ -0,0 +1,413 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + } + } + }, + "description": "oAuth2Client" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "Bad Request Error Response" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "Default Error Response" + } + } +} diff --git a/docs/reference/openapi/create-oidc-dynamic-client.api.mdx b/docs/reference/openapi/create-oidc-dynamic-client.api.mdx new file mode 100644 index 0000000000..18314e53b5 --- /dev/null +++ b/docs/reference/openapi/create-oidc-dynamic-client.api.mdx @@ -0,0 +1,49 @@ +--- +id: create-oidc-dynamic-client +title: "Register OAuth2 Client using OpenID Dynamic Client Registration" +description: "This endpoint behaves like the administrative counterpart (`createOAuth2Client`) but is capable of facing the" +sidebar_label: "Register OAuth2 Client using OpenID Dynamic Client Registration" +hide_title: true +hide_table_of_contents: true +api: eJztfXl34rqy71fRZb+zTnJfIAwJITlrv3UZE8gAYQhJmn5E2AIUbMmxbIb07u/+VkmysQlJp8+e3lmL/qO7sTWUSlKpVMPP3xImEYZLHY9yljhLdKdUIMJMh1PmoRGZ4jkRyKIzgrwpQdi0KaPCc7FH5wQZ3GcecR3semjvyXAJ9kiz6HvTbNmihHlP+2jke4gKZGAHjyyC+BiNsUHZBJobMMcfWdRAFFphxEMmdYnhWSuEmYkMzNCIIF8QE1GGBLHGSUHcOTVICtU9RG3HIjZhnpC0NR3C6hVU5owRwxuwyophmxpIkYLaZKIJ5wy1XO5xg1spJAc8JtjzXYIYIaZAHoduCQOCZc/QusHZmE58VV9XC/g0YFQgkwpVYbRCJhlj3/IklXoUQXMjGFuUj9xNDdiAtSyCBUGMe8Bp7CFfKC5F52PFfYRdWQpJdnocGVPOhZqdJ0MOdSiI4RLvCTHuxp5T8wlhYBYXZMDm2PKJQAtqWUAgcJa4aEIYcbFHTLSYEoaEQww6XgEpTx6fETYMiBli35sObeJNuWo23vtwhAU1nhB3B2zjjcOF9yQH3d1CdECPSzzfZesJcIlwOBNELg1ghCwInBiRkBku8VxK5gRRD1nYIy7iLDVgfZd6ikWqF2TyBZMNzQhxoLDgNllMiUuQwGOSShwkuEPUZNfNxFlCr21qGnpZqVWVOEi45MUnwitxc5U4+5YwOPPgxdm3BHYcixqyjcNnAdvrW0IYU2Jj+F9838ldg7KptF6uQs6zXPoeRw5xx9y10boU0B5f8Ghs8YVIoZ7wsWWtDiKFjXWTA7ae4DF3UYRGgRZTakzRAjNPLizOhG8T4LUbaYy7mx3LvU0t6lEigHOOC7yDX5ILhkGEGKrFI1c8maw+YkBRVkBdqIA6ugKsFvVCPg8eg2iR0xr8DjgWjBKp7pHsXqQG7A5b1ETcUSMGJj89L7wnydAn7uAXnzyl9DMqEEYjbCJqEnyABCFo6nmOODs8XCwWKe6uUga3D01uiEMO2yGb5NQ0Dp8XXlL1m5T9DliHeJ4Wemta5XLjc+K61CRqHBOLj7CFhC5OGXrSxYG3UVY+Aae9lUMSZwnhuZRNEt8PEtiy+IKYQ4O7YshdOqFM/HixoaKqhsrNdgc1VTXgeJMRmG+buwT12lcC7cn1S84OD6dceF/OHO56X/f1wgFmagJgCmw8I6pFvUXEgHlcDlNx61AOJJRuKVQfK3mHXRfLqSW2460O9MYF8fRPoVpUQ4sLZbT3BO+GxaurZr9aGTbb9fP6Tedpf8ACmaKPEuERbG7pThBPdRaMQnNQjcxxCDPV0D5HUGrASgThBdSWIp2wOXU5gyMLzbFLpdRSRFdviqWrauUJXfc6XSWO5SZ88lyfPMmtKmn1OFpwdwaTTz1iy8l9swr0AzkuuSp8kxJmkM+sBF1U7jemGJG0qPDgTKMsWMNBi0JRpQSM3C/r+dezrrceDCGFoEldFVnUpnJNTEkghqQUWYGSgBl6RyJ4/ECygywxnP8HyCCuhylDxVY9XEsCTmiC5BGntjGMYcD4WK7jlFrNktc3zS5Mm2xiMaUeEQ42lCDTXSTOEsG2t1cmtzFlct9jhx76grjiAL37Hs468ZOT5U25S1/lEhoa3CTDiYvhvI0KUouOgVB5pjDfsmApJc5gsRwkHOyBOpU4S/zfL+nk6df/vcfEb774zRa/id/s36b7/+uN6DhIeNSTI73xLauiF/CH5FDz/xtSXDJ2iZj+1fSMsDEzppgxYg0tPuE+KDFCAHGw9qlLzC07Ln52lrAxS5ZVI+hKNoI6qhHU1o3AXixxbhHM9IqOaGWLKfGmROl57RbSHQslcDAS1ER7mipUr+yjsoWpDQKGMsPyzbV+pTofsGCXwaHHPDpeBU0HrSyoN1UKd0vpiPD/LbzwXQpbD2RuasDqY8Rt6nnEVCJWq8jrLTrGliCRQ22kRvwOo32X/lu87bXrwM52CySAYpI8HAzsayW63YLBW3yCqAdXDgTVlC4MMg4HLSk+jVaaFVuPY63aGi6RvMSW+Fv3cngN+MRBUK8ECnq9AtNDbdv3gDJ5bjKuHzsun1MTJhWjXq9eOQr191DP/IgzDNufOZVusE0Ccqa+jVnSJdiUxye0AAeGvKOp0ur+5rgEJiw8sAeMMDMJ8hqZPpCBYvLkIyrVpeETdHZkwYBSfdcIGLK54dSVIjwmMRyjBLseWXoHUh31pqA6MgLXMjyBUwVFmqUCzYjjQWtTLKZKn7dh0zMTXsLNyCUG6Jfq5i3PXC68H490SJYOCJEh/vygUVXVQcVw/GNKLEmK4bsuYXCtB6KE74DaSExFqScix7S1wCuB0kCiGk3iLEGZlz9a0wy2gglxI0RvlwWbZOqdr3712nWlFoAUUFyQWgdakBFy8IToha2UcEUKyD48gq2/XmtKsOmlFlVUUeei2buqgFXAsfBKqUlS5CjtMVyLlA0YhtaMmZymMRbTd5cjqCmG9xmNvqyKBmqc1HD5WA9VIJdomuURAjxXFz6ogxzCHSu8cNORRQYsVEDVuA+Qt3KoARdNRGxMLYRN0yVCvFGciOX8j/6Z4u7kp1QhtUPMzy3DMhSGOapgTwqLsqpd9LQpQd2wPGoT4WHbiQuNfwq1HzXrw8VnYo8koc62+TAJ2KKGcb3k7xTwHxD016trHxDzNylsY5cz7/dqbDVo5M9T2agQaI8K4RN3XwrINxrci0/cFXKwi23iEVegERmw8HD5WcVtG0/+OM3tndb/PSb/Ht3Nhbu7qw5fzBAdA/ci2hvcTGOsl1wesJDNci626NMbs4Guiw+xwz7sAihTRuAIqXOwRmFlmxywUBVgch5NaNCmjGj7ihZYDveUMmmtkO1bHgVhrUkSiAb2a4tPJmDC8L1/ITpGhMo1R8V6rRygEfemgcVh64mjtis8/syhcw6lURdKbx4867KySSSbjCptcduBL0gKlZXlnDMCF/ez9ekNsj5QqFWnZ6EZOaJrPw1YMSp8UJmbJCz/9jb5NGAby7Bug1mCBiPbM+HYNOBU+a/9M/RE9eunAWsriaZvBUEfMTkHzYdcUOWqS9gbE3KGnnyXnVHijc/kUhJn0kJ2JpmVBGadgVFxRLBL3FhDFSll40P7YVtaNMtB/9SJHIz4bz3lNoj460+258Vsy3ZodJo3qE9G6JKsUId4byzhM7LaUu0KjGt8jKLVRaBCKxmrN/5AtjBIRKQN7JrILouRsNfoX+4Hbp4UKoVuKSXGuWuCe0Q13ehfotAf5E31DUW1a3LYzqC5A+Ol+yqs67hkTFxpzsM2V8ZB+wBhy5tyfzKNuRek9Q066hBPSLdY4LriCAtBJwxhZBOsjIw8QqRSPgl1wWHoOlwQcQAyzSQCDtuYMXTD+WBN3nK8K3mJrckggfawNeEu9ab2fpSt6gSlWkSFZaSjUhqBx+DXgmMnPFRnZJVCa6ujOj6RmHLfMgPpK91a4IYMjiIp9uvFmyIarNdPh06Y8kfCQVBlhruSpKNiQAcsAtUQnFGgz44sKu+AoxX60ugXv4LZHvxiegXJw1JbOeHaU+aWReHASILoElR4WF+z4+p7u5M9zm+9irhzYOy6ZCv5TkkzXq47vCnUk/kLkrsu4JP7zLzv5bvn9eXRsjQ8b+WuR0cd8dgpHs2T3J03Xl/b9HZ6ZbXbhQzD/Yfl+Lb44B1TUannh+Xs1enI7POjWq31fH5bm9/w9n1yKEqNVak+dK1ktzQRjw+8ZxWfc43TbN9+yFI2KiZbi1VjLHC9XjHIQ6mcJPfJJS37+Zfrl9kjzV0vbou1q/zo2mxVr9OvR42Ssah1c3cm7Rfr7Z5fLPdvF+799Uv+JLs8GV/7uI4v6Ml95XziZag3zebKV2PcrtqNmX/aujWM6cgb+tWH5PTFrT3kmdf1OkcO7vdvnwv55dXV6VEn2R3n5/nl7Oo0U2iNrzrN7kv+vvy6nFu1xWup8VJ0WHE6WrxcPTut6aR3nj6qVtrui9spGccPmdIVmbN83TmeZopTIkTJyS2uZreT16HLiTHzkqvR/PWy+1ztXPt4wpyXq3mze/JwOid1f5K9XrQaj/Xs3bPx2jYy89drkT2+d2u3hYrTWyVHN6ZTOO3a8+L9wvB617RhTi4s3lhkc+V5Ojep94qzChPdl0d75ozq46ThOpOby5p92xpWK5ecFJxh6/7xcTIetV2au+HVu/PWyfUsv6r6havnxrRsTR9x6ebZ7y+yyUurNG4Wc5OTU3s6LrFZnRFyfNk8tc/bx+mX1ixzl7zmbu/hplu7fqzb6VmtmicPd/1aadG4uLp8mF70ckcVTi8zd62kmD865axfvK7dFIe9RnVxfVq+zY4KL+QoeUxO8WpxPV8YftFtz4qlY7tUHzdxs4F5zh77s8tidetqduLL+fxItO5nRv4Bn64KvNE/Hdavno+WvuP4aeuVDi9O7rqzTmH5fNwx73MGr6Y5tR8WyzrNErtb9Em618THpjOpna9KjSOj4N1m72pH6ex9259cVrqtAp49TGv82CsWT05uyfDG9vyHRyNXztm5evboPHs+bx+LTmXZWxVvsq8vhasxO632bJF3H3LNUeGB0MtZl5ae01uH8xIfjji1ihen48mkJHitXWhiI9seVrOTRbaQdbvZ2XmzOJ3XLavarWbI2C3mp36vN78el4xrhxWsF9LPz19f2cPDcadzWztxrs3yEE/qOXZeqI+cTKk3Sjd61MXtm5fe+Gpq3I6G5ul57agyPSEnR/1RW/BRmzP/uftwk1mWcSvfbeYzz/O+e5+8yhS85f3i6PTodmhMZtuGQ+KjKd4WS9uKzTbmEC8mE7+2Onf7l3h+Urw/urvsTbZW3GY6VcfJjJpwnMzISl4LYkd04JS2sQduUn0XpEZ4ZkitXJVTzi3wUWJmkINIhIc6YLH0DPIx1A0PaxycqwOmbZtAh8stC8x/+lgSnusb8lhZ6xOS6OAiN2A+06QRM4VQHy5OsUKRqITNng+QScdSF/AGLEpboF50iBcYxeDcNKnwKDO8jQ5SCO01QeHX04OUV86YrptXI7fpZOqh4OIn4Da3OR5Ex9K7uEIQxRRpYJCYeatgtmCS94PhQbQSDBFiH6i6MMrb1IDBJX2OLekCsECVlBFQIrjfRRSdMHKH2Kl9xXpNmVbGlOXRwIIkBWGCylAqtcjip28mn86ZY5LG48L46Ph06/E687YEU+g+Nwf5roIjNQw+cbEzpcZa3RmwMbaptVrPeKDpHCDhw1IWaJBod4qDBOgbg0S1PEikwp41T5UKNGAf6EBoUwUC/VXdI/88RSecmjWxn56Zdqe4bTJYXLDMuy/usre6bVnDbBq/jI9n9xeLyqNLrOQln9edgjghiwY3s9X7C6vg9a12KTdsEzt3dLkojV+sy9tzJ8Ne8DR5nLk4ary6/gtJG7XWcWHaqta9fP/FnTO7Ub5fshu/XjrO0fuh3+vd319ULkoEt8qdNr9pvN6sxDNv5NLdek9clih1pyV8Ms7mjlv3o0t6YfrGFZnf5VvG5bJxbDwUXpvZQv6lcVXqd1p2slkn88WLqItO/eLo6NazTwXlNTqbzkZXC/6y6Dfb58WHNLPy9/O7pjUtVsyr51LnpVMk3Uyt5ZcrZXa/eC1X2oWb03qtNKw/mx2vNisn3Tsve3lcehi3zLSRW9Wc4fyinTkmbTP92ijc354seKlcuGMCG/mql3EuO8enzn0+e5yvtPp+oVcxq01uXRZbE8McTrI3TvEkbxRxbfhsdAvp59NLt/q6KHTnadYonRPhl59bN8/nYnj5as763d69l81dsNPbhjCNzPWjj/tp+nJfIs7Fw/iBv9wQ6/XOI5nMiXdUWtw56VnvOr8g6frL6r5s4cdJs17oJPuV0iI7bM5Nu0COb+zpQ3FkVe/4amLcFx6O8vwiP7qkuHw7vizXKtdGe1Ke2uSkyKuZ1ePjg2iN8PkwV39uueWjq9L1xe2i4F6fmv3nRqFuP1Nj/phxinbaXCYvL8qt3Oq4dXfpLkuVcea10xSl9qzZeS4Vuq1mhTWuX/PJZ/N42vUel85ja9HidbOMWfcx91jJ++2S07UrC89pn9v5XO9WZOzjWr+1GKW72Xptq3Kwoerkb0az+0Wl35vSJGkfH5cno3H2pDa7rVT6dWw3ccVNu8+Zl/Q4M65VXzP94+IwffowP0+f1ug8U2xmk5VC2ypMOpm72WuWpl/LnRe2WhWK6ezxfdNoz2nz+vKE1ZfVo+bFsFUVM14wvbo7ynXtanbau5+XZ/br4rQqurXM1W2peV7OU19cde+JUy9nlqf+rHxZe7ydmxOv2hzdHs9ezdOb6UvSMF/sDrm+u+LL1pWZGVlzetc9vbMLyVUmW/YeHNK4aOJ6xbtrXVmlaYOWeOuyP8nNlx376H5Zt+hNk4xfyKRuCbtbx7lrp5Pv963yZW51McVe+jbptpeVpbmid+b5cPHamDvp+mKYXdjixCHJ1uSm9TDv9S9OG8603zq+zBUeXqol2qjd325j/IZSli5marbT7LdPM8N2se+8uKTfwfMb/Dg6ZffkkpZ4unJ7XnrNZSujl8uX20LnCJca9qg9bRiG91y+esaUJenc945OTrxi79p+bSzuGpXKS/b6sbYon94mj+4eHu1a7+iiQb3Vrd95vXgg+aP2802yOry5TWe7/el57va8n3f5S944PjFOT123J6rdRaNBF53C9bGTOb6m/utxroKbz/Ok//JSK9bGq8XNcX+2vBi5uGQ8X3jX9NZf3Y5uX2bl2jTJMbuYLR5uyMoTN9Oun7Vv7UX7uNLOuvwxy1q09lzOM2HOksWTaq6TW1y/PjzUFifP81G/zx/6/HReOkoPrx+yD+naw23nxai8GqW68TJMe4xhMc7d9Y9q5jJvF9Lt1+YoWxPMYifzy/vidsbTDc1wdT108g33ftWhrxmP1yaXo/5dsmHWc8+3RyvHP3VH1/1lzr1tlMa2l67xh9dJr/5YvatVjebLgtjtm0LmlVeKGCdLs/Rl/+a88ty4eKyYFbs27eeKNydWPen4y9nQvng8b2Qy7nLVLjSPj++vOiTXadnt8eXisZ5f9bJHj8v57WXtoe6Zltm7PH9t5us4/9q9nBbv2r1tw/HFFud6TxC0N0joyGtQDnxBBon9TZ0gNHWAjsWVJoXWtVL69JSV4+ousR2Lr7QvgpmgFpHA6QHOzkjXgXIsA7q0oYNNkIk9DAf7nLjaZyKVvMAuMmCcyTIpdLdWSw1u25xZKzRICCptO2GFfaWeEGbAYxJaVPbjp7qgW7X+ZXxRjAu5ZiNXyS5rmdKkMPdHp94VyUwurl/vTvKk0PXFqd+6mLfvqlsnZXlsvKewLY8lffep4/SpDGuDSwIwz5hiyqL6W0TDke9ApVd2ch2t2bqs30ebEOhLu1Y+zhbSX7Xi86Z9eQMIHcPgnofmpUoWGhijlbRfS3mUUwhVsTEdMO1Mj1kQdRytIPmjJGFgdTbRXocYUls+gnaBuKP8UeErSiaVrVEV910rqLGPKtU2+lLv9lL3+dN0KnN6evT1zTgVVSllPX3zUrMtWFCwAtUogqhL6RGjLoQKRur9XLTlKr5clsNa9bXtn9q5/MXVzdDzSf749OrGue/nnfKq49HZw/NlvV8/xlsO4e8qvlw5Jr/IDa1UfnUXPZAGzq9hNT56JoYXsVxD2HmfjC7J6i2l3z9TDezY2uL9yTiLTTM4OOvAnA0+O23I1UX/Kd4W/tLoX35FJjd8iJLVMbpBBSkBRBhOHBiJOzLi4gDC+IN9oaQVFNeX4T2xHykLQkfE/G+hqBDgEbUjnSpBF9xgwb2HLcHDkFFpwQ3HsxYt8pa6J/YPIsHRUtTpC6MmRDoFZZ0wwSEcV9C/vIdLV50e0ICBYXijL9mDjU2C8BxT6fyAoCyQ3nvA3Z6I3QDD+067eturt6sVlQ5gWaqxMOlCm/fNAQtYEJXqBBtTqPBPET0v8ISkUDHwAUBqxfpOqd1861u7vJ7yMDobqICxDlhkSuLDPUAmh2kVHOiH+N12tdy8vq7eVKqVAxBbVPoTLQgaFsTwXbKexOWx8dZbCz3L4HQdzoaUCA6Foc6PCKwuQdCbnhpltlFRkG5EqugAY+HpADDdmBwNvBkwZRCS+ThhVFhc7LyRNs8Lb6jcgH+rDw58+Z8UCOC9D3z3xWjAVbC4AnEcRuJA41sHbxMPw7kv5bCmDERIGy+uiYB1t54zOHNAjqUiL1XMAHdnAi2IZSmTBjRwgDq3VyrqrrPAkwlxI/1r8fj9IMEXjLifGHITyskECviPOv+Cg1EHZwSDlk0GFrnNhrYyweEWNVafZH5LFg7Yr35tC36TnFGh89Iftxlm6bh0jo0VUp2HAhrkLIbcACBiRASa6q1tEtABZaYDdyeYBS54g1sWMTxxIEXwASgcUmAr3ptUGBa49yDjSXCGLaXmbWeD8IKQEpeoxEFgyhYXa5De0uLCS7Z12UhUiYpWCHQcmRoAQYoWXYtrFa6hRDlVx0CY3wAcgDJVZiZ7QuaEwD+oOCEyhxIF5EnhuM59fGcAEfGEx/JvpEpBnCcaEcKCfLAN1+cPNZMfsOnN4glZFfAoeAC/N33PQfRG0AnyXUuEJ74Rrud4UkUkZ0InBUFQIQR8/+TIogFlf6dg3EbJXx+hsI2Kvynozo3k3cbm5IdBYB8l8EZTgtTKXL+M5AnGcoghrsgBbe8ATcBhwV1kEovozFCVtxwqXXVPZYQxHUCmokOlA0atZXD/w+8PqNwqt2L8+DCC+fPc0Cp29FkszhnGB8L+p9mwfQBS7g3VsTjUOulwa6jFxhjaWmQ2ZVUZ6AAsLK4dDqBmduAW0PkKOmMk9EJZ+6WwDW5rocIYKPrx9vX0aW1aBvlZ1maZAdP6PhUBa4PmXfIshbaMNZGR63TC1o4QGbGmqfuQUe9I2+2seXMcRVoJ1EqV2+NKjTIZcaaszypgCmj++mSCsasLh5BHl4GNqY451PnKIlBBxtQiIqL360YFkZTJU1plFuhEa3BzBd1AnDSSDrfwtiNdhHoIqQFrtlTkj77UqpFsGaG6Kb0ZYOiC0vWHkarD6MYaMFAlwPkZic382cNSXcc+Hf3YDhLUtwZAxtW7MJkdGg+j8kNNQsdEGpipICP9OBayGMmbXQdKIh0neUOIjlLaTNaOhzSegdBQwfH1SphguT7De+06xDmaYQRjULoYSaveLB6UjRDxQRzmzwchCoM7n8ka6kA54Ib8T0wLjxiCwB2PDXD4wUIBHc3SEXmyn2BF7mExYIGeK9d1YMDKpXLxCFcwZuVPjk6/7m/O6IDB4pdhYyooWa5eSUUsTT1ulQQyMoqaZFb9m8qpf8+OtgkeQQyPu8PQoOt+6oDpyFqoHtYKbg3q5AguLDLVFak88OjFHbKfsWX4ljomW4L4Jmcrm/si0qaIxlx39bEUShuB8ICBBFI7HcKt2cQiG0bImLKswwa2smFGnSF48jUeQ3z0nRl1yuolgpIigPlQTwwXFO2NtJcALkQmNsFUgr15wHS6dmg4kugekI+8PShe0qUV/w/JUzeUt0Tq68BfQquvTnn15kcrSBWWAjCE94i2IIZh8tcTqryV0BG79oAF21BaisKcsWhzwd4MR65yr6RXgJo6xlxHu6MnB1N3QQXRWA/KC7EdRuF9pBPFAxlGC6ggbxFPEgfviiUd8x2AucBz2BY6auRatq/UOCkWAI8hSMqPlVSUhFereLNqV0XwLeR5sBWb5QwC2uVQ9lGHAE+iODGR3wE0C4C8REFNlsnFYpGEm2jSdy1tp39CgYlfW7Quut3WxgEwJdgkgHuzDRnm7A8lJkrEiJsr6FQaMzwynJHVEIA+zuC+vrZFdxVgAZhB1own8ay/J8YZURXVTGinVgC1sqfigyAuSBwgm49AqMGPACwDdiQoUjI0SY1puxTbthY/1rnfW3Bb1e0fLbZAtV4r4u+su+20f9Zr0CWuLXXQjgJ42mowlB3p6PA3FiovaEFDRA1YYKTaMEKgDZMVllLHxYbnYwu5xFLW3il1QFp6C6IzpcKUTZ2bG2suXsAwiOMJecgPWKC1xc2cW/ml7mWfTHi8wnBdkDXCnEf184c5jxZUVZ19PtsRhga5sEN1DRqGCvLP3Px6uhG5GIm5Vprf3AG33f5ivopgZUKTdWgyaEusoV3gTAgiGg/iMFJBWnaj3x2wL41+9yusHIot+irT2WXqnaRR6T6NfkfJ1jCLgkYS4+ja1PWGHg1M5btMu3UwtcWASfdqr1tLFkKJKUWQuldHNK5NHCmk72wyl2fLOvq+NsZsLpq3Ru3v3zcPrI8MDcE0SrSrqG9SGY6WSYWDg60WHOk3Mrs/IQtHblRSy8+mMzu4rB1c1g4uaweXtYPL2sFl7eCydnBZO7isHVzWDi5rB5e1g8vawWXt4LJ2cFk7uKwdXNYOLmsHl7WDy9rBZe3gsnZwWTu4rB1c1g4uaweXtYPL2sFl7eCydnBZO7isHVzWDi5rB5e1g8vawWXt4LJ2cFk7uKwdXNYOLmsHl7WDy9rBZe3gsnZwWTu4rB1c1g4uaweXtYPL2sFl7eCydnBZO7isHVzWDi5rB5e1g8vawWXt4LJ2cFk7uKwdXNYOLmsHl7WDy9rBZe3gsnZwWTu4rB1c1s/DZXFpAdDlvx8kjtLp3wFsVXVd7r5JhSHy6buF3wb2wouhSUb+lqUma6EKvET1dbK2AjCChJXAHwaHgUnmyObmdudK0E2k9fc6Wz97t50p3abYqQYuKJPJ2RfE0kqdygaPpm7KVlR2Y/xG0J2S6J3rKkj31ybY7cqwhz1fyJSvtzTJ07EjS8jLWbS3o3TmE8n4HziT5TCUWWnbcithM5QOijfBvlFJxFrX2i3A3QL8cxZgReczby4+aBFPBMRdAKobhFkAHOAqCVYCCV6VHPnGDIBBEtOV6eKk0gGTFl8koCwMtSMHAY18S1iYTYB5K4d0ZP+Jg4SFR8RKnCX+h7urQyOQ0YL7riGHZ8O1B30bMIQQalLTKDr0QP0qR7HG9LNmRHYP2Hd1zftnpPF//gsmHW6O3gZ62q+IkUW80b39fwVlsUPrOidBl9TE7MVa2ZfNW5ChEKHkLEbXv9Dh4WchGdfEfkNqAR2o4LDv6FdAVqMxylIKMAIo0x2o9vcUc3iMOfv/Snw/CCflnEcmQ+nu0XlwsDEDBzL4qYAmPS97AzbwBkoyLT0I8IefYzv8Lxfqf9whDDtUa4yDxIR6U38kUcLWc5OccCi9Dx2MfWbI3vb2YfYHXpR4dPYr+u9Yk6kbsojyeG8fHR7GuI5++9CDsMn0gRdfHWe/ojcdbqwVqIQduibxTYViq67Jiy8aqAl62QFyD0DoQOWwpZRcaK16qvzO5GrupwDuaeJyn5l7+/upGDeizNtPVZfE8D2iKIbUeNdF//UrYtRSrB54Y9tL1RyXMm+8x0Wq45nEdQ8gwUHKCOUQwpYFGtrTD+h7ejpD/5gPBmyQkIPb/0EXNd+y1HU1UFUj9VXt7/DX4eFal5Xb/Ok9As42xMK2zrnvQefteIs/GlqUMiKc/QH7Ht1UrZU3ledTsLFAer4r5Li7GgZmUtn9+kEKDkxLpLi8/maHAWaAqhgf3WZVF5a1Lll0aHUJdzN5OsuSjmRDUED9gg3wC6pEAQ8B7hJOOWVYwZYKV1AnhzQVBAiAgPajVmHKcbl0MQFQKHaogO0ODXcI2QCKdFYq+io0PUMc1trmFd+Ka+SPlBSOMRkeGXh8eyoRKIfxKxokPktuII+A7ipT0Qh6w2kbLQuT1YLbJQAxBhMpy0SIKgbbekMEyGBTh+piZ4raXxSoD3m/EyyEKgp16fqAivQYnFPr1vf1cRBfTPFKcVn6y+8RpdCX5670mNS42tqnFXe36jufvjp/0Me6KRhVKAZ+jbFBn4ZDUF6GpmpMj28vPvb9dXty/e8NtIan2wXvhuJi8v+83+iZlATRtlRjURL1WyI3IQr3Isw+OXtLxbpATOR+hhj0DyHpQf9AZD/xXSpvkEgAYL2gf0a0MLg8BLGGYNR955zZh0uEBNSQ2pyCrovflkMdtBl/+gfhUcMolCGhu6UbgGvhm4N599D0lpGD8G8dmYQP+uHQHHWWbJ2rrUv8nUHFFv72Ye1Ff6Rsc/8vmsG3/cIdhCw9SEXkTI1jRlYQVL79InKQkB6RbRcSOJaDuuE+CMvv9sNuP/xH7AeoEHjiZAioHJU3TZwlNAT7YRAvAiqminmRA/ZdKwLk/E1rO0Nh+ZPvW3WfQ7k9FEp3AC0TVon7Adda1BvWPEj0fHeFbogHkceopVpB0EoKPXBfuoLGVGJhBu6qL9Ea4ADmFvm6FxBvqAcSgF5MDwPiDzXO5uGEeEnhAZSouZ/STJNx8NRbdaTjXo5H+SsD05l0/GoPpl4E0J/E35Xx5vGS6tGbomoOoKj8HIE01kVdf2Vt/ok97MWmRoqulElsHgxQTyz8ndDhH7JlPh5blEmkBx2sEayuN/EVOvgxACPfwxbFymT/pFvRsYlPsLrjj36+fWjCIQzQIhLtENTtTSiOjrgJvXyf5IOKnoxavBTTgf3uKhL9uCXPjGvIBEjTC/yCK+4jRiQea3zhgY49I6v1wnvz1QMDUGUdTxwG8dqx7x7I9LofLxl31YeQfIjCKToUcpV+lm4V0y/DeCwyJ9ZfPwzIzBA88KaCrKsG9st3P4Gxjp3d/tmGL0GBr1EI/9+PRf+zCPMROn8CDP4Ttd6LSF5X/RTEugpafg8kfN3Yz6Jxv6kp9/PmQ32Qbj4OMKPfeRGDWE7HoYwjVULA321AulF43EQ2nT1Kpk+S2dNu5vjsOHOWLaTSJ5nHxL8DU7um4OcQZT9V78ez/jmcVjXt7yKMrpuLgVhGN9Xn0AzXDf0YeHBdNsAIVKB/XzQUXQioJvHTQtA0cweMtgNG+48CRgMctP8w8DPAOvsPAziLgJjNPgIqk7hk2+CiJDqURitiO0SiHSLRfxQikbNDHfrzUIdedshCfx6yEAAJ/YehB0mwIA2Bs/xpmBuJahPVrVc/CX3y/WsMZiSqSH8O8GBdY41NsH4WQQ5Y5/GvX0dz6qNP300xjw5149WP85p/Ilt5TcwnE4s/rvDju9cH6brvFNp+df0oS/RtqW1MjaffRd/pBLAfZ0a9kwi17j+eIqRulFvTc/SrWDZMJPf5g3yRd5JEfhjWH239zaaIBop/dPX/OGY7Ep0HhYIgS2xIH5D8rg8UUnEI/6OMkKBIKosHmNU66l3iTVDdL6jOPJebvqH81RUdi698AgHUjE6akJ/WgDwkvajmRFrMi626SKFi/AU8DNOZJPKnXKOA36JzxiSmD2oFABLRTPEUaqkeZSsSMIcLLwA4pQyNXL4QKrJiwH75BXUqlwLymKgIIS8imQM6DkHEAzxldtva/KiCxsMO10WxkM2HceNjgOtdgDEZwmd8PCFC5u78hq70b+0d/w1V+IJZHJvQAPp3/kAT0Qn5g/78BtQmY3/Q5oOf//MHNLG9WaC2gl0vxpgvjj9KmWS+NhfrB4c6CFAcrgNF9rfy9ku7WqxcV9ctbIT7CXN2OLL46NDG4KjS4X9C/3toYtc7VE2A1yvK29RNtRvvivkT4oFBMG7eDh+vqW66q5TypR3u/5HUco+RN/RKaqsWXVI32tWULFOOve5K/f4sZ/8AaokkaSu153yzq3XT73YXRm7+KSthwt+uA01tA89xvCsbzwmLrwRBsGtMU+GbQwzgUtjwDsUUPCCH64C8/d9P7TOe43fWLVCrogvCdevYzyLOWrlug8fBmjiMBC/v/5G8lXqFJClK8ya1e304VMbEM6b7/y7ZSV39TyFeNR4bAoIxtC5aG0tRUUbFhrSIPY7txA2u/26inamzZTlLjqtI0Ri1K4duEKqfBP7uyOI9fLv7fj+1kqStkqLtj1bxrlx/tJoQW8Qpjj49hP/E9tsfSi109c7ea/ti44QzwAMpUpRHQgqCR/p/71L6B1Ertp9wcHujBmEKuDZQNB0JV5JNgU0oHsYBew/L15LHuq44vKqXqzedajKbSqemnm1JFzskiDbHOsEUAkY8LiJpIoHKCWEfxBVKj7WAGV6AN2ZrvCRF1+8M4twMFYlkOCW6MUf3iECWsEAWnZF10v5aJza4D6G5Dqgye086XisSO/O0Lz9sANAA2FEfgx2jMTbWUGRKK4ZkGpcRD6n7rPzWkxmDUKLwFWRrnNQ5tgomCVyStsx6lqpvLMhhwD6KDWq53OMGtwKsAqI+ewRO/eAzduqTeeuP5sbiplGMT/IbGiYVqsIo/N6VpFKPImhuJL9jFeEjd6XO37IIFgSSmTQ4TZCGuRl4ALq8THmSucfhRzqAxs1MdaYV/FhGu1Cwj8H3ucJ0VP352PDryfrT0+uvRz69f9lUSfHbUv0RfK5qW7J9KsRp2CA6oEdFZ60nIAwKhqUBjJAFJWIvCZkRogNRD8EOchFnqQHru1Tn0etvGJt8wWRDM0IcKAxYoYspcQEbdBxNkYOAcwhWpzJaRgqBbzrw60sQ/xLYJYgLRgIIdYeX374BlHDPtb5/h8fye42Jsy9f18Fd8Ov7QUKBEkSCLMs6zVaGpq1DK98kH65DK4sy8fvDstH4tVaz04UgB4iMO/uWsGVsVMLFkD4Gf58lZCCRp4I/v6lnKrsCroMaqBcCvL5//38J84ro +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint behaves like the administrative counterpart (`createOAuth2Client`) but is capable of facing the public internet +directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature +needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. + +Please note that using this endpoint you are not able to choose the `client_secret` nor the `client_id` as those values will be +server generated when specifying `token_endpoint_auth_method` as `client_secret_basic` or `client_secret_post`. + +The `client_secret` will be returned in the response and you will not be able to retrieve it later on. Write the secret down and +keep it somewhere safe. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-organization-onboarding-portal-link.ParamsDetails.json b/docs/reference/openapi/create-organization-onboarding-portal-link.ParamsDetails.json new file mode 100644 index 0000000000..4069711adf --- /dev/null +++ b/docs/reference/openapi/create-organization-onboarding-portal-link.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Organization ID\n\nThe Organization's ID.", + "in": "path", + "name": "organization_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-organization-onboarding-portal-link.RequestSchema.json b/docs/reference/openapi/create-organization-onboarding-portal-link.RequestSchema.json new file mode 100644 index 0000000000..b67ce7e7e4 --- /dev/null +++ b/docs/reference/openapi/create-organization-onboarding-portal-link.RequestSchema.json @@ -0,0 +1,96 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "apple_mapper_url": { + "description": "AppleMapper specifies the JSONNet code snippet which uses Apple's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "auth0_mapper_url": { + "description": "Auth0Mapper specifies the JSONNet code snippet which uses Auth0's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "custom_hostname_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "enable_scim": { + "description": "Feature flag to enable SCIM configuration", + "type": "boolean" + }, + "enable_sso": { + "description": "Feature flag to enable SSO configuration", + "type": "boolean" + }, + "expires_at": { + "format": "date-time", + "type": "string", + "title": "Time" + }, + "facebook_mapper_url": { + "description": "FacebookMapper specifies the JSONNet code snippet which uses Facebook's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "generic_oidc_mapper_url": { + "description": "GenericOIDCMapper specifies the JSONNet code snippet which uses the OIDC Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "github_mapper_url": { + "description": "GithubMapper specifies the JSONNet code snippet which uses GitHub's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "gitlab_mapper_url": { + "description": "GitLabMapper specifies the JSONNet code snippet which uses GitLab's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "google_mapper_url": { + "description": "GoogleMapper specifies the JSONNet code snippet which uses Google's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "microsoft_mapper_url": { + "description": "MicrosoftMapper specifies the JSONNet code snippet which uses Microsoft's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "netid_mapper_url": { + "description": "NetIDMapper specifies the JSONNet code snippet which uses NetID's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "proxy_acs_url": { + "description": "Proxy ACS URL if overriding with a customer-controlled URL", + "type": "string" + }, + "proxy_oidc_redirect_url": { + "description": "Proxy OIDC Redirect URL if overriding with a customer-controlled URL", + "type": "string" + }, + "proxy_saml_audience_override": { + "description": "SAML Audience Override if overriding with a customer-controlled one", + "type": "string" + }, + "proxy_scim_server_url": { + "description": "Proxy SCIM Server URL if overriding with a customer-controlled URL", + "type": "string" + }, + "saml_mapper_url": { + "description": "SAMLMapper specifies the JSONNet code snippet which uses the SAML Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "scim_mapper_url": { + "description": "SCIMMapper specifies the JSONNet code snippet which uses the SCIM Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + } + }, + "required": ["enable_sso", "enable_scim"], + "type": "object", + "title": "createOrganizationOnboardingPortalLinkBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-organization-onboarding-portal-link.StatusCodes.json b/docs/reference/openapi/create-organization-onboarding-portal-link.StatusCodes.json new file mode 100644 index 0000000000..4646f2334d --- /dev/null +++ b/docs/reference/openapi/create-organization-onboarding-portal-link.StatusCodes.json @@ -0,0 +1,186 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "apple_mapper_url": { + "description": "AppleMapper specifies the JSONNet code snippet which uses Apple's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "auth0_mapper_url": { + "description": "Auth0Mapper specifies the JSONNet code snippet which uses Auth0's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "created_at": { + "description": "The onboarding portal link's creation date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "custom_hostname_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "enable_scim": { + "description": "Feature flag to enable SCIM configuration", + "type": "boolean" + }, + "enable_sso": { + "description": "Feature flag to enable SSO configuration", + "type": "boolean" + }, + "expires_at": { + "description": "The onboarding portal link's expiry date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "facebook_mapper_url": { + "description": "FacebookMapper specifies the JSONNet code snippet which uses Facebook's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "generic_oidc_mapper_url": { + "description": "GenericOIDCMapper specifies the JSONNet code snippet which uses the OIDC Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "github_mapper_url": { + "description": "GithubMapper specifies the JSONNet code snippet which uses GitHub's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "gitlab_mapper_url": { + "description": "GitLabMapper specifies the JSONNet code snippet which uses GitLab's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "google_mapper_url": { + "description": "GoogleMapper specifies the JSONNet code snippet which uses Google's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "id": { + "description": "The onboarding portal link's ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "microsoft_mapper_url": { + "description": "MicrosoftMapper specifies the JSONNet code snippet which uses Microsoft's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "netid_mapper_url": { + "description": "NetIDMapper specifies the JSONNet code snippet which uses NetID's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "organization_id": { + "description": "The onboarding portal link's organization ID", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "project_id": { + "description": "The onboarding portal link's project ID", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "proxy_acs_url": { + "description": "Proxy ACS URL if overriding with a customer-controlled URL", + "type": "string" + }, + "proxy_oidc_redirect_url": { + "description": "Proxy OIDC Redirect URL if overriding with a customer-controlled URL", + "type": "string" + }, + "proxy_saml_audience_override": { + "description": "SAML Audience Override if overriding with a customer-controlled one", + "type": "string" + }, + "proxy_scim_server_url": { + "description": "Proxy SCIM Server URL if overriding with a customer-controlled URL", + "type": "string" + }, + "saml_mapper_url": { + "description": "SAMLMapper specifies the JSONNet code snippet which uses the SAML Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "scim_mapper_url": { + "description": "SCIMMapper specifies the JSONNet code snippet which uses the SCIM Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "value": { + "description": "The onboarding portal link's value", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "id", + "value", + "project_id", + "organization_id", + "expires_at" + ], + "type": "object", + "title": "onboardingPortalLink" + } + } + }, + "description": "onboardingPortalLink" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-organization-onboarding-portal-link.api.mdx b/docs/reference/openapi/create-organization-onboarding-portal-link.api.mdx new file mode 100644 index 0000000000..d88bd30444 --- /dev/null +++ b/docs/reference/openapi/create-organization-onboarding-portal-link.api.mdx @@ -0,0 +1,41 @@ +--- +id: create-organization-onboarding-portal-link +title: "Create organization onboarding portal link" +description: "Create a onboarding portal link for an organization." +sidebar_label: "Create organization onboarding portal link" +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2ziS/is4pqYibUmU483c3mkqV6uxPRntJLbPdmqrLnIpENmSMCYBDgBa1jn671cNgG8iZUuKsnMf7A+2hZfGg0YD/YKGHr0QVCBZopngXt87kUA1EEoEnwgqQ8ZnJBFS04hEjN+RqZCEciLkjHL2vxR7+V7HEwlI82EYen0vMEQuSm0ucmqXhtgHxu+8jpdQSWPQIJXX//y4BuVSit8h0GR4OuIjfjMHktiS14oMT3FUhs0Squdex+M0Bvxkm4xZ6HU8CX+kTELo9bVMoeOpYA4x9fqPnl4m2FppyfjMW60664OXwZcQlIufglHmz65Ybm1jUPpnES6xRSC4Bq7xX5okEQsM3d7vCqE+lkglEhdCM1BZWxjHNElAjlMZYVl1lgNs8dE0ICqBgE0ZKKLnQP5xfXF+DpoEIgSiOEsS0GQxZ8GcpAoUMT1fqxFPpJiyCAjjUyFjyy8tyHwZShQkpMVC4Jrp5WtFQqopsmxtzh2Ppnp+9DRWbLEfVux5QKxBqrSIx3OhNC43rm//0bMkvb6Xpix8i6KQRhGdRJCteJVOx9NMY6V3nkbRp0/DUyQNHHuMVcDiOgd+AapTCWQa0Rnito3J9cnwIwkEn7JZajdhAXoiRASUl0krsT3l64ttCD8kTIIaU11hQ0g1dDWLocbCYuo3WL3qeFMawESIuycF4BfXaC8ZyDofUAxmwEGyYCxYGDwJ/L1teDE8PdkLO7bBzuRSinsWgjzkJJiep5On4ZsmeyF/z/Sv6eSwcCP6LNwPdG+4H+hB4Qoxe+YIfm+a7AfXdD0g3JgFUigx1U8i/pi12gt03vuAuDloFj6J+Rz08HQvvKbnAbEmUjwsxzRQzUAvsZoMTq7Jp6sPhE2JuAcpmbHDFkzPCSVW/YDsolkgRRRBiI03D2YOKAkhk2gZPTGsOWSuXMMDAlA0jsY0DRnwAMaOINRRXA8+fiAD145cuHbbgxC8rmwKEAGLxwrk/SYZsTww2vTaNDsIB8zcnxJNnPTeasFw7DuoBcOsJ1GfDD/ujxp5fHDUq7KR/bls71Ttqtu8p5igr1CyR7ZzXIxZvsLxHrpCshnjNLpET+bcGv+2HtGoRHBljfHjozcvpvz/P1PeLHjobNcqSvT3mr3g14qYjjgomrlep9nslUDDCx4tmz2AF0/iaU9ih9UwHZffthYvPsiLD/Lig/zpPog9AnfY+zYGVzkzt9nuL77O9/d11qOguy2sqIZg91nkUjR4t7GTPPa857AvPt6Lj/fi430H1Pc0ShvE6sndbPs8u3HXHEiz17OulXul+u1OyXJ9wr0UTbdgxpGsTqa5Hbaa0jTSO/mRdTYpTXlIZUgu5NIsJRlcDglIKSSxS+PbCZf8T1NbJ3dmOmV+bq1XCJN0Vu91isXoDmjKuCKmVVksfHIzZ4owRVKV0ihaEi40ofeUGS+IUB6SOVUoPRNwHkbom1WgcWIvFuZgRGhCFRAa0kSDJAuqSGr9ES3IlPHQSB1EECMrG4Rtw7TRz0d4prdhAXpvdQTuGg9CZJFIZQAkEGkUmvlMgExFysON444rg9aZmH8qWDlNpZ6DrOwx3GZzINz6ZWJaoK4CvjDSak+/4Sl5c/zXtz+SUIAyaOGBqUYWNanW4Slyh5KUsz/SjEXDU3/Ep9Y9HHOhx8WCnknp/MZzoQdZ8Yj/kQpNx/AQAIQQYrP/xpIzV2DiOmmMe7WRrtfxqhRKezP3nR+6M9FFMl2cg9dvJrU3RLQ0QSk6azizPtqKYvkKeXJ9ms9tTXWqxnj41mme4JEsIZGggOsySdvNntmtt0dvO+Tt0V/x15sO8X2/XZEGrC/sHsb1v78toDCuYQbSHJibjjrnmJoD4sSdVbUIndldt0Wn/DCy58pVca5Uh2k4Mg0t5+SagRQEqWR6aRILhFz+U8g7ldAABgn7DbD4Fm/arbHQlH5gr/uXaBQvhLwjzgwgSUQ5GJRW45ljCkI8UmLKcT2XIpWVrk55KHNyLTIgCjluFK831zpR/V6PJswPBFciAl/Ipa/mHoLUdIYIMyWELMPI47KLmjNiMdPdSRrcAa7VhAZ3YjplAXRpGDPejcTCiDku/LVZXjvbiPIZTnOZwLWZttfxIjoBxPN3IZe9IGL2WLRHFy58jHqVPI44IYS4/IxBwjq24KQc4MnKto6ojviKTKWIyevS6K9/wswLZImuxo/IO8JhUR2y1f4pa0sTNuSo6AJwLQu0rQqhthkhAp2t0jDsE7vZfiK9XpGEQkgpBWU0sp4naTmdjMuf8hCmjEPYtgTLZkKV6lp2iSVdLtyK/vbR6v4O64D4SEuYbUCjdsH/R3eEdIxmJSvyjtAFZRVm+9thalnhyDnuhKXKMFe4/SxHvP2Th6k8TrTfi5JIc6rZPZSlOaHBHW7XmDKOs3TS3RrxkR5ZA+tBjzz7cRrn/wpl/xMJcJowK6hk5MJYfiDiXiHA3ZnA1oaN05QHZrRWG/fQSOfzJ/13ZOTlH8fuHB55uBZWbMhXskEWraQYRBX+WaLVsg2Un5XHYoztlwPH/0uFSf45LLYXxNaURgo6xPxpI97t+5KvZE2GR7p6fvTfkTq26mmCnWjCTuwCN3UYXA5t7dqZgj3RKu4Q2UH1i51zSn52FF0O/e1m1HLC6P9Mg7uZRKux1e6Uts/azmlvSddwefsFbftnDxCkGixr2NRM7d/eEc4iK9AjPY21/0siGdfTllD+tQ5Byg4ZOVdhMQdOAhpFKHdfdmbEly998sP9aMRHnuFr+5lBf0mjiPx6c3OZ+yil/rb3Cn/1enkDq4O+bImnT5qKkWQdk0g1YrqqDrQ7D8pTAJW0R3xVPvUul3pu7leykw8NhY26XMjl2FaOuAFUFPixCCFS7kgfV5zewkMdW1d7jK72eIJbz1HeRfNvGLl5lGyAZs6vk5KgdNZjkDA0zM2x4FomZomyBvYTHhevyCnqWhRTNKHxhg4tvexIMZacU83GEc0suCSiS7tD/czqQ0uOJkyhZkDC1wBVW8ZPljavlkRMaXTRaBQRlSaICcI1w6fImfWNZq7YRKWJVw8zq0vNNFArbAs3U12vjEZwqi5OS9aYjdzgnS/GbmwYwnAHi4TMlEqBGokxTmgQCBkaA824nEgFjWprkJPMfCeJiFiw9LHXmdVdyjALaDA3Y5AY9FyEhEqjETHeFJIJRGLRQcPcekC2J9FzqpGSopopE84ytrohg20DqsC38z3J5/czUAmyOp8+qbsUO68GDQJQaqzFHZjWygd+z6Tgn0fez2eDq7Or8c3Fb2fnI+82X4YzjpEMSpxGcMFKTlhm7ToHH1mZ7WvTpoRlkGmiNa1FqEIt5Zr1LchXJEsJ3zQIVcrNJ2FjVljdpRFLxncxQLtiBI5ZSN6R18WnzFR5TV6hofK8/bNuQTqKa0V1slsbP4U1uv1hWBWC7bVyO2f8fuYOYtVy6RaxspCVe5XmmGnRC5crV43vKku8g2JoFcvaWV+jzq48fbdj+3YxG3O8t0YuOOdmJaYl57D7X9tT7xstXCZv6Zd55mrBqB2Sax/catCvAysaVCylPfGRH5SBSH4g0DaRhIeuCu+6oQhMfLbk+2PMmM1skHDrRKhWO3vDYUMK7vHDDllUeWRne1n31kM/tccVaAxVn4MM61HWdSrPOPpPDVI1vp8daWvnvz6meRqiU8lv7AiNz2rMnf/6gm7raOiHkpXfuLrfzNJ/PUOfH/HPFFnj3269tIk17xv361ZH8ZOram+zCnZ/nzV9dpSDrejWSmKfZW1t39SPw3Ztlp8zjX27305vNRWakVYmmU4DV0xwu853GPPeFDbOr1Wbw8fI1qx/rj9KV7EveuRFj7zokT9bZF/0yIseObgeQQI2wIKLK0wOgHnq3Pd6WcSo91is+qpX5pTqPa6t16pXMK9rmddF5qE+yWI+15i8YjNIJlSxIE9osQoKS3IuYyALxXligjTVlrao1lRgJOfYJNpHYmGfV5RjOyfuYr1S+KlyT2uSlvwQYuGuaXuWaA9/40wCkdgJiOk0YhyHHxBTSrIFsh6eSxFBJ0/CVIKaExMPUqRFI0ZtrOuLozK2EaMvKALVot3p20f7HNM3vCvbCEM8Fwnw4SlGv7jbnjfYHPlm+m3JB207lRIELNNNUuhyYDBbwvUUJeHCdkwR4GEiMD67FCnhACFC/Fy+WscQ1B0sb1sZpMViYbDgNRzaKb1AcPSpVS8BqXCXdC3LugajSXt4XmQa8gd2xF3c+3cjuIfoXz+NVcfD9LCr4rsFzrJ0j6YHRoWWrD/oKeqaXrAUtZVHKDbnrvx4xJWUXn14x0fHb7tHf+se/+fNmx/7P77pH/+Hf/S3N//jbXigUYy18SlEqUn9oUGlcj2tv1RZT6IvKptTyYv6esp2UbeWKrxe0ZDWu95kU+Jtrd16bmzRoJa/WqpaTxItp37xqchyEWlgbH+IKTON7OXF310SS/69GCjn17bOq+XwvCJDTLEJ08Be0JyKIMXMPKu+zQ1JFJEknUQssFcM6KEwpaW52zcpN4PLofLJoFqBhSTAry3h0RIT7+zWgdDFxilmiLKQXLqtRewBZY8+n1zaEQ0VvGWIhdLR0mb9ME4mUiyUvY4Z8VevyPXpbwq/LYQpEroZEDvRicuNtZTy3DJmM/RK54FvDJV8wFLqozLkDTOwz1REkVjg6Y63fymdgeojjK/kg/vsAoxfyalY8EjQEAmQfX6QRHlBDvTzFdF2Kz9kvWD3nwOQaCaLaE+p1BXGfE7SiR/CfXF+u4KeSzJRveIaoN3I289XZ4PTj2cFhbV0EhXe9SaRmPRiqjRIl16i3N9eSKXuWRJouZV565+f3VSH4ukMtC/krKpv8uIC9YVc+vauqNc+JFqhOdTwGrRnEXtgsjzUHB78JC6Gsp+35ewB0IKB1Ij2vVgfqiC9cbg8M+i7SMJM1OXAof0HvafVoWJ6D7wqCQqoDOZ+XtOjUrMpDXRPzdEk6RX5BO1vR/s7vacb5BbR2qhSLrdJ/LuqstbIbVacyUSvlEHYPiRv0Z6yGquMeR1t65+oVKagg3l7X9hd1/27gLfEK1MgOIfLXy/XRNEiY2rttKgUV3biGte/GXQyTxrE2XDcJrpU0C4TtgbUlWS+akl4e/Xd9+1oDaTGk+IqnSyrQ8l0spxBrKqIy6U9/Key3w6KFofasPeuMMWjMlSAQWPlM1GMlhe5/zYiPRBa1azhMNWJBYCJ4v08bDNIaDAHcuwf1ZKsce9RU2147Pqq3ofhydn59Vn32D/y5zqOjM8LMlYXU3wrxkzaVE8LVUpzz0xOjIaDVNaOjZAZxr7FgElMeQnX9nfw62Ge0puffb+lz7mDmDiCmT/MuPXu6ZcN6uQ55jij/sZHT6a2HonbFNq57XjoICL5x0d8kvNJRqsVFv+RgjS5+HibIJn9kgNMxWfKvOpxUc0nWNG6cvGONnn+CwMbGeAKKV+W7kG8jrvxKPHAfEvgPsB2+TLBPSCuL8TqdtXx5kBDDIjlVz/uFUbXBAILKrXXY8VlD3pBiX6ybTk6eHlxfeN1vIn70sLYhNE8SfH5Af42iG2o0oTGTJlNW0zN+xjP0ly57xApfTdiHtDIwnyfH5t58vhoWxjPbbXKWeTiUber1er/AIKKQlw= +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Create a onboarding portal link for an organization. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-organization.ParamsDetails.json b/docs/reference/openapi/create-organization.ParamsDetails.json new file mode 100644 index 0000000000..6d2900b86b --- /dev/null +++ b/docs/reference/openapi/create-organization.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-organization.RequestSchema.json b/docs/reference/openapi/create-organization.RequestSchema.json new file mode 100644 index 0000000000..9097b7623c --- /dev/null +++ b/docs/reference/openapi/create-organization.RequestSchema.json @@ -0,0 +1,41 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create B2B SSO Organization Request Body", + "properties": { + "default_region": { + "description": "DefaultRegion is the default Ory region for identities provisioned\ninto this organization via JIT. Must be inside the project's home\nregion.\n\nEmpty (or omitted) means the organization has no default region:\neach identity provisioned via JIT is then homed in the gateway\nregion of the request that created it, constrained by the project's\nhome region. On update, an empty string clears the value.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "domains": { + "description": "Domains contains the list of organization's domains.", + "items": { "type": "string" }, + "type": "array" + }, + "label": { + "description": "Label contains the organization's label.", + "type": "string" + } + }, + "type": "object", + "title": "OrganizationBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-organization.StatusCodes.json b/docs/reference/openapi/create-organization.StatusCodes.json new file mode 100644 index 0000000000..0c8c1ecefc --- /dev/null +++ b/docs/reference/openapi/create-organization.StatusCodes.json @@ -0,0 +1,261 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "B2B SSO Organization", + "properties": { + "created_at": { "format": "date-time", "type": "string" }, + "default_region": { + "description": "DefaultRegion sets the default region for identities provisioned into\nthis organization, when the identity does not specify a region explictly.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "domains": { + "description": "The list of organization's domains.", + "items": { "type": "string" }, + "type": "array" + }, + "id": { + "description": "The organization's ID.", + "format": "uuid", + "type": "string" + }, + "label": { + "description": "The organization's human-readable label.", + "type": "string" + } + }, + "required": ["id", "label", "domains", "created_at"], + "type": "object", + "title": "organization" + } + } + }, + "description": "organization" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-organization.api.mdx b/docs/reference/openapi/create-organization.api.mdx new file mode 100644 index 0000000000..01019ebdf7 --- /dev/null +++ b/docs/reference/openapi/create-organization.api.mdx @@ -0,0 +1,39 @@ +--- +id: create-organization +title: "Create an Enterprise SSO Organization" +description: "Deprecated: use setProject or patchProjectWithRevision instead" +sidebar_label: "Create an Enterprise SSO Organization" +hide_title: true +hide_table_of_contents: true +api: eJztXG1z27gR/itbem4idSgql0s7U92kU8fW3flebNd25j6YHgUiVxLOJMADQMuqo//eWYDvlJ2k8bX9oHxIRBDYNwAPFrvLPHgx6kjxzHApvIl3jJnCiBmMJ5BrBI3mXMnfMDIgFWTMRKvi+VduVhd4xzWXArjQBlkcilAcKWQGNTABU2FQZYprhMvLMzhTSyb4v5hxI4BB5kgFnu/JDJV9cxJ7Ey+yRJoDPN/LmGIpGlTam1w/dAQvpTw5JiGuVlgSf6Hh5Jg4cOqWMbPyfE+wFOnJdZnx2PM9hb/nXGHsTYzK0fd0tMKUeZMHz2wy6q2N4mLpbbc3rjNq81bGG+oRSWFQGPrJsizhkZV5/Jsm2R4apNpCO1vB21dv+wa6cBzAsvBJ1AyV4agdmQXLEzNTuOSORXca7fsL+xq4BrNCKAbBmdqAGwgLqYDHKAwnymQyN6EYh4ILI8GsuAbZlOuOM/jx5CqAX3JtYI409zxGy6E2+UqmGArHJaAZmaaZ2cBAKpApNwbjIaTIhJOsxWDFNAhZSetoTEKBLFqVwm6aopYiFXoKyzymFUa0l8zgmm1KYUAubHMxgWBWzIBbbjFw40MkhTaKcSI837TVCgWRLkQK4ExAnsXMoE+rHa2GbpFAlCBTTrk7luQYhALzUYTCKJbA9N2R+xUKpjkbCanMCpk2cKg5O6WnKdMmFLke2eZ3l9XzGu3zr0jPmMP0nSNih1IPeHcZimUi5yyB7+0/nu+hyFNvcu3VQni+1+bt+V7Bzv0iRjQyL3raVs/3HGnvxu/sC9+7Hy3liDiNaDV6E+9/qPLW92KZMi70jt3hXtBUG/uDpinh2tDiaK7FFxoKIhZADKZ6Bx5UhmBKsQ09J2yOSZ/vz9Tc5trhZgcSry7kVC1yTkuRenCTUEMTNCxWbKn3/UgqvuSCJeeEmqcO79x7Qi+dSaEdlrx6+fUXQNgu7OrBVbG/ZsySX0iV0i+Pts7I8BT7CvufCXEaTRvkPgpwQPgWih7A+bAmDCFaFdjEEgmTDOgMI77YACvp4z2ZyiSb/Qb/P9rgV8+8n3m8m0eHtvMzquWd59av6FF/BB12EFzlKRMjhSxm8wSfQofaebn2LFfHpLaR39yEN4/DSVMCByVtKdvvfe/1y5dfgB6kszZMxEzF1i/58fLsFA7PTwCVkgqcLYMeoNi3fXJTO6hEtx1e0zxf7kKSeb6sYdn2Ai4cb3vQXxFIcA25zlmSbCwUsDvGEzstTMTWaTGS3CEU1BiTzHjP0sxalfSMmWFzphFYzDKDCtZMQ25709AFF7FFHUwwJVPuWDmPqE3oXjp5zm7k3/YlKHwejMlEMlcRQiTzJLb6zBEWMhc7V6wlOmsx7RuxeqpNucgJA1TTmCAdtgpmcoWlN2YZtAU+sysT1tys4OQYvn71zeu/1ECM91zvNNGurXpyTNZhkAv+e16a6OQ4CMUCrRgzIc2sntCpUt+5F6fSHJbNofg9l4bN8D5CjDGmbv+klmnR0EDhnXQ932tT+CSIfV4Rt76XotZsiX0z/eJetB0UZ6xizA7s8T1tmMn1LJLxDppHMqZ1lynUKEyTpBsGNAwGr1++9uH1y2/or699CIJg2FoN9L4GVi7MX1/XonBhcInqSS9piQIVjyxAHBVY1cVNt7tu6kEVGDlcuahxpc1mB0xaWt87pg4mv9nD5B4m9zC5h8k9TD4Fk3/bw+QeJvcwuYfJPUw+DpNFkGsPlXuo3EPlHir3UPkYVJKVMMoVNxubM5Zq86tUtzpjER5m/Cek5htK6GpUd7szy7SBCSFP0aylurWzpGQCWcIEWinXK06pSYIpjAlSUiZoPjcyV62hRSJRW+Ral4LYYHSuEm/irYzJ9GQ8ZhkPKBEpEwyk2gR65ZGQhi1JwjJvTSajRM9mpJjBhKfcjOZ5dIs0V3MW3crFgkc4YnHKxSiRa7vMaeIv7fQ6bRMmlqTmJsNLq3YVPZ54/5BqM44S7mDRQRdNfJpJZeAhFAAARer9MOO+aziSYsGXucvnF23dNFUotrBQMoUXDR4vvqVUsc3AkplrIvAGBK7bhAfDb8u+LOMngo6zCIuetUyDFqGh5ZCgKefiJJ4UOdtvYTyuqwgAGjUEYeii+zAo00tGQi5iXFCaeOgIyo6Gk57OxAEG0i4slgxrXR+KTenbswq28AbYmvGWYkG/JmLgTFtpUpi6K0goht96W7+a6e9lY4YFM/wOm5ObseiWVi/lDUjEYrIHoQhN6PyNexN67nGRVj+ldr9khoJl3M0ohN6Sm1U+DyKZjuuZHi0l9bY2WOQistwGQ1pSoakUgskbCL3qcVbAUuiRIYtM+wd4ZNLclFmJOgYhsn9uiRmc4ro7W4Mhcem2wgfoTGFo2kt18gZ6tDsLlwaxjB85E+0acHh+4t52li+NJDfLB+UTntPgilJQrvrzk+Cov1qKqQvesuh2qcjlGAz9evUMg54FuoYbBtN7jHKDTgW+sCL86Q0InripC80iNcF3meLCLAZSB5cmRqV8CAsf0SZXI5YkNHfvnxT4/fsJfHUXhiL0rK7DjzD4Lk8S+OHq6rxyRBvj3egt/TUeVx0cBL3fwbu9e2lYn6/MDfG9aBN7WqemSKizYSi2zb15vjErm0Av9yeh+6MALNVm5l6GwjKvG4JUxpjooFVaUwxra/YJA2dzWvk7Rjt46VJQlM4teh9mnHygrMErs0YsO7gn2kgHcEyASguDvJWVJCoays1mD80Cf63PXx6WWcI2bj0H5QFLhybLuCbUIcKXiO0DJcg2tjaAVXliliSg84xkwrhz+tSVZ4GF7NbB1FC8vc0dGls1CMY+VdwSFg8smBUwmuaNI9EVW7Gcip1MceOz1qEmqcrZrqUmYlRwF0VSxfaUtN49USH/xfk+UHpKkMmER1TRcABTh7jaGstWYBEPSNGsZAxMoSupIJd3jolc+7Zq0DqbbqQtsCJKmhmuF1SEYd0iS4b6Rkxj4PQ9qvR7i0yhauszgb739tmzwaIItZ4ZeYu2tw5Q3HElxXXovZ0eXkwvZldnP01PQ++mmgZbxggMCvx0tmOu6NEas7hLkSnL3Wj7NGQ5LDG6g+fANOF30W3ihDyAojDwUSZM60KfjM947fo0ODY8oJrBsOUxzHgMb+BF/VQesC/ggI7Xj5+tXXfDAUVLjh3H6sEnnKpE2ahNYZGuVZ6oLK0HkNoV0L9pmapwpmZN2Qe1Hfy+Um96LcOak4WwQVjc9QuOctHwQkd/38FxYg+CJh1HqCl48RYthkIFpbRucNKXoO7QOmg/Jgh8pa0s8BXg0F417kc6vh3FMrIBnMblgIJKfOmiCDsrdQfDslbX3S+KWtuuL1Ff5noVbN07Xa84lw7MdgnvST980qXyEd++z8SW+Zpciau+nHT/XsquMXY5Xea+4TXttMwXq/CYAv6zG3/BEv1xw2TOidm5Utpb7kmDzDrlU3+MOexeftweg25DkMbDniTXJXbdfN4yalG3lClkgfcGBVUpOqvcUpTisYu+79n64scu/KR0Ob7a0NWY/cbeb+z9xv5vbWwa4BxnMoW0YXT7PcrEG5c3gfFDbaPtuKkObdvSQ7+krI5LrcyZ5lGV6XE4QC2V3nTtoLmbW5e63dM19bpK8rtf2VLtRK4tm5YnflREnFuN71oBzNUmViyIMZVF/HLsiI7pb9IkkplTQC4WCRfE/hBsK5Rmdi5MkTshL0bhQqFegfXeNQxYwpm7mbwvqMycf/+eJrLd9Pn03UdJgvIaXvkxDhNwlqE4Oaa7iiiW6BV1t2XD9OMT7WDcoEbk3BmdzK82h1ZmR7ifu5PFJYtrQBFnkm7TG5mDQIxJxOtmzJkuDLe4uRmUIq3XaysLBeToOBhHUpDTqMcZKk1rfeRMNrIy2nzAx5fMjsD6Z8pdB8RHCd5h8t9XY+t7lDe9qL/tmpZ5kP4nV+1K+6oU/bqE+Js6htNIkomFLLO2LLJnLqaM204u9vCPItxffaNGil+6d14v23EAJ5SMiPPIXX2OZZRTDtPdhm2AI0kgy+cJj1yEgDwDTh84UdjXJicOz090AIftF9QIEaOsYbKhFKWzJX0X5q6/9FkTj+G8sDW4Fev2QgDnjqOlQkGCVGqTbFx+hAuYK7nWLpoSioMDuDz+SdNHe5zq850G4BSdoy6vvbqR+S2+7WoskMAeFBXDRpJYW/LWGDRmIZNErmm7U8gtZ0vUExLjA/xcPBdXqg9wLNcikSwmAvCf/CESzQl5pj8fSNpR6w90Gz7/zzOQ2E2WpD1myrQMc53l8yDGu3pDFw3jIv+gx3UQYbjTttcX08PjX6Y1hU6mQce343ki5+OUaYOqyDzo4t9xzJQZOxJ0QDdtG5xOr9qsRL5EQzHRNgBVzbXUZ2oTuFDPePic0kojsCevlXaa8HuumqxWeB9kac3KPX+qZZ9BWrQi7ZT2e9llVZN+lF2VNPpDVsJS9tdBIe2P7I61WaXsDkV7JWhkKloF1ZsxU4YvWGTGekVn1LgO4g+/XNrf2B17ZN2StO42V63bLP1Nt01r123ZXK6JcSMLO3xO29IB606spsxdaQf0NTks0ESr4X8q9qgY/ocI74i3VADS4fyH885SdJJx3UGLVnNrJ3as/sVCZ6tsx3K2FnfZpZa0m4x3BC1ayitJY/GO+7vvy6W1Iu1Eiot8vmmzUvl8s8RUtyVuto7pR2u/Pau0xOqRvXdBGZoWq4iCNTrgsuZWNRW/HpX0maTVu084yi/yCKmkZlLdnQ8zFq0QXgUve+UotPeYfW1tXIzV459Pjqanl9PRq+BlsDKp/SjToEr12eIS1R23ucqxkbr1vbJzOSkKhUo7PzYhY1j/lu7FKRMNuT4p6t+9uDcKI/93/6dFcbmgpBFl/bi9JFrLPhQX/6qUh8wxaYVH2nf/G9+jRCKNeHigYsZ3Ktluqfn3HJWtYqKonuK23s0WMXFt6yGL2M4T9hlcFBfiIXz8f9HYqVP5vazYNOKRnl9EHhtqbW+2vrdCFlMkogptFnVhIxtHqQn06lnrYCbdNjLzZN9msOX87PLK87158b91pDZ+4SlGBVH0txXWRXpsTMK2uZx8biv2PEeTbog2gFF/NFzdJMv4yvXDbnM8PLge9oa03VbWKQIBN9vt9t8AHyMl +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Deprecated: use setProject or patchProjectWithRevision instead + +Creates an Enterprise SSO Organization in a project. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-project-api-key.ParamsDetails.json b/docs/reference/openapi/create-project-api-key.ParamsDetails.json new file mode 100644 index 0000000000..d2edce0345 --- /dev/null +++ b/docs/reference/openapi/create-project-api-key.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The Project ID or Project slug", + "in": "path", + "name": "project", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-project-api-key.RequestSchema.json b/docs/reference/openapi/create-project-api-key.RequestSchema.json new file mode 100644 index 0000000000..564087fafa --- /dev/null +++ b/docs/reference/openapi/create-project-api-key.RequestSchema.json @@ -0,0 +1,25 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "expires_at": { + "format": "date-time", + "type": "string", + "title": "Time" + }, + "name": { + "description": "The Token Name\n\nA descriptive name for the token.\n\nin: body", + "type": "string" + } + }, + "required": ["name"], + "type": "object" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-project-api-key.StatusCodes.json b/docs/reference/openapi/create-project-api-key.StatusCodes.json new file mode 100644 index 0000000000..9f4d9d7a86 --- /dev/null +++ b/docs/reference/openapi/create-project-api-key.StatusCodes.json @@ -0,0 +1,115 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "created_at": { + "description": "The token's creation date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "expires_at": { + "format": "date-time", + "type": "string", + "title": "Time" + }, + "id": { + "description": "The token's ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The Token's Name\n\nSet this to help you remember, for example, where you use the token.", + "type": "string" + }, + "owner_id": { + "description": "The token's owner", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "project_id": { + "description": "The Token's Project ID", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "updated_at": { + "description": "The token's last update date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The token's value", + "readOnly": true, + "type": "string" + } + }, + "required": ["id", "name", "owner_id"], + "type": "object", + "title": "projectApiKey" + } + } + }, + "description": "projectApiKey" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-project-api-key.api.mdx b/docs/reference/openapi/create-project-api-key.api.mdx new file mode 100644 index 0000000000..0a35694399 --- /dev/null +++ b/docs/reference/openapi/create-project-api-key.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-project-api-key +title: "Create project API key" +description: "Create an API key for a project." +sidebar_label: "Create project API key" +hide_title: true +hide_table_of_contents: true +api: eJztG/1v2zb2X+GpGGofZCnNutudixwuTbwt+0hySYYBFwcpLT1bbCRSJak4vtT/++GR1KflJG2zAQfMPzgWRb4vPr5P5t6LQUWS5ZoJ7o29AwlUA6Gc7J8ekRtYkbmQhJJcivcQ6cDzPZGDpDj9KPbGXmQWnNrX+zn7CVae7+VU0gw0SOWNL+87OC4SIG4BOTokQlZPKi0Wnu8xnJVTnXi+x2kG+GRneL4n4UPBJMTeWMsCfE9FCWTUG997epXjVKUl4wtvvb6yk0HptyJe4YxIcA1c40+a5ymLDB/he4V03TdA5RK51AwUPsFdziSoa2pWzoXM8JcXUw0jzTLw/A5u39NMpzhwga/XJRt9krgQN8DJMc1gyqd8n1QzboHgKrMBOgGicWKAkxgfkxmy1MW7Xjflc2mxXlWzxMzIcI3T7kZCsgXjND3FvTq2YjaCMkBULriy7O/uvPoC4VkFiZ3wNvk3bL1UxMxjghMUq+f3i1kCjU94uio3v8O+/xxbxeKHCT06DJrkFQWLn0LZIxrwUlU6cA6a6IQpogVJIM3JShREQgbZDKRv9AHuaJan4JNlAhLMhEJBQ002VcP3xJKDvH6MPTPrcxh0R3QrgpLN+uh/DpYij5+kTilVmtjJX6ZRtzQttmxcictOeRRW53Aafo1WNLZm47DW+pm3bKw5xG2SOhPw9ZwWqf6kw7vJpdKUx1TG5ESuyI/nJ8fGNYCUQhIrUtS2jsXEt5vgJmZRaVw2VsUwKxabqw5xmCAHlHFFzCzCuMXNBA/IBZ4WpkihCpqmK8KFJvSWspTOUnRmMUmoOU4zIMBxMEaa3SlyfMZU0xlVQGhMcw2SLKkihZmNS+eMx+aAQQoZirLP+vSzjQcbyTOrjQhw2zcpcN4KYhSRKGQEJBJFGht+ZugJCh5vxXvdQropxOqpFuW8kDoB2RQmEdzQyakuJBAxr6luE3xi9JMsmU7Qi7/a/fr1NyQWoAy1cMdUr4j6rMPRIUqHkoKzD0UpoqPDYMrnYMi45kJf1xs6kfI7++JY6P1yeMo/FELTa7iLAGKIcdq/cWTiBpB8XmR49nrher7XhtA4jZW3uBstxAjBjJAHb9wP6rNJXPteBkrRRY/J+cW+qLev1ie3ptfsK011oa4jEffAPBAx6l0uQQHXTZB2GcFlZPB657VPXu98jV+vfBIEwbClDfi+tq+M67+9rklhXMMCpDGA24zbAjhIFhkDceBsVddg2tN1VS+qjJG1K2e1XekJeNp8G1jfW6QGkYKokEyvTLwq5Oo3IW9UTiNw5nR8eYUBpQJ5uz2qRQt5DHop5I3ZJSlSkqeUg6FymbAosWYKYjQpGeW4nytRyNZSZ8iVsVzLkhCFEi9k6o29ROtcjcOQ5iyIBFcihUDIVaASD4nUdIEUVkHzlQ33ViNJNaQsY3o0K6IbwL2a0ehGzOcsghGNM8ZHqVgaNceNPzfba7lNKV8gm6sczg3bnu+ldAZIz7+EXIVRyqxZtKYLNz7LhdTkfsoJIaTOEXw7cCD4nC0Km0yUY5vpxJm1ilO+JnMpMvKyge3lGwyYUAQaBV6DI3uEw7KNYjB8U86lOTvi6NgicDNrlIMWoKHBkIIud2VM7NF6Q8Lw4UyGDJwDxr0ueAxzxiEeWmg9eZNjdPyAEBApGQijczQd1szfu/PqGzdG1mSP0CVlLU6DHpwDK3bHm9uE7bRN+fCNt/YrbfheNLSAU0xamgqQ0+gGNTyjjJvExSrEYMqnempjkjs99ezjPKt+CmV/iRw4zZndazL1FkwnxSyIRBbWOjBaCJxthDEveGSwDYaodlPtGCPjPTKtIlRntqYeStPuJvlIHt5MBLZdLgj/ry1qg2NYbt/HwdQEBTUlQyRl+3zykXS2farb+j7eI5v429qPi2jODqw0+xbsnx7Zt50zgCsxavOJ9NE94OIKUlASfHoU9HAwcNscvKXRzUJiCDMY+qXGDfuWlELaLu9hMLmDqNBguWJzQ9Vf9ghnqd34qZ5nOvgul4zr+UCo4FzHIKVPpi4KXSbASUTTFHf/3cM8vHs3Jl/dTqd86hn+h49g+K5IU/LDxcVpFes21tvVa/wKw2qCtW3v+pCPSesZF25iFoVGzGdtcI+w1aQKVD6c8nXzdJ+udCJ444SjD9lq5oVcXduXU26w1wNBJmJIlTNA1+U5pDm7voHVtYt7iQP0kA/YArgDsYTUkVt3sWwg3c8ZBmHmiLmZuRFwOcE+4dF7QQ7RlKPeYLiUCISiSHk8jdd2lt/m8M5b5yld2QNQ0qvQa9OcKTRpCPgcoO3HgryswKVMaQzHaZoSVeRIE8Qdp1eX3QLjGFr+sMF42zBYo2/YQCv5VHJLm/vCWE5no7Oi4YltQYIWOgGuXcpppINDQrL/dqlGYIwTGkVCxsY5m/QCoWAAZYMvUoZqJBcpi1YBrppYQ6psdYRGicFBMtCJiAmVgAbnlmHMPYNULP2qXuJMMNEJ1QhJUc3UnIGycZkBg3MjqiCw/B5U/L0FKkG2+RmTzfDxk3eDRhEodW0qDDhbBcBvmRT8cuq9neyfTc6uL05+mhxPvatqGyYcs1ZKnMG1sqOcsDLScckcirI8qGZOg5b90qp3PAChCi2+mza2RL4gdbm4HwlVyvGTs2tWR1wNjI3Aq0YwbIUlZI+87Pjul+QFeu4nuO06oNlqd9q7sd0fDSuOn+ajEbWWKyetlsRKzlyVvZ6BtFU+Ya8lty3mc1AGb4+wuffw62FNg7F0g6mrSThaxLxhTkf/7Ac2Nt6kCcrCanLl3oKxtqQyuqhhMN4kop7Q8thPoIV8pQw55CsCQ5MY3Y1UfDOKRWTKTY1UBktgbGFrHv1NjcGwbGvYdMj1JbaHKHUWul1lvG5autHfQG+80QLp1iQ+sb3SwWDaJLqQ/MKCbfdy1r63EF359IZ5+q4RlfUK6/fiwP9DtmNOU/UEaeU2aOrVqI2j+3Q5PbuQttmBpwhqsP1VkMXDDVovS7N49YnqN2g9Gdhr0+XRwBUT3IrtBusz20ocVQW/v9SBcinXV8ahUfX/00j8aST+NBL/f0YCl9joH2UlDMnmSsHYC8t0Jrx3v9ahCbTx4JfJxTl2xGxbakYVi6oumbUkOFLJADMm3NWZyQbaM+3QxlSBKcOu6VGnYmnQtJKIA1etbw3+2ir+JqtY0iCGTLjab2iBhviNnEQitwyI+TxlHNHvEzNKSvHamMptKoZVEuYSVGJbm4oMaMqoTareOSjXNjV5hxvYHvp0+PY2CceekFdG0ZSTkxz40SGmWdwprukdo9zMuifKQdtFja6DFTqKX672Dc0W8GbfU7j8kCkCPM4FFgKwy84BYiTxslmvd0H81aAkablcGlqwUIkOJYwExyhWhTlIhTo+siIbGRpNL+VxlelpSnwi3XUzYZTCLaR/PBtr38Oe81l9L2dS9pDa92y83Z3d16Odb0e7/7h49c34m1fj3b8HO9+++k99J6jRVORzUXa5aWQ8NWSUoZa4Usm/XHukWozMntt33kZ36AU5wuZNXES2HHQoogJ7vjZ5N/WYNCV5MUtZZAsaGE8wpaUpgZtmzv7pkQrIfvsFDpKIYpc1XWFL18oPYpeJU7xLwGJy6uRLrJZa/Q/IqcVooGBNIxNKpyvbT2KczKRYKlv8mfIXL8j54U9qyk1zPHYcuOtFM1Bllq4anXJme78NpQhMfl0hbDTVlQFf3U6aizQVSzziWDws6ALUGMn4SH52zy6v+0gOxZKngsYIgHzOB0E0N+SZPh+R2lHrQ7oDn/55BhD9YJHaQyp1SzCXeTELYritD7EbCF0vRoV1rWPYK9vLs8n+4S+TGkKn66Lim3CWilmYUaVBui6Mcn/DmEodWhDoipuyDY4nF21UvFiADoRctI1ONVxTfSJXga1MhcPnpFZoDhv0GmonKbtjsokqgbsgz2pU9vmpkn0GasGQ1Evt96KLqga9FV3VQPtdNGEhNvXAUfsjvaVtVBm9Bd7WBAVURklQvQmp1GxOIx2qBP1SWLcjhl9O7Xt6S7foLVJrc8BKb/PsvWqL1uhtOVzqRNjoVQ+fU7boVK3HatLcpXbwGzqVOegoGX4u2SO3/Hch3gJvsUCQh9MfTjuqaCljqmMtWsOtk9iR+hcTnSd5jzobids+WYvaVc46hLqRMvloKG+4efq+nFpDUq+lOCtmqzYqWcxWC8hUm+LmaIg/WuftWalFVFvO3hk2lFqoIizxqICJGls15H5tpfSZqFX9Hg47pSwCvII0rhLp/ZxGCZDdYGfj+g6ePWpeGxm7tSr8+ehgcnw+Ge0GO0Gis9QkPiAzdTI/B3nLTNc11EI1LlCVISfWrkAqG8emKAwT32IGnFHeoKu/EdHNyhs3R5/yvwEu1sf2E/YPmcnZDNP3LvuubiUhpeNGEcMmhFe+h41InHd/j7cxf5Xpeo3DHwqQ5hoWFuckMxf2zC0spsyFTld7eYD+wZnLSoePNI22MeIGKV81qoqe7+qHJS/rq7XvJUBjLAVU1Ul3qW1kChj16o3LuHU9EkP/XD84t1njOD05v/B8b+b+1SEzBQRPUrzNhd+GUltiMUUBM2Zb/YW5buhZmJiimQpC/R8VVSpXFjgu7/tlcX9vZ5h0Zb2uROMy8av1ev0/U5la5g== +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Create an API key for a project. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-project.RequestSchema.json b/docs/reference/openapi/create-project.RequestSchema.json new file mode 100644 index 0000000000..53f34d508c --- /dev/null +++ b/docs/reference/openapi/create-project.RequestSchema.json @@ -0,0 +1,48 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create Project Request Body", + "properties": { + "environment": { + "description": "The environment of the project.\nprod Production\nstage Staging\ndev Development", + "enum": ["prod", "stage", "dev"], + "type": "string", + "x-go-enum-desc": "prod Production\nstage Staging\ndev Development" + }, + "home_region": { + "description": "Home Region\n\nThe home region of the project. This is the region where the project will be created.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "name": { + "description": "The name of the project to be created", + "type": "string" + }, + "workspace_id": { + "description": "The workspace to create the project in.", + "format": "uuid", + "type": "string" + } + }, + "required": ["name", "environment"], + "type": "object", + "title": "createProjectBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-project.StatusCodes.json b/docs/reference/openapi/create-project.StatusCodes.json new file mode 100644 index 0000000000..47dcbc3849 --- /dev/null +++ b/docs/reference/openapi/create-project.StatusCodes.json @@ -0,0 +1,448 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "cors_admin": { + "properties": { + "enabled": { + "description": "Whether CORS is enabled for this endpoint.", + "type": "boolean" + }, + "origins": { + "description": "The allowed origins. Use `*` to allow all origins. A wildcard can also be used in the subdomain, i.e. `https://*.example.com` will allow all origins on all subdomains of `example.com`.", + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object", + "title": "projectCors" + }, + "cors_public": { + "properties": { + "enabled": { + "description": "Whether CORS is enabled for this endpoint.", + "type": "boolean" + }, + "origins": { + "description": "The allowed origins. Use `*` to allow all origins. A wildcard can also be used in the subdomain, i.e. `https://*.example.com` will allow all origins on all subdomains of `example.com`.", + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object", + "title": "projectCors" + }, + "environment": { + "description": "The environment of the project.\nprod Production\nstage Staging\ndev Development", + "enum": ["prod", "stage", "dev"], + "type": "string", + "x-go-enum-desc": "prod Production\nstage Staging\ndev Development" + }, + "home_region": { + "description": "The project home region.\n\nThis is used to set where the project data is stored and where the project's endpoints are located.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "id": { + "description": "The project's ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the project.", + "type": "string" + }, + "organizations": { + "description": "The organizations of the project.\n\nOrganizations are used to group users and enforce certain restrictions like usage of SSO.", + "items": { + "properties": { + "default_region": { + "description": "DefaultRegion sets the default region for identities provisioned into\nthis organization, when the identity does not specify a region explictly.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "domains": { + "description": "The list of organization's domains.", + "items": { "type": "string" }, + "type": "array" + }, + "id": { + "description": "The organization's ID.", + "format": "uuid", + "type": "string" + }, + "label": { + "description": "The organization's human-readable label.", + "type": "string" + } + }, + "required": ["id", "label", "domains"], + "type": "object", + "title": "basicOrganization" + }, + "type": "array" + }, + "revision_id": { + "description": "The configuration revision ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "services": { + "properties": { + "account_experience": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServiceAccountExperience" + }, + "identity": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServiceIdentity" + }, + "oauth2": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServiceOAuth2" + }, + "permission": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServicePermission" + } + }, + "type": "object", + "title": "projectServices" + }, + "slug": { + "description": "The project's slug", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the project.\nrunning Running\nhalted Halted\ndeleted Deleted", + "enum": ["running", "halted", "deleted"], + "readOnly": true, + "type": "string", + "x-go-enum-desc": "running Running\nhalted Halted\ndeleted Deleted" + }, + "workspace_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + } + }, + "required": [ + "id", + "revision_id", + "slug", + "services", + "state", + "name", + "environment", + "home_region", + "organizations" + ], + "type": "object", + "title": "project" + } + } + }, + "description": "project" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-project.api.mdx b/docs/reference/openapi/create-project.api.mdx new file mode 100644 index 0000000000..c6dbf48592 --- /dev/null +++ b/docs/reference/openapi/create-project.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-project +title: "Create a Project" +description: "Creates a new project." +sidebar_label: "Create a Project" +hide_title: true +hide_table_of_contents: true +api: eJztXG1z4zaS/is4TKUipShqMuPM7ik1V+vYSuLNru21PZUPpsuGyJaEmAQYALStc/TfrxoA30TKYyeT2ata+YMlgkB3o9F40Gg09EgT0LHiueFS0Ak9UMAMaMKIgHuSK/kLxCakAZU5KIaVjhI6obGtdupe04Aq+LUAbb6TyYpOHmkshQFh8CvL85THtuX4F408HqmOl5Ax/NbHnHiy5MwRJZZqQHOFMhgOGluCuONKisyzaRO6WAJpVCByTswSqu5EIlcyQT5JEWOTSGjDFkDODVtwsYhEAnfkEO4glbnlEFAQRUYnlyhFQgNq69OAJnBHrwJqVjnQCdVGcbGgAX0YLeQIm4xQMDqhL2W4DuhSZnCtYMGd0to9/FFmQM7sy0hEAjuM9Ymrv9lhcrHkmnBtC32V+yUoaNYi9zxNyQyIG9wkjAQUoxiEUSwl0w8H7lskmOZsJKQyS2DakH3N2TE+TZk2kSj0yBZ/OK+e78E+/wz4DAWZfnBEbFOsQT6cR2KRyhlLyQ/2o6HxWgga0DZvGlDPzn1DRtiy8DVtKQ2oI/2sgfo3dnkdUMEy6DdnfLMxrMTIxnDRzc6tA3ov1a3OWQzXPOknW9VAYo5SiwUXOPnnUmXM0AktCt7DaO0AgCtIcMBsJ4LWDK01L2ceMgw3KWxCiZ3qayT4MJKKL7hg6SlTLDu2iqHuPbLTuRTaQcGb11+/CHTaQBJLpa9ZknHRfQeCzVLoUd3PSzBLUOTg5Owc55WvSOZSEbO0BUkuubDQ6Xs+kzIFJlB81zXdPyQsTeU9JMRXCskHDeTmqxscIfsO/9dv93HeJjFTCYmZICzV1ioKDQnhwg6mLmaJzBgXAeEhhORmaUyuJ+PxVyE8sCxPIYxlduMAoMOCSGEfKyoa7fCm2RJ7yQ1ktkcdK/QFTCm2ssayzRS80R1IpbGdHZm8mKU83g3N/6+h+Q9ffS8aCNlYdkO3FLul1o6ykUSD6VlrE2YY1tJGKkgIE0m30pe1rWrCFJBUxruF+d+zMG9bP+uhOjrsWykVsOREpCs6MaqAniX6RSt+2LfIS7Vggv+vXe224FarSnc+RuKkVQFtrTTfhZJFjk9KWysFMZcqBhKDMowLogAliV3DlN9iS5xbck7Oz09a6NMG8ATmrEjN1jl26N47HxdnkfNefbPSi0VU5wkIw5Eu9umOay6FRVgjI2Ehv9n/ACeaA1/fcEUSCZoIaYjOIebzFWElfXhAT8Kkq92k+/yTzq9p/Tadcm2XlubYfqmJb/OSZW/77N6g3T/FO9RTNoP0WQSXRcbECDECfRRiG/bM8Q3/2nJ1TGodPeFhz5jmcXOG96lAgZs4W3cKsRRzvihcEICU1X8v7GlQdzyGHlxgcSwLYa7hIQfFQcTQ57OjLI2h9X3e1JSv94RuPAieO3H2He9pzdoah0OJzyfGUckR0Z0VZvnm8/E+2bf81gHNQWVcaw/On4f7ac3zGd7oeWlEaFBpsfjYEm3rPMc4DTNbFmX7qruCqkIILhbkzH1GYslSAwn50X6gg5kCPh+6zwae+5Y0oK6J9WpdpauPidoD2C8VpCdI0JrLezSgokhTxKdtQpSjclyk6YcPR4f9gNUEGD9cDRgolR70RQ/a3vimx/Nx43IRhfZgVq8Cuvf69R8IWnqrEAlu807Uivz9/OSY7J8eEVBKKuLUGXYDmPi2S25qG5XxjU6rBGZ9dn6IxQjRxm4CbS3CheONOxNSb0sKlqYr6+2wO8btyFrPbsm0jyj5LTPK7LeSvp+4a5kxDYQlLDegyD3TpLC1semci8RODEjBD1xnbm3pNsZ3ygCl0xvaQVcCH2iGBFUkC+uJyiJNbH9mQOayEL2LsiV63WLaVWL1VKtyXigbTmgoE3fdxjroplAVGFgGbYFPZj6uapbk6JB8/ebt3je1rwkPXPeqqG8FPjpE7TBSCP5rUaro6DCMxBysGNdCmut6QKdKfe9eHEuzXxZH4tdCGnYNDzFAAglW+xeWTH1BA5h66dKAtik8y4v8tCKuA5qBxk1GV03/dC/q4avtybfp3UIh9hT6OpZJD80DmaDd5Qo0CNMk6ZoRbEYGe6/3ArL3+i3++zogYRgOW9aA72ts5cK826tF4cLAAtSTi94CBCgeW4A48Fi1ibRudl3VjSowcrhyVuPK5sLdQUhL6wfH1MHky8KsO5jcweQOJncw+R8Hk293MLmDyR1M7mByB5NPweTeDiZ3MLmDyR1M7mByO0z6484dVO6gcgeVO6jcQeU2qLRnynGh7EHt5SOVavVzebC1n/OfAIuv1lfuzAmUtrW6UIkIeQwGD8XsKCmZkjxlAqyU90seL5vZXRkTOJ4rWahWU3+85HJmqhM2m5ZQqJROaJnnx3IexlJomUIo1SrUS4pCGrbQPuHN9v/KZcSuRooZSHnGzWhWxLdg7Pl+fCvncx7DyOaxjlJ5b80cB/7cDq/rbcrEAru5yuHcdrvKI5jQv0m1Gscpd7DooAsHPsulMuQxEoSQMjN/P+eBKzhoJgWUZZsJvZFYk7mSGfmyweTLbzHvCHtuNlIL3turBy3Kg+G3ZV2W8yNM3xMx+Jq1UIMWoaHlkIIhnRTjSVfIb8l4TAbSmgJLh7Vwj34aBS5nb03eE3bPeEuSsMVh4PTQ4RqJ4bd0HVTj8INs6F8ww++gqfqcxbdoW5jfgeL4oRhEIjKR8wYeTETd4zyrvkrtvskcBMu5UzeJ6IKbZTHDpNBxPQyjhcTatr/zQsSW22CIAx6ZTg/I5D35qkU3PIb7ji4HEZ3Wx7fXHmIiGpDILqR1yRC13mlPfiMbQxGZto1M3pOuGG2LwUYs5weu+30N9k+P3NsNu8GW6OAERAWIpNi4ohSW5nZ6FLYEH/gRCb9j8S1mzYlkMByGXeV0tDoMpw8QFwac0Hxumf7XeyJ46gYiMvPMhN/nigszH0gdnpsElEJ9Oty0KW0xS1M8+7/ZJuLNzYR8cRdFAocClBp+hPb3RZqSHy8uTit/r9HetV7jv/G4quAm+k2b7aSco1i5y00WBrmdtUls7URTBtD5MBLr5qw6XZmlzRIoZxai5lZgk2p17V5GwvKtC8JMJpBqP7evPRJfz9BAfeseqNtCpLpP4RpW+tisjumUZaX9nKNTkbuUZVszt4orK7gnnB+vyCHMuc38MPYqEFLRpJxDdhXyWwnrRJerT56ylbPVUkKNqxDLuUagQMLnsJH7FeYrm3bJqhQ8l4Keo0yQbKB5jrc3wIDSoUXUFtA3Ot6evQ5BbTfek4g+V9wSyV4Rm7Hmpn5WNJYYl2CNOVWYYuW2UFY7WCSVTyppSI3EuCCYlaYSu+pYdxmpoEPgnAlSuh4klymPMVn0FZk6kNNWWcDipeVBMjBLmdgcW5utij7kDFJ5H6BT4bw315KYJTNISTPD9RzzW62fYclg3ZhpCF1/D6r+fQdMgWr3Z0K67tCLR4PFMWh9beQt2No69Dk6lxH9brp/Nj27vjj5aXoc0atqGKYCd2GMeGx0umOC8HIJ95sTVGU5DW2dhiz7JfRuwDRhGmHZV5s4IV/5ObmdCdPa9yfn17x2JRocGx5FzWDYXNXbaNBWXQfwh5VUT65xSN2ole9IuzM1YJTvULAKdN+3OrOBWIMekd/3lA1r4hZXBpHf0Xomct5wtUb/06YwsYjcJOFoNMX0b8FiGqmgDccRJl3mdYXW6vaEDOQLbcUgXxAYWjf6YaST21EiYxucaDi+GDDhC7dD3ryENhhiWAMRwLnNLkW/56JatUnpjC7d3KzQ5j4I0+jWNrvPFEpcOBrlZdp1QBdyU74NT8M8NHyGP1nYOUv1k9LmbsHt1Whlg09J2bLCJ+QcdErCLBl2pL8sZ9XVs5U+8J+WHm4l4cGA0O5CxeUjvcXd47YNWEDvWFrAto0YuiZl+8oYqzY7o9wZ5fOMEqs53wH3htKG5nJmlnRCx6UzROsgyDmGg11M1ub/VyHi6kZA3Sl0r1BpM+s6tGu6ok7VOi19nsp7l7jf9DgOfKiqVfihFflYrhLFwgQy6QMfY0d0jP+xJ7HMXQfkfJ5ygez3iS0lpQbd0uCDrrg6KJgr0EtivRRNBizlzHlgN57KtfNjbnCM2kUvp+9+F0FgQJSWv1bABDnJQRwdok8m0Oc/OiQXWN1eu8Avz9SDcY0aITdW5uZLtdq3MjvC3aC/9M5k474rOo9EgL1tSC6bwSp0jG5hdTUoRbq/v7eyYKwA8WocS4GLsR7noDSa8cipbGRltIHEj5tMT0TuhXLXkbRRitc1P3831gHFA5ez+vcupmUAdeM3Kcq7qq2LpO3rWx5wqsB0OxOfvp2zv34zf7c3+uYvX/9ltPfNuzej2dt5PHoT//e7t/N379icvbPxeDGX5QERi+0yAhnjaGN+V/Y3H1msWKKqzt072gmsviJHGPesLsseyrjAPrl9gt36pSlxF7Pd3gkXO66NsjEsGwfdPz3CC9DtF1hob0JLka7wNMRpH+8luI0BuWMpT8ipHx3ibNzNnpCcOo6WCm6fMqlNuqquU8+UvNdunxmJV6/I+eFP2l/HTXwPiOvoDHS5IdCNQyZ/JbthUqHdR1YMG+dR2pL3l8rxWAevZiNAYBSiYAvQExTjN/IP/+yd29/IobwXqWQJEiC/5w9JNAfkE/39htKOWn9ks+Dlf5+ARD9ZlPaQKdNSzGVezMIE7moI8AVjH0zV43qnNuzV7eXZdP/wn9OawkbYVCe341kqZ+OMaQPKh1G1/xwnTJmxI4HrdlO34fH0os1KFAswoVSLNmRVxbXUJ2oVuk3wePgppZVGQEdeK+005Q9cNVkt4SHMs5qVe36uZj+BtGBF6pX2B7nJqia9lV0VAf9TLGEhu3bgpf07u2NtVhm7A9G2BA1MxcuwejNmyvA5i81YL3FVG9dxzeEfl/YXdse22C1K6zYold3m2S+6rVprt2VxaRPjxnnP8FPqFpdkt2I1Zd6UdvAzLipzMPFy+HvFHvnmf4rwjnirCwT7cPrj6YYpOsm43kCLVnFrJm5o/Q8LnS/zHnO2GncB95a0q5xvCOpLyp1Kw3jH3dn3x6W1IvUixVkxW7VZqWK2WkCm2xI3S8f4pTXfPqm0yGrL3DvD2HWLVYzxBx1yWXOrivy3rZJ+Iml1/wqHRy48Bjy9n1Sb6f2cxUsgb8LXnZNvnHvMvrY69m31+B9HB9Pj8+noTfg6XJrM/hKAAZXpk7m/8ItbXiN1I/egdDkxsALK3VmmKSrDRQOkNhkTDbk2A6ubG/ZGutX238TzOwOMbOPRBLc7PNvJR781rw7w7TVVPM/AssdHTFL6oNL1Got/LUDZ7ASMCinurtpeXuGP0ABLcENehaB8XsXIRgrqwFMnH6wOOqELnZsn6zYDC6cn5xc0oDP/Q36Z3cZTxTChAP/bOIyLZdituS1zZ2+FzXihjiZulOw+vr4iXm2oyjDDZfWKiVVDwsdHV8O6/es1DXxX/H74ar1e/x8GIghF +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Creates a new project. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-recovery-code-for-identity.RequestSchema.json b/docs/reference/openapi/create-recovery-code-for-identity.RequestSchema.json new file mode 100644 index 0000000000..058ed152cd --- /dev/null +++ b/docs/reference/openapi/create-recovery-code-for-identity.RequestSchema.json @@ -0,0 +1,33 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create Recovery Code for Identity Request Body", + "properties": { + "expires_in": { + "description": "Code Expires In\n\nThe recovery code will expire after that amount of time has passed. Defaults to the configuration value of\n`selfservice.methods.code.config.lifespan`.", + "pattern": "^([0-9]+(ns|us|ms|s|m|h))*$", + "type": "string" + }, + "flow_type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "identity_id": { + "description": "Identity to Recover\n\nThe identity's ID you wish to recover.", + "format": "uuid", + "type": "string" + } + }, + "required": ["identity_id"], + "type": "object", + "title": "createRecoveryCodeForIdentityBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-recovery-code-for-identity.StatusCodes.json b/docs/reference/openapi/create-recovery-code-for-identity.StatusCodes.json new file mode 100644 index 0000000000..c430d0fae4 --- /dev/null +++ b/docs/reference/openapi/create-recovery-code-for-identity.StatusCodes.json @@ -0,0 +1,191 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Used when an administrator creates a recovery code for an identity.", + "properties": { + "expires_at": { + "description": "Expires At is the timestamp of when the recovery flow expires\n\nThe timestamp when the recovery code expires.", + "format": "date-time", + "type": "string" + }, + "recovery_code": { + "description": "RecoveryCode is the code that can be used to recover the account", + "type": "string" + }, + "recovery_link": { + "description": "RecoveryLink with flow\n\nThis link opens the recovery UI with an empty `code` field.", + "type": "string" + } + }, + "required": ["recovery_link", "recovery_code"], + "title": "Recovery Code for Identity", + "type": "object" + } + } + }, + "description": "recoveryCodeForIdentity" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-recovery-code-for-identity.api.mdx b/docs/reference/openapi/create-recovery-code-for-identity.api.mdx new file mode 100644 index 0000000000..9d6d5c8bc8 --- /dev/null +++ b/docs/reference/openapi/create-recovery-code-for-identity.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-recovery-code-for-identity +title: "Create a Recovery Code" +description: "This endpoint creates a recovery code which should be given to the user in order for them to recover" +sidebar_label: "Create a Recovery Code" +hide_title: true +hide_table_of_contents: true +api: eJztW21zG7cR/itbuJmQKXl0bMVpmHEniqSkbBJblZTpdESVAu/2SER3wAXAiWIl/vfOAvfKF9GOnbYf5A8yiZfdZxeLxWIXvGcRmlCLzAol2ZBdzIUBlFGmhLQQauQWDXDQGKpb1EsIVYSwmItwDmau8iSCKcJM3KIEq8DOEXKDGoQEpSPUECtNrSn1FkTGsqM08NCKW26xS92CvocqlzZgPaYy1JwAjSI2ZB7EWQHgSEX4ndKjCKUVdsl6TOOvORr7rYqWbHjPQiUtSksfeZYlInSUBr8Yku+emXCOKadPbcGPHBco2QDxceBLTnDm+YBj1GOZJphWoCFieJcJjWYi5BbSROrED4CRHMuxvJjjukpFkoCnAjy2SFrjFnhKSgEVgxUpwpwbyLgxGAVwjDHPE2tKvYdKxmKWe83BLU9yBBWP5bXBJDaob0WIQYp2riITEM/AzwgSEaPJuLwm3WfcWtQE+1+dy+f9r67+1JHmITcPqXkwD+nDvNv97I+sx+wyQzZkxmohZ2zVY3GiFhPfuq4Akpa6gboh5BJQ2DlqMp1rnolrUBqup1otDGqHwgqbEPkLmiCMk6+iEGxjL4plmohoE0C1hlaVK1yuQjnvUwOjY1iqHBbCzBvWStxipVNu2ZDluYg2ua+8EQqNERtetqBcVYPV9BcMbUO2R+3aGdmKKN/1lRYzIXlyyjVP3/CUJvt+4msyJY03whfPP/+AHfCzwQgWc5TAJfAoFVIYq7lVeqcfoP3BZaXDYOe24HaTX7kjDm25wmTixvI0I3t3SGxznzgDKCiWy1dP2RzvIBbjW6sYcYt9mrnNkMrpE5q+ibq5XiVux8htV7LtqXOBUcOE3KDCvz3KMhHyZjfLH4W8gYWwc6cJrwFhgCaBylCatvg/j/xg2m5pZpdwTTivIRaYRFv20JoVt0Gt6+WqtuPdLpOtG78z6LZweodfX/XYwfPnH2DOZB3GchlxHcFbvYS/nb99A4enI0CtlTuYUm63mCz1brFWN6ncbhuzIpzms81Zx9RMntlyIQ24USCk5y2UDMAtoTCQm5wnyRKkssBvuUj4NEHgMnI+3yoyK5TU6NYO73iaeRc5R4i45VNuEHjEMzo7FtxA7kbT1FjIyNkGJpjidhvcITa5m9LMvd4kT3ETQXEIY0QqUrkOaVdQdEDyTMkscrnFcxZ8Jy2mm0qsvtWqjHPtjpCGMkF5ByC5zTW6M7NE3Qb81lmj3x2jY/j8xcuDLyBSaBxavBNmq4q2nizHpB0OuRS/5qWKRsfBWMboYEykspN6QU+0/s53vFH2sGwey19zZfkE70LECCMa9ndqOSkaCL7MU9qXW+myHmtTaBw8hQB0ksxUn8j0SQY23E7qN0Nc9ViKxvDZFq/5k++ol6+2p2LO1kPdWG5zs8MTO3ejMdNoUNomST/Nu+XOwfODHhw8f0l/Pu9BEATdljVQf300CGlfHdRQhLQ4Q+2c465zfIYStQidgzgqfNW6M/W7q+E0K2fk/cpZ7Vf2ekxH63vP1LvJgyc3+eQmn9zkk5t8cpO73WTkr8tPrvLJVT65yidX+eQqd7lK0hKGuaZb+PDynim9PAxDNOZC3aBkw8urFbHlM9NMdhEUSlUt+5pbTEQqbH+ahzdIOrihNJLpu6RSP1ELZzqkzHOnMuP4JFzOipTfuQPHeizhU0zYkH2j9HIQJsK7Gu8OSJlpprSF+7EEgCrtcJiJnm85aqZEy7Z9abexXEGsVQqfNrh++jXlW0IljV1LtL4GiYs2p07363Isz8RI0qERYjGygbLTotR1LBIs0+6PQBzul+JrGAygo9wS86Rbo78vjLnnfDys4DXwBRctqMGjCDpekXtRjmX3a7bqVSv7vWqsqORW3GJzMTMe3tCOTrlwOfJicTtjObZjf2bf2THzX+O0+qiM/0QpMJ4Jv14wZjNh5/k0CFU6qNexP1M02ukjzmXouHW6ZEJju1ciGL6Gz1p8gje42LsWnXGVgR5Fk8JPjFmXlmjvZHiAtXUc27YFDl/DJqa2PdIknokjr5ttEw5PR753zShpJsUoPdA9coY0uaIUVMZ8OgoelaRTrF/wLQ9vZprO7k63+/gcp7q9a9INTu4wzC16KUXsUP7hNUiR+GUd2zi1wXeZFtLGHWWCcxuh1j0YFzGYSx2HPEmEnMH1O8t0fT2ET27HYzlmTjXdPcy+y5ME/npxcVoFfY35fvaK/gwG1QDviK4fhzGEHT1EbBONyi2hOWuzeHepm6DRZN2xXDV3+enSzpVs7HQ6E3a6bkUJZdc5lg5I3RCkKsLEFL5o0so/T2KlJ1WdZUrbpCD4Du59B5/dDEraO9W8TlFTnbCYdJgJCmjcBi5GZm49ygH+G23sZ1TTE5KskEKPuTKuNFJufhe7R42q39zazAwHgyzhS7+ngkwrOuVNoPSSZ4IKfSkRPse1AmGQLX35BhJhXIGRJwmYPCNMGK0dchmVntCiNoE7R1rnX0Pwttvx54QT4zWM2bvCLf3zM6B7QOHP07xx8qKvqOR2Tivgr29OO9SktPj3OmoiJqSrwejIHcYuVCcqFDJRdRQ1lGEPZCoR4TKgWSfeWxunLOTh3PEAX0cFrhEyrW4Fxa9TTNSiR8UfHzn6ma4wRJQMt8LEAg1VGbUnQ2NDbjDw8h5V8n2LXKNuyzOEdij23ivB3dyJpck02gQob4VW8nLMvj05PDs5m1y8/eHkzZhdVUtwIun2x6Hw31VJSZRRTXEpIjWWG9mNaWA5LM+LtbMFuKGzpBg29CCfFVt4NxNuTCFPJiaijq4aHJtBVs2h2wxc9jqUtjr3HlTdCvl7HeYEyOplIXxbAe3XCPUIkqg6IV631LDfW3beTfzX7zasW6NybqwzLi7vBToVNwPe/l/2Uh26o6VJ1tNtylz0onOrUHlXMiccbgKqB7QO+vfEBZ8YBw0+AeyylbvumOimH6nQ5Wsa9xbKIYmZTxrsK/R3uu7RheapvwVJX9/f/zigutftNTq2ft9jzauk1TmSNBptruWFp7nrtc2qx2ZqXb49gZ+9a4Ro/2NhY56Y95I289HM1hV9bJM9Jui+PfUe0nb2jgjSqLuhk8vSBV39ZlPo7Gh3/CiHgHcWpRFKeg3c4JINd2UIesw9V9qWKaDIspxbbbdq/NO2e9p2T9uu3nZExoemlFBRLuuccTtnQzZwe2pQKmHgUqCU6qPQ16sr13RfK8P0+yI4n5gkn622huoDtxO1oHSuOwSbU3x+tSi6sDro31DLPykcpnrKG7QLpW/g1FMBohLAP1Xu3lW5moOwFMdTLHjZnHGkpFEJXnVK8KFvILCBmQ9K8IMw1xqlHczQ9o3ldNXpBoXiyvD/nOo/Xp4pNyKsakK0Lr6lMhXiRwY7dfF6e6Rv2hiqKKh/QUPpGZdj0wrzj4rcdKvx59bSzJeR5kGEqSoF9EQH9JcWNVSZF0DFcSIksT8E1wql3flgqKiyUDykMdbonj7e0FuyDk8E99ee64LKxF8grsmy203vT98/85VUAWHly1ou4W2GcnRM6ynJAkbH4LPOlC2nD++oB+snNXLsXumk/rV09kaVTxU3uOZDaHoXKhEjgtgyPLqR3OCyNrzFYuGw0O6gs4oskcJPM8hQG9r8fa+yvsPoKgf7TUYv/6H0jcl4iIeZ+AGX740bFiWBfoK3mPz3xVj1GFVYz+rn2idlxaT9frquLzXeFNeNrZe+7GXM//xF/Oqg/8WXn3/ZP/ji1Yv+9GUc9l+EX716Gb96xWP+ypXaZKzK2i8PXbCAKRdkTUXS4xtvQqxXHhuklHPfxzZqJs9gJK1WUR76xM6xCnOqhPqruMusJAlk+TQRoU9N1C9qxS06f3d4OjIBHLY7qNH5OyWTJRU6vZ4xKu7VnJ52iwhOi3UAb81+nwRw6jk6KpSdSJWxydK/SBUSikfWxiccnsH58Q+meEcaFRKAF3SKprxzm0b9uPC+DeMJXJqmYtgoNRtHvvwJAMQqSdSCXAGlCnM+QzMkGA/wY/G9uLg9wLFayETxiAjAb/lHJJoL8pH+PRDafusfrDe8/7+PQGI7WUJ7zLVtKeYyy6dBhLf1Zi8aBkUFxgzqxEd3q24vz04Oj386qSms1VpMdDOYJmo6SLmxqIvaiyn+H0Rc24EnQXFLU7fBm5OLNiuZz9AGSs/azqlqrlG/1cvA55kG3Y+JVlmJG3gd2pNE3AndZDXHuyBLa1b++7tq9iOgRQdpK9rv1TqrmvROdlXZ7HexhJnatIMC7d/4LW+zSvktyrYlGOQ6nAdVz4BrK2Ie2oGZ0/k1qIsP3Q9H+wu/5TvsltD6a2hlt1n6i2mr1tlt2VzaxKBRZe5+TN3SuelPrCbmdbSdf7gfFKAN593fCrtfTP9dwHviLRGAZDj96+maKXpkwqx5i1Zzayeuaf2DQWfzbIs5O437qlgL7TITa0CLlvK20jDewebu+3C0DtJWT3GWT5dtVjqfLmeYmjbiZuuAPrT220dFS6x27L0zKg21WIWUYTKBUI0LYdlUfNqJ9COhNdtPOKqLihDpYc6wyk8cZjycI7wInrPe2iWc9h533U7HxVwz+HF0dPLm/KT/IngezG2auAsS6tS8jc/9T/3oym+VaTwrKkNOurSjNj6OTUgZLr6ldEHKZQPX9jrE+v298Z7y/+Pno8WFgcpVVGsU7vbo1HpfJEMumYvGG79qYj1W/q6J6pU05P6eHkD+rJPVipp/zWnY8PKqTnm4t1A9Nkce0d2/ynIWb7b6LpVT5zY33prWuU2K4TP76NhmZuf07fkF67Fp8ZPX1GUMmOb0sIr+uvSbTza5LIBr8xX63L2mY54m3clcymB4X2qturuVGY3LqovLZQPh/b0f4e4dqxXrFaIUV++r1Wr1H9iRFI0= +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint creates a recovery code which should be given to the user in order for them to recover (or activate) their account. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-recovery-link-for-identity.ParamsDetails.json b/docs/reference/openapi/create-recovery-link-for-identity.ParamsDetails.json new file mode 100644 index 0000000000..07d859f360 --- /dev/null +++ b/docs/reference/openapi/create-recovery-link-for-identity.ParamsDetails.json @@ -0,0 +1,5 @@ +{ + "parameters": [ + { "in": "query", "name": "return_to", "schema": { "type": "string" } } + ] +} diff --git a/docs/reference/openapi/create-recovery-link-for-identity.RequestSchema.json b/docs/reference/openapi/create-recovery-link-for-identity.RequestSchema.json new file mode 100644 index 0000000000..61be0dfed8 --- /dev/null +++ b/docs/reference/openapi/create-recovery-link-for-identity.RequestSchema.json @@ -0,0 +1,28 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create Recovery Link for Identity Request Body", + "properties": { + "expires_in": { + "description": "Link Expires In\n\nThe recovery link will expire after that amount of time has passed. Defaults to the configuration value of\n`selfservice.methods.code.config.lifespan`.", + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string" + }, + "identity_id": { + "description": "Identity to Recover\n\nThe identity's ID you wish to recover.", + "format": "uuid", + "type": "string" + } + }, + "required": ["identity_id"], + "type": "object", + "title": "createRecoveryLinkForIdentityBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-recovery-link-for-identity.StatusCodes.json b/docs/reference/openapi/create-recovery-link-for-identity.StatusCodes.json new file mode 100644 index 0000000000..9bf359c722 --- /dev/null +++ b/docs/reference/openapi/create-recovery-link-for-identity.StatusCodes.json @@ -0,0 +1,187 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Used when an administrator creates a recovery link for an identity.", + "properties": { + "expires_at": { + "description": "Recovery Link Expires At\n\nThe timestamp when the recovery link expires.", + "format": "date-time", + "type": "string" + }, + "recovery_link": { + "description": "Recovery Link\n\nThis link can be used to recover the account.", + "type": "string" + } + }, + "required": ["recovery_link"], + "title": "Identity Recovery Link", + "type": "object" + } + } + }, + "description": "recoveryLinkForIdentity" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-recovery-link-for-identity.api.mdx b/docs/reference/openapi/create-recovery-link-for-identity.api.mdx new file mode 100644 index 0000000000..a3ead9e8f8 --- /dev/null +++ b/docs/reference/openapi/create-recovery-link-for-identity.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-recovery-link-for-identity +title: "Create a Recovery Link" +description: "This endpoint creates a recovery link which should be given to the user in order for them to recover" +sidebar_label: "Create a Recovery Link" +hide_title: true +hide_table_of_contents: true +api: eJztW+tzG7cR/1e2cDMmW/Lo2IrbMqNOFYtJ1KS2KinT6YgqDd7tkYjugAuAE8VK/N87C9yTD1GK3U4/yB9kEo/dHxaLBfbBOxahCbXIrFCSDdnFXBhAGWVKSAuhRm7RAAeNobpBvYREyGtYzEU4BzNXeRLBFGEmblCCVWDnCLlBDUKC0hFqiJWm1pR6CyJj2VEaeGjFDbfYpW5B30OVSxuwHlMZak6ATiI2ZB7EWQHgRyGvv1X6JEJphV2yHsu45ila1IYNL++YoGX8kqOmPslTZEOm0eZaTqxiPWbCOaacDe+YXWbUaawWcsZWq6se0/hLjsZ+o6IljQiVtCgtfeRZlojQoRr8bEhWdw1SbSG+c4ihhAyE2QmiRA1nng84Rj2WaVqyFWiIGN5mQqOZCLlJ2pEa+QFwIsdyLC/muL49IknAUwEeW6Qd4BZ4SgIGFYMVKcKcG8i4MRgFcIwxzxNryj0MlYzFLPe7ADc8yRFUPJYfDSaxQX0jQgxStHMVmSBUEQZ+RpCIGE3G5cfA7Yy1qAn2vy5f9f909fuONPe5uU/NvblP7+fd37Le+i70mCiENBHR5vorCVpVyreUQTnvpYGTY1iqHBbCzBt6R5BipVNu2ZDluYg2ua+8CgiNERtetqBcVYPV9GcMLU0WNsF9Guq2eEWUb/tKi5mQPDkllX3vddP3E1+TKWm8Crx+9eoT9O8ngxEs5iiBS+BRKqQwVnOr9M4TTdrJZSXDYKdScrvJr63opXYe2XJnSN2M5WnmQdkNhS2ItzYo4hb7NHObjpTTJzR9DyCPQhjPKuSSLFZOIqpVw2FqWKCH1aLN/apWhMb5bgBg65rjtKGNWO8wb6seO/gkXSD5G8tlxHUEH/QS/nr+4T0cnZ4Aaq2cfU653bLf1LtJbuQmlbq6MSvCaT7bnHVMzWRULBfSgBsFQnreQskA3AYJA7nJeZIsQSoL/IaLhE8TBC4jZ66sor1DSY0RYcZbnmZO9LTOiFs+5QaBRzwjs7fgBnI3mqbGQkZuozHBlES5RbF2LJvOKsFzs50I6GbZRFDcHxiRiFSuQzKldEnSeqYIscrlFrNT8J20mG4KsfpWizLOtZ27+7YSJih/xCS3uUZn7kvUbcAfnDbCQtg5WcwvX785+AoihcahxVthtopoq1k+JulwyKX4JS9FdHIcjGWMDsZEKjupN3Sk9be+472yR2XzWP6SK8sneBsiRhjRsL9Ty6hoIPgyT+kMbqXLeqxNoWG1iwWQGZ6pPpHp0xrYcDupXw1x1WMpGsNnuCmmv/mOevtqfSrmbDE+PWYst7mZ0D275bGhItK7TKNBaZsk/TSgadA5eHXQg4NXb+jPlz0IgqDb0gbqr42vkPbtQQ1FSIsz1M4Q7roEZyhRi9AZiHeFrVo3nP50NQxmZYy8XTmr7cpei+lofeeZejN58Gwmn83ks5l8NpPPZnK3mYy8p/dsKp9N5bOpfDaVz6Zyl6kkKWGYa/LCKa6o9PIoDNGYC3WNkg0vryhgaPnMNCNFBIXiPMu+5hYTkQrbn+bhNZIMrikGY/ouItNP1MKpDgnz3InMxy8TLmd09pcZnjtwrMcSPsWEDdlflF4OwkR4U+PNAQkzzZS2cDeWAFAFGY8y0fMt75rRvLJtX8xqLFcQa5XCywbXl19TNCVU0ti1GOEhSFy0OXW6X5djeSZOJF0aIRYjGyg7LUpdxyJBCz5qe6GG4BX3axgMoKPcdvGkC53iLiNLnMsIYyEx6vq5e0Nyw/0SWONXr/yuOAg9dz/ACg6BL7hoLTN4EEHHb0K5wmJP9oIey+7XbNWrlOQ71VAOya24waZeZDy8JuOQcuEixYWedMZybMf++r+1Y+a/xmn1URn/SWUoeSb81sOYzYSd59MgVOmgVon+TNFoJ544l6Hj1umSNo5tuUAYHsKYld8mhY0YM5Kw31y4h7as7V5pENHftTAG73Gxd1s74ypOdxLVULqEZe/kDZgEtHUQhoewial9LGgSz8Q7L9dtE45OT3zv2tnwMjVZD3SPbDJNrigF1Zk6PQkeXEmn2PvgGx5ezzQ9ITrdbnBW7E+n3Kjuw2ScNPduUzcY3WKYW/QLF7ED/ptDkCLxWjK2cWqDbzMtpI07ygTnNkKtezAuXocubBzyJCFF+fjoZX78OIQvbsZjOWZOWt09zL7NkwS+v7g4rZ6jjfl+9or+DAbVAG8iPz4MYwg7eojYJhqVW0Jz1mbx+FU3QaPJumO5ahqN06WdK9kwHHRb7bxUlF5OfOdYOiB1Q5CqCBNTWLpJKyo+iZWeVOmTKZ2cguAjLp4dfHYzKGnvFPM6RU3Jt2LSUSboqeXOdDEyc/tRDvDf6Ky/oESZkKSF9CiaK6JioLQHzquIGqm0ubWZGQ4GWcKX/pgFmVb0/jCB0kueCcqepUT4HNeybkG29FkZSIRxWTueJGDyjDBhtHb91knQwN1SrZu5sfC2JfLXjlsG2efHwi3N/QsgD6W4HtK88SZAn1DJ7Zx2wDuWTjrUpLT49zpqIiakS8HoyD0TnBNBVOgxRylH1FA+yCBTiQiXAc0aeQNunLCQh3PHA3xyErhGyLS6EfSynmKiFj3K/fg3rZ/pkqNEyXArTCzQUPJQezI0NuQGA7/ed9X6vkGuUbfXM4T2I/HJO8Hd3ImlyTTaBChvhFbycsy+GR2djc4mFx9+GL0fs6tqC0aS/FIOhUn3cqNUXvneKtw1EmN5kN2YBpaj8gpZu26AG7peimFDD/JFcYR3M+HGFOvJxETU774Gx+bzr+bQbT6LJlbBIbysvpRX9Ut4QW+G9Zu4fkDttUTtfdh7w3WrJT/pYUCArF4WUmtLDtYylOUIEkV1tRy25LffzHYqUR1Wn3qPlMnh44Z1a6jOKHbGRZCigKzi5sO+/+e9VIfuomqS9XSbgih60RlpqGw1KScONwHVA1rPhifigi+MgwZfAHbZyrl1JrruRyp0camGf0axMjHzwZF91QCdblmx4r29okBlfwVB5b/u1US27teypstsdY70GGhVxlyojSDBOpGG39W84Sq/a5OJK6dx1D3hXRU8qx6bqXUh7nm+2tvGq3KrRB+9sBbwmCemKZ7/3b54zk+QWeafcVuV7yEj8ZC4fIVULa8NyJelFlw9pFSPsyVPEF1n74ggjbpPQvtISXd2tDt+FCPCW4vSCCW9OK9xyYa7IkA95iqptkWCSHrl3MrMVOOfzc2zuXk2N8/mhsh4x4aie8plUzJu52zIBs6WDEohDBJfeOYdJy/7XJO3Xzp5d4VrNzFJPlttdfQGzgJpQWkK9+hpTvF5gyKZyGqXcUMs/yRnivKE79EulL6GU08FiEoA/1S5K8pzuTRhyQskT+KyOeOdkkYleNUpwYe+gcAGZj4owQ/CXGuUdjBD2zeWk6PcDQrBlc7jOeU1/Xqm3IiwynXSvviWSlWIH2n/1Hl77ZG+aWOoIpfwNQ2NE7VwbFpO4rsi59Jq/Km1NfNlpHkQYarKBXqiA/rrSphV5heg4jgRktgfgWuFUu/847fIHtL7V2Os0dXDXqM00OGJ4N5p/lhQmXj38yNpdrvp6fR9FbekzB4ri525hA8ZypNj2k9JGnByDD6bQlkg+vBIOVg/qZE78kIn8a+laTay16rw/5t17lQsLBEjgthSPPJnr3FZK95isXBY6HTQHU2aSO6GGWSoDR3+vhdZ32F0GbH9KqOX/1D62mQ8xKNM/IDLJ+OGRUmgn+ANJv/7Zax6jCoHzuoK+lGZCWyXtNc3Y6vSm72J+R+/it8e9L/6w5d/6B989fZ1f/omDvuvwz+9fRO/fctj/tZli2WsyvIFHrr3EKZckOIU0bG/eG2p6/9p/ee+j22k/V7AibRaRXnoI4DHKswpme9jNi4ElySQ5dNEhD6GVVdUixt0pu3o9MQEcNTuoEZn2pRMlpSr9yLFqAjAcCqsFxGcFiIHr7j+SARw6jk6KhTGSpWxydJXLgsJU60Wxsf7xvLFCzg//sEUhc5RsQLwC52iKYMzplECURjahp4ELp5XMWxUSxhHvvwxB8QqSdSCTj3FlHM+QzMkGPfwY/G98Mnv4VgtZKJ4RATg1/wjEs0N+Uz/7gltv/UP1hue/u8zkNhOltAec21bgrnM8mkQ4U19rouGQZH5M4M60NXdKtvLs9HR8d9GNYW1HJ+JrgfTRE0HKTcWdZHzM8X/g4hrO/Ak6InSlG3wfnTRZiXzGdpA6VnbDlXNNeoPehn4gOSg+znRKitxA69DO0rErdBNVnO8DbK0ZuW/P1aynwEtOkhb0X6n1lnVpHeyq9K1/xVNmKlNPSjQ/pXf8DarlN+gbGuCQa7DeVD1DLi2IuahHZg5XVWDOkvV/XS0P/MbvkNvCa33tCu9zdKfTVu0Tm/L5lInBo1Cie7nlC3ds/7GamJeR9v5B10qMdpw3v21sPvF9P8KeE+8tQSgNZx+f7qmih6ZMGvWotXcOolrUv9k0Nk826LOTuI+fdpCu8zEGtCipXRMGso72Dx9n47WQdpqKc7y6bLNSufT5QxT00bcbB3Qh9Z5+6xoidWOs3dGOcQWq5CCaCYQquH7lU3Fp51IPxNas/2GowS6CJFqy4ZVKOIo4+Ec4XXwivXW/G06e9x1OxkXc83gx5N3o/fno/7r4FUwt2nifCHUqfkQn/sfWpJ3b5VpVMaVT07yz1Eb/45NSBjufUuRgZTLBq7tead1V71REvz/8UPgwsGgvCYlpYVzFJ1Y74q4xyVzr3FW/yTQ7Yv/WR4ltmnI3R3V8P6kk9WKmv2PgykiEgnjCn+LeFivCME2o1NlxNalgMpgiKv+67E58oiiAlXct6hS7LsgTz13o7q6jvbSkz+zD45txnxOP5xfsB6bFr9PTl0sgWlOpYT010X5fBjKxQdcm6/8yF39KPM0yVtzwYT6Z9CVV1fGOi6rLi6XDYR3d36Ec1NWK1ZKrXDKr1ar1X8ASxDHwQ== +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-relationship.RequestSchema.json b/docs/reference/openapi/create-relationship.RequestSchema.json new file mode 100644 index 0000000000..5366b2b611 --- /dev/null +++ b/docs/reference/openapi/create-relationship.RequestSchema.json @@ -0,0 +1,49 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "description": "Create Relationship Request Body", + "properties": { + "namespace": { + "description": "Namespace to query", + "type": "string" + }, + "object": { "description": "Object to query", "type": "string" }, + "relation": { + "description": "Relation to query", + "type": "string" + }, + "subject_id": { + "description": "SubjectID to query\n\nEither SubjectSet or SubjectID can be provided.", + "type": "string" + }, + "subject_set": { + "properties": { + "namespace": { + "description": "Namespace of the Subject Set", + "type": "string" + }, + "object": { + "description": "Object of the Subject Set", + "type": "string" + }, + "relation": { + "description": "Relation of the Subject Set", + "type": "string" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "subjectSet" + } + }, + "type": "object", + "title": "createRelationshipBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-relationship.StatusCodes.json b/docs/reference/openapi/create-relationship.StatusCodes.json new file mode 100644 index 0000000000..0332f1a9ca --- /dev/null +++ b/docs/reference/openapi/create-relationship.StatusCodes.json @@ -0,0 +1,160 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Relationship", + "properties": { + "namespace": { + "description": "Namespace of the Relation Tuple", + "type": "string" + }, + "object": { + "description": "Object of the Relation Tuple", + "type": "string" + }, + "relation": { + "description": "Relation of the Relation Tuple", + "type": "string" + }, + "subject_id": { + "description": "SubjectID of the Relation Tuple\n\nEither SubjectSet or SubjectID can be provided.", + "type": "string" + }, + "subject_set": { + "properties": { + "namespace": { + "description": "Namespace of the Subject Set", + "type": "string" + }, + "object": { + "description": "Object of the Subject Set", + "type": "string" + }, + "relation": { + "description": "Relation of the Subject Set", + "type": "string" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "subjectSet" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "relationship" + } + } + }, + "description": "relationship" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-relationship.api.mdx b/docs/reference/openapi/create-relationship.api.mdx new file mode 100644 index 0000000000..07dbb0dd84 --- /dev/null +++ b/docs/reference/openapi/create-relationship.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-relationship +title: "Create a Relationship" +description: "Use this endpoint to create a relationship." +sidebar_label: "Create a Relationship" +hide_title: true +hide_table_of_contents: true +api: eJztW21TGzkS/it9Sm2dfWXPZLO5++AUV0vAu8u+EA5IbW1hisgzbVthRppIGoyP+L9ftTSv9jghhN26D/ABbL10P91qtbpb4o7FaCItMiuUZCP21iDYhTCAMs6UkBasgkgjtwgcNCacBpqFyAI2YCpD7RqOYjZifthpYwwbMI0fcjT2tYpXbHTHIiUtSksfeZYlInJjw/eGuN8xEy0w5fSpDevAI2jShlNPGRzpAcs0obECDU2XPEWT8Qi3aR2XXSTahxw1zbarDNmIGauFnLP1gKnpe4zs9uw3rv2TU0stbU8u8X9yuskdiysRbxM4831HhxWFiZzIsbAL1FB0nqEFVX07OoSIS5giZFrdiBjj4FNMDTqZH6BMNQO7wJItnKF9gFrvR+QeCr4PobW3TqExZqOLhpQVzAary2p61WeFTRy9Su+O5q5h29vDWe6a5twOlRZzIXlywjVPSatsxHw/gTCZksYvxovn337FRtrYnQ9f50rT53mW4MOX+vN07r/an6d1v73VSe5po/2/bbRHodk80vxebAva7h+wl8+ff8X2O18gGMtlzHUMb/QKfj57cwz7J0eAWisNM6VTboOtnel6t8mN3aTSPWzNinGaz7dnHVIzkARcSANuFAjpeQslAzinCEAYyE3Ok2QFUlngN1wkfJogcBnDghs6gqYIKKnRGTve8jRzWiU5Y275lBsEHvPMooYlN5C70TR1JmTsTAcTTEmVHfa3Q2zaCwTPzXYqoOXfRlDEHhiTilSuI4RI5Uns5JkizFQu4518r1pMt5VYfatVOcu1cxANZQKd9gsEyW2uq83rGLQBFxtzKewCjg7h2xffvfwnxAqNQ4u3wnSqqMuTHR2SdjjkUnzISxUdHQYTOUMH40oqe1Uv6FjrH3zHsbL7ZfNEfsiV5Vd4GyHGGNOw/1DLuGgg+DJPaft10mUD1qbQ2IeFAHTyzdWQyAxJBjbqJvVgiOsBS9EYPu9wqb/5jnr5ansq5nR7cMttbq4iFXfQPFAx2V2m0aC0TZJ+GtA06L18/nIAL59/R7++HUAQBP2WNVA/8zbERkxI+6+XNRQhLc5RfzLYmKNELSLnIA4KX7XpM/3uuqwnVc7I+5XT2q+02XS4SUfrR8+Uud4ZzxP75CqfXOWTq3xylU+ucperJC1hlGthV2x0cceUXu1HERpzrq5RstHF5ZrY8rkhHK1o9NLnjauh5hYTkQo7nObRNSUW7BqtGvI4FXKYqKUzHlLnmVOacZwSLue0+1cZnjl4bMASPsWEjdj3Sq/CKBHe2XiHQOpMM6Ut3E0kALSqMfuZGPjWAyVnYp77ulDZ1pn6TuQaZlql8PcGu7+/okQrUtJYsraaFOyBxGWbfK//qhzLM3Ek6byIsBi5Aa/XotZ3bBK00J2Wj3ZgfgVhCD3l1pIn/RrrXWG1A+fMYQ17wJdctIAF27x6XkHdICay/4qtB9VS/agaSyS5FTfYXJ2MR9e0SVMuJAErVqs3kRM78cfwrZ0w/3WWVh+V8Z9UhpJnwq8DTNhc2EU+DSKVhvX6DOeKRjvJZ7mMHLden2xiYrvFgNEe/KNFPDjGZbd+e31ScHcffIQN1U9s20RGe7DNp20wNIln4sAL2TVh/+TI925YDM2k+GEAekCOiiZXlIKWtZ0cBdsi9IoVCF7z6Hqu6UDt9fsdA50eulXZD8a3GOUWvSBi5oD8bQ+kSPwSTOwstcEPmRbSznrKBGc2Rq0HMClCoOUCJUQ8SYScw7vPw373bgTf3EwmcsKc2P3PcPkhTxL46fz8pAq2GvP97DX9CsNqgPcC7zp4j1q7mKZt81W5Jb6nbWL3EKyJC03Wn8h1c7edrOxCycaOI1e70ycqvbrynRPpENQNQapiTEyx+6+aPvxqSnZdkNjlJXeQa9IpSbS1tTlRU7m8GLmfCTr53W4qRmZOreUA/4122TM4xJmQZC90Ri8UUTFQ7kQX5Bbxvot0F9ZmZhSGWcJX3s6DTCs6Dk2g9IpnwpBTIcJniG0vH2QriuyBQyKMK1PxJAGTZ4QJ440jIaNiKVrUJnB+uHVaNARv+wDvcp0YezBh94Vber1nQAFz4SXTvHFOodMPz+0CpS3yHKcdalJa/HcTNRETEngUKR27o8vFtESFYguD+gY1lPEBZCoR0SqgWWMf/hinLOTRwvGAFO1CxcB1XYWEKSZqOYDceHhF4AR2wS1RMtwKMxNoYKVy7cnQ2IgbDLy8B5V8r5Fr1G15RtCOWb54Jbibe2VpMo02AcoboZW8mLDX4/3T8enV+ZtfxscTdlktwVhSmsSh8Kleb1yCKGOAInsgNZbb0o1pYNkvnfeGowduyLEXw0Ye5LNie+5mwo0p5MnElahjkQbHzZCk5tJvxgEdLqKtxF1H57N7n5zEzOpVIVxbwA0vUg4gsJXH3mtJ2eXaertk2dvV0a95Od/TmxSpacFTzTZjuuG/O2iNnE9vEvPUmviLXnQeECpHSCuPo20Y9YDW6XkvNPCNcYDgG8A+W7ug3cTXw1hFrvLQiL+pGiLmPv3tvDDq9alwQe7Dh/DS3xPtuFmqcpFuo2CbiQlr5jxW50hgNdpcy3NPqHV7tB6wudrE3BX22NtG2PKXCTDjifm8BJk/5Ds13zbnTyHftuXPYe91Nwdp3N8S66LcuZdftkK95hdHmbJNvLUoDbU6Oa5xxUa78sgBu+FJjtv5JIVJ5czKmKvRT0b9ZNR/pVHTBB/5UBacWyeUXbARC53JhqUkQ5u78gfVXCi08lLnmqL7Mgy8K4K/K5Pk83VnKBg6U9eC6mqmuMWtpvhCV1H9ZnVQuaWBPyjcosL2Mdql0tdw4qkAUQngD5W7C2VX/BWW4kSKNS6aMw6UNCrBy14JPvINBDYwi7AEH0a51ihtOEc7NJZTKN0PCs2V4eUZFeK9PFNuRFQV52kJfEu1/sSPLG3q4sH2SN+0NVRR0PiChs4StXRsWmHkQVEkbDW+bS3NYhVrHsSYqlJATzSk37Sokcq8AGo2S4Qk9vvgWqE0MX+CF+VuOsQ1zjSaBbjw00CPJ4L7sPpdQeXKB6jvyIjbTV9O3z+aklSKZuUDJi7hTYby6JDWU5IFHB2CL/9R2ZI+3FMP1k9qFDu90kn9G3XFresWVWQIzbdfK5WDRIwJYsvwKOK9xlVteMvl0mGh3UGHAVkixUwmzFAb2udDr7Khw+hKuJ83Gb36Xelrd6+/n4lfcPXFuGFZEhgmeIPJXy/GesDoquu0fgc3LkvXrQcfdZ2/fLpRt9TvMOq25lOW7dbiecmD6RNsupopL/C4f0uCKReJe4nhEvLvvfmxQXlykELPfB/bKnw/gyNptYrzyBcdDlWU03WWTxNd1p8kkOXTREQ+bSbnLYzVrtTpfOX+yZEJYL/dQY3OVyqZrOi2yq8RxkXOx+GGJyKGk2INwe8Ev8cCOPEcHRXKnFNlbLIis4rJ6061WhpfYpjIZ8/g7PAXM5Hu3i8uJAAv6BRNmQ+axiVg4bkbhhe4EkLFsHFfaBx5pwyaM1NJopbkRqgolfM5mhHB+Ai/Ft+LTOUjHKqlTBSPiQA85IdINBfkkX4+Etph6wc2G7785xFIdJMltIdc25ZiLrJ8GsR4UzuKoiEsau4mrNPzfqduL07H+4e/jWsKG9V1E1+H00RNw5Qbi7qotpvibxhzbUNPgoKepm6D4/F5m5XM52gDpedtx1Y116jf6FXgayBh/zHRKitxC69DO07ErdBNVgu8DbK0ZuW/31ezj4AWHaROtD+qTVY16Z3sqouSP8US5mrbDgq0P/Mb3maV8huUbUswyHW0CKqekGsrZjyyoVnQ2RfWZe7+16N9z2/4DrsltD5HrOw2S9+btmqd3ZbNpU2EjfvC/mPqlg5uf2I1MW+i7f1Oh8oMbbToPxT2sJj+p4D3xFsiAMlw8tPJhil6ZMJseItWc2snbmj9q0Fni6zDnJ3G/f1LC+0qExtAi5Yy02kYb7i9+74erYPU6SlO8+mqzUrn09UcU9NG3GwN6UNrvz0qWmK1Y++d0rVFi1VExR8TCNVIJsum4tNOpI+E1nSfcHQDJyKk1xWjqkSxn/FogfAieM4GGwk87T3uup2Oi7km/PXoYHx8Nh6+CJ4HC5smLrlCnZo3szPUN8IFyaFVpvE2pAw5KeFHbXwcm5AyXHybKWNTLhu4Omvom6l/403cF/7DTZFZ0JUH3VcJlyE68e+KkscFc1FzI6gvix6XA0Z3XjTk7o5em73VyXpNzf5fUUYXl3VZwz08GbAF8pjy+6pQWDyQGbrKTF0e3HrYVxcIKdbO7CfHNss3J2/P2YBNi38XSl1RgGlOT1jot6uH+dKRS/Rdm7+yzd3LJeZJUv7iqgKju1JpVXpWFi0uqi4uVw2Ad3d+hEsP1ms2KCQpsuvL9Xr9P3cFbyg= +sidebar_class_name: "put api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to create a relationship. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-test-login-flow.RequestSchema.json b/docs/reference/openapi/create-test-login-flow.RequestSchema.json new file mode 100644 index 0000000000..2976b0f5f1 --- /dev/null +++ b/docs/reference/openapi/create-test-login-flow.RequestSchema.json @@ -0,0 +1,23 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "provider_id": { + "description": "ID of the OIDC provider to test. Must match a provider configured on\nthe project that serves this request.", + "maxLength": 255, + "type": "string" + } + }, + "required": ["provider_id"], + "title": "Request body for creating a test OIDC login flow.", + "type": "object" + } + } + }, + "required": true, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-test-login-flow.StatusCodes.json b/docs/reference/openapi/create-test-login-flow.StatusCodes.json new file mode 100644 index 0000000000..645c7bf7af --- /dev/null +++ b/docs/reference/openapi/create-test-login-flow.StatusCodes.json @@ -0,0 +1,1671 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "This object represents a login flow. A login flow is initiated at the \"Initiate Login API / Browser Flow\"\nendpoint by a client.\n\nOnce a login flow is completed successfully, a session cookie or session token will be issued.", + "properties": { + "active": { + "description": "The active login method\n\nIf set contains the login method used. If the flow is new, it is unset.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the login flow, this\nrepresents the id in the login UI's query parameter: http:///?flow=", + "format": "uuid", + "type": "string" + }, + "identity_schema": { + "description": "IdentitySchema optionally holds the ID of the identity schema that is used\nfor this flow. This value can be set by the user when creating the flow and\nshould be retained when the flow is saved or converted to another flow.", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow started.", + "format": "date-time", + "type": "string" + }, + "oauth2_login_challenge": { + "description": "Ory OAuth 2.0 Login Challenge.\n\nThis value is set using the `login_challenge` query parameter of the registration and login endpoints.\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.", + "type": "string" + }, + "oauth2_login_request": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "refresh": { + "description": "Refresh stores whether this login flow should enforce re-authentication.", + "type": "boolean" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "requested_aal": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "session_token_exchange_code": { + "description": "SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed.\nThis is only set if the client has requested a session token exchange code, and if the flow is of type \"api\",\nand only on creating the login flow.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method to sign in with\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the login challenge was passed." + }, + "test_context": { + "description": "Admin-test extension of a login flow. Populated only for flows created by\nthe admin test endpoint; included in the flow's API response so the admin\nUI can render the pre-scoped provider and (once captured) the debug\nround-trip result.", + "properties": { + "debug_payload": { + "description": "Contains the parsed claims, the Jsonnet mapper input and output, and any\nschema validation errors. Bearer tokens (id_token, access_token,\nrefresh_token) are intentionally excluded to limit the blast radius of\nthe debug payload leaking through audit logs or admin browsers.", + "properties": { + "error": { + "description": "Populated when any step (token exchange, claims decode, Jsonnet\nevaluation, schema validation) cannot complete.", + "properties": { + "message": { + "description": "Human-readable message describing the failure.", + "type": "string" + }, + "reason": { + "description": "Short classification of the failure cause (for example,\n\"access_denied\" or \"traits_invalid\").", + "type": "string" + }, + "step": { + "description": "Machine-readable identifier of the failed step (for example,\n\"token_exchange\" or \"schema_validate\").", + "type": "string" + } + }, + "title": "Classified failure of a step in an OIDC test round-trip.", + "type": "object" + }, + "id_token_claims": { + "additionalProperties": {}, + "description": "Claims extracted from the ID token.", + "type": "object" + }, + "jsonnet_input": { + "additionalProperties": {}, + "description": "Input JSON that was fed into the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_mapper_url": { + "description": "URL of the Jsonnet mapper that was executed on the claims.", + "type": "string" + }, + "jsonnet_output": { + "additionalProperties": {}, + "description": "Output JSON returned by the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_stderr": { + "description": "Anything the Jsonnet mapper wrote to standard error.", + "type": "string" + }, + "schema_validation_errors": { + "description": "Identity-schema validation errors produced from the mapped traits.", + "items": { + "description": "One identity-schema validation failure recorded while evaluating the\ntraits produced by the Jsonnet mapper.", + "properties": { + "message": { + "description": "Human-readable description of the validation failure.", + "type": "string" + }, + "path": { + "description": "JSON pointer to the field that failed validation.", + "type": "string" + } + }, + "type": "object", + "title": "loginFlowTestSchemaValidationError" + }, + "type": "array" + }, + "userinfo": { + "additionalProperties": {}, + "description": "Claims returned from the provider's userinfo endpoint, if any.", + "type": "object" + } + }, + "title": "Diagnostic payload captured during a test-mode OIDC round-trip.", + "type": "object" + }, + "provider_id": { + "description": "The ID of the OIDC provider this test flow targets.", + "type": "string" + } + }, + "required": ["provider_id"], + "type": "object", + "title": "loginFlowTestContext" + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the login to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "title": "Login Flow", + "type": "object" + } + } + }, + "description": "loginFlow" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-test-login-flow.api.mdx b/docs/reference/openapi/create-test-login-flow.api.mdx new file mode 100644 index 0000000000..77ccba651c --- /dev/null +++ b/docs/reference/openapi/create-test-login-flow.api.mdx @@ -0,0 +1,39 @@ +--- +id: create-test-login-flow +title: "Create a test OIDC login flow" +description: "Creates a dry-run OIDC test login flow pre-scoped to one provider. The" +sidebar_label: "Create a test OIDC login flow" +hide_title: true +hide_table_of_contents: true +api: eJztvWl3IruSKPpXdOm31i6vC3h22e7u8y4GD3jEgMt2bephkSlAJpHSqUww3qf++10RknKAxOXaZw/9uqkPZTtTKYVCoVDM+q3gMuUE3A+5FIXDQjVgNGSKUOIGs1IQCXJTr1VJyFRIPDnggvQ9OSV+wErKkT5zSSiJFIz4gZxwlwVl0h6yjghYGAWCubq5Q4OAY6+Ki4HHSirqjXlI7uqECpdQUm01T0iP0YAFJJQjJsrkWnYEd5kIeTgjXBGfBYqrkLn4iZBEMaW4FPCOKxUxl0yHTJBwyMygcux7LGTq3zsCHjrUD6OAucRlvWhAXBpS+DaGlCff/qJwxl1HipC9huVCsSB9FlBAUt0tHBYcRFObqfASkHLiyWmhWAjYS8RUeCTdWeHwtwJ+LUL4lfq+xx38fv1ZAaZ/KyhnyMYUfvMD6D3kTJm/EJNd7sKf2fWp14jsI5y4LrYtrAJAXCZXkQrJmIbOkNDktSNFnw9w9lJodPiBfGZOSMIhDYliwYQpEg4RITgLmPSYvl4yMQiHhcOt3d1iIZz5rHBYUGHAxaDw/bueMg+YWzj8NQP4t2Ih5KEHrZu6P9KT7oz0ZUAQeVwMCNV0hTNJiAsGNgPJHoBY+J4dKQwiViy8lmTAB1xQr0EDOr6mY/gCcY+tlS+F0hjd2tj8qfXIorwNSNGQkID5AVNMhEDLKZBJJb07gCIFDzlFag1xuTqFunlEkGRIpVEn6+QokFPFAgIU1Cl0BBOuL7kISW9GKHE8zkRY7oiOuBEOy4wJo1gSd4mKHIcp1Y88b1aEfWY2hyPliDMig/gJbi8y5Z5HeszsHEB5lgipE/IJy0MGI/qdAWXMwqF0AcJ6nygWAqmFlAuFs063IZFibpnU+8kW5YoINi0SHsKvkVAMJutTpaYycEk1YMgAqKfaM581zPOOkNx15t8CFXVEKEN//k37pt3oCE/KUeR3FXMCFs43ucSXHTFlPRqFQzH//p71KvC8Ixzpsvm3VekyeK1BH7FZHuQjNusIP5B97i100NCPO0LRsTf/slW5uuwIl024w3KBq+ErA59mmX3Ogm6fB2phpvX4/Qm87giPi1E3YI6csGAB8KZ5fsnFiLz7kiN395nDqQc73DQksJMJjKGPCiQKaK/CgIZsMCOf4rGBJNbKhNSRGoQMkWLIlIdDw5uTfuMdyUPFvH5ZL8wP5wErVSgWmIjGyLEMRQF/564DjEeGfqFYyBBLoViwdFEoFhzdhVlpvXFg8QrFAqxeoVhILVWhWJhfEOg9jXLTZfL3t3k+C7xuIEsAdAl2Y+GwsNoiqy3yZ26R70Uj4rhdGi6eAlpKdCuhntOQeT4LAN7ICUmfM8/Fg34ge1G/Tz1Z9qUPZ0xfBmPor+DSkJVCPmaFBaGiWGCvPg+Yyh35WL/TI8N8oRPy6a5dXZsT/0wv8YETKQQRzr0pV0OQdiScT4SLYkdQOIj0h0OKr+BwtIf4x2FfIrOl5IaUjBkJ/hIxUq+VyT3A7rMARgHRKDk8oW0RJTOQqjPd8Fho1U3v6r8o8hLB4vogE7GQBYdkGIb+4fr6fwARgJzHHVaGTlUZvypHvBsF3j/W/194+J//Af93ufuP9JSjiLv5s9XyeXeZ7FQ3DVr4nkh8Tj1vRobSc/UsEpE2Fvd1d1o0BcFAMbcjgKJQQNUSF4plE+pFINkLWC6QPnqzZLGRHmJhMyYMKtyOUEMZeS58FTAQVxa0B66IohOQl1F6nrAg1NuTChkOWTAvqqaQgiJVLvXW8dUHiFeFNPgpupPA9ra6uKJdZ0g9j4lBjvx2E8zIDfBBslXeMJJo1TZHQTOFV8ABAxZj8fc01//TPLXZlQzYgCP7AokT9DVNoFa6VeVYXERB1JFavWLIyUgM5BZ+e+MzUa8h7p2QUEWosK9RbwnIum3TsFroD3FktJxF9esd5NVrduGSI8TOWE8wpTstDK+F+ZwliZejii0UoQHTfD2UliekFi2FkqoUAji83s7kTkUU5f+ksZN02REDJhDLmjundCBFpkPuDMmUihAGdaRQ0ZiRmYyCVGcymB/YoT7tcY8D8vKUCNBJuqhxdO1p9h4CKvgBaaOK0jIfAFHqF/jcPrZLEZ+SFmN2lkQPrxUeoLgv1OOu4UEayU/P0/AJEfokffoSsaeyeYbnWo+6sNK0SBRjyEfV4fr6dDoty2BWduR43ZWOWtd0VQKJa/15Gpb0uCUctyNaLIz5TwzrkAWMwHEbcJfpeQw82aMe7AlszgV5Ms0Bt2lUPuWSF/U8OWVu15GB6mrVWP2Y2EhFf0aqN80WudGfaX0TtcaxDBi5a14q8gmZMjtcXx9KFf566Msg/LZmCAeQaQCAJRjTEdM9mg2hQOzEaWpsrWst1PIDc0gD0oOA4tKysR/OihpruMl/UbpHPbXYoqFZzKcneNetXF7e3B/XujfN+mn9uvW01hFW0UXq4EKFjLo5wykW6sHsLAwG9cx8nwk3kc5+DFC5I44YoVP4Gk8xJiY8kGIMKJ/QgNOex4gG+vi6cnR5XHsiV3ettj3HQkmewM7xROJjL5RkKoMRLD4P2RgXd4EKzAOcF1JF5HImnLyTYIESTFPcb0IjouRxFRKX9bmwNGx7NNYizWBwvyTrb1bdbD2YQplAl+ZT4vExR5oYMsuGkIvMgJta7r7IEUJZRHSwVwp2jyJxWACHN9pSkrMFLJDJCUYJzKEjZB/puKypGXF9fdO25gqg45ApnzqakZkhCocFu+3HM1eOKRe476nP10HGUEWy9L0vVah+crHCoQz4G5JQF6X1QUBF2M0wUo/3AVC0WYnI84CUrFHMp2HIAlje/+/XjdLBt//9Sah/RuqfY/VP9c/xP4dr/88C60gMddeR59UMAb8LDnf/y4ASsH7A1PCvhqdHnZEzpEIwD+QJGYVdY1/rJnbKhR2XPTuPqDMqVXUnIInJKCQtY6Rrmk5gLx5J6TEqDEWj/tifwW6cDhlKorCLmg1iBlaa4YCp3SWfrNWvXlsjVY/ysdZrHC9yE5O3Hrwj7C6z4s3Mdm17QekMjc+NRGDNwUUUcCu3a0lPjnkYMlezWJf1aeSFyRbtU0+x1KHW0zNegugo4L8Lt3fNOqCz2QAOoJGkhU8aKWZnanVCVJkJfIbzBJ2LUNuTxpNRNW4a70h73ZQ6/rfuZQNOnnq6cBDUa1oPQNUMbNnjcRQCZHhuCmkeG3O/C+bmu7t6bSc2Ksdy5nuYEWiw/yEwYNe34AyjMRWlgFEXj0/owYrf5hjSertRkuMDG83qJdQJ3ShAz0Oan7wHpbEA/hjOFja0kBoTWmxln9tw2rYSH5MUjlEGGt9rWERxNByC6CgYKDd0AKcKSXXLFRkxP4TehlQNtTw/hk0vXGsXMmYeRJTEM1e+q5eYmXbfM74smTQxRhlSieevbUAgHkRBwETozRAoFfkgNhofHg9Tiib1pnSmyEZG5eUi3NtJYOYiZAMWpIDO5wXzYJqdr/+6a9a1WABcQGMBpQ4yZT3i04F1ZWohXIOCWmwPtn5Ca5qxGVJLC6qkdXZzd1kjLle+R2daTEKWo6XHmBa5ALuT43FnhMvUp2q4lBxBTHHCj0j0Vd3UinEo4cq+mapKTFF4hADOtcIH3xCfSd8DwkTvGe+BwTUWQPW8i2Cv5A4acdiYco9Q1w2YUguCE/P8/2P+LMtg8FOi0HvWx8UZo41HClKjITKLxD6pvbuJtUWFdOxnmcYvyhiJNOo/Zm/RtuZuVi75Oxn8OwD99eLaO8D8TQJbP5Ai/FclthPo5M8T2bhS5BNaD4M1ZJALEtyctU2RHuuI+HD5WcEtDyd/nOS2pPffh+R/RXYLQHcP9OFLBeF9wF5KegPNNIN6xDI4qqxRU8eo/Gg1yFXlMXPYx0MAZEwgj09AnYA1CqSAUMfLGFFA4Dq60OGYC2bsK4Zh+TLUwqQ3I+PICzkwawOSItz6LTw5GIAJIwr/nfA+YRxpDhwIFrYi6clwaC0OuSeO3q7w+COHzim0JuBHUvMHT9IWu0R3l0oLbVnbQaRYmVS1RV8KBor7YXJ6p71WetBD8rQoaz91RCXNfAh4teL2i9rkU0fMkWF9DGYJbmf2yYVj04FT5X+tHZInbl4/dURTczSjFdgxMnwOuo+xoNsdv8LeGLBD8hQF4pCzsH+IpKQO0UJ2iMgqAbIOwaiog6MyHWmnZnZqP+zLsGac9E+dyHbGf+spNwfEX3+yPU9HOdvhvHVzTe5Zj1ywGWlhxEDWEj5is5zPLsG4Jvsk/bmyIrTmsWbjd7CHTiHFbTj6QeJdlgHh0/n9xVpHYBeqTI5mlnNrNi4DN3FcnN9f6LFU2o2s+3UlbGeQ3AHxMxgw/tYPWJ8FaM6jY6mNg+MioV44lNFgmHEvoPUNBmqxUKG7zhlKCZxbEqoUHwhCyZhRbWSUKSC18Ml40BF+FPhSMVUEnuYyBYdtxhg653zwBvnhSx141SmQT9QbyICHw/FaGq3Ws6OMOdi0IaB8oBG4L4OOgGMnPlRHbFYmidVRH5/EuBgN9+1Zp5g9ipDt1yvXFdJJ6KfFB4JClCIeBMfCCWYIOqlYOIAIjHdt1hEgz/Y8jjpgb0Z+Pb+vfAOzfQ9ixTQF4WEZB2VRUpWex+HAKAHrgpBKatTsrPjebG3t7uWqIsEEEJu0bJSWtHSz7drd6/16ae+MbV/t088Pm5P7cK99Wn/deT3qnja2r3o7LfW1VdmZlGQwOX97a/Lb4aXXbO5vCnr/+Nq/rTyGu1zV6nvd6tblQc+9lzsnJ43n09uTybVsPpS66uh8dlTvBl6pfTRQXx/lnVd53j4/2LofP25x0auUGtPZeV/Rer3msMejaok9lF55Ndp7uXoZfeXbV9PbysnlXu/KbRxfbbztnB8505P29heX31fqzbuoUr2/nQYPVy97n7deP/evIlqnZ/zzQ+10EG7ycLi1Xb3s0+bx+HwUHTRuHWfYC7vR8WNp+BKcPO6JsB22dnx6f3/7vL/3enl5sNMqtft7k73X0eXB5n6jf9m6ab/sPVTfXifeyfTt6Pyl4ovKsDd9uXz2G8PB3enGznGtGbwErSNn93Hz6JJNxF7d3x1uVoZMqSN/e3o5uh28dQPJnFFYmvUmbxft5+PWVUQHwn+5nNy0Pz8eTFg9GmxdTRvnX+tbX56dt6azOXm7Ulu7D8HJ7X7Nv5uVeteuv3/QHk8qD1MnvLvi5+7gzJPn063t6mRje1C/q4xqQrVfvo5Hfq/eLzmBP7i+OBnfNrrHtQvJ9v1u4+Hr10G/1wz49rU8/nLa+Hw12psdR/uXz+fDqjf8So+un6P76Vbpwjvq31S2B58PxsP+kRjVBWO7FzcH49Pm7sZLY7T5pXQlg7vH6/bJ1df6eGN0crzHHr/cnxxNz88uLx6HZ3fbOzXJLza/NEpq8tWvbkWVq5PrSvfu/Hh6dVC93ertv7Cd0i47oLPp1WTqRJWgOaoc7Y6P6v0benNO5fa4H40uKse51Oxnyfl0RzUeRs7eIz2Y7cvz+4Nu/fJ55zXy/WjDe+Pds89f2qPW/uvzbst92Hbk8Ybk48fpa51vsXG7ErGNuxu66/qDk9PZ0fmOsx/ebn052dnYemhGg4tau7FPR4/DE7kbViqfP9+y7vU4jB6/OtvV7fF2fWvndOt00txVrdrr3axyvfX2sn/ZFwfHd2O1Fzxu3/T2Hxm/GLX50fNG7nRestNRB17l7KA/GBwpedLcv6HOVrN7vDWYbu1vBe2t0elNZTipe95x+3iT9YPK3jC6u5tc9Y+cK1/sey/sfm/y9iYeH3dbrduTz/6VW+3SQX1bnO7Xe/7m0V1v4/yOB7R5/XLXvxw6t72ue3B6slMbfmafd+57TSV7TSmi5/bj9eZrlTb22jd7m8+T++ChdLm5H74+THcOdm67zmCUGzSUnU3ltnKU12w0t4Z0OhhEJ7PT4P6CTj5XHna+XNwNcj/MM53q42TEXThOIKgN1ILMEW2d0jYiW+uC3InPDJTKdTvt3AIfJRUOK6JdRh+T+oCl6BmUffg2PqypPVc7wtg2AY5Aeh6Y/8yxpCOz4FhJ5AkE2ipyHREJAxrE6OpwpEyjVFTC/MhF4vI+ygJhR6Rhs+JFi4XWKAbnpstVyIUTzg1QJuTTDQj8ZnmI9so5w6R7PfMxHwwx8E0b3UCbm58P4X30Ls7IkE5YqoNOYRTO7GrBIq/Z6fWiEKcIsQ9cK4yoTXUEKOkT6qELwANRkkL8s7L6XUrQSUJlxuU1jXoDmRHGtOXRoYqVFBOKYyC1JrLs6bu5t7Ht9tkG7e/3d3YPco/XUZgTTGHGnJ/kUgEHJQw5CKg/5E4i7nREn465N0tW3Eo6RYg1H4LNulNotiqdAsgbncJxtVMoxyMbnGoRqCPekYHIvAgE8qvWI/88QSdemgTYD69Ms1XJWwyRZSyT9kvweje7bXjdrQ360t8dPZxNa18D5pUu5KTu76vPbHou3a3jhzNvP7z3mkfb3SYbb+9cTI/6L97F7am/KV7osLS7ebZz/hZEL2zDOWns7g8bx/Vw7/4lmIjxefXhVVxH9aPdbf7Qje7uHh7OamdHjDaqraa8Pn+7nqlneb690a7fqYsjzoPhEf3c39rebTz0LviZGzmXbPJlr+FcvJ7vOo/7bzdb+3sv55dH963GuHRTZ5Ppi6qrVv1sZ+c2HB8oLk/4aDjqXU7ly/T+pnlaedwQ3t7D5MuNN6zU3Mvno9ZLq8LamyeNqFqriofpW7XW3L8+qJ8cdevPbis8GVVLwZdw62L36LHfcDec7dmJ352cNTd3WdPdeDvff7j9PJVH1f0vQlFn7zjc9C9auwf+w97W7l6tcR/t39Xc4xvpXVQaA8ftDrau/crnPadCT7rPTnt/4/ngIjh+m+63Jxvi/OiUqaj63Lh+PlXdizd3dN++ewi3ts/Ewe25cp3Nq68Rvd/gLw9HzD977D/Kl2vmvX0J2ebm53DnaPrF3xjdXe1N2Ub9ZfZQ9ejXwU19v1W6rx1Nt7o3E3e8z3avx8PHSs87/iJnA+dh/3FnT57t9S44rd72L6ontSunOagOx+xzRR5vzr5+fVSNHj3tbtefG0F15/Lo6ux2uh9cHbj3z+f79fEzdyZfN/3KeMN9LV2cVRvbs93Gl4vg9ajW33xr3aij5uim9Xy0327c1MT51dte6dndHbbDr6/+18a0IetulYr21+2vtb2oeeS3x7Vp6DdPx3vbd7dqc7x7ct+Y9jbaW/WTXOFgTtTZu+6NHqa1+7shL7Hm7m510OtvfT4Z3dZq93U6vqG1YCN43nzZ6G/2T47fNu93K92Ng8fJ6cbBCZ9sVm62SrX9prc/aG1+Gb1t8Y23autFzGb7lY2t3YcbpznhN1cXn0X99Xjn5qzbOFYjue+G9aC33R4fbw3vHibV0fhtenCs2iebl7dHN6fVPR6py/YD8+vVzdeDaFS9OPl6O3EH4fFN73Z39OYeXA9fSo77Mm6xqy+X8rVx6W72vAn/0j74Mt4vzTa3quGjz87Pbmi9Fn5pXHpHw3N+JBsX94PtyWtrvPPwWvf49Q3rv7BB3VPjdp1uX/mtvft7r3qxPTsb0nDjthQ0X2uv7ox/cU+707fzib9Rn3a3pmP12WelxuC68Ti5uz87OPeH943di+39x5fjI35+8nCbh/g5oWyjsnky9m/umweb3Wbl3n8J2H2LTq7p196BeGAX/Ehu1G5Pj962t2q9l4uX2/3WDj06H/eaw3PHCZ+rl8+UixKfROHO589h5e5q/HY+/XJeq71sXX09mVYPbks7Xx6/jk/uds7OeTi7jVpvZ49sb6f5fF067l7fbmy174en27en93uBfNlzdj87BwdBcKeO29Pzcz5t7V/t+pu7Vzx6292u0ZvnSSl6eTmpnPRn0+vd+9HrWS+gR87zWXjFb6PZbe/2ZVQ9GZYkFWej6eM1m4XqetiOtsa342lzt9bcCuTXLdHgJ8/VPaHcUany+Xi7tT29ent8PJl+fp707u/l4708mBztbHSvHrceN04eb1svTu3NOao7L92NUAiq+ttf7ndO3Ne98f5G8+2mt3WihCc+Ty4eKvmI53OS4eyq6++dBw+zFn/bDOXJ4KJ3/6V07ta3n293Zn50EPSu7l+3g9vzo/443DiRj2+Du/rX4y8nx87Ny5SNm9f7m2+yVqG0dDTauLi/Pq09n599rbm18cnwfrty/dmrl/zoddQdn309Pd/cDF5nzf2b3d2HyxbbbjXGzf7F9Gt9b3a3tfP1dXJ7cfJYD13Pvbs4fbvZq9O9t/bFsPKleZc3nUjlONfvFCOfOgU/6nlaAoXTvVNYm5cJYlMHyFiyb/IF46/K5vTEj7PiLhv7npwZX4RwQSxi1ukBzs7U0FY4xoAuY+gQJi1TBmTCAuMzQSHP2kU6QgpsUyZfErHUkeOxFN6MdAqKo20n/mBNiydMOPCYxRaVteyprniu1P+aJYr+/vbN+XZt6/Vk82iwP4l6B+El2xycXb19+bzH9tuROogaZ5Pml+PcRXnddZYJbK+7CN9DeXfjAMPaQEkA5DlDykVafktJOPgORHptJzfRmo2L+kO6C0V+bZ5Ud7f2N74ZwWehf5JJLgD3PHSPIllsYEx/ZPxa2qNcJuSYOsOOMM70jAXRxNEqtrdTYpiA4pJPLeagtLwD/QJwO3s7+99IqaRtjbp5FHj2izVSO26SX+vtu/LD3sFGefPgYOfbwjw1VGVtPV14adBmCQooUM/CRl2iR0zn+6S++7loy1mWXF67J8dvzehgvL13dnndDSO2t3twee0/3O/51Vkr5KPH54v6fX2X5hzCc8m1sKG1yK910SIaOJNcMZMqm1iuIa31nvUu2GwR0u8f+Qzs2Mbi/cE4i3kzODjrwJwNPjtjyDVNf1GLjX89v7/4RlzpRBAlG+ftmL5hQ8e5ycoaiVsYcYEJpHZfaG4FzY0y/EmtpdoC01EZ/1vMKhR4RMepQTWjsxosuPeop2QcMooW3Hg+CWtBLfWTWiumgqOR1RmF0QCCTkH8hsTZynZednzUw9FVZybUEWAYnhsLRxhTlxE6oRydHxCUBdz7E2D3TmU0wFjfaR7f3tWbxzWdDuB5ujOzf2PzvtsRFgVprs6oM4QPflHp84IOWJlUrA9AyXHKhG7cfInWjuqpjKOzAQqYa0ekliQ73SJxJSyrkgA/xO82j6s3V1fH17XjWhHYlk4l9iBoWDEnCliyiK+7zqK3VucWQaKFDmcjmgXHzNDkR1iriw16M0ujzTY6CjJIcRUTYKzTzZKINJwNvOkIbRAKh2DesVFhWbazwG2ep2FXuwH/Vh8c+PI/yBDAe29995V0wJUlLsuO40gc6Dx38mMWUjj3kQ8byICFNOn0iimgu2xyPvCxcuqljhmQwUiRKcMcwHCIPKhIWreXOuquNaWDQSZ5yBYgKBbkVLDgA1O+gXaYQAG/mJxPczCa4Aw7aewyLucw11EuEnzpcWf2QeQ3sLFFv/4rL/gNMaND59EfNx9m6Qd8Qp0Z0YPHDBr4LIXcAACixxQZmq3tMpABMdNBBgMqrAvekZ7HnFAVkQUXsUYIMGyNe5crxwP3Hhb6gCRBLeblo0GFNqQkYC4PmIOxJTkuVpve0pAqLDVN21RUiY5WsDIOpgZAkKLHE3atwzU0K+f6GIjzG4amusOxcEt3CnNC4AepDGD6aO/SQyJzNAvfEcsmkGJPtI//E90Kk1J7LMkRnXN9/lAy+QGaFognRpXFkX0Af8/7nm30hh2ERIGn4hPfiek5m1SRypkwSUEQVAgB3z85s3RA2d/JGPMg+esjFPKg+JuC7tJZoJk1+WEQWG0m6Jg7CTWm0knTKUGaMpOXqTxBmxVsPTCRD9JekQzAYSED4jKonJLw3q1Y6NLJ9XheZ1OIbUEWcP/D3+9Amcu3Mvh4N4L549gwInb6WSbOGeYHzP6n0ZA/AeR7XX0sdo1M2s0NtZibg60CdKNrErSMfF5JHA4gZrZAC2h9A5kxFXqhrf3IbK22FguMVtDP9m+Wz0jTGOTnefNtOsLI+1xZ1NruA/aMTBtjTTBynQ9E4gjBiDUD3buIWsJt81GzcBylerFipc7tCVCiLKWcKclZBUgByd+cTDB3rXAoPLoc6gxNzKGph6SsCAL1NVRK7jedKoaQmbJbGFIdcDbBTsZ2GMxkR4dbrO2gi9AmRHfETUNH/hilVs8kZ4ZaU1qYYOyCMt93U5920xurI0CU0CUu4uP0Zw9LrY59OPqxaT7ID4DMine2c132w0blx5KEiYl0qNBBRuZxJmQxlTebBEoSEyd5zZiJUppP1s6GNB4C09DB8fVanGCZnOF3zTrEObpxBKNtXUmlVc83t21TQLwTh/nzQYhYc+4jiSnQDrCBv2Sk8JQhCNzx1AGHHxAKyGieicjDcSxFfqIKistoORfp2hqwtsvb2QhXMGbtfd45+LY2v6IdAcSPYWM6KBmpF6HIpKlnrZIAxqaGprSlf5a39c/DnTzGo5gTSqjAFpe4+cgB08KvSFL4xmoN+uSwCgumuuriHCytuEP2M/WcyNPHZEOxyJViNpaRSvWp0jHXbXMsxdxGEdoRWPgHd7qtFDhnhMwIyyZsIBcNI+5D9T6VW3GhNeJ+Vb8k0NJ4wu0TJwBBey7txRQc0YlNsJRgb+4Ik64dG46oO9b5yPlB8QiXEfzfBU9rKItAGnXgL4E10qe8fvMjCtKNkQHaCNandA+qGyd/PZHaIodO2bWh4JLehmgpinPG0t3ZvRnPXOdeoVeAuybG3ES7kyef8mDKFTO1HrQXIr+MghaRLYPFFJaurl+ncYBhtFABMpM116OKO1j6K58tmZhvW9wPnsO2MFEjV3ENPSMKQD0Gm5SfaWkq6VnVKtut3lWp+hZ4HjzlQPp0CAHtOJU10mKAkzhB1OAo89UTWNae0kUTX0vT6bQEmmgpCjxjp38i1sRvLFpn7XZj7gAYMgr1WRbgApX46fAPBSYNBBSfhEHRmBGy7ojNulDo4xD09cQW3dYFC8AMkiCeZbP+noQUTH+oV8I4tWyplU86PgjiglSRjGUPmBr8YYtlwI4EQQpDk/Sc8rlYHi2+L3MvI7hccftHxGZF60QQX0J3+bB/1GvQZsEYZdCWLk6VazDEgUx0+IKFKrQ9mPJWHWGNVHNGCDJnsqLIdQLqhBH1SMA8be0dch+4ZThlJlMqTtk0ubmZ7rINHIf5ocJDviOs1JY1c+biS+tlH0x4vKSgLuAXcc6j/vOHOY8efKoH+3i2I0wNcmG7Wg3qxgLyz2h+d6YTJEbmJkLzgg6Yp/1lfBWWMqHLOnRp+1JJaRc4E2xEY9FoDmZAm5Z9ft/uiF/P79vfgHI49fgbprNj6h3CqGWf8/uW5q1xFgVPJcbxxNS1AI+WqGE5jFuH8rHqCHSv3rVPSvsxx0QWZAr2JRLXfJ1aYnQ2zOXJoaPviTFmnmhyjdrcdWyR45wMCifo6mM2x65abRr/u7ExzPGODNOv6hFg+kqRZpw3EsQMyLDqVN2XzKGRaJF1U3IwkRuwOI1WVucID11Hr77OTTa812MT5qHNMgvvJ1YelMnWSWWNmBLImF6Chvxsr3o8dDRRWHmwfarDjvgHSfjp70GGDYJtzakkaSu9JWiTm+IYX54ytni7DgnijKuRg/FY+10siDrTTp9fgQQNRI/C1Tz0ZlrFWAW3iUVYF4lan39OYpDeNB9HhqIhV/2U6T27SB0RG78zhbtpgg5d4gQpE72BMQdIa21bGq6kfVL02oQ+dMQX6UUipFAmU1dNMXn8v9OiYGoBLO6jmikSkNZQU+GsyYJb70ru+pruVQ7ScBdYdcGUHQhZ0KcOw2oHscvZujBMAIXdVknw9yGkxELCYnsZGAuFD94F5q6uY61ViJZWrfVBAeu0CwULMkw4m8bxALb3TNwRmujS3J7HjMnmLNvvxtKFIBFf+pH/584Fh0hPZsqFq0tXsmUvSVKYUpfCoj4w5YDrSIU3vWNNHfBSXzqogLucQuYzHlz6e0CI7ClwgBsBJQSjmxlEp5sjK/Wl7wPRRT7WoyuDLzxyhn8uZnQSqgYDOHKAhEgJDp0QaLkjpvRPXqROoc90xp0/hDCqgrbLmS7LVpfNHT6OCAGnydgPbea2Yww/qeKIVvxKLTiAlsQFZBbajp5fc9W4cYagEzgoUeBp7bo8xOqqjfQp/n1eKa3XUHo/4yLU4gihgdVw8E8DaWwU9AM24TJS3szes2C4cy5O9DkDRZ5tGBnAmVRP6YiUr9RUhwE/hA9yaVrpcheLFyx4JhJJRhf1hKFy0mzhHcwXQVGpSi66aGeqmGeaEabzTGylYPIJ/AEMjksazNbKplwqTjHtb+phrmyzAYIiD3VcGaFqpLIjxNmthJXSpVTIJxkQXWY2AW5Nx/4AhrBQJ3JuQLTeR/rUSDBu2Lo1hsNqZNbLlgJOF9KNCRrSKjoCdwQR0biHx4Z2EuhKQ8nBamVfbNw1jZGyNKPTMaRzpydwHlsMOF8d4l1POtTLkz3v6pf6lWXxMUVx10gfMF2PikGkGQvwRewgEdWzR2GRzEc/dsQy2/BRtbHzWcdU7u3sfYvHISE1Z7cqamlIE0JaHjrJJnjZjOGO6BT6QalaIX0IhsXMl1QsSyrVGsA/gV+HWrzBHQo1fKmgLi1q6jANPsHGAVKnmEgDgbNMR1ZB/GsRKvsYx31vRo7FANJrfvARFstgQSBj3gsxWAFTcMLyvg74MsFkcSlgI1lBfXm9bMBwsuWgrGV4sYrvR2WslOZTtZZES2FL6jjNCfaLtXsT9pI4m7xFejQCMlgrDEHam0mWKjTa9G1FTjv7uaq91hNtXbiowUAND12VXL2rMqGjRaar98bun1T9bAtzXNEJlkWg86YIGXEdoZmgA+uK5caEO4OFnskorhbsMmriqZIzKA6RSYrVvOcoBcNHOmZjednSWMmy5UqzF46knSlJvVGq3sN2cqz8jIvQwr3EJRXDqT1QGSCTofXLPxg2W9coL2PVVCtKKlnrIzApa5Opl1+iKKkEDINm6VzjTxNO7QUz6yRgY4a8v+/RwRpopBw9i2hsCaBSmIgjP/MGcbmbWEWpIOyVG//YnFXSjo4aezyqLUZkR7Y2Hl3YP6DClWMTIU6yJc4jleiQkD/gZpMaRFYawsJ15lYsXapoHYtNdoSpdWRcNLB5f0kXqNdFEWGPpYJSqFLS4SY+HeJVUzfrxLHO+iogU+oWMLbU5ZXvS0JzFYb3YBkPzhbdzcPMDokDdJG2U2HR+BBPzkQo1GWidPfAFWCuAAuIO9aMhZ9AaW5dACh9KpgxrNUNy4z0ZTClgZv5VH8UO5svk1r1Vn7HKDSFMMRxLmQdXV7xVWHJOfCuzysHj8a/ZXYNQpVcXBCbf3V4RlqKhYvM8P4GLALt6i+Bw6oEIRiGI/TWV9pz/ZHDwQhVmVr96C4B9GMJ82RVMLDF+sO0w8zMKESPHTqltfE6e/1EYK0/Rm6yfB33V5/yPPFtLnUhqahvqDTBc1wVP3vEfss5zNNnOCp2RIoBBoMvK72fsnOm4lANW8zcbQGu9PlIuPeC3KDcaSrWLo/765pQKpQB2h5t2Teu0ld42RIxMDW0h5ayzC6fSH9SGNHygpeqnJbZ7Li54caFi4CGUqHQkVJlMDbebsj0GpgTLTHe3jUvfwERPxwCrejiaKlq3T86/mnOZNpZhR4ES6WigGI9U7TkOun4FyjtQ73NTqGof9uC3zD9i1JvG/LTK2TIB7ASRk+BmkMqbQ4ZUhDcddFLUMrDkDojzYHgsrVAjrmpO0AdR0bmcrZTy9uLMQhZVgvwzZ1jfYoxF7AYOsd+CH7CSuVya45LT6Vpq/SZl7og7X8TuLhpTZ+ZGB5sCvdBLWcCJWWFzgmLhV5lEKeI7zGqGPpj0fJDQnmYe8fBCOlCX3XgQClZP1TrqVprqfu0KPUgkwkwoH9s6R/b6R1dySxoJV7QS1zQT5XK5Vo+qYC5txvKPJqHV22ZlbISEo8/xYMjP2xGi0zG42pqs2GVtKUyFMoDtowbitvJnTamUC/ehJUT2mWNCnEoHZ27nk9Hf4eZS4CSGPD42j9rfwBtGtIf4QTg/eUH+/wwdqIIqD6CefZ6PjjgwB7WKVCfdwpFbYPAweTc5Tq5NzimUBzSMA+Zoa6EnLnYCNvGVgMDP0Yz6IIoJiLjEGSMjJRg66XYQIlQoicPS4lwzCyCOAIsW3uoT240u8SYTUeNQp96r8GtGvYMO8yegqCEx1cvxu5hjYr4G2ymOyqjwJ66WzTHtQZhOSW8GZO9hlCLQgpdoTh94WRD+hBvxcxiAL/CW2BMbWmQG8z9Chjlo7szDvt/XyhIbS6kgnsUYi+pkkmUUEeA8ZTaYpra4JPcARvfMwoI+ITlpu1tq2vGCN+LBh0RyEi4pTDgvrEZLN4Zgy27Pp15kuboL9X0DvdpAJxT2y21OeVcgTYPN6D6PkrvfqSFIhmFfmSqa1Mx6whzx5RJA8SoSrBrQLm81D20UBbUGFyLJK2iYv5KKqp+Da0amAkX2juu2GtSmRWvvEAQe+iCD6jLIxVnV+s7ac20gXMb2TnQtfQil+P9uwqNK7iiPX1zaM61OziPRdQlFKOFPTEjKmQ++ZTlBUVrB3aZ5goGpR3BQNKkOg1vAXtrQB6gv1nmtAjXWKdiLUJ2lg3nMO1snEZ8eRflHuTz5R8O1NziOsddhjIIYUJK6cw6s5dS/Zkasp/SF4uAPc4stssEZ66tchMGlIeqywVOvFNYW8LqWI4qdkWdIRcsmefiJVIAErp8YVnmAcqeTRYivRBdm82aD1LaOGZwAZKfQQDyFhxTV8hNbnxO9muuWB27In7eC2FcD+wVo2+sGGo0bX0DdN6Iz5oWu7ivf8rrgYwAgyxiGbiP/M9w+yzjeHdw3SRf/AYh2xbWzLKieFj2Cno+Mu6U2yU/49OMqJnXz8z3Br/QE44d5UaV/ImpqtBlQQ4vqYgZVPga5E10GsgQpRswc7ugNiBDyt8pGeoFCUwz4eU3CZaW8W04hNzISZMSAuQSvWkzNrQ5ZInk7sGc/u0+gSsVAjcW1S07tEl9epgEjKXY/n1cMfXSUtgijPnpkjTMUVGRNFAcSAwsOmIYKdWwomSIJWxlSRkBz16LDnek69sfv8RdHeMBlWO5tHFmv4OTJBfO29W3QskvqGDp0DMrAaFJjIpZDvGneGWN04GQKuROfDInl8ibi0SQUZYgqEDzzR+wzHcvd29nbsOcu+AdrwADpoyieUiDQX7Y6A8uZf/IepmoHFyhgAqFwbdLRbK2bdIwOEqVPUT3JJZ0iZdFC7GhJEMpRya/H4VwcKGDfKLy8JYfhN62mgrqKCCfJpXmnqjPn+CMfDKSko73NvOFOHVrIIl7WOKJXCqFsiDrpztrX12Ci894Pp24FUAGuefaS4L1HDAqGdoiBgyf1gbf3MvY86Sbio5nSkJG0qZsvDVSf4mmn6f/SD35z07ht99I2XTw/XunYDSm/+xgdnWn8I/88HjDrRCsJYWXlyo2gBPzPfj+dTO4tZKB7qRTLSMVyrEOmLVDLRE9Mka8JRfFJOut7XU/hItokO4DiO1EtZGOWcCRsrSDND/YeSl1xv0CeYHvri8JRIh2hPaiIivsCKNDkpb+mTKpIDssGpkeDKe6wUcuCf/oYPMsQ9/1C6gyg7zDNyLetpwizcvnGyhTwiFOo8gIxlpX5ym6Neq79vE0blrtXJOQkO4cJWY7vob3qJfNefdxozKPjXX6ow3CMIH7d3WSlPxU2mmfCOKUwLDW8EgFefoPPh784wnc/2ht1I9Q3jRD/ONJVxeFyIondJH7HrrD2Gv4lHNtahgGvBeFRiHmMKUxF2AuQ4GBYsQWtlzcfcOA9fNJEe4U/0URaADZH+BcM5qbdafo7XRIIG7/g3dbV+wl1okys2ylliQSwSIhN87YgDCmzwU+gak81hVOyZgjKcs+eYIGZXj9pO90xjvJ+JgGcd1S8LBhyRlQSmnIzSWT+pJhnwmwd2yXN+BCdWG8IvoOc1DVmTMUxituLqfiUPOUdgoQJAdRq0DZsKdhqVHB6Ag+HpD6mA4YEEoFzFWw4XC6pIU/ID91Qmp8grVJ08bTD23qP2zgRM5ZMfAVA5/vAtmIbVXUPSabOG3NR1KrxCxr3pSbMDMb0Iof4O7OJQyXT/LCpDXVgmE9Tm9LigCgEgOSzQRCXF2QjJP8coh7pShtWmtn7eaKrOuo4gXmi7aiPD6HL/DKQR2ZnbpAPr5fyKhRtZurXCqz9YuWqDZ5t4xlkABytGaC1DcVqUra+wsJjuniADr8Mg4B1MizwawzMqazTBGFJ4CsVC6Xn1Lr9c62/TvOgD/7CPj4CaAh/7OOAaD/v/YgyOMeuXvdfpK32yGqe26T5hPQeJAjtDCIMssxgeBzqxBzmNXHrodciSpAqHw8+LOoFJbxrxZXVLCkfCoSxi+KKBkFmD/6IXF2yt08u9g9PP5pkpvbQwCqOTX1MEVL40u2FuLiJ05RBGz5IRrbx3Os4D8zCi4ZjLKopEShtK6epYEbcYuk6zgAG/sud4Q2/mQhq6Q+PYb3QMPvNWozryOi4L0md4HXESbhoBRHUCxvX9VNG6Yl3MY7/ch312yafCOFTqotYSTA8o9uBGvzMUYRYNmXAAWNKetB0Ih4b1am7b1pmtqiiFgUBOF/8FYUC/PzB3JMTatQLGQgLmiTbAaYD2371aL+oYuqMwjBDZAb0huqZEf9oohtas35EuMAwTTxznWdHu0xb6ULrnRBXJExfYXIlbzz8Yq+XuIr1CJStZBj+hvTVz6OxkT38MELvfOvg2+nujXGNLz2PXfh/jtJbigl/VmyGwoHf7X0JgXedJ7nfa3Ciww5PdMJNf3pvP1E3U67z7FHE8+fXhhkt1q1vWc9CDjUym8tvsQVyrcAX7KDp25ijlPWwMH7yRZt0QnaUFEaFjfgaoTMznbQDjiUDsbkLkbdXPo0GDBNlyLCdpXGB43nQULz+sd4sbmrYdyhbyr8ntMJ1etE+pHQTiBb2RoLKQQzW7zcfKyM40jFtz/BeQjFxdO19+CMQf9eGa4jmFmYMwUr7UMzTZXXKPM1pm8u/QzfYnsAaMRm+c3TLxdap8/euuDhu1/PN0739u5Ec9qkv22xEGIJ1Ef6yGub2uBLUA/S3Rxa9aP09BafzE8402Kx//dA/AjPWdHNX0w3yJnyXfs34hIc+r+DM0N//yJjxqH/Bb4M33+MLXtJy2U4+AOYMqJkxZP/R+2tFU9e0c3v5cm6juMS25pJ3M9UwTSqkla+kV+CY8rD+yYwwEiHNkItW13CCiIVYJmfzG0mRjUqxqUMDSNLBf1rk4IpkMDgPod1N5C+K6eCBNQkuYGXj/QDxrAmI6rhxtynx6E9HKYj7DjAUbmITE4MDkZTMRL646LOSIgLm8KdVXBbAGamWd3L1o+9qxt3mCsxq9gD9x9meb0TB9pMB3OZ+rN6khiBqV1tJjPMolra8pFZ5Lpp5MY3w+NppdU8SpRDPRqYmGTQTT/pDVg0yWlFvNLLmGjWUhXq4G60Hg35OJWYi4MvWcaOWFxHn2LhFZMfoc/QzGouekZxBvnkmKpYZfOuVdTTBfIsOcYVP1Ag4M4I05dsrf135pbCrsEoVDOC0xBuAQqRDnKRqqGaxypJIbW8YC7Rk3zXRgK2hDlD+o1vd+18RGt8n8J7lg3TaGmGpAZu0RATjEylK1zFeGvG1etyDX3LzVvzhhZj5sIdmJ0wmFK0WWCJ7RQapIysOtlysck1voCsLuaMevI1p0nVvOqIIXddNm82hSZn+CLfkwDvlxqb9TQ8MKIBsea8beGLjuhFYSjzxj7CFx0BuRdoE8YaJzkNoUwnWIOxdI1uv6RVns0b3t016yl5wpj00oZ8RCYY+Q3KwOmEqIHPMs4APd9CsaDnVcDQhBT85oFxG3zYUrQikv8SRPK9+B6vtrtc18JYSHyfZ4holzUEkPJCzLsxf4Zb6sQPgCqn5qiaiSVeXqN1Ygti4Flkb04gldL1d97tBtuZQj3maqs/OOYRjduglb4Hh7k9D9tBGurw/4+G7f8qoTOGqP5qy7aQuZWKrqUt2FVtNXRBa2yJ9TjAjmDrJ5lkcA7lBSb4OiBVXecXapZqy4a+v63cEY8yskItpv3bDpJSIBBrPFeiKds3gIMkD0UGLDTQCQ/L5NHUcNFXXep8ajMGfg2Svp4Hjva/8oUWrMEWmH313j60Td/Zg0vjPkwXOuzj51x55tOr+tXxHC9ZkkejIzo0e1qYYJbtpLd+zDlNVJVAQHNDQDR55cZWGWgx3t0WMgbrWGKMy/Wr5pd1XsVGAScC3PxZfAjx/pcHc+cu9sp//z/Qfz/Xhfl6eVwnfPXhqDBtkVkSefY9NhrMrtGhnxoQTe3spl84/HUVl/Y/LoRpFZf233BRV3Fpq3NtFZe2iktbxaWt4tJWcWkrX/YqBmJFN6u4tFVc2oon/xffWyuevKKbVVzaKi5tFZe2iktbxaWtQo5WcWkrIlnFpX0vrmIlVrESK5/S/ySf0t8XK7HAbFZVsFZVsFZVsP64Klir0rir0rir0rgrEeG/S2ncVa7MKldmlSuzypVZ5cr88bkyq4Ljq4Ljq4Lj//0KjqfFsVxBjBKPKzSupMQxfe/ME0h6/9kp9KXsFJ6QbkFRVGt4iesgkFHOLY+n8JgonzlAl5YDYWPTbex1yNxsvZbQH+kxT4oBxN+U0W9LIy8kNf0T+0+5LqyjwjyX3HWQzOq1Ktw758QfBLIPt9Y19E/zFOZDLrkYmb8xcwASA8zfoQx9vGPatpdyFPldc73xJf5lXsX5AzaeIAXpiM2ICSswT5Od2+3zQIWkHj84gb8tPNQPnSElVf3TPFV07JFW5erS/O2yCXeYHr2GvycApAldYzDrnQKEaZ4MaCkUC4ASOKR0mgkgAB6m5w3mjCStxcwPj63snKAXDTcoN3SM7qsEVBgcftmCq4CBGD+0C1fk8K+Rw+oOs5We/6/dYUbzsMQVGaOV3tysDecKZC7pu6cx/ogbIyJevw6CE6yIDj2BE78jrICUBBvd1XOud15lRK1INmWaisUbcq1l1ysWUhzfEFtuZYClmEsJwH+ev9deUKGvgykW8IDUBoni3y+PGi10YMSH1HV8qbPDsIKUfAnoz0qWcLHoL1qme+dS0xx2gxcXLsBlrgGNL1K0FyC+SyfxVaV4l6kPoRtul+Zsxzv9rmJ0niHz4DJno5zoGC6QgAeyF/X71JNlX/qZHDr4HPNPf2gf0JSuscxefYijB5CKBa5UpMHTHzAVdnWCcARuFxVC8E8K5ToOF66tzUlFX1Bn4ztuARU7Gxsx1xT6am3f98wV8evP5jZ5Hd63xCxir7e+CWY6sA9UO73lNVIWebfmJwvdIYcgAVM+SIILX7msFw0Wv6rBYxv1rwi2Sp8ySZ5DpCJUKsEQRieUY1wNHk1DimH+kBIgMIKmjGuCl12aeYKq3qOKEepSHy6LhkvMI2wNn/a5cFHrN+F5eYx6ybShRIC99lPjzeZQZiEwpMAgUtR4Nx00hsB8emA3jIS7dNxuZtBFJMZ/JajsR8HCkW1uaxcU7n+2ntH4ZvME4BukP63v12tkc2t7Z5e4kimElr1ylYuiPDtHvab3orF2aBTVa+WO6DMEoytk2E0W9DgITvSLaxlW7OOOeIlkSLvs1WEMkjaOg+AWnhybBynunNtvoVjI9vAh9vzHgpiI7TkBp+awj5cvoSfzTf7d8yENI9VFRS/nhmeXzftrdJf6M4Kq0aedjZ0i2dnYhv82i6RcLq9lqAHef8htvoyBD5gAQQgZhLFzL7BTvbtSbDFmRpqvNBO+8kMeiX2d6kE1m9xZsckVm1yxyRWbXLHJ5WzSmhZXrHLFKlescsUqV6xyCasELJkwDawDJ4NZBc1hbTlionD46zd02dGB0oYC8AKEMwDltSSDWSmgIfP4mIelXuSMGOBgFNBQqhJ1x1yUtCngFUtgtRBl0NE3QGDIhNKZq7/+VgCPzeGyPuM8lcW+ATpjfjks+FJpbxJE0BbWsdV6yFRYQlNDCew/YPhRLJiwQA8M5ozDwjAMfXW4vv6bH0hAXFd50eB72fylyjKYUZ+rsiPH6whOwIGqraci/kSTmTl7Cr5HZ2C1QtaVXYVHCEeBY+WahVMZjMDxg1wFekkCWZD1Qu6iZk2/pr+oSqGkx759ssA7+gEAW1bDdQv8uql7tj5gYUmFNAiZixmNgDu7+C04BvV8elRxJz4aMUQNn8S0BePB9uoxGuhKCElL/WihqXasoa0a10AXBhzKgL8h762aLZp5eJdZmuHMDWjZZWNpJ6g7XYf/0V4pfT0B2e97XGgbLD6NMx21dd0cNmBcD1g/YGpIQqB2RT5Rj1OdJv1keulS3A5Pa+AezDz6+f6hC58JOAgKTd0Iwgy1P5AYhyAcKXrzAdOAXz6Ih1B/lGI1Gunfiwu7ekHYScVhMeH6kosQg6sE0xnKGcIDvjNis4TwptMpwgK7w5WOAkp0mB+qdZ8FCtwpJY2yEsKIDPTHJBPM7mUwUj51WMXnFywvFut9uMnUdlDy2IR5f/00vhcLIGiaxT6S7uzYHhzIOKBqR9BFgkgHX/allVypg5KrTss8LKjI92UQ/h+98gVbDq0Ac2npd4thQ/9G6iIMpBs5uv5ATToRyHFa6sE8dc8jftTzuIMiIzJOU2RgwpBNVRp1VSaV7At4qL1mwsN4Io0e5nYECkcUwuy4SxoGfUQToSbvMmnoEbEXCFoaSxXaqB0uSC+QU8UChVFL//ZvpFW7UBC+xBVxzQyInmjP1H3RPcWSiGGaqTXXKfbxgClBWWH3cYGEvoSQIdjBHhWDCDwMhwDGP8ml+Zvof/8kNTnFwjDQAfk9/6CL9IL8Qf/+CdCWMv/I/IOf//cHdJHfLUBbo0GYQcyvftQru2yS7FHzYN2nzghWZV0Gs66uX7CWi9tfm8eV2tVx0sOAh8Ooh5tcBrN15Y7We57srY+pClmwbmohmJ/rLg3Cdd1FeeyupXFbvj5uZ4cS0YCFZRkMsjwlfpxAfRPMylU9wtofCa0MBVuAF6E99vgrD9JDDdlr2R8nQ+m/P4rZPwBahiDlQnsq54dKul46nO62NJB/CiUM5CIdGGihJFN2qDGdMJGlBMVo4AzL8Zt1GoS8T51wXQ3h2AEYShbf/zK0EF27hG5TBaQs3frjZ5VFLdKtfWxpYv3/JGhe+yNxi5H+CFIa5nloP93DodJnoTNc+71gl8znfwrwuvPMFAjMoXHWmCNFDRlXc9wi8zizE+ew/i8D7Q/9HHJGjDdm4TB1DAG0M5/PAWqeWCUjRbzri7vvX4cWQcrlFM2oN8sOFUS92YCNVRbi9NN1+CWz3/5QaGGoJXuvGam5E84BbVeVuUzpcfaR+W0ppH8QtCr/hMPYS4eBWeHwt1jQ9KkzZGSrvGGKfiSKCew9iq8Rx+ZbtX5Zrx5ft45LW+WN8jAcezoCKRirm36LBRAOCMp6KFXKKGJFTtC1WaBMvAAgA+VbUPTHVKTgqgYMimBAhrcKyU29VtXF7DDmY177ThmFzYdgg3PB9BAJ/TF2k/QAtZJKqOthOJgUzNbcC1Cm7IiAhVEA9ZywuUODgLOkPFTJFAW5q2sBm1RbzROidQatHJbJtbRxl+EMax/BxNEmCp8ISRRTytRF0oEZSQWvvg1whwpl6t87Ah5CdGYEWqm2G7smeyCGlCffQoQRBHfYaLREj4E/17HEFgasBDrSDS0svxZQUcAoqTkby7diYQjGmMNfC7/9Bqblu8D7/h0ev0QsmGkTkLWioJUJUpGpC+aE2BpkrGGlto5MsTagBSs+ZIvoL0C/8MN326btRY2bVhuK20gXdcsxGiEKAQWCgf8PC4VMfTV8BgF/WgUoHBZ0n6DmoRUiSeGI1UFrJPk1fkXFLAXhb7/pFqgTff9eKJqpGG3+2/fv3/8vgXG+nQ== +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Creates a dry-run OIDC test login flow pre-scoped to one provider. The returned flow carries a single-submit UI and a CSRF bearer +token. No identity is persisted and no session is issued when the flow completes; the captured debug data is returned in the +flow's test_context. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-verifiable-credential.RequestSchema.json b/docs/reference/openapi/create-verifiable-credential.RequestSchema.json new file mode 100644 index 0000000000..62153fc1fc --- /dev/null +++ b/docs/reference/openapi/create-verifiable-credential.RequestSchema.json @@ -0,0 +1,26 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "format": { "type": "string" }, + "proof": { + "properties": { + "jwt": { "type": "string" }, + "proof_type": { "type": "string" } + }, + "title": "VerifiableCredentialProof contains the proof of a verifiable credential.", + "type": "object" + }, + "types": { "items": { "type": "string" }, "type": "array" } + }, + "title": "CreateVerifiableCredentialRequestBody contains the request body to request a verifiable credential.", + "type": "object" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-verifiable-credential.StatusCodes.json b/docs/reference/openapi/create-verifiable-credential.StatusCodes.json new file mode 100644 index 0000000000..7825f70065 --- /dev/null +++ b/docs/reference/openapi/create-verifiable-credential.StatusCodes.json @@ -0,0 +1,74 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "credential_draft_00": { "type": "string" }, + "format": { "type": "string" } + }, + "title": "VerifiableCredentialResponse contains the verifiable credential.", + "type": "object" + } + } + }, + "description": "verifiableCredentialResponse" + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "c_nonce": { "type": "string" }, + "c_nonce_expires_in": { "format": "int64", "type": "integer" }, + "error": { "type": "string" }, + "error_debug": { "type": "string" }, + "error_description": { "type": "string" }, + "error_hint": { "type": "string" }, + "format": { "type": "string" }, + "status_code": { "format": "int64", "type": "integer" } + }, + "title": "VerifiableCredentialPrimingResponse contains the nonce to include in the proof-of-possession JWT.", + "type": "object" + } + } + }, + "description": "verifiableCredentialPrimingResponse" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/create-verifiable-credential.api.mdx b/docs/reference/openapi/create-verifiable-credential.api.mdx new file mode 100644 index 0000000000..c21ca3c546 --- /dev/null +++ b/docs/reference/openapi/create-verifiable-credential.api.mdx @@ -0,0 +1,40 @@ +--- +id: create-verifiable-credential +title: "Issues a Verifiable Credential" +description: "This endpoint creates a verifiable credential that attests that the user" +sidebar_label: "Issues a Verifiable Credential" +hide_title: true +hide_table_of_contents: true +api: eJztWm1z2zYS/it7yHQq3Uhkmun0gzK+qWu7jfsSe2z3Oh0ro0DkUkJMAiwASuY5+u83C5AiKUuKnKQ39yH+kIggsHh2sbvYFz6wGE2kRW6FkmzEbubCAMo4V0JaiDRyiwY4LFCLRPBpijQYo7SCp2Dn3AK3Fo01/sHOEQqDeix5Yec0LeIWY1gKO3cvc60WIsYYeBShMWDVHUpQS0m7RKgtFxLyYpqKKMy1WHCLcIflWOZc6GAsx/I3pRGETJTOOKGGiEuYIiSqkDFwO5Zza3MzCkOVoxRxINGGJsfIVAPDSEmJkR0SUCI0XETDbybPg7nN0oANmMpRO9LnMRsxL4R/rwVwsuafDZjGvwo09gcVl2z0wCIlLUpLP3mep8S8UDJ8Z0i4D8xEc8w4/co1bWIFGnryvNAvW+bIRsxYLeSMrQY0USWPV7xb7pk+8cOPXq8GzAqb0tA2di5pLRALXEhTn5ZKQCW7NICkVW2ipu8wsoSBBhxIYTEzW2FWA1xrXnZwnewU9lUj6S7G6ghgSm+sWj8fDpkA3A+VFjMheXrJNc9e84xmuHNd0TGbXEnj2Xrx/PknnHWDZBJrntiJp/ZIRDt14gOneFVB7QrpKaLoeoTFnj0I57efJo2JVDLapqyD+t0E73Oh0UyEbNsKE9J+923DgZAWZ6hpIWqt9FaS7s0kxmkx2/u+JYCds+ZCbrfBPdZsLLeFmUQqxoN4+aDFikzI2fYjd8IjgxAySouYfGZj00OVDHNlDBpDLvTnP24+Whk2QDC3KOFFap+kF92NztwRDja0ZX2w2yd/6Li3rIJTegnnzXVCV8yFTEvgCy5SZzFCQowLyFSMwb5tOlqzfbNmbCedWq+2EXglpCWArzDNzfqyBeGOIindiKMCES+MQ4v3PMudBt04ZxkLjZGF369+BWFAKgs8TdUS462sbShsF9Orm5tLuHYz4IRmtHb79vk3g8P0u6Nzjb47Ni6OCzt/sU0Tu68HzPKZYaNbpkQcsTfen5dDzS2mIhN2OC2iOyQo8zLWfMjjTMhhhrEoMkazicNrh53IPLCUyxnJrMzx2m3LBizlU0zZiH2vdBlGqSC9HjCjCh05rrJcaQsPYwkAcCHi6DgXA/90omQiZoUPK+qxQ+66sVxBolUGX7d2/folKUGkpLFk8w1lOAKJy+5uvf7Lei7Pxbk0lpNj8DMrlL0Olb4jn2IdAH4A4ugwTl5CGEJPuQPkab/h4AG8lg0g5pbDCo6AL7nowA12I+l5aR4EdSz7L9lqsD7en1TrWCW3YoHtE815dMdnCBkXzi9UJ9wby7Ede9d2b8fMPybZ+qcy/hfFmzwX/tBgzGbCzotpEKksbA5zOFM02wkkKWTkduv1SY/G9iCuYHQE/+zsFbzG5UGH0uvTqRwWdb2HjeMb267yjY7gMYquKtIinosTL5FtC44vz/3bDZ2klRSGDUAPyMfR4jWlwOnx5Xmwm5NedVzBDzy6m2lKFnr9/p4FbSkddAz94Oweo8KiZ1MkDuY/jkCK1J/m2CaZDX7MtZA26SkTXNsYtR7AuPLvyzlSPpOmQs7g7YeZevt2BF8txmM5Zk4o/Q/s8mORpuDcdh3Rttb71Sv6JwzXE7z3ebsHwwj2xaFE7jEeVVjCc9Xd5ACG23jR5P2xXLUN+rK0c3e51kZNt8BOV610OfEvx9IhaAYCuu1TU/mdSRP4TFoBfJVqTFzqUdE80Kvv2G7XPpWYqj32y3uTtKZsqFp5nIuz+whzH+m4mbk7mHqCfyLrfganmAhJmkhhxVwRFQO1BwAuY6gCPUrjoc6685SX3r6CXCu61U2gdMlzYcjzEeFrxO69FeQlJEoDh1QY6xLONAVT5IQJ441LLqcMDS1qE7g7pHP/tRjv+h5/TTg2jmDMDoVbu2bCfSYtEsjKlfiqBpcg6ktVJU5Wx5fnUOuVm9MCdVz7rA3/BtyQP6umjTzaZ5U67d6EG+On0lrRXO6tHes7vqHeb1+Zh+h2V6wHXizPPvZeIWxWl5UMvBzOjSlcJaqhBg25ZiYxuTaXo45U9tpy72BhHB08s9/AclbVG1cxeAVPJXX8NfzXPqIj5/Da1Dy5Nq/VW3TGDWsbJ63C0WMczYTOlXMYHPjKOETwFWCfrVy0beK7Yawil6a1gmZK8cRMclto3FtL6/Up2yPD9vG39AWYgy7eJrE4SOHYZi5R1fGExpiNrC6QWNJoCy1vPN19DpfSpJna5HRfIGLvW6HC/wnbCU/N0/nO/XW79ZR32Nk+hg+wqScy3TtoVpDF/Ufiua190ptP04/evpduZ8pf8d6ipFqMF8sdlmy0K4kdsAVPC9yezFIwVK9eG+V6xRfj/GKcX4zzacZJBDO0c0XdoFwZ64Rk52zEwkYQZGQG9QK1l12hKf2oo8yHKracmLSYrbZGmqGzUu2wmKpSvl7ii29VVZU1MesjwfypCg0XuoTXaJdK38GlpwJEJYA/VeH6ZYmQMQhb14Rv2ytOlDQqxTe9GnzkBwhsYOZhDT6MCq1R2nCGdmgsp0i9H1QCMxgVWtjymgq8np8pNyJaF33pZPzIWmloP1LcKXKNujvTDz2aqrirAFItPVVLtw2NKC3+48Lqk6pw2Rn8vXM0zocGMWaqZtATDelfOtRIVf0slSSpkLT9MbhRqDXPR1GVKVAgpTHRaOa+vWmgx1PBjUtx3lZUJr4B+pZ0uzv0dPq+ZykFKehV3f6ScJGjPD+l86R2J5yfwg1Ndw04+nGgHKxf1KrVeqGT+HV57DB7wo8qxDeKCtRgO13lUhUgkVrAsqt4lNHcYdko3nK5dFjIOugeI02kuNWEOWpD5j/0Ihs6jP3AHdeHVEaXfyh9Z3Ie4XEufsHyybhhWRMYprjA9H/PxmrAqIXScpNndeW91Vaq6vitLrLrG2+MT7a2Z101vRp6sxowapTXDR0eueABMy5Ig6o8/XuvNmxQ3xskiGv/jj0q4D+Dc2m1iovI1yJOVVRkKK3P410xIE2rLwFcrcFFOcJY7cq0zscdX56bAI67L2jQ+ThFXZwpVl8aYFzl4hwWPBUxXFayB6/B3jYCuPQ7OipcI2TK2LQkdYjJW061WhpfeRjLZ8/g+vQXM5bus4m44gA8o1M0dZ5uus0kGm0pTAA362kaW1O5ceSdMGhNoqhTQ+ZP1a6Cz9CMCMZ7+LV6rrK893CqljJVPCYC8DF/RKJ9IJ/p7z2hHXb+YHPg6X+fgcR2soT2lGvbEcxtXkyDGBeNgVcDYdUvMGFTLelvle3t1dnx6W9nDYWNzoCJ78JpqqZhxo1FXXUKTPV/GHNtQ0+CYpS2bIPXZzfdrWQxQxsoPes6pPVwg/pCl4GvTYX9z4lWWfoEZwOvQ3uWinuh21vN8T7Is2Yr/3yoZD8DWnSQtqL9SW1u1ZDeud26yfO3aMJMPdaDCu3PfMG7W2V8gbKrCQa5jubB+k3ItRUJj2xo5nRnhU39vP/paN/xBd+ht4TWp6Vrvc2zd6YrWqe39XCtE2GrMdr/nLJ1t6CD1Ma8ibb3B10qCdpo3v9Y2MNq+d8C3hPvsADEw+Wryw1V9MiE2fAWneGOJW5I/ZNB5/N8izo7ifvGTgdtmYsNoNVInaG0lDd8bH2fjtZB2uopropp2d1KF9NyhpnpIm6PhvSjY2+fFS1ttcP2rgqzccNFVHMygVCtJLAeqn7tRPqZ0JrtNxy19kSEVOIYrQsUxzmP5ggvgudssJF4k+1x99rJuFprwl/PT85eX58NXwT+u08X9qLOzEVyjXohXJswtMq0PkmpQ05K1FEbH8emJAwX31JpIOOyhWt/02Izd299LPXlO9zW10jUaqM2nXCZqzveh6oAc8vaBZg3A0btPRp+eJhyg7/rdLWi4b8K1CUb3b5pSiz0tBqwOfKYag3rmuuJP4OhKx41ldZHH681dVbKH3K7d267gnR5cX3DBmxafTKcuQoF03xJlSy+9LU/X95yVQc35hvcFOKzEfM06e+/ycD3FQ== +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint creates a verifiable credential that attests that the user authenticated with the provided access token owns a +certain public/private key pair. + +More information can be found at https://openid.net/specs/openid-connect-userinfo-vc-1_0.html. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-workspace-api-key.ParamsDetails.json b/docs/reference/openapi/create-workspace-api-key.ParamsDetails.json new file mode 100644 index 0000000000..e1defeb6c5 --- /dev/null +++ b/docs/reference/openapi/create-workspace-api-key.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The Workspace ID", + "in": "path", + "name": "workspace", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/create-workspace-api-key.RequestSchema.json b/docs/reference/openapi/create-workspace-api-key.RequestSchema.json new file mode 100644 index 0000000000..061dead5da --- /dev/null +++ b/docs/reference/openapi/create-workspace-api-key.RequestSchema.json @@ -0,0 +1,26 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "expires_at": { + "format": "date-time", + "type": "string", + "title": "Time" + }, + "name": { + "description": "The API Key Name\n\nA descriptive name for the API key.", + "type": "string" + } + }, + "required": ["name"], + "type": "object", + "title": "CreateWorkspaceApiKeyBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-workspace-api-key.StatusCodes.json b/docs/reference/openapi/create-workspace-api-key.StatusCodes.json new file mode 100644 index 0000000000..8d576befbc --- /dev/null +++ b/docs/reference/openapi/create-workspace-api-key.StatusCodes.json @@ -0,0 +1,115 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "created_at": { + "description": "The API key's creation date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "expires_at": { + "format": "date-time", + "type": "string", + "title": "Time" + }, + "id": { + "description": "The key's ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The API key's Name\n\nSet this to help you remember, for example, where you use the API key.", + "type": "string" + }, + "owner_id": { + "description": "The key's owner", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "updated_at": { + "description": "The API key's last update date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The key's value", + "readOnly": true, + "type": "string" + }, + "workspace_id": { + "description": "The API key's workspace ID", + "format": "uuid", + "readOnly": true, + "type": "string" + } + }, + "required": ["id", "name", "owner_id"], + "type": "object", + "title": "workspaceApiKey" + } + } + }, + "description": "workspaceApiKey" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-workspace-api-key.api.mdx b/docs/reference/openapi/create-workspace-api-key.api.mdx new file mode 100644 index 0000000000..3b91d8198a --- /dev/null +++ b/docs/reference/openapi/create-workspace-api-key.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-workspace-api-key +title: "Create workspace API key" +description: "Create an API key for a workspace." +sidebar_label: "Create workspace API key" +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/is4ZjqRbijScdPrnTK+OddWWzet7bPd6cxZHgciVxJiEmAA0DLP0X+/WQB8FeXYidu5D/UHWwKB3WcXi8W+0PdeDCqSLNNMcG/sHUigGgjlZP/0iNxAQeZCEkpWQt6ojEYQeL4nMpAUFxzF3tiLzJLfygn7GXsLhed7GZU0BQ1SeePL+w6fiyWQagk5OvR8j+F4RvXS8z1OU/DGXsXV8z0JH3ImIfbGWubgeypaQkq98b2niwwnKy0ZX3jr9ZWdDEp/J+ICZ0SCa+AaP9IsS1hk0IfvFWK5b5DKJMqmGSj8BncZk6CuqVk5FzLFT15MNYw0SxFVm7fvaaYTHLjAx+tSkD7pUb9voSDHNIUpn/J9Us25BYLrjOq1m3oDRbDBb71u6uXScruqZonZe4h0A9VB31YZJa2R1N1ISLZgnCanuHfHdhPsc2SkMsGVVc3uzqsvUKw1mdgptl83N1C8VMTMZIITVLrn92+CBBqf8KQoTaOjJP85NpLF/VAtzKPDoAkuz1n8GFwPW4clXdrHOWiil0wRLcgSkowUIicSUkhnIH1jK3BH0ywBn6yWIMFMyBV8woR8T6w4yOuHBTRzPkfEPIsfudUJVZrY6V+227c0ybeo1XKyEx5BqfI/W7VTw1+1vdkTFdU5yGaJsY7G9jxwsFcd72uOcxvtxhScMKd5op90kDdVoDTlMZUxOZEF+en85NgoBaQUklgtoNV1PCs+3SQ3MYtKR7OxKoZZvthcdYjDBCWgjCtiZhHGLW8meEAu8NwwRXKV0yQpCBea0FvKEjpL8LKLyZKagzUDAhwHY8TszpOTM6aazqgCQmOaaZBkRRXJzWxcOmc8NkcNEkhRlX1+qF9sPOIIz6w2KsCt30TgbjWIUUUilxGQSORJbOSZ4X2R83gr3+sW000lVt9qVc5zqZcgm8okghucnOpcAhHzGnUb8ImxUbJiekmODsmr3a9ff0NiAcqghTumelXUd9CODlE7lOScfchLFR0dBlM+BwPjmgt9XW/oRMrv7YNjoffL4Sn/kAtNr+EuAoghxmn/xpGJG0D4PE/x/PXS9XyvTaFxIqt74260ECMkM0IZvHE/qc+GuPa9FJSiix4H94t9UG9fbU9uTa/7V5rqXF1HIu6heSBitLtMggKumyTtMoLLyOD1zmufvN75Gn+98kkQBMOWNeDz2iUyrv/2uobCuIYFSOMEtzm4BXCQLDIO4sD5qq7TtKfrql5UOSPrV85qv9Jm0+MtDa0fLFPDSEGUS6YLE8sKWXTj3fHlFQaeCuTt9ogXPeQxaHTFZpekSEiWUG7vkdWSRUvrpiBGl5JSjvtZiFy2lmZSIG5lPFfl1xVqPJeJN/aWWmdqHIY0Y0EkuBIJBEIWgVp6CFLTBSJshNdXNvgrRpJqSFjK9GiWRzeAuzWj0Y2Yz1kEIxqnjI8SsTKGjlt/bjbYyptQvkBBiwzOjeCe7yV0BojoX0IWYZQw6xit88KtTzMhNbmfckIIaerUt0MHgs/ZIrfpRjm2LYqd8jWZS5GSlw12L99g9IRa0KjzmhrZIxxWbQ6D4ZtyLs3YEce7LQI3s8lx0CI1NDwS0PVujIk9YW9IGHaTHTJwNy9ucs5jmDMO8dBS6E2nULrxdsGRCRkIY2o0GdYC37tj6pvbi6zJHqErylrSBb0cB1bXlTxO91vRTfnwjbf2Kyv4QTR2n1NMapobn9HoBm07pYwjXGcIgymf6qmNRu701LNf52n1USj7SWTAacbsFpOpt2B6mc+CSKRhvfWjhcDZRh/znEeG22CI5jbVdbw23iPTRqjnnNbUQ6XaTSQfSXcPkcRWZSDJv7YgBsew2rp9g6kJAWrOQ2S9dTr5SDqbPdVtyx7vkU3ubTvHRTRjB1aBfQv2T4/s046t40oM0XwifbwLcHFFKajxnh4FvSIM3O4G39HoZiExZhkM/drShv3LjKK2anwYTO4gyjVYydjcIPvLHuEssfs91fNUB99nknE9HwgVnOsYpPTJ1IWdqyVwEtEkwQ1/92k53r0bk69up1M+9Ywehp/g8n2eJOTHi4vTKsBtrLer1/grDKsJ1pu962c/Jp0RXLzJXeQauZ+1ST5CvCY6UNlwytfNA35a6KXgjUOO18dWDy9kcW0fTrlBUA8EqYghUc4NXdcHkWbs+gaK6xnavKPzgO/fQnaDXklqQ3tdAhKULifvZwxjMHPo3MzMqLmcYL/hYXxBDtGhoxVhtLQUSEWR8sCaS9v5f5vMu8s6S2hhj0NQXvB4adOMKfRrSPgcoH2HBVlZoEuY0hiN0yQhKs8QE8SdC6+uyAXmgmjdhQ3B267COn4jBjrKx8ItHe8L4zqdo07zxi1sKxM010vg2mWcRjs4JCT7bxc1EmOc0CgSMjYXs8kuyvqGjb1IGamRTCQsKgJcNbGeVdkyCY2WhgdJQS9FTKgEjKluGYbcM0jEyq8KJ84nE72kGikpqpmaM1A2LDNkcG5EFQRW3oNKvu+ASpBtecZkM3p88m7QKAKlrrW4ATNbBcBvmRT8cup9N9k/m5xdX5y8nRxPvatqGyYck1ZKnPu1uqOcsDLKcbkcqrI8qmZOA8t+6ec7dwKhCu8AN21sQb4gdTW5nwlVysmTsWtWR1sNjq2gq2Yx7IQnZI+83LjCX5IXeIH33t51MLPN47Q3YeuVNKzkfNRVjXy1LJyKWmqqhXFVpXoOAqsuhb2Wurb6zUEduz0s6d6DT4c1CuPiBlNXi3BoxLzlSUf/3EZtbC6TJjlLrymbewrG1ZLK46J5wXgTSD2hdXk/Eg/5ShlI5CsCQ5MY3Y1UfDOKRWTKTY1EBktgbGFrHttaHoNh2fSw6ZDrYWwNWeo0dHtZvpuWbvRB8ELuaZZ0qxKfbL50qJoWis4lv7CEutnu2vcWoquVLdGevmsEZ70qek7k/h+g+DlN1KN0lNkYqdd6eg7sU7TzDKrZcuAfoZ7B1idBGg83oF2WHvDqyZY26Hw39NempaOBKya41dUNlmC21TCqlkB/LQMVU66vzn+jjfCnH/jTD/zpB/4v/QAus0E81pSEaSmYVwjGXlgXRsP76vM6NDEznu8yTzjH3pZtMM2oYlHV77IOA0cqTWDygxs6M4F9e6Yd2pgqMPrfNX3nRKwMm1Y+cODq7q3BX1tl3GURSxrEkApXxQ0t0RB/oySRyKwAYj5PGEf2+8SMklLNNkJyHSQMkiTMJaglsfogA5owavOjd47Ktc0y3uFGtoeeTt++NcKxu+Od2UmYFpxkwI8OMWPi2Cw6OiQXOB31ZtY9Ug/aLmr0D6zSUf2y2DeYLeHNDqZwqR5TBHicCczpsXPOAWKEeNmsvLvA/GpQQlqtVgYLFh7x3ggjwTEmVWEGUqGtj6zKRgaj6Yp82mR62gtPxF0nE6MEbiH548VY+x52j8/qN3EmZTeo/WaNt7uz+3q08+1o9x8Xr74Zf/NqvPv3YOfbV/+p3wNqtAf5XJT9ahqZCxlSytBKXNXjX67RUS1GYc/tM2+jz/OCHGEbJs4jW9k5FFGO3Vubh5vSSpKQLJ8lLLK1CQwbmNLSlLRNW2b/9EgFZL/9AAdJRLFfmhTYnLX6g9gl1RTfQmAxOXX6JdZKrf0H5NRyNFSwPJEKpZPCdoYYJzMpVsrWcab8xQtyfvhWTblpc8dOAvc60QxUmXCrRs+b2S5uwygCclFNk9BsjytDvnobaS6SRKzwiGMlMKcLUGOE8ZH87L67LO0jORQrnggaIwHyOT9Iorkhz/TzEdGOWj+kO/D0n2cg0U8W0R5SqVuKuczyWRDDbX2I3UDoeisqrOsXw17dXp5N9g9/mdQUOl0UFd+Es0TMwpQqDdJ1VZT7G8ZU6tCSwOu4qdvgeHLRZsXzBehAyEXb6VTDNeoTWQS2yBQOnxOt0Bw28Bq0k4TdMdlktYS7IEtrVvb7YzX7DGjBQOpF+4PosqpJb2VXNcR+F0tYiE07cGh/ore0zSqlt8DblqCAymgZVE9CKjWb00iHaon3Ulj3FoZfjvY9vaVb7BbR2lSvstssfa/aqjV2Ww6XNhE2Ws7D59QtXqr2xmpi7qId/IaXyhx0tBx+LuyRW/67gLfEWyIQlOH0x9OOKVpkTHW8RWu4dRI7Wv9i0Nky6zFno3Hb9GqhLTLWAepGQtcWaRhvuHn6vhytgdTrKc7yWdFmJfNZsYBUtRE3R0P80Dpvz4oWWW05e2fYG2qxirCSowImam7VkPu0FekzoVX9Nxy2PVkE+DLRuMqm9zMaLYHsBjsbL+Lg2aPmsdGxW6vCn48OJsfnk9FusBMsdZqYxAdkqk7m5yBvmWmhhlqoxqtQZciJJSqQysaxCSrDxLeYBaeUN3Btay908/PGW6CP+z8AF+9jNwnbgczkbUbwe5eFN94xQrzjVg3DJoZXvoe9RZx7f4/vV/4qk/Uahz/kIM2LVViLk8y8gmfeq2LKvKLpCjAPSDE4c9npcKMDtA2+G6S8aJQNPd8VCGv866u17y2BxlgGqAqQ7tW0kSli1Os3XqmtS44Y9mf6wbnNGsfpyfmF53sz948NqSkeeJLiG1n422C1ZRZTEDBjtmefm5cGPUsT0zNTPaj/f6JK48rixuV9vzbu7+0Mk6qs15VyXBZ+tV6v/wfyFlEi +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Create an API key for a workspace. + + + Request + + + + + + + diff --git a/docs/reference/openapi/create-workspace.RequestSchema.json b/docs/reference/openapi/create-workspace.RequestSchema.json new file mode 100644 index 0000000000..380b62144e --- /dev/null +++ b/docs/reference/openapi/create-workspace.RequestSchema.json @@ -0,0 +1,21 @@ +{ + "title": "Body", + "body": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "The name of the workspace", + "type": "string" + } + }, + "required": ["name"], + "type": "object", + "title": "createWorkspaceBody" + } + } + }, + "x-originalParamName": "Body" + } +} diff --git a/docs/reference/openapi/create-workspace.StatusCodes.json b/docs/reference/openapi/create-workspace.StatusCodes.json new file mode 100644 index 0000000000..bc3ba345b0 --- /dev/null +++ b/docs/reference/openapi/create-workspace.StatusCodes.json @@ -0,0 +1,313 @@ +{ + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "properties": { + "access_policy": { + "description": "Controls who can access the workspace and its projects\n\nThis does not control access level, only who can access it at all.\nCHECK_ORGANIZATION_AND_WORKSPACE_MEMBERSHIP WorkspaceAccessPolicyOrganizationMembershipRequired Only invited members that are part of the organization defined for the workspace can access it\nCHECK_ACCESS_PERMISSION WorkspaceAccessPolicyMembershipRequired All invited members can access the workspace, regardless of their organization membership This is useful for migration scenarios where workspaces previously did not have an organization assigned If a user is just a member of a project within the workspace, they'll still have access to the project, but not to the workspace itself (the default for existing workspaces)", + "enum": [ + "CHECK_ORGANIZATION_AND_WORKSPACE_MEMBERSHIP", + "CHECK_ACCESS_PERMISSION" + ], + "type": "string", + "x-go-enum-desc": "CHECK_ORGANIZATION_AND_WORKSPACE_MEMBERSHIP WorkspaceAccessPolicyOrganizationMembershipRequired Only invited members that are part of the organization defined for the workspace can access it\nCHECK_ACCESS_PERMISSION WorkspaceAccessPolicyMembershipRequired All invited members can access the workspace, regardless of their organization membership This is useful for migration scenarios where workspaces previously did not have an organization assigned If a user is just a member of a project within the workspace, they'll still have access to the project, but not to the workspace itself (the default for existing workspaces)" + }, + "created_at": { "format": "date-time", "type": "string" }, + "id": { "format": "uuid", "type": "string" }, + "name": { "type": "string" }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "subscription_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "subscription_plan": { + "nullable": true, + "type": "string", + "title": "NullString" + }, + "updated_at": { "format": "date-time", "type": "string" } + }, + "required": ["id", "name", "created_at", "updated_at"], + "type": "object", + "title": "workspace" + } + } + }, + "description": "workspace" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "500": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/create-workspace.api.mdx b/docs/reference/openapi/create-workspace.api.mdx new file mode 100644 index 0000000000..e7686aa2e2 --- /dev/null +++ b/docs/reference/openapi/create-workspace.api.mdx @@ -0,0 +1,37 @@ +--- +id: create-workspace +title: "Create a new workspace" +description: "Create a new workspace" +sidebar_label: "Create a new workspace" +hide_title: true +hide_table_of_contents: true +api: eJztXF9z2zYS/yo4ZjqVbiQqTdN7UCc3p9hqq6axfZY7nTnLo0DkSkQMAiwASta5+u43C4D/JCqpm7QvJz8oEgjs/naxWOwuwDwGMgNFDZNiEgfDIFJADfwi1b3OaARBL1Dwaw7avJbxNhg+BpEUBoTBrzTLOIvs2MF7LQW26SiBlOK3TCFlw0DjL0FTwH9j0JFiGY4JhsFNAgSfELkkJgGyqfE12wyCYaCNYmIV7HYOCVMQB8NbR++u7CUX7yEyOIoZDodyWPQ7JPLQl4qtmKD8iiqaXlhcgXuOLHQmhXaYXzz/6hMkplEEWs8zyVm0PRT9TAqjJNdkk0gSUUFc/6YaCBUxYUaTTEkUUM/ETNwkTJNYgiZCGhI5OsVwDmvgPSIF3+5TZoZQQyjn4Uyc/TA+ezO/vP5+dDH5z+hmcnkxH12cz3+5vH4zvRqdjedvx29fj6+nP0yuSKnEkaVzZQW6VCsq2H+tKt5CugClE5Zd+xki5BIBMLFmBmKSug7EJAhAAcmoMsWcyxolEsOSCYjJUqo9TTQEKQQYnZ2Np9P51fj67WQ6nVxetINtAzji/ADfsWnoEQUrqmKOTxxspprA05IFIXaCmCa5hmXOrSwpW7lFRnQEgiomceJB1ZjgJMOayVzzLYlZbGc3oWs0giYvqjVboZbIZEkoslHI7n2uDaEeCcKkhdmQDTMJE/tCmQS2X3JOtGGce1Zeemn7+uE9ssiNhePbq1lhRgNfkg62xrCkOTdWXnhg2jCxqonXDXoBiDzF1fsE8wt6wZG5ri1/7yRwda9kH7n0cbXhMjsZ+snQ/2pD3/X8/hPPqd03llKl+C2IqYG+YWnLBtcLWNzom+csbutWbKUHD+q6m7cQexn0ApFzThe4RRqVw+ECKvbPi5zzn3+enCNdnS/KnetPo5txarfTpxCalqLnWfxEde/FE1bVVrONuWtQ/kC4UQUuNshobvW1h73g5fPnTwoqDgMmbaiIqYrJpdqSH6eXF2R0NSGglFTESR4Gvb1gxD49JDe2g4qg52BUDIt8dTjqHJtt4EGZ0MT2Ikw43kyKsOYYcsr51i4puqbMzqwNahJqF98CCAhsjBEzPNA0s/pEOWNq6IJqIDSmmQFFNlST3PbGoUsmYrtIgUOKqmxZKkfExqAP4dnRVgU484cIfOgLMapI5gq9s8y581gLIEuZi9YlaonOG0wPlVj+qlS5zJVJ0MlVyiTSuTNBTa7KQNkyaAK+XJQekEzOyVcvvn75TRUmWj913Ok0sU3OUTuU5IL9mhcqmpyHM7EEC2MupJlXEzpW6jv34EKaUdE8E7/m0tA5PEQAMcTY7d/YMvYNtYCglW7QC5oUfteO/3kh7npBClrTVUv28tY9qKavsic/JmzTuDbU5HoeybiF5pmM0e4yBRqEqZN0wwgOI52Xz1/2yMvnX+PHVz0ShmG3YQ34vHKDTJh/vKygMGFgBcr6wGMObQUCFIusgzjzvmrfZ7rVdVcNKp2R8yvXlV9psmnxkZbW946pc5NPy71ObvLkJk9u8uQm/+/c5NcnN3lykyc3eXKTJzd53E1+c0q6T27y5CZPbvLkJj/kJn1h++QqT67y5CpPrvLkKo+5StQSRLliZhsMbx8DqbbVeWzG3gA23+3usJtag9K216GrRA95AQYPiMqLHHgQBhblJmFR4s9XY3QpKRU4n1uZq8bQ4naI9VzVQSRqPFc8GAaJMZkeDgY0Y2EkhZYcQqm2oU4CBGnoChHWDqru3EWZbV9RA5ylzPQXeXQPOFsLGt3L5ZJF0KdxykSfy401dJz6qZ1gJy+nYoWCbjOYWsGDXsDpAhDRv6TaDiLOnGN0zgunPs2kMuRxJgghpK7Tnms6k2LJVrk7Yy7aDu/6zMSOLJVMyZc1Rl9+i9dnUH57baaiQ14RAZsm7U7326IvzdhE4K4Wge9ZB9ZpkOpaHhwMabmBNGyD+i0ZDEhHWrOgvFtBfPRLqmd3GrIjrwjdUNbAE+5x6TiNtPCeie63wa5Xzsr3sjYbghq2hvpEZDS6R1tLKRMIyU9MZyZmZuaigwczC9zPZVp+ldp9kxkImjGneDILVswk+SKMZDqoJqS/ktjbyrzMRWS5dbo4/TPTIgMZviJ/b1AOL2DTotPOzO6hc+9vZkEXldzSkfxG9nQ/M03TGL4ihxybhoKDaMbOnKxtA0ZXE/d0z1hwJEY3PaJ66EZxcEkprKzsahLuge/4KQhf0+h+pXCj73S7+72sLloU2Q3HDxDlBhx4trTM//aKCMad9mdmmZrwu0wxYZYdqcOpiUGpHpn5oGyTgCAR5RwvP7z7ENR374bki/VsJmaBFbL7Efrf5ZyTH25ursrArzbejd7hx2BQdnBr/d0+42G1UHHAIUeZG+R43STzQWHqWEBn3ZnY1ZfV1dYkUtSWFjrRo35Oqu3cPZwJy7tqCFMZA9d+gc9L1zxfoNn68a2e7wih2l0WN7imm/0hCrQpuo0yhtGGXSO+Z2aVWHRwv3DtPCPneK0JLQLjgkQiFU2K9WW3J59j2Oi62JYyTrfOhsNiK8PtiWZMo8dAwlOAps8Os629gEMJZ9resaJ4wyfPEBPEew4+w7ueYEDp0LrXhu+vCd5c2c6ZWjFekVnwe+EWLu0ZwT3eu8A0r+06YPVDc5OAMD63strBJqmK+08VaiTG7J0tqWK7Edk4GqlgpOCiDFLEJMRdOg1x1Ni5QO1uK9EosTxICiaRsbujpuSaYXC5AC43PYw2XFjnRtrLbEhJU8P0koF2AYglg30jqiF08p6V8r0GqkA15RmSwzjpybPhr9UaeQ+2tw5BrJmS4nYWvB6PrsfX85vLN+OLWXBXTsNYYHpGifeZTndUEFbs6j5rQVUWy9H2qWEZFW55z4UTqtFl+25DB/KZX5nHmVCtvTwZm7MquqhxbAQZFYtufYvf9wtN9bVsBt0S20f2QeRh1NYL1BTKxkCbyn0UPRBk6ZJfNUQ78GOdVgFetbZ2KxbW13RmPv31rOSyEZH1/7lPZWg9dp2Mo1MH7J+C9XWkdHk4vzA8BFB1aOyEH8FBvtAWCvmCQNfG3g99Hd/3YxnZikYtVsYqC1u5tPrwQnsHr9Na/+BibXcpsPXae5ndtMx7sJ/nBPUUCm/gIUYFJlfixlGp3g3Y9YKV3Md5EKeYh1q08ReAXlKuP4I6c5t0q4ZrFvohtHsW+kG8nZa2MI27B3LcFivw7gnT0Cm/WZqHqWv7qrXZuAGhmRROvnvMWo+lfb1gTXkOx9I/jICK8aU9l2NOdn2y60+3a+zqwhbMT6UtF2bUJMEwGFRFj6AqzUyxSO0qxQuqWVQWrp0ZY0spHsZ2qMKFjVuaPV3TQVeJwc0Le9+Yy41756ce7pz5Alqj8edGPSbZxoqGMaTSl2MGjugAP1GSSGZOALlcciaQ/YjYVlLo0e0/vhSMW5CCpQKdEBsiadKhnFEX/r3zVOYuiHqHM9Vsejp9JJGBwDJtcO06YdRzmYGYnGNAKLDqOzknN9gd9WbH/U49GDeoVgh0Sre33bfu1QdH+PAoQvpIlmkCIs4kpixbmRMBECPE23oJDaOye9jedQpIm83GYsGKBXqzQSQF7vh6kIHSaMx9p7K+xWjLmx83mZY64RNxVx68b9/1+uvF2PUCPAa6rt4LHBdl3dKZ1Or3YimLAyUaWfcPKWU4+z5Z+5evRBZvNgQoxNQ9Cw52s2dkgnXSOI9cQnouoxyPV1z6YDNCzkmWLziLXEqFmxTTRtkal62bjq4mOiSj5gNstC/G2HfnFsUrIhD7XICSNeUsJldeb8RZn7PrkFw5jpYKZlWp1IZvXemWCbJQcqNd+jkTz56R6fkbXb7K5yQgTtAF6CJP0LVDKf9WS22yQ5telgxr51faki/fLVpKzuUGly4WKXK6Aj1EGL+Rn/xvH9v+Rs7lRnBJYyRA/sgfkqhPyGf6+w3R9ht/ZL/h6X+fgUQ7WUR7jq9+1RVzm+WLMIZ1tTh9w8AXW/WgSt66rbq9vR6Pzt+OKwp7ZVUd3w8WXC4GKdUGlC+zav/vIKbKDBwJ3FPrug0vxjdNViJfgQmlWjWdSdlcob5U29DlxoPu50QrjYADvBbtmLMHpuqsEngIs7Ri5X7/Xs1+BrRgIbWi/V7us6pIH2VXVsj/FEtYyUM78Gh/pGvaZJXSNYimJWigKkrC8smAKsOWNDIDneB+M6jKnt1PR/uerukRu0W0LrEo7TZL3+umaq3dFs2FTQxqJ0Pdz6lb3CzdjlXHvI+28wtuKkswUdL9o7D7fvifAt4Rb4hAUIarH672TNEhY3rPWzSaGytxT+ufDDpLshZzthp39fgG2m3G9oD6loGv5taMd3C4+j4drYXU6imu88W2yUrli+0KUt1EXG8d4JfGevusaJHVkbV3jSXtBqsI6wY6ZLLiVjb5b0eRfia0un2HwxMZFgGe9ldR6iijUQLkRfj84KQc1x61j62O/Vg9+GlyNr6YjvsvwudhYlJuExpQqb5cTkGtmT3dGRipa3cVipATCyKgtItjOSrDxreYyqb+5VeH62jFZu/Gjg/LsaaNhxLMpldWjkefGdfO9DUe6uNZBrY+PuLNpZ8V3+2w+dcclL2ygCUbxdz7t7d3u16QAI0xHy7rQ/6yRd+m61VV6OCSWFURwjg5Mx/sW8/sry6nN0EvWPj/byS1WXSgKN4xwE9bFnEFBZsZ2zZ3/pbbazCBo4l5ik2jK0WV+UyR5d+Wj6jY1hA+ProeNrbf7YKeF8Wno3e73e5/9JQHgw== +sidebar_class_name: "post api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Create a new workspace + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-event-stream.ParamsDetails.json b/docs/reference/openapi/delete-event-stream.ParamsDetails.json new file mode 100644 index 0000000000..73fb489b72 --- /dev/null +++ b/docs/reference/openapi/delete-event-stream.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Event Stream ID\n\nThe ID of the event stream to be deleted, as returned when created.", + "in": "path", + "name": "event_stream_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-event-stream.RequestSchema.json b/docs/reference/openapi/delete-event-stream.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-event-stream.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-event-stream.StatusCodes.json b/docs/reference/openapi/delete-event-stream.StatusCodes.json new file mode 100644 index 0000000000..4425c9cea9 --- /dev/null +++ b/docs/reference/openapi/delete-event-stream.StatusCodes.json @@ -0,0 +1,219 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-event-stream.api.mdx b/docs/reference/openapi/delete-event-stream.api.mdx new file mode 100644 index 0000000000..e83784095c --- /dev/null +++ b/docs/reference/openapi/delete-event-stream.api.mdx @@ -0,0 +1,41 @@ +--- +id: delete-event-stream +title: "Remove an event stream from a project" +description: "Remove an event stream from a project." +sidebar_label: "Remove an event stream from a project" +hide_title: true +hide_table_of_contents: true +api: eJztW/tv2zgS/ld4Kha1AVvKdnsHnIseLht7d72PNJdksT9EgUtLY4uNRKokZUeX+n8/DEm9/OgzvRfsHxKLIoffDIcfyRn6wYtBRZLlmgnujbxLyMQKCOUEVsA1UVoCzchCioxQkkvxBiLtewNP5CApNprG3siLIQUNE2xyZVp4Ay+nkmagQSpvdPOw1c+FlUSm45CH/DqBSvZTRaZj7IBhtZzqxBt4nGaAT7bKjMXewJPwtmASYm+kZQEDT0UJZNQbPXi6zLG20pLxpbfZDLY7NziJBdpCMB0TsSA6ga7uWpA5EKthPCBUEQm6kBxisk6Ak0gC1RAfwGxEzayoTwV+i5VVLrgChe+fnTzHf1vKZLkuSV2PUAlEIXwENyALIQnc0yxPYYC1RCEjV8up5BNU/qfr6wuiNNWFIpGIwTbcks1UyHWZs4imaUmenXzre5uB9/zkBGFFgmvgGr/SPE9ZZNwjeKMQ5kNLzS5+7FxpymMqY/JKluTnq1fn5PRiSkBKIRFHRo3L5RKdTjNrDPN2jzlMowryTqsY5sVyt9UYiwlqQBlXxNQijNu+meBoI4b6k0IVRnkuNKErylI6T3G+xCShyvkKcCw0HuFM7/SMqaZzqoDQmOYaJFlTRQpTG5suGI+t/6WQoSkH2y4xOKT2Oc0A4ZnWxgTof7sI0PlAaYhrXyCRKNLY6DPHUS94fLDfWafTXSPWT40pF4XUCci2MYngBienupBQzznsoAv41dxwxJrpBCfnt8++e/5nEgtQBi3cM7XXRCzexTYdo3UoKTh7W1Qmmo79kC/AwJhxoWfNgE6k/MG+OBf6tCoO+dtCaDqD+wgghhir/QNLJq4A4fMi80Y33l653sDrSvButxUYePfDpRiimCHq4I32i/psiJuBl4FSdAm7ZvrNvmiGr/En18bfZ3HLGzPkjV2ZZ8gmEnIJSEttkW266T0/eT4gz0++wz/fDojv+/2ON+B7z/qQN/IY13953kBhXMMSJJJ9VSSM82AVpo03LYGDZJEhiDPHVVi/4eMbN7tum0Y1GVleuWx4pdvNBiV19TayfrSdWpr87kiTR5o80uSRJo80+T6a/OuRJo80eaTJI00eafIwTcawoEWqj1R5pMojVR6p8kiVh6gSrQRRIZkuTRxayPIPIe9UTiM4zdkvgMW3GGtVIFf7o9U4gZEhz0GvhbwzoyRFSvKUcjAo1wmLEktTECOlZJTjeJaikJ2mLoatDHOtKyAKLV7I1Bt5ida5GgUBzZkfCa5ECr6Qpa8SD0FqulTGYBhXVmix+6GQ5VBSDSnLmB7Oi+gOcKjmNLoTiwWLYEjjjPFhKtbGy3Hcr8zoWmVTypeoZZnDldHaG3gpnQPC+buQZRClzLKiZS4c9ywXUpOHkBNCiAmoq9OcDezzmeALtixsgiDkG5s/eNqS9fQFRt1RP43WbGqTl4TDuiuh139R1aU5m3JctSJwNeu+ex05fdNBCrqy+DQeETtxXpAgaPIPhLSyD2Fo8w+k59ZXHMqCx7BgHOK+FQhNmqMrdCuvYCV/YVbhIJLKIg9uNg/MIkc25CWha8o6pvJ38jM9O1C1bdzAdVQLef+Fh9kT5x8/ipZfcKrZCtoukdPoDl0+o4wjPOcivZCHOrSblHsdevZxkdVfhbLfRA6c5sz6Bwm9JdNJMfcjkQWN3wyXAmsb/RcFj0xvvT46YqhrbcjoJQm9+nHmuCz0SBC48SLvyAEfsB6A8jrWsDI7RQfkfg03QH1D3Z0po5ekYzP/HNZb8wYb0ZydWZvua3B6MbVvt6YPtpQDXC+wWS3Dd9PtYuqPd3zKjbH/PY3ulhI3NL3+oOVjXffq+5N7iAoNFiZbmM7+9JJwltrxDPUi0/4PuWRcL3pC+Vc6BikHJHS7TWsimqZo+Nfvgfb69Yh8swpDHnpGp/4HxP9QpKlNiVUb2lZ723oT8k17dlyUOhG8NUOQlQ8Sp5DlzL4MuSHHpsCXoDRx9U5zhvuH3BKpqZkbwFUF+4Tu8YSMkRzQFOhmiUApigjTlqZmwXFcYvbL1UKTp7S0o+VXixMuODRnCicfCr4C6LK0n5cmQUhJypRGz6ZpSlSRIyaItyi9yQT7hrU6bN9SvOu8lpGMGjjzPhZuxQ5PzLRzbJIVrXUGjH1ooRPg2p2WjHWwSEj2z23UKIxxQqNIyNgsPWZnjFJw7bf7BlLtMkguUhaVPraaWIJQNptKo8T0QTLQiYhNEjaXYsVwuziHVKwHuH+wLGFbEp1QjZIU1UwtGCi7pTBisG5EFfhW37Nav++BSpBdfUZkd+fzyaNBowiUmmlxB6a28oGvmBT8JvS+n5xeTi5n169+mZyH3m09DBOOBy5KHDtY21FOWLWOO15EU1ZTwtRpYTmt+GeLpZAwac5ctZEF+YScGdY83AlVyumTsxlr9hOtHpttRSO/31k0ZywmL8nT5qlaDp6SJ0jvH15h6hW3uR+AEreKdsV+rQUG8WhZOjNaU37UhZCmQdugbtcxa+vTa8w12NbdmRcM35Ga9hAztDAZwuuFXlOhswzUAzf8257+R+QbZWicfEOgb3bU90MV3w1jEZk4RWsTjLETtrSH5X13XHr96paL3UZ3b6lMd0/z2weVD2xCd+6K4GrTvlZSraQf7OhrOMwuOnNdBateWzArwWLS694hIXMRl308ui7FtoH3bCj0fWuX8HWs/f9h64Nmzu22ZK8vd2fme+1rry41mj+ydTsXpN7Ty3+fI2OE7l4DV0xwa7g7jCgcOpUPvBVNCzh0Oke7VO1rVqrbHNnpyE7/k7Y+stN/ip2wtj1t1HY1htSJN/KC6gAVPDSG3AQ2tGhgquBhywIbr4mnXmFmyaZ35lSxqM42WX7DktpeeHzDEZ+bo0m3pi3aqSrw/PIMqy5SsTbddE40Zy7q3Sn8vRNETcpYUj+GTLgYamCFBvgXNYlEbhUQi0XKOHZ/Skwpqcxux8Plb3CHKWEhQSXEnIIU6dGUUXvCe+2kzOw56TU6bbfo0+Xbu9Yccyvepa2Eu/FXOfDpGM983Dn2NVZHu5l2H2kHbRu1ovfW6Gh+WZ4azFbwbv5QuMMqUwR4nAuMSpSiIBwgRog37bg3HrzuoLztVZDW67XBgvE9XOaCSHDc0KsgB6kwYjG0JhsajCYn8WGX2RPc/0TcTVB+mMIK0n+/GphJ4wtRpXZpZBZ7yCjDIXVBlr+7nEB90RyRXdl33k5K5AmZYsYiLiIbSBqLqMBEpz32m0hOmpK8mKcssqEQ3JIwpaUJ85oMxunFVPnktPsCC0lEMbWYlshoVlmI3RmekhVNWUwunDGIdSnrrD65sD0aKRgNyYTSaWmTKIyTuRRrZcNGIX/yhFyNf1F4V58pEjsNiFV0Dqo636tWepjZhGdrBO1t97rDViZZGfHGGNhmIdJUrHE+YoCvoEtQI4Txjvzqnt159B0ZizVPBY1RAPmcD4poD8gjfd4h2mHnQ7YLPv3zCCL2i0W0Yyp1xzA3eTH3Y1g1M84VBC7foIImatPfa9uby8np+LdJI2Ers6Diu2CeinmQUaVBukyDcv+DmEodWBF+FvfbtvXPJ9fdrnixBO0LuewyRF3coH4lS9/GtIL+Y6IVmsMOXoN2krJ7JttdJXDv51nTlX3+WMs+AlowkPai/VFsd9WIPthdnST6Kp6wFLt+4ND+TFe021VGV8C7nqCAyijx6zcBlZotaKQDleAiEjQpg/6Xo31DV/SA3yJae4ys/TbP3qiuaY3fVsWVTwStHG7/MW2LK6BdsdqYt9H2/sBFZQE6SvqfC3vomn8V8FZ4RwWCOlz8dLHlihYZU1ts0SnuzMQtq38x6DzJ97izsbjNZXXQljnbAupKqkNEy3mD3dn35WgNpL1McVnMy25XspiXS8hUF3G7NMAvnfn2qGixqwNz7xJTUZ2uIowSKZ+Jpre6yH07iPSR0Kr9KxxmM1kEeO9mVB+JT3MaJUCe+Sc7d1Zw7lHz2tjYtVXBr9OzyfnVZPjMP/ETnaXmlAIyU68WVyBXzGRGAy1U69ZQteXE8BdIZfexKRrD7G9zoXRGeQvXR2Uqts/srduTH//bV7dbx2wWpiOZOXUZSzy4o/VNFZlA+KNOlKJ9usaX2xGG24GHOU+U8fCAdxZ/l+lmg8VvC5DmshIGBCUz19rMXSWmzLVHb7SgqYL3aNi7dGfOPvnwD3D3aukKKS9boUxv4IKWLUXNr24/B9hX+3HuZ+izPTab283AS4DGGMGoQ714pMnbod2dW7idKMx48uvkeuINTNyi9bPf+jBYhUhuHvbDe3iwNcwZarOp0bqz/O1ms/kXWihCUw== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Remove an event stream from a project. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-identity-credentials.ParamsDetails.json b/docs/reference/openapi/delete-identity-credentials.ParamsDetails.json new file mode 100644 index 0000000000..083a43e5ef --- /dev/null +++ b/docs/reference/openapi/delete-identity-credentials.ParamsDetails.json @@ -0,0 +1,42 @@ +{ + "parameters": [ + { + "description": "ID is the identity's ID.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Type is the type of credentials to delete.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "in": "path", + "name": "type", + "required": true, + "schema": { + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string" + }, + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + { + "description": "Identifier is the identifier of the OIDC/SAML credential to delete.\nFind the identifier by calling the `GET /admin/identities/{id}?include_credential={oidc,saml}` endpoint.", + "in": "query", + "name": "identifier", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-identity-credentials.RequestSchema.json b/docs/reference/openapi/delete-identity-credentials.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-identity-credentials.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-identity-credentials.StatusCodes.json b/docs/reference/openapi/delete-identity-credentials.StatusCodes.json new file mode 100644 index 0000000000..1a36572fcd --- /dev/null +++ b/docs/reference/openapi/delete-identity-credentials.StatusCodes.json @@ -0,0 +1,113 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-identity-credentials.api.mdx b/docs/reference/openapi/delete-identity-credentials.api.mdx new file mode 100644 index 0000000000..cba6b0cf95 --- /dev/null +++ b/docs/reference/openapi/delete-identity-credentials.api.mdx @@ -0,0 +1,38 @@ +--- +id: delete-identity-credentials +title: "Delete a credential for a specific identity" +description: "Delete an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) credential by its type." +sidebar_label: "Delete a credential for a specific identity" +hide_title: true +hide_table_of_contents: true +api: eJztXG1zGzeS/it948qZ3BrOOI7vPtDlu1VEOsuNY+kkbaW2NC4anGmSiIbABMCImpX5368amFe+yHKi7G0u1Ad7iAEajUbj6UajMfdegjpWPDNcCm/ojTBFg8AEXPMEheGm+NBbGpPpYRiu1+tAqiKI5SpMZKzDG8WM1GEsRYyZ0WHVZJBrVIOVTDDtQ6zQFrMUZgVwo8EUGQaR+LvMIWZCSAOJ6zZjWt9goUEqiGWCwHKzbBHQYJZK5oslmCXXcHI+CTzfkxkqRvxPEm/oOVKTkpPTpq3nexlTbIUGlfaG1/dbQ5+MgFMHCNUwnmuYjKgHTu8zZpae7wm2Qm/o8cTzPYU/51xh4g2NytH3dLzEFfOG9x4N0Rt62iguFt5m42/3dlVkWPVHlUHOuwOVpVCCSJBY1lIl0BoNtT8vyyMheRJvvz2bjE4jYaTJtt9cnV2dRyKV8ibPphpjhWa7yjv7MhJrnNEciO33P+LshMojYedp6+2pTJBeO9ZvsNjH+Q0WkciUnPN0h8C5K46EZqt0++XlyQ/vIpHgLY9xL3Mj+6rkz03mnKOazrnSOyOd1O/f0utIpFzcTBXG8hbVDuMXZfk7Lm7gwZdcAwOdYUyK31oDdrKpD0xokmn+6Rdoo5jBRQG9uu95Ktf9AGBiiBqtk1xjAmtullzYlm2NkbOfMDa0wDCdB25iPjsOmqn9Cm41+CEVR5GvvOG1V2knrUSexJ7vkc55vtdRMM/3Kl3yfC923ZbaQU9uwj3foxn3fK81vcTf1iQS9fY0lSSb3x/87SXoe3eDhRwQ1wNainbAx3V1XFe/3braRf1GKF1bY0vk3JaQfoU0F53RtczBWy6S7bazAmKWplws7JuP342vIGTJiovKKHPU4T1PNv/NRZzmCU4b6m/uSc990onNR0CRZJILUxu+n3O3wmrLV/XqPWTxPhB26EwKjZrev3zxiv7rymO8ykwBdT1gCkGjMLBeovBhLhXgHVtlKfpUS+YqLms5aSQBXC0R/nJ1dQ7aMJNr5zfYhlu0uY6EKTJOcirg5YuvAwKFV46tWAqDwtAjy7KUx9ahCH/SxOZ9a5hbVnyJ1K9ImErgTBXw18uz9+SXAColFfGxYlaSmSI3hWbBYie93SMO26hieadVgrN8sdtqRMVAI2BcaLC1gAvXN5eCZMRp/JDr3A6eVJ7dMp6yWUrOXgJLZl2OGQIKKkyI51L05TgTZtiMaQSWsMyggjXTkNva1HReaSWmuCJR7kHgA8N+z1a1L+TkRqq2ywHZItQGk1oXIJZ5mtjxzGjWc5Ec7Hfa6XRXiPWvRpTzXJklrdVGmCAdQghmcoXVmrUddBk+c7BBoAKTEXz98ptX/wGJRAc4eMf1XhHxZJc355kyyAX/Oa9ENBkFkZijZWMqpJk2EzpW6q178V6ak6o4Ej/n0rAp3sWICSZU7X+oZFwWEPulTd9L1/O9LoVdK7vHyD4tixvfW6HWbIG7YvrBvWimr9Gnsk2wT+ION6bWJdmhSTgOCjOFBEttkm246b168cqHVy++oX++9iEIgn5HG+i953SIEFSY/3zVsMKFwQUq2iVURc7mUBVurDYtUKDisQWI0xKrqH7jnl2Xq+tD06gGI4crFw2udLvZEKXuuC2t71ynnn07Z3lqjlB5hMojVB6h8giVh6CSpIRxrrgpbIxJquIkjlHrK3mDwhtefyDP2LAFhaC8KtJErNwNpCoGtFlJ+YqbwSyPb5Bk4KJsA+vND1K5tqpDwry0InOxrJSJRRlWurTM0RaZzTD1ht6fpSrCOOUOahwckDBXmVQG7iMBAFBFzE4y7ruSUynmfJG72FokNjBXcgXPW9Sev47sTlVoQ6rU1IY3IHDdpdDrv67qsoxPBBmDGMuard57HUp920WKBngyBKeKryEMd6N1UeTiddArjRVBbS4SnHOBSd8RodkcwvNq5/8cPsFz2vzYB9rT24fOFt6WVPt1+4Nkbx/KXbh7dltr+0w7KfvQ2kw7wu09cE2rKaGRPT4yCJ8LYMCh+AUcCl/AI6IX8LngBTwUu4CHQxfwcOQCDgUu4HFxC/j/EYWARwchHlwNzVa+s7R+fZAC/lkxCuhJi8Ms7R8caYU696Uh8q1/Bht4A2zNeAeOgoPHBz0Hijwp0ZFm2q/KqjFGov/ahn1KOP5OtmBYMMNvsY3AGYtvyAyvGBfEZ4nIvUhEJnKO9p2JPPdzvqofpXZPMkPBMu7AGCJvwc0yn9nzmQakBwtJta0g5rmIbW+9PuF+ZHgCwzcQeTyZlhY48iAMS22AT3DoVIQakwimrr19PEDiCGhHQHs6QHNaW4NKqb11LPqAFv8+IY2WbGS6ntXwDXSWffAe11t+FjViGT91sLCvwcn5xL3dcraopfLJbadmNY2gds/OJ8HoIEKWgBV8y+KbhaIdZq/vE2JaLZr2g2Yaeo0Q+8H4DuPcoGOcz233//YGBE8dSEVmvjLB20xxYeY9qYNLk6BSPkRlGICixfVEfHwUsx8/DuGr2ygSkWfH2/9MR2/zNHVx5irm0GrvWm8isWmD/3lhllK0DAD59wfdcKmKqXsZCetoNwWBQm2grHeScdriZc4ptzUzy3BVwf0i1XkGIzKClXYupbYrs1IvG80obaZF4eqcP0tZ4eYvyJSkZarp3J9lXJNtIcKXiF2PP8gKG3VnkHJtaE2xNAWdZ8QTJlvbg+Yg3h6odHcOrYF3FdtZWzsMWvWPZbcyfs/sWUFpLFd5a8+CVj4EtaQdLqBlpUNFUvF/bHNNxLgAFsdSJXYbY4MXRIU2kRrVLSqoNoKQyZTHRUCtxg6ftDuiYPHS5Tis0CxlYk82MiVvOe3oZ5jKtU8g6vbSriWYJTNESTPD9ZyjhkLmypGhujHTdEpEVU7r8X2LTKHqjmcI3c3pF88Es22nhhpTbR2guOVKiuvI+3Z8cjG+mF6dfT9+H3kf6ikYC4qHMSixwsmNCeDVfrBEYxJjtRxsnRYvJxUubaEXME2YVVYbOiafkTFhLqdlfydM63I8GZ/yZl/a6rG9PW166FfuH7yB540H9RyekeV50HmqPEhqacFxp+3Razp6TU/pNXU3Kk5jt72mlub+fh0mu7RUUS5/BwFVWlubU2et7OTNedyEkepmbTgo94XTqlaLK92rPBy/NdI3LQfHkURrtaE23oRW2OLSmu1e5DUVOm5NC4IG//UAN0P4Slu3BL4C7HsbG1nUyc2AMvYoatsKEdJxDV+4+PxDqXO9fpU854KN7Ry47aj255LqqjDdTm4ReU7d3KOS9PWf/tQE7HZ6cOG7h6h1EhY+w+6/otr/+7O7b0avD+ZoNOOes1SjS7wwuRJXbqi3kifQ62ZDwEwmRZ9C+gu5rQUP+PfmruWsP51KPE4hpp+lfDSZR5P5dCbzCCkHIeUgmmRuy7vXruy3nY+CkSfDkIepHvHjiB//p/jxhwCPh/wRSkC5Myg0l8IBAqWHDw+djfveLUtz3HdGTsKu2tbeb13/6AX/0UzW0Qs+WrGjFTt6wUcv+OgFH/HjXxo//hDg8aAXTLXdiWCNGxYgzNIbevs5DFuTFd6TMDd0yGwPIh2o5IrOoKtD0/vyqHSq03yx2XtwGlp/WXFKN7aR43YTl/9bXgrwmiPYncn7Ox1OUr7/ezRrqW7g3FEBohJAeQnc5cRzA6XqXbdbnEqhZYrNRfTYFdjL6HoZVsyHca4UChMu0Ay0YXTw3A9KeVaHsZd0P8GNZ8Y0j+s7CzQrrqRWRuqPAH1mT0+7NV3RTlVJCPCSqtL6st10Dl1Py9zpTuHfOlOzLBLFggRXshqgIxrSv/bOnczcAOR8nnJB3Z+ALYVK7dzZQXkLgBRc4VyhXoI9rNXQYyln7hD6Y0ll6o5zP5It6hZ9OX13K19Qhr534SrR+etZhmIyovkUpAGTEbisaMrmpodHysG4Rq0ccCd0Ev9WuvXOLRRZnqdzXS9XOj8HgZjYzx60FY/Oh2/woS8g1J8+yFBpOoIaOJENLI82s/3zKqOKH6W60RmL8STj39Ou9Qv5hnVFYJDiLab//GHQfQwxl9UFIRbbfTWuGKcpLfNA/uzmsblLSpxdunfeTmL9M5gIo2SSxy7XZSTjnK7LuOwEe3yXppDls5THLluDgJFbU8dv0YLOyflEB3DSfUGFFnSkSAu6DeMGi0mZasDglqU8gfNSGOBUyilrAOeuR0uFEjZWUpu0cNaTC5gpudYusyUSz57B5eh7HQl7rygpRwBuoDPUVRqCbl0yKiGwNYPulmvdYes+krbkrTCozVymqVzTeqQcpJwtUA+JjU/wrvxdHjZ+gpFci1SyhAjAL/kjEu0JeaK/T8TtoPMH2wVf/vcEJPaTJW5HTJmOYK6zfBYkeNusuLIgLDN+ddgkl/T3yvb6Ynwy+mHcUNjK7dXJTThL5SxcMW1Qlbm+uvw/TJgyoSMRrJJ+W7bB+/FVtyuRL9AEUi26CFEXN1yfqSJwqTdh/ym5lUbgDr+W23HK77hqd7XEuyBbNV2534+V7BNwi5alvdx+J7e7akgf7K5O0/5NNGEhd/Wg5Pav7JZ1u1qxWxRdTdDIVLwM6jchU4bPWWxCvSQjEjZZjf1fz+1P7JYd0Fvi1kVsa73NVj/prmit3lbFlU6ErStL/aeULVlAZ7HaPG9z2/uRjMocTbzs/1K2B2Xz34R5R7wzBKAxnP/lfEsVHWdcb6FFp7izErek/quZzpbZHnW2Enfpth1ui4xvMVqWVFuGlvKGu6vv13NrWdqLFBf5rOh2pfJZscCV7nLcLg3pobPenpRb6urA2rugbNlOVzHFE3TAZWtXVhWVTwc5fSJu9X4LZ78NFCPd3hzWoYaTjMVLhJfBC8/f2gnT2mP2tZVx2VaH7yan4/eX48HL4EWwNKvU7lJQrfTZ/BIVRXRoM26kbt09rVxO2jmj0s6PTUkY1r/NpDYrJlp8fUFi2vbOunUT/3f52bZy+0BZwJTCze020E7NfRnquPasR19//8le7ve9oY2LtshTmaX2wfcoO5xa3t/TBfy/qXSzoWL3DRv70Teu7a39MjDzgFB/bx/r2StQdwbaibRVZ6Y2N7AK8HyhbHoXZSCgfzDJ+RBHZSETRZuXhlP32aRfwsnjI9fHb+odv/31W39T7xcov327+bDxvSWyhCKOdQYEhSCydsbDzrdXOkHj0fjd+Grs+TbO2Po8Vx28qUKa1/f7ebq/dzVszGOzaVh0sbcPm83mfwHpIOc1 +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Delete an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) credential by its type. You cannot delete +passkeys or code auth credentials through this API. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-identity-sessions.ParamsDetails.json b/docs/reference/openapi/delete-identity-sessions.ParamsDetails.json new file mode 100644 index 0000000000..477e498f6e --- /dev/null +++ b/docs/reference/openapi/delete-identity-sessions.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "ID is the identity's ID.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-identity-sessions.RequestSchema.json b/docs/reference/openapi/delete-identity-sessions.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-identity-sessions.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-identity-sessions.StatusCodes.json b/docs/reference/openapi/delete-identity-sessions.StatusCodes.json new file mode 100644 index 0000000000..f88ee279f6 --- /dev/null +++ b/docs/reference/openapi/delete-identity-sessions.StatusCodes.json @@ -0,0 +1,219 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-identity-sessions.api.mdx b/docs/reference/openapi/delete-identity-sessions.api.mdx new file mode 100644 index 0000000000..9c13358c81 --- /dev/null +++ b/docs/reference/openapi/delete-identity-sessions.api.mdx @@ -0,0 +1,38 @@ +--- +id: delete-identity-sessions +title: "Delete & Invalidate an Identity's Sessions" +description: + "Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity." +sidebar_label: "Delete & Invalidate an Identity's Sessions" +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/it7yPQizUikk/rugzK5qWurrfri+Gx3Oh3L40DkSkJMAgwASuY5+u83C5AiqZcmady7L/IHWwKBxbOLxYPFLv3IYjSRFpkVSrIBO+VJIuQM7FwYQBlnSkgLQmuM1AI1nyQFcBlDhjrlEqVNCogxQYvGtQu54ImIufueJGDQGKGkATvnFiaYKBKuwM4RZmKBEkYxSitsEbAeUxlqTkhGMRswL7d6flVKYj2Wcc1TtKgNG9w8bmgwOgNhnHxRjnxuYHRG4gU9z7idsx6TPEU2YCJmPabxfS40xmxgdY49ZqI5ppwNHpktMuplrBZyxlarW+psMiUNGnr+8uiY/rQRDNPMFrDuB1wjGJQWlnOUPZgqDfjA0yzBHvVSuY7KXl7jOIDrOcIP19cXYCy3uYFIxegHbsgWZixtkYmIJ0kBL49eBGzVY8dHRwQrUtKitPSRZ1kiImfb8J0hmI8NNdv4aXJjuYy5juGNLuDHqzfncHIxAtRaacKRcksGzTStmBXeGO7pDnO4QRXkrVExTvLZ9qgzagbSgAtpwPUCIf3cQkmykSD9ITe5U14qC3zBRcInCTpnnHNDvjZBQEmNMWEuTV/qGXPLJ9wg8JhnFjUsuYHc9aahUyFj50uYYEqm7G26RG+f2uc8xcoTvd3I5bYRkPOhsRivfQEilSex02dCq57LeO+8d61Jt424/labcpprO0fdNCYo6XBKbnONoKY16jbgN5N3GFlYCjuH0Rm8ePn18T8gVmgcWnwQZqeJRLyNze9TDrkU7/PKRKOzYCyn6GDcSWXv6gUdav2df3Cu7EnVPJbvc2X5HT5EiDHG1O3f1DIsGwi+zFM2uGE75bIea0tgt5sK9NhDf6b6JKZPOrDBblF/GuKqx1I0hs9w20y/+Af18tX+VI4Jdlnc88Yd8ca2zFNiE42ZRqKlpsgm3XSOj457cHz0Nf160YMgCLotb6DnzPsQMam0/zyuoQhpcYaarVbrJuWch7oI67xphhK1iBxBnJZcRf1rPr4pd9dtPWhNRp5XLmteaU+zIkltvZ2s7/2kniZfHGjyQJMHmjzQ5IEm/4gmjw80eaDJA00eaPJAk/tpMsYpzxN7oMoDVR6o8kCVB6rcR5VkJYxyLWzh8rdKFydRhMZcq3uUbHBzS3lWy2eU3mVVFpegPPSVLvqaW0xEKmx/kkf3SDa419wq0+dxKmQ/UUvnOmTMK2cynydOuJzR3i8yvHLgWI8lfIIJG7BvlC7CKBGeajwdkDHTTGkLj2MJAOtU9Ukmer7lVMmpmOU+aT2WK5hqlcLzhrTnr8ZyLCMljSVXqnvDa5C4bEvodF9VfXkmRpIOgwjLno3ZOy1JXTdFghZEPADviq8gDLcz4eOxz4VDpzysiGpzGeNUSIy7NdLH0iF7jqdhBa+BL7lowQp25+c73jIiHsvuK7bqre3+vWrYW3IrFtg0dcaje9pvKReSgJSm74zl2I79ifpgx8x/nabrj8r4TypDyTPhrQ5jNhN2nk+CSKVhvRr9maLeTtNpLiM3W6dLCzy2IobBaxgzEd+VW23MIAxLi8IH2FdaIGlj217dwWtoIQrOcbmx1jSIZ+LUI9414ORi5J9uLDiN1D2iDhq2lhGsXeRiFJztXp3SkMG3PLqfaTriOt0eiLgbDB8wyi16XGLqpP/tNUiRePOM7TS1wXeZFtJOO8oEVzZGrXswLiMNKm9AVBaQ3n4cy9u3A/hqMR7LMXO6dD8yy3d5kviqSBXTNMb70auxXDV97qKwcyUbfkf8sXebK13c+Ydj6TZy3RBoNBbKfieZoCMk85ve9cwc4KqD/0Zu8QzOaHP5khrCXJEUA8qN5YmLlsq96EKmubWZGYRhlvDCL0+QaUW8agKlC54JQy5Ngq8Q24wSZIWrEXFIhLEUTLgKXJ4RJow36KcuogVu17eYqaF422n95nZq0Fb5VLjVnnvmKlvlHk3zBieisw/P7ZycxAfMzjrUpLT4zyZqEiYk8ChSOnY06YIjkkKHlEG9QA3VQQOZSkRUBDRq6De38QU1Hs3dHJCinavY1eEyrRaCIgYqWC57kBsPr6QFV8wkSYZbYaYCDRQq114M9Y24wcDre7rW71vkGnVbnwG0D7/PXgnuxt5ZGky9TYByIbSSN2P27fDkcnh5d/3mp+H5mN2ul2AoKd7mUFKBtxuXIKrzpgxDyYzVdnB9GlhOKs7ZYCbghvio7DbwIJ/BqUZucf8k3JhSn0zcifrca8zYPP7qGbrVaQOv4XlN3M/hGdH2RzibRlpdlCg9Uk9V8HcYrSvZBHtUD67oqx7VBF2einfVbHdVBbwj4hIsOu6ANYWQzbABwpFHZ8zqDi1mbRii/699sw3gK+OYEb4C7LKVC55MfN+PVeRuf40oiG6kYuavIHvL7p1uVXj3wVSzfr4ZtX+sIF+FIVuld19ft7mW117kQokYOu2iN0xUXHQp1p6pTez7Dj370Djfnk6RT1VjrwaZP592rsAOF/ok6E+I+4/MTxfhB4vSv5RBcO6xYIN9MXqPLXiS465Ync7rauzaRdf9D656cNUvdVXq7Y/3NWQHz87ZgIXOE8NyQoEmfBTxKjT1+0Y+lvCK5JrCyCrueSyjnTuT5LPVztgndK6sBWUkHPM2h/gUQZk3ZHUUtWWY3ym+oJTgOdql0vdw4aUASQngd5VDxKVPmwlLgREZ8aY54lRJoxK87VTgI99AYAMzDyvwYZRrjdKGM7R9YznFjt2gtGIVT11RCtPrM+FGROu0Jq2Fb1kvNM1HHjRxAVC7p2/a6qooSnpJXaeJWrppWnHTaZleaTX+2lqaeRFrHsSYqkpBLzSk37Sokcq8Amo6TYSk6U/AtULla/7gLROFdPZqnGo0c3DxloEOTwT3ceTbUsqdj8jekv+3mz5fvn8jTlISj136ThSLvMlQjs5oPSV5wOgMfOKEEj704RPtYP2gRprIG53Mv5GR2UpUqzIkbr4kWKgcJGJMEFuORyHePRa14y2XS4eFdgeRPXkihTomzFAbuhf1vcn6DqNLfn3cZXTxm9L3JuMRnmTiJzpQPhM3LCsB/QQXmPzv1aCUrZyqqobAI3fkYcoFLWl5lfvGr2P9EiMhu/LP2Fbu7RmMpNUqziN/XT1TUU4ZdX/BcPfFJIEsnyQi8hcuokNhrHYpGkc6JxcjE8BJ+wE1OtJRMikoYe6Vxbi8LXBwATRclMYA71LeWQO48DM6KXTnSpWhl0lzg/QWKUy0Whp/OR3LZ8/g6uwnM5au9BCXGoBXdIKmukmYRh2ipMDGCvrXKtcTNkoWxol3xqAxU5Ukakn7kdIIOZ+hGRCMD/Bz+b2M1D/AmVrKRPGYBMCf+SERzQV5op8PhLbf+oHNhs//eQIRu8US2jOubcswN1k+CWJc1DuubAjLXKEJ6/thd6dtby6HJ2e/DGsJG1lBE9+Hk0RNwpQbi7rMEprybxhzbUMvIkjjbtO2wfnwuj2VzGdoA6VnbYZYN9eo3+gi8LfnsPuUaJWVuIXXoR0m4kHo5lRzfAiytJ7Kf/9Uyz4BWnSQdqL9Xm1OVYveO906wfuXeMJMbftBifZHvuDtqVK+QNn2BINcR/Ng/STk2oopj2xo5nSIhHVisvvlaN/xBd/jt4TWX6bWfpul70zbtM5vq+bKJ8JGVaP7lLalE9CfWE3Mm2g7v9GhMkUbzbt/Fna/HP6XgPfCWyoA6XDxw8WGK3pkwmywRau5tRM3rP7FoLN5tsOdncV9xryFtsjEBtCypboyNJw33N59X47WQdrJFJf5pGhPpfNJMcPUtBE3W0P60NpvT4qWptqz9y4p4d2aKqI8iQmEatzKqqby016kT4TW7D7hqGYiIqQC72B9fT/JeDRHeBkcsd7GTZj2HnePnY3LsSb8eXQ6PL8a9l8GR8Hcpom7paBOzZvpFeqFcPWX0CrTKE9XISfdnFEbH8cmZAwX32bK2JTLBq5PT9puXqwb7+r8n//3qbwHUEaeyinC3eecjR/LTMUNc6E5/SPTOlfBemzgkirrdMVtj1F5hro/PtIbNr/qZLWi5vc5aqq439YJCf//U8K4l3TYYMoTg39goc5leXHt7s2r79OkbOSyaKQCWa9M/ImYrW5XPTZHHlOKYJ1NpDtD1swebr1P1crtnA1/Hl4PWc8lBhr/wLW+bVU5iJvH3YgeH30Pd0lZrdYAy8vy7Wq1+i/xA/oO +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-identity.ParamsDetails.json b/docs/reference/openapi/delete-identity.ParamsDetails.json new file mode 100644 index 0000000000..477e498f6e --- /dev/null +++ b/docs/reference/openapi/delete-identity.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "ID is the identity's ID.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-identity.RequestSchema.json b/docs/reference/openapi/delete-identity.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-identity.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-identity.StatusCodes.json b/docs/reference/openapi/delete-identity.StatusCodes.json new file mode 100644 index 0000000000..1a36572fcd --- /dev/null +++ b/docs/reference/openapi/delete-identity.StatusCodes.json @@ -0,0 +1,113 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-identity.api.mdx b/docs/reference/openapi/delete-identity.api.mdx new file mode 100644 index 0000000000..600277dec8 --- /dev/null +++ b/docs/reference/openapi/delete-identity.api.mdx @@ -0,0 +1,41 @@ +--- +id: delete-identity +title: "Delete an Identity" +description: + "Calling this endpoint irrecoverably and permanently deletes the + [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) given its ID. This action can not be undone." +sidebar_label: "Delete an Identity" +hide_title: true +hide_table_of_contents: true +api: eJztWl9z4zYO/yo47nTWnrGldJu7B+/sTdPEbdM/2VySTqcTZbK0BNtsJFJLUnZ0WX/3G5CULdlOd7dN7yl+SGwKBH4EARAA9cAyNKkWpRVKshE75nku5AzsXBhAmZVKSAtCa0zVAjWf5DVwmUGJuuASpc1ryDBHiwbsHOFaZCitsPVNb25taUZxvFwuI6XrKFVFnKnUxHeaW2XiVMkUS2viZsqwMqiHhcow78NMLFCCsAZOTyK4Ijg8JZCQcglSWZggVDJTEqNEXnXgarSVlgZeHRzCco7SIWukwJKbADkDpeHw4BDEdJeERExVJbOIDZgqUXOSfpqxEfOzTwM1G7CSa16gRW3Y6PphS6WnJyBMh/9Ltyg2YIKel9zO2YBJXiAbMZGxAdP4vhIaMzayusIBM+kcC85GD8zWJVEZq4WcsdXqhohNqaRBQ89fHRzSvy6CcVHaGtZ0wDWCQWmdcgYwVRrwnhdljgOiUpVOA1XQE20AwvdXV+dgLLeVgVRl6Cdu8RYmkbYuRcrzvIZXB19GbDVghx5WqqRFaekrL8tcpE6n8e+GYD60ltnFT8KN5TLjOoO3uoYfLt+ewdH5KaDWShOOgltSaKlpp6zwynBP96jDTWog78zKcFLNdmed0DDQCriQZEH0U0gvWygZjFQYqEzlFk8WxBdc5HySo/OaOTdgFVkuShp0thVUH9aZccsn3CDwjJcWtbPFylHT1KmQmbMlzLEgVQ62TWLw2LLPeIGNJXq9kcntIiDjQ0Pe0dgCpKrKs8bpnFM8Kve2I3RXietfG1VOK23nqNvKBOWdVnJbaQQ13aDuAn47+R1TC0th53B6Al+++urwn5Ap9P6L98LsVZHIdrF5P+VQSfG+alR0ehIlcooOxq1U9nazoWOtv/UPzpQ9aoYT+b5Slt/ifYqYYUZk/6GRcRgg+LIq2Oia7eXLBqzLgd1sL2DA7oczNSQ2Q1oDG+1n9achrgasQGP4DHfV9LN/sNm+jT2FOdE+jfu4cUtxY5fnMUUTjaVGCkttlu1w0zs8OBzA4cFX9OfLAURR1O9YAz1n3oYokkr7r8MNFCEtzlCz1Wo9pJzxEImwzppmKFGL1AWI4xCriH4Tj6+Dd91sJq2DkY8rF5u40hWzIk7ddTte33mhzD2d8iq3z6HyOVQ+h8rnUPkcKh8LlaQlTCtN6Tdl3ErXR2mKxlypO5RsdH1DmbHlM0rIWZN3E5T7odL1UHOLuSiEHU6q9A5JB74qGfKsEHKYq6UzHVLmpVOZz+xzLmfk+3WJlw4cG7CcTzBnI/a10nWc5sKHGh8OSJlFqbSFh0QCADRFw1EpBn7kWMmpmFW+vEjkCqZaFfCyxe3l60QmMlXSWDKlDTW8AYnLLode/3VDy0txKukwSDFQtqT3Opz6TkSOFkQ2Am+KryGOd2uXJPHVC/TCYUWhtpIZToXErL9B+hAMcuDiNKzgDfAlFx1YUbeS6nmNiCyR/ddsNVjr+zvV0rPkViywreKSp3fkZwUXkgAElfcSmdjEn6T3NmH+57RYf1XGf1MlSl4Kr21I2EzYeTVxBetmF4YzRdRuhdNKpk5ar08bm1iRwegNJExkt8HFEgZxHDQJH+CxIpC4Jba7q6M30EEUneFya49pEi/FsUe8b8LR+al/urXRNFMPKGTQtDWPaG0a56fRSXdXggKjb3h6N9N0pPX6AxBZPxrfY1pZ9HjE1HH9xxuQIvdqSey0sNG3pRbSTnvKRJc2Q60HkITMwlXnaeg5vHscw7t3I/hikSQyYQ57/yPcv63y3NerTe7Smu9nrxK5atvYeW3nSrbsjOLEo+6sdH3rHybSOexmINJoLAS6o1LQUVF653aUpQPcEPhfZAYv4IScyHdfEOaKuBhQbi7PXVYUfM6lRk1/pcx57bclKrWi+Gmo38JLYciEifElYjdyRGXtqncOuTCWkgae52CqkjBhthVmNu2NyHl3JwK1Ft41Uu/MbhnkGp8Kt/GxF67nEHyyqFqxD51+eGXnZBw+MXbaoSGlxX+3URMzIYGnqdKZC4cuCSIudBgZ1AvU0BwoUKpcpHVEs8bemY1vdfB07mRAgXauMtchKbVaCMoMJpir5QAq4+GFMAB2zi1xMtwKMxVooFaV9myINuUGI7/e4/X6vkGuUXfXM4LuIffZO8Hd3FtLk4naRCgXQit5nbBvxkcX44vbq7c/js8SdrPegrGkvJpDCAFeb1yCaM6VkG6SGht3cDQtLEdNjNmKRMANxZ9ANvIgX8CxRm7xcSHcmLCeUtyKzfnWktg+5jYS+s3pAm/g5SZQv4QXFKY/EqNpptV1QOmR+hBFSBuBm6dtcOGUu2249kQWsKALDbCOEKQSbMlwsaGXsA1BJ2C21jn895aQEXxhXLyDLwD7bOVSH5PdDakFS2llK4ehelLMfAGx097s9ZsGp0+B2n3K7Vz7Y43PJnnYaXH6PiZ1ba88y4USGfS6zUWYqKzuU4Y8U9uYt48se986nZ5uAZ8K/1HkpT9l9mp8YyCfhPgJ4f6RtqlavbcojVDSw7nDmo0eS6QHbMHzCvcl1HTYNnPXlrimf7bIZ4v8RIskan8Er5E6eHbORix2BtdcKgk08YPIVpTCuWPe4680ZXhNSvIQEpFbk1ez1d60JHaGqgU1BVz4bE/xVXpo3bFNgrOjj9/o6Keu3BnapdJ3cO65AHGJ4DdVudst17kSlnIWd6fWnnGspFE5bq7XUj/grtjMPG7Ax2mlNUobz9AOjeWU1vWjoLwm1bmkLqJfz4Qbka47i7QFfmS9vySP7GXicpMupR/aIVWUwLwi0mmulk5MJ6U5Dh2OzuAvna2Z15nmUYaFahbomcb0lzY1VaVfgJpOcyFJ/BG4UWhMzB+aoVdH56bGqUYzB5cKGejxXHCf4r0LXG59svSOzL479Pn8/fWhpD4au/BElDO8LVGentB+SrKA0xPwvQvqudCXT9SD9ZNanRqvdFL/VlNkp1esQrbavjutVQUSMSOIHcOj7OsO/+hed32hW6I2VLIMvcqGDqPrP33cZHT9q9J3puQpHpXiRzouPhM3LBsGwxwXmP//l0FdUzlVTRufp+5Aw4IL2tJQZX3t93Fz80vILv0zttP+egGn0mqVVamvJE9UWlFT2+f+rpTLcyirSS5SXwtRFBTGatctcUHn6PzURHDUfUCDLugomdfUs/aLxSwk8hwWPBcZnAdlgDcpb6wRnHuJjguVQ4Uy9EpAZTCj8DXRaml83ZjIFy/g8uRHE27rs7AC8AudhBcIPKd1WzaEwNYO+rvotcDWrYFx7J0yaM5U5blakj9ShV/xGZoRwfgAP4XfIcv+ACdqKXPFM2IAf+ZDLNob8kSfD4R22PnA9sDnf56AxX62hPaEa9tRzHVZTaIMFxuPCwNxaNuZeFO69ffq9vpifHTy83jDYatBZ7K7eJKrSVxwY1GHhp0J/+OMaxt7FlGR9du6jc7GV11RspqhjZSedSPEeniD+q2uI1/Yxv2nRKusxB28Du04F/dCt0XN8T4qi40o//tTNfsEaNFB2ov2O7UtasP6UXHrXuvfYgkztWsHAe0PfMG7ogq+QNm1BINcp/No/STm2oopT21s5nSIxJueYf+vo/2dL/gjdktofam0ttuy+N10VevsthlubCJuXSz0n1K3dAL6E6uNeRtt71c6VKZo03n/z8Iehul/C3jPvLMEoDWcf3++ZYoemTBb0aIz3PHELa3/ZdDlvNxjzk7jvpndQVuXYgtoGGlKhpbxxrve99fROkh7I8VFNam7onQ1qWdYmC7i9mhMXzr+9qRoSdQjvndBveiOqJS6ICYSqlWVNUPh26NInwit2X/C0XWGSJHuWEfrqv2o5Okc4VV0wAZblTD5HnePnY7DXBP/dHo8PrscD19FB9HcFrmrUlAX5u30EvVCuKuR2CrTuiFuUk6qnFEbn8fmpAyX35bK2ILLFq7dfup2Ad16Leb5TdX9b6qGQoS69XTVIlxB6Tb5IXRIrpmrDej103WPhA3YSLjXJ+i+hmgeHujVml90vlrR8PsKNV2132zaIP5VV2Hc2zlsNOW5wT/Yr95FKJf7jzbaH4MfBrmsW+1FNgjNRJGx1c1qwObIM2pMrDuUVKmU7Y7kzotUnUbSyfin8dWYDVw7ovWu7brGazof1w/7ET08eApXGq1Wa4ChRL9ZrVb/A05HhbU= +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Calling this endpoint irrecoverably and permanently deletes the +[identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) given its ID. This action can not be undone. This +endpoint returns 204 when the identity was deleted or 404 if the identity was not found. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-json-web-key-set.ParamsDetails.json b/docs/reference/openapi/delete-json-web-key-set.ParamsDetails.json new file mode 100644 index 0000000000..2143c6416a --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key-set.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The JSON Web Key Set", + "in": "path", + "name": "set", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-json-web-key-set.RequestSchema.json b/docs/reference/openapi/delete-json-web-key-set.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key-set.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-json-web-key-set.StatusCodes.json b/docs/reference/openapi/delete-json-web-key-set.StatusCodes.json new file mode 100644 index 0000000000..6a8fc44752 --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key-set.StatusCodes.json @@ -0,0 +1,41 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/delete-json-web-key-set.api.mdx b/docs/reference/openapi/delete-json-web-key-set.api.mdx new file mode 100644 index 0000000000..a14c5d06a6 --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key-set.api.mdx @@ -0,0 +1,42 @@ +--- +id: delete-json-web-key-set +title: "Delete JSON Web Key Set" +description: "Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set." +sidebar_label: "Delete JSON Web Key Set" +hide_title: true +hide_table_of_contents: true +api: eJztWv9v27YS/1fuMRhqA7LUFcP7wUUfliXemqZLgiRFMcRBSktni7VEaiRlR8/1//5wpGRLjr21W7df3vJDa1PHuw+P911esQRNrEVhhZJsyN4ZBJsKAyiTQglpwSpIMEOLwCFWeeE+vrm5vID3OIFzrOAGLXCZAM8ysCnCHCsDQoJNuQWDNhzLsTzu7um9eX/eB2GAwxu+4DcOAlxOPmJs4UJZTnigR3v6kHDLwVhdxrbU6PlqLDQalJZYxLoqrJppXqQiJvkhHMOb9+cOmhdCwn+Xj0ELako7jePQRiwMiASlFVOBCUwqENa4DXT0OREkIVxe/wKvq0RzKA0ar8lpKWM6Dc+ErUidxiqNTzEb2pPAVGm4fXvj2G4A3Ko5SgM9U8YpcAOXBcqzUzhRUpLCzk7BOop+0NyEWhonSMgZ8dWDBKdCYuIlcQNLzLKQBUwVqJ22zxI2ZP6q3xgl3+PkHKsbtCxgBdc8R4vasOHdasdkbtOn9sACJuhZwW3KAiZ5jmzIjHug8ddSaEzY0OoSA2biFHPOhitmq8KRWULN1ut7IjaFkgYNPX/x/Dv6ryt+lBe2gg0dcI1A9wnLFGXg1ImPnOw2ICpV6rim8mdNQqATvL69vQJjuS0NxCpBv3GHtzBjaatCxDzLKnjx/NuQrQOW4JSXmSVosZIWpfvIiyITsdNs9NEQ1FXrqDtn0Fpp0rOm27DCHxfd6kHiHW0Fnv4hwUk5O7ALTukhnMmp0rmDRq55KbMK+IKLjE8yJM9NcAG5SjD8LTEt7oeEbdcO8kmFV9c+Bq+FtATwNWaFcaGFLLlxw8qtOC4Q89I4tPVV12apMRGaHOTd9VtyYKms9w1M9h7N3/8D3f9TTM5CbryFnBBFS9p3z78NmFcqGzIh7b+/2/IX0uIMNVuvN0vKBToiEdahdce4PC5t+oKt186o2rK7jwNmMC61sJVzR6Wr4zhGY1yUYMO7e/Icy2fkrezjcs7uA/Y4ULoaaG4xE7mwg0kZz5HAphSuBjzJhRxkasmIlBRw447mHT7jckYqrQr0kZoFLOMTzNiQfa90FcWZILMPmPcvOnReKG1hNZYAAG+W8+NCBP7LiZJTMSt1bYBrmGqVw7MWo2cv6dpjJY2FuE0Nr0Dissuh13/Z0PJCnEljuYyxpvSCex0mfcc9Q5echuCv/yVE0b5IBr3avSlyl7KOov0tvlUdNQKfXtbwCviSiw6YcE9Y7XllGLRj2X/J1sFGzT+plnolt2KBbc0WPJ7zGULOhXPfWtO9sRzbsY9Aj3bM/NdpvvmojP+kCpS8EF7TMGYzYdNyEsYqj7Y3MJgponbnpATmpPX6dJ9jS1lv+ArGFNAfah8YM4iiWpfwCfapkniNbfc+h6+ggye8wOXO7dImXogTj3ffhuOrM/90555ppw4oRNC2DY+QjOLqLDzdcym1+sIfeDyfaVXKpNcP6JL64egR49KiBySmju2/XoEUmdfK2E5zG/5YaCHttKdMeGMT1DqAcR3OKCEBpQ5S0YfDID58GMI3i/FYjpkD3/8d7j+WWebzV5OpWvv97vVYrtsmdlXZ1EXlxswoOBx0YqWrB/9wLJ2vbhdCjcZCTXdciNFjjIX3a0dZOMANgf9GdnAEp+RJpAmK4qkyrlBTha+UXBVTO54hz0utLcwwioqMV/5ewkIrCqImVLrihTBkwcT4BrEbNMKictmcQyaMK/CoUjVlQZgw2Ykw21ondC7eCT6tg3et1DuzOwY5xufCbVzsyDlM7ZJ52Qp76PTDS5tS0vP1hK/xSpsqLf67i5qYCQk8jpVOXCRcCps6LsdXZ2BQL1BDk0CgUJmIq5B2jbwnG1/6cKo0S5tCjjZViauYCq0WIqHyFzO1DCgd+yTsd7qKmjgZboWZCjRQqVJ7NkQbc4OhP+/J5nw/INeou+cZQjepffFNcLf3wVXFRG1ClAuhlbwbsx9Gx9ej64fby/PRxZjdb65gJC3hgDoGeL1xCaJJKWq6UWPjDo6mheW4CTI7oYgqbl6ImmzoQR7BiUZOndUhIdyY+jyFeBDb1NaSWGe4LfP+JrHAK3jWCtHP4IgC9G9EZ9pndVXD8xB9gNpD3pC0odWJ7oEK3oclTh7mWD0YtD2KoH4LuggBm0BBmsGWRBciemO2JejETX/cwX8OCBrCN8ZFPvgGsM/WrvIxyXyQqNgV1a0ahgpyMZOcmsH9rU+v3zQ/vg7q9DHd6nG3YjvQFXWbH9/h2FLLW89soUQCvW7bAROVVH0qT2dqF/PeFGYfW8nqbz7AQeyFzzh7df7UXD4P9t+gdOpTHi1KI5T0WOZYseGhcjpgC56VuKespuTbbN3Y44b8H7v8xy6/zC6J2mfmDVyHzaZsyCJndxGNeqKVQbumos4lfo+71FTzNUXKqi5NHkxWztZ7C5XImaoWNCBwYbS9xbfK9QyEbUueJ2r4hYqBS13BBdql0nO48lyAuITwiyoh5hKmQiYgrB8hIty1d5woaVSG970GfOwXCGxo0qgBH8Wl1ihtNEM7MJZTodcPa701xc8NjWP8eSbciHgzoiHt+5XNtZI8speJq1a6lH7pCanirl8frtiUxnFuKNQuck7qMUNn8V3nalwUCRPMVXNAzzSif+lSY1X4A6jpNBOSxB+DW4XGunz+pG9oLKVQjVONJq1HhtDjmeC+6PtQc3nw5dMHMvfu0pfz9yNGKchOrz0R1TtPJ5h+ekEzEvrwmXqwflNrsuKVTurfGYs8mVuqun5tT7srVYJETAhix/CoHptjtTW85XLpsJB3UDAnS6SKxUQFakNNzMCrbOAw9kMWfIbJ6Oq90nNT8BiPC3FOCeMLccOyYTDIcIHZ33+MNQ1/p6qZh/LYpTTMuaArrfuu7/09bofDhOzGP2NP5l9HcCatVkkZ+97yVMVljrJ+TeCauyyDopxkIvbdEQVAYax24xMXdI6vzmiq331Aiy7oKBqCTrBuHDCpS3sOC56JBK5qZYA3KW+sIVx5iY4LNUi5Mjar/CBfSJhotTS+kxzLoyO4OT03Y3lLN5fUJwB/0Amapuw33VksrbZu0E+rNwK3pNw49k4ZtGeqaNBJ/kg9f8lnaIYE4xO8rb/XBfcnOFVLmSmeEAP4I3/Eon0hX+nvE6EddP5gd+HL/74Ci/1sCe0p17ajmLuinIQJLrYeVy9E9RzPRNtmrr9Xt3fXo+PTn0dbDjsTO5PMo0mmJlHOjUVdT/BM/X+UcG0jzyLMk35bt+HF6LYrSpYztKHSs26E2CxvUV/qKvStbtT/mmiVlfgEr0M7ysSj0G1RKT6GRb4V5b9/rma/Alp0kPai/UntitqyPihuM3z9Syxhpp7aQY2WXsJ2ReV8gbJrCQa5jtNw8yTi2oopj21kUkoi0XaK2P/zaD/yBT9gt61Xxo3dFvlH01Wts9tmubGJqPWWof81dUsZ0GesNuZdtL33lFSmaOO0/0dhD+rtfwl4z7xzBKAzXL2+2jFFj0yYnWjRWe544o7W/zToIi32mLPTuB9vd9BWhdgBWq80LUPLeKOn3vfn0TpIeyPFdTmpuqJ0OalmmJsu4vZqRB86/vZV0ZKoA753TdPpjqiYxiAmFKrVlTVL9aeDSL8SWrM/w9ELDhGjNK7PagrNgscpwovwOQt2OmHyPe4eOx3Xe0309uxkdHEzGrwIn4epzTPXpaDOzeX0BvVCuJclkVWm9Ua3KTmpc0ZtfB2bkTJcfVsoY3MuW7gODFp3u+jWjwz++bXO/92vdepGi95P0Msl4RpmZ8Srevhzx1zvwwIaN5L1DWk8dR8wejlFj1erCTf4TmfrNS3/WqKm3xHcbyc8/kc+wtDnhA2nPDP4G1bYu64nAf29LxYOoa4XuaxaY1MPu56pre/XAUuRJzRw2YxeqQMr2qPWJ7+06czGTkdvR7cjFrgxS+tXRpvetZno3K32Q1qtPIW71fV6g7AePdyv1+v/AbCbSo0= +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. + +A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a +JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this +functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing +user-defined keys as well. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-json-web-key.ParamsDetails.json b/docs/reference/openapi/delete-json-web-key.ParamsDetails.json new file mode 100644 index 0000000000..ee560f9826 --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "The JSON Web Key Set", + "in": "path", + "name": "set", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "The JSON Web Key ID (kid)", + "in": "path", + "name": "kid", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-json-web-key.RequestSchema.json b/docs/reference/openapi/delete-json-web-key.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-json-web-key.StatusCodes.json b/docs/reference/openapi/delete-json-web-key.StatusCodes.json new file mode 100644 index 0000000000..6a8fc44752 --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key.StatusCodes.json @@ -0,0 +1,41 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/delete-json-web-key.api.mdx b/docs/reference/openapi/delete-json-web-key.api.mdx new file mode 100644 index 0000000000..9a674b3ae7 --- /dev/null +++ b/docs/reference/openapi/delete-json-web-key.api.mdx @@ -0,0 +1,42 @@ +--- +id: delete-json-web-key +title: "Delete JSON Web Key" +description: "Use this endpoint to delete a single JSON Web Key." +sidebar_label: "Delete JSON Web Key" +hide_title: true +hide_table_of_contents: true +api: eJztGl1v27b2r5zLYKgNyFJXDPfBRS+WJd6atrcJkhTFEAcpLR1brCVSIyk7uq7/+8UhJVty7K7dsj0M9UNiU+T5/qZWLEETa1FYoSQbsncGwabCAMqkUEJasAoSzNAicDBCzjKEV1fnb+E9TuA1VuFYjuVxZwl6r96/7oMwwOEVX/ArBx/OJx8xtvBWWU7IoEdn+pBwy8FYXca21IScW9BYaDQoLYGIdVVYNdO8SEUMc6xCOB7LV+9fwxXaGgth/11ABi2oKbx6/9qEsEOyMCASlFZMBSYwqUBY4w5wmRBOEEkI55e/wssq0RxKg2YsnaCmpYyJH54JW5G0jFUaH1Jt6FACU6Xh+s2Vg7uh4FrNURromTJOgRs4L1CencKJkpJEdnYK1u3oB2NJB3mWqaVxmIScEWA9SHAqJCYeFTewxCwLWcBUgdoJ/CxhQ+ZV+coo+R4nr7FiASu45jla1IYNb1Y79nCddtVNMmcBE/Ss4DZlAZM8RzZkxj3Q+FspNCZsaHWJATNxijlnwxWzVeG2WSKZrdfB76I6O4XeXCT9/fjmIvkqfLe02RRKGjT0/NnTH+hfl4ZRXtgKNvuAawQyH1imKAOnPLzneZFhQLtUqeN6lxdsEgKx8fL6+gKM5bY0EKsE/cEd2IIsqCpEzLOsgmdPvw/ZOmAJTnmZWSItVtKidF95UWQidmqMPhoiddVidYcHrZUmvWpSvRWeXXSrBzfvSCvw++8SnJSzA6fglB7CmZwqnTvSKBScy6wCvuAi45MMQUhIcAG5SjD8HJoW9EPItmsH4aTCi2sfgJdCWiLwJWaFAZuic5vG6yu34qBAzEvjqK1VXdumxkRocsd3l28oXkhlvSNispc1r/870v9DmpyFXHkLOaEdLWw/PP0+YF6obMiEtP/+YQtfSIsz1ORAzZJygZW2COuodWycH5c2fcbWa2dUbdzdxwEzGJda2Mq5v9LVcRyjMS4mseHNLXmO5TOKDuzjcs5uA3Y/ULoaaG4xE7mwg0kZz5GITSk6DniSCznI1JLRVhLAlWPNB5iMyxmJtCrQZwYWsIxPMGND9qPSVRRngsw+YN6/iOm8UNrCaiwBAF4t58eFCPyPEyWnYlbq2gDXMNUqhyctQE+ek9pjJY2FuL0bXoDEZRdCr/+82csLcSaN5TLGeqdH3OsA6TvoGVrKFkPw6n8OUbQvckKvdm/KE6WsQ3bfn5+L5LPnm3B4EEhD+KoOPYFPiWt4AXzJRYejcDcR9Lw4DdpasHORjGX/OaNAXavsF9VSleRWLLCtpYLHcz5DyLlwoaDWWm8sx3bso9m9HTP/c5pvvirjv6kCJS+E1xqM2UzYtJyEscqjrTYHM0W7HbuUeh22Xp9sY2wpYQ9fwJiS0V3tT2MGUVTLFT7BPrXQ0blI/NG5SL70aKMRomVsu7Y1fAEdfsK3uNyxNDrEC3Hi+d134PjizD/dsTk6qQMKV3RsAyMkA704C093dVvLPvyJx/OZVqVMev3A6ZrU3A9H9xiXFj1JYuoA/+sFSJF5uY7tNLfhz4UW0k57yoRXNkGtAxjXwZXSI1AiI0l9OEDGhw9D+G4xHssxc7T3fwf0z2WW+VTaJM3WeX96PZbrtoVeVDZ1CaKxUopTB+OJ0tWdfziWLmxsF0KNxkK977gQo/sYCx9i3M7CEdxs8L/IDI7glPyRxEAJJVXGlaiq8CWiK/tq9zXkv6m1hRlGUZHxymsmLLSieG5CpSteCEMOQICvELvxKywqV1hwyIRxpS3PMjBlQTRhshPstmVe6AJFJw62GO8aqY8Fjg1yji8lt/HQI+c0tUfnZSsCo5MPL21K+deXNk46tKS0+N8u1QRMSOBxrHTigvJS2NRBOb44A4N6gRqaXAaFykRM3ckRjLw3G1+FcSqxS5tCjjZViSveCq0WIqHCHzO1DKgy8PWAP+l6CYJkuBVmKtBApUrtwdDemBsMPb8nG/5+Qq5Rd/kZQje/frUmuDt759oB2m1ClAuhlbwZs59Gx5ejy7vr89ejt2N2u1HBSFqiA+oo4OXGJYgmu6npRoyNO7g9LVqOmxizE4mo0+CFqLcNPZFHcKKRU8d4CAk3puanEHdim2VbGOtkuwXe32QoeAFPWhH+CRxRkD4Y3OtsRqdawf0zp9pxnQ5bXdWcee58YOuc2T5uc1Rn2Tsq2e+WOLmbY9XbhF1/Bl1kgU2AIYliC50LLb0x227oBFsvpsF/9mAawnfGRUv4DrDP1q5wM8l8kKjY9QStEoz6CTGTnFrnPW1ir980ir6G6/R83cp3t9o80EF2GzcK4Z2+7ithtlrFHcCu7bOlltce4kKJBHrdXgwmKqn6VLPP1K4kHuZSe99KmP8UsRyUSOEz6l776Nr1l8ni0QXxdxkHNZn3FqURSnoO51ix4aFeKGALnpW4pyciXpqjG2/cbP/mld+88ptXfrlX0m5fyW0E4Di2KRuyyHldRCPRaGXQrqPVXCRragVcuehlUmrqFJrSdlUXtHcmK2frveVt5NxVC5pwuUTaPuJnPfUQj20L5QcS+ZVKyHNdwVu0S6XncOGhAEEJ4VdVQswlTIVMQFiqfal+ummfOFHSqAxvew3xsV8gYkOTRg3xUVxqjdJGM7QDYzm1B/2wll5TMl/RPNHzM+FGxJsZI+nAr2w0TPjIDieuxu3u9EsPtiruBk7DFZvS8NpNNdul8Uk9J+ssvuuoxkXSMMFcNQx6oBH9JaXGqvAMqOk0E5LQH4NbhcbGfPVEv9BYKqA0TjWatJ6wQ49ngvtW4UMN5c4X3R/IVLtLXw/fD+SlIGu99JuoSn448PfjNxry0ZcvlIP1h1qjQS90Ev/OXO/B9F3VXU/77qdSJUjEhEjsGB5V8XOstoa3XC4dLeQdlNDIEqleNVGB2lDrO/AiGzga+yELvsBkdPVe6bkpeIzHhaDriq+lG5YNgEGGC8z+fjbWdHsxVc1An8curWPOBam07tZ/9Hrc3m4QZVf+GXswwD2CM2m1SsrYTyROVVzmKOt7NTcSyDIoykkmYt9TUxgUxmo3s3NB5/jijG7Bug9o0QUdRVP8CdbtJiZ1Q8hhwTORwEUtDPAm5Y01hAuP0UGhtjpXxmaVv/cSEiZaLY2fP4zl0RFcnb42Y3lNmktqDsAzOkHTNIume5lAqy0N+uuWDcLtVm4ceCcMOjNVNKknf6RJUclnaIZExid4U/+u261PcKqWMlM8IQDwRz4Eoq2QR/p8ImoHnQ/sLnz95xFA7AdL1J5ybTuCuSnKSZjgYutx9UJUD49NtB0B9PfK9uZydHz639EWws6Y2CTzaJKpSZRzY1HXY2NT/48Srm3kQYR50m/LNnw7uu6ikuUMbaj0rBshNstbqs91FfoBSdR/TGqVlfiAXkftKBP3QrdRpXgfFvkWlf/9pZJ9BGrRkbSX2l/ULqot6IPoNhP/v8QSZuqhHdTU0lsLXVQ5X6DsWoJBruM03DyJuLZiymMbmZSSSLSdPff/PLUf+YIfsNvWOxaN3Rb5R9MVrbPbZrmxiah1TdZ/TNlSBvQZq03zLrW995RUpmjjtP9HyR7Ux/8S4j3wDgtAPFy8vNgxRU+ZMDvRorPc8cQdqf9poou02GPOTuL+UqRDbVWIHULrlaZlaBlv9ND7/jy1jqS9keKynFRdVLqcVDPMTZfi9mpEXzr+9qjUEqoDvndJdxodVDGNgkwoVKsra5bqbwcpfSRqzf4MR9diIkZpXJ/VFJoFj1OEZ+FTFux0wuR73D12Mq7PmujN2cno7dVo8Cx8GqY2z1yXgjo359Mr1Avhrtgiq0zrlYSm5KTOGbXxdWxGwnD1baGMzbls0bVnxr7bQbfekPn23to/7r21uomiGyu6bhSuGXYGuqrHOzfM9TUsoHEqWdbQj7WGNIy6DRjdWtKu1WrCDb7T2XpNy7+VqOldl9vtEMe/+CYMfU/YcMozg58xtt5l3ez39944HSK+XuSyak2HPfX1SM69FPcoZLSma3+AFhLg+nYdsBR5QvOdzbSbGr6iPd1+8GZaZyB3Onozuh6xwE11Wm/lbVrlZoB0s9pP0mrldzhLW683FNaTjtv1ev1/xAJlBg== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to delete a single JSON Web Key. + +A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a +JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this +functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing +user-defined keys as well. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-o-auth-2-client.ParamsDetails.json b/docs/reference/openapi/delete-o-auth-2-client.ParamsDetails.json new file mode 100644 index 0000000000..d1972bb4af --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-client.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The id of the OAuth 2.0 Client.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-o-auth-2-client.RequestSchema.json b/docs/reference/openapi/delete-o-auth-2-client.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-client.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-o-auth-2-client.StatusCodes.json b/docs/reference/openapi/delete-o-auth-2-client.StatusCodes.json new file mode 100644 index 0000000000..c77d7a2a06 --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-client.StatusCodes.json @@ -0,0 +1,96 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.", + "properties": { + "code": { + "description": "The status code", + "example": 404, + "format": "int64", + "type": "integer" + }, + "debug": { + "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.", + "example": "SQL field \"foo\" is not a bool.", + "type": "string" + }, + "details": { "description": "Further error details" }, + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + }, + "id": { + "description": "The error ID\n\nUseful when trying to identify various errors in application logic.", + "type": "string" + }, + "message": { + "description": "Error message\n\nThe error's message.", + "example": "The resource could not be found", + "type": "string" + }, + "reason": { + "description": "A human-readable reason for the error", + "example": "User with ID 1234 does not exist.", + "type": "string" + }, + "request": { + "description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.", + "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", + "type": "string" + }, + "status": { + "description": "The status description", + "example": "Not Found", + "type": "string" + } + }, + "required": ["message"], + "title": "Error response", + "type": "object" + } + } + }, + "description": "genericError" + } + } +} diff --git a/docs/reference/openapi/delete-o-auth-2-client.api.mdx b/docs/reference/openapi/delete-o-auth-2-client.api.mdx new file mode 100644 index 0000000000..0d528f43ae --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-client.api.mdx @@ -0,0 +1,42 @@ +--- +id: delete-o-auth-2-client +title: "Delete OAuth 2.0 Client" +description: "Delete an existing OAuth 2.0 Client by its ID." +sidebar_label: "Delete OAuth 2.0 Client" +hide_title: true +hide_table_of_contents: true +api: eJztWm1z2zYS/it7yHQizVBU4jq9G3VyU9dWWl/bxI2d6XQsjwORSxExCbAAaJnn6r/fLABKpCQ3SZv2vlQfbAkEFs++YnfBe5aiSbSorFCSTdgJFmgRuAS8E8YKuYBXR7XN4SB+AseFQGlh3oCwBk5P4pmcyc3jxD02wDVCbTAFq6BCnSlddohwmcKrCuXpCRwrKTGxkBVqaWJ4Y2peFE0Ee0nO5AIlam4xhUxp4FVViIQTbgPLXCQ5LLm0tGmipKlLhEbVukNM6e2NE17xuSiEFWgcMz/wGwRTawSbcws2FwZQppUS0oIwsMSigEoriwnhIF6ULBpIeFHweYEkm0xoY0cV17aBRJWVksRCzCKmKsIvlDxN2YSlTtQO3oGXLItYxTUv0aI2bHJ5v6WcixxBpKAysDnu6IV2EDSt4jZnEZO8RDZhImUR0/hLLTSmbGJ1jREzSY4lZ5N7ZpuKZhmrhVyw1eqKJptKSYOGnh88OaR/fSDTsrINrOc5jRsyjWWOMnLqwTteVgVGNEvVOgmzPNNpDMTLtxcXZ2Ast7WBRKXoF27RFmYmbVMJEnEDB0+exmwVsRQzXheWoCVKWhLe5J51bGL8zhDU+w6rWzxorfRDPDgHcBMGGC9iqCWvba60+C+mEcx5CiRRNDaCOI6HoJKk1hpT0kGlSc9kUh5dirubE/cdxlnEgrzY5PDJYcTIZ7gl7Un7xSGLWjUJaXGB2ktgXi92KZ/QMAjpKQglyawvyI4zgUVKRqwyixKksoB3lWod1Rs18AUX0lgokN8IuZhJg9IIK26xSzTuImbnP34fqM9YptSM0S5En8NcqSLe4G/NjOBbLgqzy8CLWtscdRB/O20VMTfwPj3uyP83xUSmQ+xCui01MlBBxge1j0qen1suvJ+T5+fckOTmCChpMO1LhXSccsvn3CDwlFcWNSy5IWMiElZBJmTqfBkLLH0A2BHUA2y/5CUSPLfaiYD8fRdBsFNM144IiaqL1PEzJ5erZfrgvte9TXeFuP61EWUW9NcRJijpcEpuKbSG+OU26AN+NX9HNrgUNofTE3h68PnhM0gVmmCtwuwVkUh3sZ2ekHQ41FL8UrcickdWhg7GtVT2eqPQqdYv/IOXyh61wzP5S60sv8a7BDHFlKb9SCPTMEDwZV2yySXbS5dFrE+BXW0zELG70UKNiMyIeGCT/aR+N8RVxEo0hi/2BKIf/ION+jb2FNbs9V4fu673B7djCuUaK43GHd4bkt1YP6BAB4dPPqc/T30cjT8+EK7WQ8oZD00R1lmTyxdE4gLEcTgkHrCWi3xjIhQw3xjM6sIfBVY3lAZZBSJFaUXWwC3XQtXGLzEgZDcbgUItRLJXbA+qYdqVuI/YAdBj01XEtm9/lEdr5GafGx9BXpdcjjTy1Bman+hO47Xuepu/MRTKOl665aR7mQ+RaL/ww8Mg/v7I5sxqzyvSvpYuLAsJSqeoST9W8wRnMmiFJ1oZAwb1rUgQuE5yQUdcrdFswrsnzOHNm9OTvoTTf2L27HD+dITJ02ejwy/wi9E8SeajZweH838dJE8+f4ZfPOwbv3nmdx90t3ypLLzYr75VN4m7XFvS1cbcdw7Cvl+sVu7U7SLqOojbwWBSa2Ebl3sq3RwlCRpzoW5QssnlFSWHli8oNWXK5a20/91I6WZEiXkhSmFH8zq5QXLZvEk1H/G0FHJUqKULdOT6545dn+AWXC5INk2F5w4Zi1jB51iwCftK6WactJmxN3Vy/bJS2sL9TAKAz4IPjioR+d/HSmZiUeuQ+6wg06qExx1aj78kE6MawVLY28yG5yBx2acwGH7ZzuWVOJXGcplgmLnee9CjM3QbFGhBpBPwCvwSxuP3pO8wCEktmXItU8yExHS4AXsfzCdyaQWs4DnwJRc9ZPFuVTHwghHpTA6/ZKtoLfRvVEfYklOO15VzxZMbOhpKLlwSGeQ+mMmZnfms+87OmP+ZleuvyvhvqkLJK+GFDjO2EDav53GiyvFGGaOFotmOy6yWidttMCTtzqxIYfIcZkyk18FHZgzG4yBS+BXeI1EiOrN9HU+eQw9Y/BKXWxqnRbwSodrdt+Do7DTItq94WqkjCpi0bE0jDoZydhqf7KonSDL+mic3C03ePxhGINJhPL3DpLboEYnM0f3Hc5Ci8PKZ2ay08YtKC2mzgTLxuU1R6whmIRi484sKJxLX299C8fbtBD67nc3kjDn8w/fQf1EXha/f2oDTWe9Xr2Zy1TW3s8bmLt61Jkdh40H3Vrq59g9n0rnwZiDWdC6EeUeVoESn8u7uZlYOcDvB/yJTeAQn5FPuMM8RcmVcTa/cWl64nD64oEvsc2srMxmPq4I3XjFxpRUFUxMr3fBKGLJmInyO2I8lcdX4LgUUwliyUF4UYOqKMGG6FXg2VX/snL0XkzqM9w3V+7Vjg7zkQ+G27vbIuU9wz7LuREN08qGKl/KdkNWQdNoieBs1EaMkKEmUTl2AdMkBUTk6O3VHMGpoTxeoVCGSJqZVU+/Xxpf+PMndHlCizVXqavJKq1tBee0cC7WMqLPksxK/0jVqiJLhVphMoPFtH0eG5ibcYOz5PV7z9zVyjbrPzwT6J95Ha4K7tdeWFtNsE6O8FVrJyxn7enr0evr6+uLVd9OXM3a1VsGUMhngEIKAlxuXINqTJsQ2EmPrDm5OB8tRG2e2ohFwQzEoTJt4kI/gWCP3Lb79m3BjAj+VuBabE6+z4+bg29AftscMPIfHm4j9GB5RvP6wYE0ErG4CVA83dCS352+mdGGG4+9aXZNqDwK0gUgDOnShAtYRg0SEne1crBjM2GZCL4Su+R79e+9GE/jMuBgInwEO2cplRya9GaUqcRlhJ8+h1pRY+JJ4bzdwMGz7gT5V6vbztivIj+0T9vuBvulnay0vPN1bJVIY9DtxMFdpM6QEd6G2we871exd5wD7v3HyIBOVP432amHbfD4I/l+rBWrQ3FlqzSnpUd1gwyYPJeMRu+VFjXuScjqg26VrS11P/9ti/7bYT2WxNNuf62vYDqXN2YSNnUWGosCM70W6oqTQJQ6eh1pTztgmOfchtbk2Rb1Y7U10xs6MtaCWhgu+3SW+PA93CGyTMu3I5Gd3h6QbeIl2qfQNnHkqQFRi+FnVkHDpO7nCUhZEsrvsrjhW0qgCrwYt+MQPENjY5OMW/NjdIUg7XqAdGcspURzGQXJt8nRO1xmenzk3IllfcZD8/chax7QfWc7cZTv9mX5oZ6pyZkRT3aWcu1TpJknHoePXG3zTU42LMHGKpWoZ9ETH9JeUmqjKM6CyrBASXQvKjUJrX/7YDS0gOnk1ZhpNDi65MjDgheA+aXwbqFz79OstmX5/6OPp+7s6SZ1C9jr0objcvj08PQHfGqEeJH35QDlYv6jTufRCJ/Fv9Vx2ekgq5L/de8lG1SDRXUf2DY/yuRtsNoa3XC4dFvIOCvRkiZTomHGF2lARNPIiGzmMrh/7fpPRzU9K35iKJ3hUie/oMPlI3LBsCYwKvMXir2eD+sIyU+19Ik/ccYclF6TSULd95fW4uVslZOf+Gdvprj2CU2m1SuvE16YnKqnpksdXE644pMvkel6IxFdXFAKFsdq1YlzQOTo7NTEc9R/QoAs67up5jqHwwDSUBhxueSFSOAvCAG9S3lhjOPM7OipUYJXK2KLxN/ZCwlyrpfGV6Ew+egTnJ9+ZcIOYBg5C/3KOpi0bTOdqLITAjgb9be96w84tmnHk153mTBWFWpI/Us+g5gs0E4LxK3wffoc8/Vc4UUtZKJ4SAfg9HyLRVcgn+vxKaEe9D2wPfPznE5DYT5bQnnBte4K5rOp5nOLtxuPCwDj0BM14UwwO98r28vX06OSH6YbCVvfPpDfjeaHm45Ibi3p98Pv/45RrO/Yk4jIddmUbv5xe9LeS9QJtrPSiHyHWwxvUr3QT+2RmPPyUaJWVuIPXoZ0W4k7o7lY53sVVudnK//5QyX4CtOgg7UX7jdreakP6we3Wjdw/xRIWatcOAtr/8Fve36rktyj7lmCQLn7i9ZMx11ZkPLFjk9MhMt50IYd/HO07fssfsFtC6wuptd1W5TvTF62z23a4tYlx5/Ji+CllSyegP7G6mLfRDn6iQyVDm+TD3wt7FJb/KeA98R4LQDycfXu2ZYoeGV1Q9mykN9zzxC2p/2HQVV7tMWcncd8e76FtKrEFNIy0JUPHeMe73vfH0TpIeyPF63re9LfS9bxZYGn6iLujY/rS87dPipa2esD3XlN3u7dVQi0SEwvVqcraofDtQaSfCK3Zf8LRBYlIkK5wJ+vK/ajiSY5UjLNoqxIm3+PusZNxWGvG358eT1+eT0cH8ZM4t2XhqhTUpXmVnfsrcSq7rTKdNybalJMqZ9TG57EFCcPlt5UytuSyg+uB5ux2Fd15Se/vN0z/zDdMQ01DVwl0DyRcbers5T50Wi6ZKzNYxALnLGIT4V5LopskmnB/T6+svdHFakXDv9So6Y2Aq007xb+bKox7641NMl4Y/A2VD16Hsnv4vkuAh1gIg1w2nVYmi0LnUqRsdbWKWI48pT7HuhtKhU/V7X7uvCDaa0qdTL+fXkxZ5LobnZdj1yVj20i5vN+P6P7ez3CV1mq1Bhgq/qvVavU/E11vsg== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Delete an existing OAuth 2.0 Client by its ID. + +OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for +applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. + +Make sure that this endpoint is well protected and only callable by first-party components. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-o-auth-2-token.ParamsDetails.json b/docs/reference/openapi/delete-o-auth-2-token.ParamsDetails.json new file mode 100644 index 0000000000..45f4b8fb01 --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-token.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "OAuth 2.0 Client ID", + "in": "query", + "name": "client_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-o-auth-2-token.RequestSchema.json b/docs/reference/openapi/delete-o-auth-2-token.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-token.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-o-auth-2-token.StatusCodes.json b/docs/reference/openapi/delete-o-auth-2-token.StatusCodes.json new file mode 100644 index 0000000000..6a8fc44752 --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-token.StatusCodes.json @@ -0,0 +1,41 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/delete-o-auth-2-token.api.mdx b/docs/reference/openapi/delete-o-auth-2-token.api.mdx new file mode 100644 index 0000000000..a112f64084 --- /dev/null +++ b/docs/reference/openapi/delete-o-auth-2-token.api.mdx @@ -0,0 +1,41 @@ +--- +id: delete-o-auth-2-token +title: "Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client" +description: "This endpoint deletes OAuth2 access tokens issued to an OAuth 2.0 Client from the database." +sidebar_label: "Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client" +hide_title: true +hide_table_of_contents: true +api: eJztWm1v2zgS/itzDIragC11i8V9cNHDZhPv1ru9NkhSLBZxkdLSyGIjkVqSsqNL/d8PQ0qy5Je9dpvep82H1qaGw2eG8y4/sBhNpEVhhZJswq5TYQBlXCghLcSYoUUDb09Lmz4HHkVoDFh1h9KAMKbEGKwCLj0FPA+ewVkmUFpItMrBpggxt3zBDQZsxFSBmtNJs5hNmOfueV8TTzZiBdc8R4vasMnNww64vUNm52zEBD36o0RdsRGTPEc2YZF7fitiNmIa/yiFxphNrC5xxEyUYs7Z5IHZqiBiY7WQS7bZvCdiUyhp0NDz58++p//6IKZ5YSto6YBrBENg1inKESRKA97zvMhwRFSq1FFN5eWNA7hOEV5dX1+AsdyWBiIVo9+4w1uYubRVISKeZRU8f/ZdwDYjFmPCy8wStEhJi9J95EWRichpN/xoCOpDR9QdGbRWmrSt6Uas8OKiWz1KvKOtkae/jXFRLo/sgnN6CDOZKJ07aHM5l29lVgFfcZHxRYYgJMS4glzFzkaOHtPhfuyw7dpRPqnw6jrE4JWQlgC+wqwwznhLgxpEjNKKpHIrjgtEvPQWXV+18xwEjbHQGFl4d/kahAGpLPAsU2uMD4rm7/+W7n8fk7OQK28hZ0TROe37Z9+NmFcqmzAh7T+/3/IX0uISNdts2iW1+IiRJRJhHVonhnc9ttk4o+qe3X88YgajUgtbOadUujp1kcA77eTmPXmO5UvyWab8rvcjdj9WuhprbjETubDjRRndIeFNq1jzMY9zIceZWjMiJR1cOem852dcLkmrVYFXDhgbsYwvMGMT9oPSVehdnI2YdzGSOy+UtvAwlwBQx6zTQoz89zMlE7EsdW2GGx+hnnZ4PX1Blx8paSxEXWp4CRLXfQ6D4YuGlhdiJo3lMsKasj170OMzdAdkaMEfOIsn4I3hBYThgegGg9rXKcqWMsZESIyHW5gPdQgZuTALG3gJfM1FD1OwF2cHXiMNiLkcvmCbUavzn1VH15JbscKumgse3fElQs6Fc+da7YO5nNu5j0j3ds781yRvPyrjP6kCJS+EPx3mbClsWi6CSOXh9i7GS0XUTtSklJE7bTCky53bBjhMXsKcNd9ua++YMwjDWq/waT8zzc6J6dz2r3jyEnrAgje43rlw2sQLUbM5tOH0Yuaf7tw77dQjih20reUR1HZyMQvO9+6oVmTwI4/ullqVMh4Mh8FZLeygkXoYTO8xKi16fCJxp/zjJUiReW3NbZLb4KdCC2mTgTLBlY1R6xHM67BHiQsoxZDCPvwJpg8fJvBkNZ/LOXPCDP8H+5/KLPOJrklpnf1+92YuN13bu6hs6sJ3Y38UQo66utLVrX84l86dtwuBRmOhpjstxPQ+wsK7vqMsHOCGwH8juziBc/IyUgWF+1QRFwPK7eUZcBlD7ZRUCUFqbWEmYVhkvPLXFBRaUbQ1gdIVL4Qh0ybGV4j9uBIUlUv7HDJhLKiEkgWYsiBMGO8EoW1pFDj378WnjuB9q/Wu7sQgZ/lcuI3vnbhipfbVvOxERnT64aVNKTv6wsNph5aUFv/ZRU3MhKQiUunYBcu1sKnjcnoxA4N6hRqaTAOFykRUBbRr6h3b+BqJR6k7A3K0qYpdaVVotRIxxrDATK1HlLd9tvY7wabcEifDrTCJQAOVKrVnQ7QRFahe3rNWvh+Ra9R9eSbQz35ffBO+hr51NTRRmwDlSmglb+bsx+np5fTy9vrtr9M3c/a+vYKptIQD6pDg9cYliCbrqKRVY+MOjqaD5bQJOjuhCbihgFSTTTzIEzjTyC0eP4QbU8tTiFuxzX6dE7dJcMt/2M08tyKGl/C0/dIE8KdwQuH7eOwmFlZXNVgP2Aerzg5/SXDtmxXn86bASCQi2uO7ZdQVp06ct+qWTOC5v7NBC7eWBV1ggTa+kEKxA81FlsGcbQl68bbV0vhfh46bwBPjAiY8ARyyjSurTHw3jlXkivZOgUQFv1hKbkuNh9qrwbBpsHyJ1euVZvFegbpbFB5uv/rtle+hbKnltee1UiKGQb+xgYWKqyEVwEu1i/pAIrT3nST3bUVIeGb2ZTgKv/DZ6qDid8zmz4D7PnWL/Ntrntqhe4vSCCU9oDus2ORYyT5iK56VeKB0p9TdbG3NsiX/2zz/Ns+/ZJ5E7dN7C9gBtCmbsNCZX6gc/tBPo6g4dAWEx19qqh2bYuehLnFuTVYuNwcLntAZrRY0kXBxtbvF9+b10IVtS6c9RfxORcVbXcEbtGul7+DCcwHiEsDvqoSIS0iEjEFYqoYoo950d5wpaVSG7wcN+MgvENjApGEDPoxKrVHacIl2bCyngnEY1Kpriqgrmv94eRbciKidCdEF+JX2Yuk8MpqFq3r6lH5pj9TfAJEmmVq7Y3rF0lk91+gtvutdjYsnQYy5agSsr5X+pUuNVOEFUEmSCUnHn4JbhcbAfEKlb2gs5VSNiUaTNoPKAc8E98Xjh5rLrS/DPpDZ95e+nL+fa0pBpnrpidxEtEA5O6f7lGQBs3NfipDe3L7P1IP1mzqjHK90Uv/OHGZ3gHSt6jq4O9KtVAkSMSaIPcOjuu4Oq63hrddrh4W8g8I6WSKVMCYsUBtqhsZeZWOHcRiw0WeYjK5+U/rOFDzC00L8SqnjC3HDumEwznCF2f9fjA0NnRPVDGB55JIb5lzQldb92w/+HrczaUJ25Z+xvYHbCcyk1SouI9+jnquozFFa31W4JjHLoCgXmYh8l0UxUBir3XzGBZ3Ti5kJ4LT/gBZd0FE0dV1g3YBgXLcIHFY8EzFc1Mro1c0BXPgTHRdqtHJlbFbR/cQUvhZarY3vSOfy5ASuzn81c+leIsS1BOAFXaBp2gfTH/7SaucG/Xi8PXBLyo1j75RBexJFk1XyR5odlHyJZkIwPsHr+ntdgX+Cc7WWmeIxMYC/8kcsuhfySH+fCO249we7C1/+9wgsDrMltOdc255ibopyEcS42npcvRDWg0ITbpvC4UHd3lxOT8//Pd1y2BkJmvguXGRqEebcWNT1iNDU/4cx1zb0LII8HnZ1G7yZXvePkuUSbaD0sh8h2uUt6re6qsdt4fAx0SorcQ+vQzvNxL3Q3aNSvA+KfHuU//65mn0EtOggHUT7s9o9asv66HHtdPebWMJS7dtBjfYXvuL9o3K+Qtm3BINcR2nQPgm5tiLhkQ1NSkkk3E4jh1+P9iNf8SN2S2h929TabZF/NH3VOrttlhubCDsvNIaPqVvKgD5jdTHvoh38RkklQRulw78Ke1xv/ybgPfOeCEAyXLy62DFFj0yYnWjRW+554o7Wvxp0kRYHzNlp3I/Je2irQuwArVealqFjvOG+9309WgfpYKS4LBdV/yhdLqol5qaPuLsa0oeevz0qWjrqiO9d0pS7d1REAxETCNXpypql+tNRpI+E1hzOcPSiREQojeuzmkKz4FGK1I+z0U4nTL7H3WOn43qvCV/PzqZvrqbj58GzILV55roU1Ll5m1yhXgn30iW0ynReITclJ3XOqI2vYzNShqtvC2VszmUH11eNaHd77c5vH77xj1bq0p8m7/TaRLgWzqn1oZ5I3DBXjbO2I65bPENvwenVC5E8PBDDdzrbbGjZ/2DF/cZFGKpvm/HOn8g5uKw70uGhyfgxqH481x3lNMM8N05uph7uPf6Ipchjav/bkSBdUtEdAe790KQ3rDmfvp5eT9nINf2dH9m0nVQzX7hpH3FZddg/PHgKZxWbDWsEqBvh95vN5r81lWRR +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint deletes OAuth2 access tokens issued to an OAuth 2.0 Client from the database. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-oidc-dynamic-client.ParamsDetails.json b/docs/reference/openapi/delete-oidc-dynamic-client.ParamsDetails.json new file mode 100644 index 0000000000..d1972bb4af --- /dev/null +++ b/docs/reference/openapi/delete-oidc-dynamic-client.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The id of the OAuth 2.0 Client.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-oidc-dynamic-client.RequestSchema.json b/docs/reference/openapi/delete-oidc-dynamic-client.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-oidc-dynamic-client.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-oidc-dynamic-client.StatusCodes.json b/docs/reference/openapi/delete-oidc-dynamic-client.StatusCodes.json new file mode 100644 index 0000000000..c77d7a2a06 --- /dev/null +++ b/docs/reference/openapi/delete-oidc-dynamic-client.StatusCodes.json @@ -0,0 +1,96 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.", + "properties": { + "code": { + "description": "The status code", + "example": 404, + "format": "int64", + "type": "integer" + }, + "debug": { + "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.", + "example": "SQL field \"foo\" is not a bool.", + "type": "string" + }, + "details": { "description": "Further error details" }, + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + }, + "id": { + "description": "The error ID\n\nUseful when trying to identify various errors in application logic.", + "type": "string" + }, + "message": { + "description": "Error message\n\nThe error's message.", + "example": "The resource could not be found", + "type": "string" + }, + "reason": { + "description": "A human-readable reason for the error", + "example": "User with ID 1234 does not exist.", + "type": "string" + }, + "request": { + "description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.", + "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", + "type": "string" + }, + "status": { + "description": "The status description", + "example": "Not Found", + "type": "string" + } + }, + "required": ["message"], + "title": "Error response", + "type": "object" + } + } + }, + "description": "genericError" + } + } +} diff --git a/docs/reference/openapi/delete-oidc-dynamic-client.api.mdx b/docs/reference/openapi/delete-oidc-dynamic-client.api.mdx new file mode 100644 index 0000000000..adaba4f9a8 --- /dev/null +++ b/docs/reference/openapi/delete-oidc-dynamic-client.api.mdx @@ -0,0 +1,50 @@ +--- +id: delete-oidc-dynamic-client +title: "Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol" +description: "This endpoint behaves like the administrative counterpart (`deleteOAuth2Client`) but is capable of facing the" +sidebar_label: "Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol" +hide_title: true +hide_table_of_contents: true +api: eJztWm1zG7cR/itbeDImZ45HW5HTDjPuVJHolo1jq5I8nY7OI4F3eySiO+AC4ESxCv97ZwEceceX2E6cth+sD5IIAotn3xcLPLIMTapFZYWSbMSu5sIAyqxSQlqY4pzfo4FC3CHYOQLPSiGFsZpbcY+Qqlpa1BXXFnq3GRZo8e1JbedHp4VAaW/7MK0tCAMpr/i0QFA55DwVckbkElnV00KkIIiKRAuZ0JjaYglcZpByCVOE2mAGQoLBIh8Y1PcixRgmFkRZFViitMZhe1uhnJzBqZISU5vIs6XkpUjBQ4ELnAXgSsK5VlalqojBMZwjt7VGkIiZAatoW5QE2O1M1FMlczGr/fqwrJFTIoWBTBi/YLqEDHNeF9ahDFw05KbEW1uOSseJTOSVIkbBtulGsFQ1LERROGQErNJoiBsHyTH21ACv7RylFalnLtWY0UdemBgmuReO00qQRSJrg15oV+oOJYwbhZ90Kf2Adq4yuPU73RhMNdqbShl767EdhgV+ciO+dxev4aca9TJO5CQHYcFB2KI85Uakt1GHXFDf5MzZRGvksrMBIVda/NsDnyPP0AvWcQ5H8bMAzADXwagIOOpc6RI2s2iXrilBXqiFieGdqXlRLCPYSzKRM5SoucUMcqWBV1UR5GhgMRfpHBaceFJkS6YukSSoW8SU3t7YeY0ohBVoYhYxVaE3wEnGRiz4m8jSYOpeMCxiFde8RIvasNH1446LI4iMPHFtGG57v5q2ETSt4nbOIiZ5iWzERMYipvGnWmjM2MjqGiNm0jmWnI0emV1WNMtYLeSMrVbvabKplDRo6PujZ8f0pwtkXFZ2Cet5Ti9O7Ys5ysgJER84OXlEs1St0zDLc56RGyL87erqHIzltjaQqgz9wi3awiTSLiuRkgbh6NnzmK0iFvyUoKVKWhLe6JG1NDf80RDUxxarWzxorfQhHsjT0U3oYTyLoZY8WClmEUx5BiRRNDaCOI77oNK01hoz0kGlSdmkeI8uw93NifsW4yxiQV5sdPzsOGJk2dyS9qT95phFjZoo3M5QewlM69ku5TMaBiE9BaGkC1EuVAosMoroKrcoQSoL+FCpxp20smS4fMaFNBYK5HdCzhJpUBrhckaLaNxGzC7/8TpQT1iuVMJoF6LPYapUEW/wN2ZG8C0Xhdll4FWt7Rx1EH8zbRUxN/AhPe7I/xfFRKZD7EK2LbWQJ4SB2scOz889F4XLhhRr5nwr43SlQjrOuOVTbij98sqihgU3ZExEwirIRQiM6NPhPkEdYPsNL5HgudVOBOTvuwiCnWK2dkTK/UXm+JmSy9UyO7jvTWfTXSGuP21EmQf9tYQJykd66XN1iF9ugy7gt9MfyQYXws4pbTw/+vr4BWQKTbBWYfaKSGS72CZnJB0OtRQ/1Y2IJmdxIkPJcCOVvdkodKz1K//FG2VPmuFE/lQry2/wIUXMMKNp/6CRcRgg+LIu2eia7aXLItalwN5vMxCxh8FMDYjMgHhgo/2kfjXEVcRKNIbP9gSiH/wXG/Vt7Cms2eu9Pnbd7A9upxTKNYZSoE2yHet7FOjg+NnX9Ou5j6PxpwfC1XpIOeOhKcI6a3JZXaQuQJyGJHHAWq7mGxOhgPnOYF4XPhVYvXRVrwLhirN8CfdcC1Ubv8RQIdPKPFComUj3iu2gGsZtifuIHQA9NW1FbPv2J3m0Rm72ufEJzOuSy4FGnjlD8xNdNl7rrrP5O0OhrOWlW066l/kQifYLP3wZxN8d2eSsJl/5U4cLy0KC0hlq0o/VPMVEBq3wVCtjIJw7gOt0LijF1RrNJrx7whzevZucdSWc/RHzF8fT5wNMn78YHH+D3wymaTodvDg6nv7pKH329Qv85rBv/GLOb3/R3vKNsvBqv/pW7SLuem1J7zfmvpMIu36xWrms20bUdhC3g8G01sIuXe05Ra5Rs9H1eyoKLZ9RScqUyFLa9WGg9HJARXMhSmEH0zq9Q3LU+TLTfOCPh4NCLVx8I4+/dFz6urbgckYiWVZ46QCxiBV8igUbsb8ovRymTUHsLZw8vqyUtvCYSAAAqp1PKhH5T6ftI14iV5BrVcLTFqWn35JdUfluuwdCeAkSF10Kvf63zVxeiYk0lssUw8ywc69Dpe/IF3SoyUbgdfYtDIcfqNihF+pYst5aZpgLiVl/A/UxWEzkKglYwUvgCy46uOIDp4mel43IEtn/lq2itdT/qlrSlq4f0BZ0xdM7SgklF654DILvJTKxia+2H2zC/Me8XP+rjP9PVSh5JcJhMmEzYef1NE5VOdzoYzBTNNuxmtcydbv1+qTexIoMRi8hYSK7Cb6RMBgOg1zhZ/iAWIloYrtqHr2EDrD4DS62lE6LeCXCIXXfgpPzSZBtV/u0UkcUKGnZmkbsbOV8Ep8d0FAQZvwdT+9mmhy/149AZP14/IBpbdGDErkj/YeXIEXhRZTYvLTxq0oLafOeMvGlzVDrCJIQB1zqojMTSez2A0Bub0fw1X2SyIQ5Lvof2OJVXRT+9NaEm9Z6v3qVyFXb6M6Xdu6iXWN4FD4OernSy5s0dDycL28GYk1ZIcw7qQSVOZX3ezezcoCbCf4TGcQTOCP3Cg0smCvj2lvKreWFq+iDN7qyfm5tZUbDYVXwpddNXGlFodTESi95JQzZNBG+xO0uU7X0nQQohLFkp7wowNQVYcJsKwJtzvyx8/tOcGox3jVX792ODfKVj4XbON0T50TBScu6FRZDv7DbTyLp8E6jZoOaiFEJlKZKZy5SutLA9XbOJy4Bo4Ymt0ClCpFSN+kJjL13G3/w5+nc7QGlb17RibzS6l5QVTvFQi2i0GnDpr0Ads4tUTLcCpMLNL4148jQ3JQbjD2/p2v+vnOZrcvPCHy++2QN8DRFY26sa8e9BGVilPdCK3mdsO/GJxfji5urt9+P3yTs/Vr0Y6pfgEPwfy8vLkE0qSZENhJf4wZuTgvLSRNltmIRcEMRKEwbeZBP4FQjt3h4E25M4KcSN2KT8lo7NplvQ73fpBh4CU830fopPKFY/XGBmghYvQxAPVgfpnbmQ20a9w3ttl/qFP/AJZ+5Y/W6abzZo81lSKA3VNrcZJ5iYLAnssAjujAD62hDYsYWaBdnegnbTOhE4CC7wZ8P7zWCr4wLofAVYJ+tXJFlsrtBplJXTraqJepriZk/Tx/uJ/b6TUfRV13tjuD2GfRTO43djqJvG9payytP916JDHrdXh5MVbbsU4k8U9scHMyQ9qGVDP9n7BzkpPJpba8+9hrUR/Hw39UHNXseLLX5lPSo7nDJRodK/Ijd86LGfaU+5ftm7dpy1/O/WPAXC/6dLJhm+6phjd2htHM2YkNFmf5oqF12QD18FNmKik5XmHguak01aVNEPYbS6cYU9Wy1t5AaOrvWghomLjq3l/jDf7ihYJuSbEcq/3L3SHoJb9AulL6jTOVaoEQlhn+p2t1Cuj6xWN+YXbdXnCppVIHvew341A8Q2NjMhw34obuhkHY4QzswllMh2o+D7Jri7JIuSzw/7kZvfYFCGvAjay3TfmRATZ+gPdMP7Uz1iqCp7mLOXdm0i7DT0E/sDL7rqMbFnDjDUjUMBu3Sb1JqqirPgMrzQkh0DS43Co2F+dQcGkyUnTXmGs0cXBFnoMcLwX1Rehuo3Pgy75aMvzv06fT9daCkPiS7CF0uLrdvECdn/oqX5ObWfaQcrF/U6ot6oZP49fLEYfaEdztUe26yN5fFXHYNj+rGO1xuDG+xWDgs5B0U+ckSqRgywwq1oUPWwIts4DC6bu+HTUYv/6n0nal4iieV+J6yyyfihkVDYFDgPRb/fTao6yxz1dxW8tTlPyy5IJWGc+FfvB43N7eE7NJ/x3Z6d09gIq1WWZ36s++ZSmuqdX3t6w6fRQHhlYY7vXUfgJAITs4nJoaT7hc06IKOksWS+smeWczCEYTDPS9EBudBGOBNyhtrDOd+R0eFDnClMvQqpHkKMtVqYfxJN5FPnsDl2fcm3E9mgYPQHZ2Gdw6e0voSJITAlgb9XfJ6w9YdnXHk133sXBWFWpA/Uk+i5jM0I4LxM7wOn0Mt/zOcqYUsFM+IAPyaHyLRVshn+vmZ0A46P7A98Ok/n4HEfrKE9oyeGLUFc13V0zjD+43HhYFh6Dya4ebQ2d8r2+uL8cnZD+MNha0eo8nuhtNCTYcldwk/PPYIf4cZ13boScRl1m/LNn4zvupuJesZ2ljpWTdCrIc3qN/qZezLmWH/c6JVVuIOXod2XIgHodtbzfEhrsrNVv7zx0r2M6BFB2kv2r+q7a02pA9ut24X/y6WMFO7dhDQ/p3f8+5WJb9H2bUEg3StFK+/GXJtRc5TOzRzSiLDTZez/9vR/sjv+QG7JbT+ZLW226r80XRF6+y2GW5sYti6Jel/TtlSBvQZq415G23vn5RUcrTpvP9rYQ/C8t8FvCfeYQGIh/O/nW+ZokdG158dG+kMdzxxS+q/GXQ1r/aYs5O4b7930C4rsQU0jDRHhpbxDne977ejdZD2RoqLerrsbqXr6XKGpekibo8O6Z+Ov31WtLTVAd+7oO55Z6uUmiYmFqp1KmuGwn8HkX4mtGZ/hqMLGJEiXRCP1mf3k4qnc6TjOIu2TsLke9x97WQc1prh68np+M3leHAUP4vntizcKQV1ad7ml/7CnQ7eVpnWe4ym5KSTM2rj69iChOHqW3qcWnLZwvV7tYG3j+GtN4RfnlF/eUb95Rn1/+0z6nCqpkszuukUrjviItZj6PZdN/0Oah/6fh+L2Ei4h3d0W0pTHh/pUeY7XaxWNOz0Qg9dNi09//o6WDQb5bww+AtRo3cRWj/9D115HWIiDHK5bDXYWRTa6SJjq/eriHm1tnr0dPiu2j35nSfQndbo2fj1+GrMItdhaz3/Xrct1o9+Hvcjenz0M5zbrFZrgKHr9H61Wv0HikpaSg== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint behaves like the administrative counterpart (`deleteOAuth2Client`) but is capable of facing the public internet +directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature +needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. + +To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token +Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses +`client_secret_basic`, present the Client ID and the Client Secret in the Authorization header. + +OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for +applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-organization-onboarding-portal-link.ParamsDetails.json b/docs/reference/openapi/delete-organization-onboarding-portal-link.ParamsDetails.json new file mode 100644 index 0000000000..744416b9fa --- /dev/null +++ b/docs/reference/openapi/delete-organization-onboarding-portal-link.ParamsDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": [ + { + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + }, + { + "in": "path", + "name": "organization_id", + "required": true, + "schema": { "type": "string" } + }, + { + "in": "path", + "name": "onboarding_portal_link_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-organization-onboarding-portal-link.RequestSchema.json b/docs/reference/openapi/delete-organization-onboarding-portal-link.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-organization-onboarding-portal-link.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-organization-onboarding-portal-link.StatusCodes.json b/docs/reference/openapi/delete-organization-onboarding-portal-link.StatusCodes.json new file mode 100644 index 0000000000..4f979fdf28 --- /dev/null +++ b/docs/reference/openapi/delete-organization-onboarding-portal-link.StatusCodes.json @@ -0,0 +1,166 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-organization-onboarding-portal-link.api.mdx b/docs/reference/openapi/delete-organization-onboarding-portal-link.api.mdx new file mode 100644 index 0000000000..04b8048dd2 --- /dev/null +++ b/docs/reference/openapi/delete-organization-onboarding-portal-link.api.mdx @@ -0,0 +1,41 @@ +--- +id: delete-organization-onboarding-portal-link +title: "Delete an organization onboarding portal link" +description: "Deletes a onboarding portal link for an organization." +sidebar_label: "Delete an organization onboarding portal link" +hide_title: true +hide_table_of_contents: true +api: eJztW21z2zYS/it7zHQizUikm+bugzK5OddSW7Wp7bPd6QfLo0DkSkRMAgwAStY5+u83C/BVL6mdOP1kf7AlEFg8+2CxwO7S916EOlQ8M1wKb+ANMUGDGhhIMZNMRVwsIJPKsAQSLm5hLhUwAVItmOD/YzTM93qezFDZL+PIG3iRlXLW6HNWSTu3wt5xcev1vIwplqJBpb3B9b3HCULGTOz1PMFSpG9KfsDQTHnk9TyFH3OuMPIGRuXY83QYY8q8wb1n1hn11kZxsfA2m95eYU3UTySx0mvqWJoSS4+VfUOddSaFRk3PXx29pj/tpRmlmVlD1Q+YQtAoDKxiFD27MHjH0izBHvWSuQqLXm45Ih+uYoRfrq7OQRtmcg2hjNAN3JLN9USYdcZDliRreHX0ve9tet7royOCFUphUBj6yLIs4aHlM/igCeZ9Q802fppcGyYipiI4U2v49fLsFI7Px4BKSUU4UmbImDJF5mS4I8M+3UOHHVRC3hkV4Sxf7I4aUjOQBowLDbYXcOHmJluGq5iT/pDr3CovpAG2ZDxhswSBiQhipsFImCGgoMaIMBfUF3pGzLAZ0wgsYplBBSumIbe9aeiciwhMjIAJpkRlb9skeofUPmUpEjw72lJAlriLgIwPtcGosgUIZZ5EVp8ZrXouooPzTluT7pJYfaupnOfKxKiaZIIUFqdgJlcIcl6jbgM+m9EehxU3MYyH8P2rH17/EyKJ2qLFO673UsSjXWzjIbHDIBf8Y15SNB76EzFHC2MqpJnWCzpS6if34FSa47J5Ij7m0rAp3oWIEUbU7b/UMioaCL7IU29w7e2V6/W8tgTvZluBnnfXX8g+iemTDt5gv6gvhrjpeSlqzRa4S9Pv7kG9fLU9FWP8fYw7vzElv7Er84S8icJMIbmlpsimu+m8Pnrdg9dHP9Cv73vg+363ZQ303HM25A08Lsy/XtdQuDC4QEX+uGyS1nioCzfWmhYoUPHQOoiTwldR/9ofXxe766YeVDkj51cuar/SnmZDktp6W1k/u0mdm/zh2U0+u8lnN/nsJp/d5GE3GeGc5Yl5dpXPrvLZVT67ymdXechVEksY5oqbtc2SSLX+U6pbnbEQjzP+G1LzDSURNKplmUvZdZXkIU/RrKS6taukZAJZwgRalKuYh7FzUxiRS0mZoPVcy1y1hhYZGW0916oEoonxXCXewIuNyfQgCFjG/VAKLRP0pVr7OvYIpGELQlhmdoiyu75U675iBhOectOf5eEt0lrNWHgr53MeYp9FKRf9RK6smdPCX9rlddomTCxIzXWGl1Ztr+clbIaE5z9SrYMw4c4tOtdFC59SxgbuJwIA4NyhOc54zzWcSDHni9xltSZiA3MlU3jZEPbyzURMBGloiM+6N7wFgau2hE73TdmXZXws6NwKsehZT95pCeraGRI0JenjaABu77yBIIBOcYbScuUiwjkXGHXdiGau6zHD9iTqHji81O++2J09e2jBBt4CWzHeUtx/WIqw49ai0r5Ym7ZuZeNe5BPRfeNR8q6wkJ9lwzIEM3yJTaPIWHhLVp8yLkijwkg6EzExE3dPuTMTz32dp9VHqd0nmaFgGXcGAhNvwU2cz/xQpkFtOP2FpN6WsnkuQjtbp0umODGVrjB4CxOv+jot3NnEozVwywGfwE7aosONa7d9bvBe2gohe58dFiYmpr0RBm+hxYh/iqutbUGDWMZPHGP7Bhyfj93Trc1BI1WPDgQaVsnwy910PvaHD7OyYl39H1l4u1B0j+l0ew2r2za4A7bW9Ud3GOYGnVZ8brH94y0InrjFnZh5avyfMsWFmXek9i9NhEr1YFLcPimXC5R1JU7fP1qT9+8H8N1yMhETzxLT/YtJf8qTxGWEy2tvY7wbvZmITXMDna9NLEVjE5HrPuhdpVpP3cOJsA60bvAVagNFv+OM0y0jc87W9sws4LKD+0Y29gKG5HKIILoPxJKkaJB2LEvssVR4KHurLo+jLGFrt7h+eYTRscQyrml/kuBLxLYn97O1q3hAwrWh+yZLEtB5Rpgw2nL7dTXDt76wdSI0FG/vAOe9rBq05x4Kt3QgL2xWv3A4ad44i9Dyw3ITozBFTGXZoSapCjNqoCZhXAALQ6kiezzZ+zNJoRuCu11AeReBTCY8XPs0auQ8gnbFBBbGdg5I0cQysjWITMklp0vlDBO56tEtw13n3EgwMTMkSTPD9ZyjdhcPK4b6hkyj7/Q9qfT7EZlC1dZnALv3o0evBgtD1Hpq5C3a3tpHseRKiuuJ9+Po+GJ0Mb06+210OvFuqmUYCQrLGBTOxHHHBPDyrC+iFaKy3BK2TwPLcenEtlwdME0Orug2cCBfwIlCZvDwJEzrQp+MT3l952jM2Lh61BN0W8fulEfwFl7W38oD4CW8IPdvff/2sVwM2mo6OPJQGc3KOPRwnzQnz6h1QZIjynnP7cLlgRpnPbBJW3FjmbY02g+tU1PV2yald1jXgnW0fhAqd0hrjw1trCPsTLy6Q+vQqBe0/++HQx7Ad9q6ffgOsGvv6Xd9Hd32Ixna7EfjZk0ZGb5wIfiDi72dblnudRf2dnl3vJs42I6Jmi69unXuVFnpoNpT7P0m8vfeAZ5qHlsSNrkSV07aUvIIOu06LcxktO5SFL2Q26vy0JuPuWvcWr5yiZ5wNb4B8X/N8UF6M3fn2Wv4D3IIn2XWvS1Qg/9iXr9O0GfeZHiUyMdYLmUH7wwKzaVw1NxSNuNQQqDnLVmS46HEAGlTjq98VzXm2Yc9+7BnH/bsw57ch1FvF+lUhFqqTOwNvKAM3oL7mqpN0FRZB/dbDGyCWpO+06RPmlDPQypuvDpNfEkFM1e1mjHNw6qI5lwntVSEULxJ9jGzsVS7p2va6Sop4HpFXeeJXNlpWiHYSZHMbzX+0coNx+tIMT/CVBap4cAJDeg3aRLKzCkg5/OEC5r+GGwrlGvl7r1FWYquvgrnCnUMNmzT0GEJZy4kfV9ImbrA7j3Zcrvp8fLdW4+CSkbehetEAcZZhmI8pCBVUAVqPIQr6k682XEP5MG4QY2ihCOd6FfrY4vZCd4ti8oiuuYaUESZpDTKWuYgECOCeN1M51OkeIvrm04JabVaWSyUs6QTNAiloEhDBxkqTSmWvqOsbzHaUstfm8yemsUjcde1hn6CS0z+fjWoQCjmsqxYs9DeIzBlnJa0yAr9pyh1VK+IErJL98zbqfS8gDEVYqI8dJmvoQxzqt+6+NSmnpIEsnyW8NDlbui2w7VRNnVtCzPH52Ptw3H7ATVCSAGvSNZUnnXKYlQkHRgsWcIjOC/IAGdSzlh9OHczWimUvkmlNsna1Ya4gJmSK+3yXBPx4gVcDn/TE2EL3VGhAThFZ6jLhIRuVL25q+M2VtC9nVpN2CiQayvekkFj5jJJ5Ir2I2Ukc7ZAPSAYn+Bd8b0IlD/BUK5EIllEAuBLfkhEc0Ge6OcToe23fmC74fE/TyBiv1hCO2TKtIi5zvKZH+Gy3nFFQ1DUUHRQp5m6e7m9vhgdD38f1RK2qiU6ug1miZwFKdMGVVE90cXfIGLKBE6En0bdJrf+6eiqPZXIF2h8qRZtD1E116jP1Np3Sbig+5RopRG4g9eiHSX8jqvmVDHe+VlaT+W+P5TZJ0CLFtJetD/L7alq0Qenqwpf38QSFnLXDgq0v7Ila0+VsiWKtiVoZCqM/epJwJThcxaaQMd0iAR1jaP79Wg/sCU7YLeE1kWold1m6Qfdptbabdlc2kTQKEx3n5JbOgHdidXEvI228ycdKnM0Ydz9Utj9Yvg3Ae+Et1QA0uH8l/MtU3TIuN7yFq3m1k7cYv2rQWdxtsecLeOu+NZCu874FtCipYw8GsYb7O6+r0drIe31FBf5bN2eSuWz9QJT3UbcbA3oQ2u/PSlamurA3rug2llrqpASUNrnsp6taio+HUT6RGj1/hOOyq88RHqdaFBFv8cZC2OEV/7Rzqs4tPeYfWw5Lsbq4N34ZHR6Oeq/8o/82KSJjVJQpfpsfolqyW0pNzBSN16GKq+clFlDpd09NiEy7P02k9qkTDRwPar4sh2cN14O/eJ/Tisu8VSVo7Iqt8GYJei+CNOrt5FIq0Erp9GK1OnpbrbiQLBuOx/MSNz0PKr50tz39/Rm5x8q2Wyo+WOOyr7SRalLxe3Lf/aNLq7ty6HeYM4SjZ8hqnNRhLBdOKR+0cjEupFV9XpF/rTBAKVX/saZt9n9u6c/uF6bm03Pi5FFlCSpEtUUNWXNxPTO+8ut7NBw9G50NfJ6NjXS+E/AKt4sszDX9/uB3t+7HjZM22wq3EW64Gaz2fwf9GEDzw== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Deletes a onboarding portal link for an organization. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-organization.ParamsDetails.json b/docs/reference/openapi/delete-organization.ParamsDetails.json new file mode 100644 index 0000000000..4069711adf --- /dev/null +++ b/docs/reference/openapi/delete-organization.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Organization ID\n\nThe Organization's ID.", + "in": "path", + "name": "organization_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-organization.RequestSchema.json b/docs/reference/openapi/delete-organization.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-organization.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-organization.StatusCodes.json b/docs/reference/openapi/delete-organization.StatusCodes.json new file mode 100644 index 0000000000..c72349ff4d --- /dev/null +++ b/docs/reference/openapi/delete-organization.StatusCodes.json @@ -0,0 +1,272 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-organization.api.mdx b/docs/reference/openapi/delete-organization.api.mdx new file mode 100644 index 0000000000..c7cb12049c --- /dev/null +++ b/docs/reference/openapi/delete-organization.api.mdx @@ -0,0 +1,43 @@ +--- +id: delete-organization +title: "Delete Enterprise SSO Organization" +description: "Deprecated: use setProject or patchProjectWithRevision instead" +sidebar_label: "Delete Enterprise SSO Organization" +hide_title: true +hide_table_of_contents: true +api: eJztW21v2zgS/itzKha1AVvKdnMHnIseNht7u96XJJdksR/iIKWlscVGIlWSsqNL/d8PQ0qWZDtJ200Xd4DzobUocvjMcPiQnKHuvQh1qHhmuBTewBtipjBkBqMB5BpBozlT8j2GBqSCjJkwLp//4CY+xwXXXArgQhtk0URMxFgpDOUCFZsmBUSYoEENTMBIGFSZ4hrh4uIUTtWcCf4fZlx7YJCVHU0L4EbDeOh7PU9mqGydceQNPCeu2dTreRlTLEWDSnuDq/sNhSr04yGBu4yx6uZl1QOnahkzsdfzBEuRnlyVGx55PU/hh5wrjLyBUTn2PB3GmDJvcO+ZIqPa2igu5t5q1dvsvKVjjaBZ/BgM2aj3uViuqbLOpNCo6f2rg0P6r41vlGamgHU9YIpGXBhYxih6MJMK8I6lWYI9qiVzFZa13EBEPpA+P11enoE2zOQaQhmha7ghm+uJMEXGQ5YkBbw6+Nb3Vj3v8OCAYIVSGBSGfrIsS3hodQ7ea4J531CzjZ8614aJiKkITlUBP1+cnsDR2RhQKakIR8oMWTdT5EiGO2PYtzvMYRtVkLdaRTjN59uthlQMpAHjQoOtBVy4vrkUZCNO+kOuc6u8kAbYgvGETRMEJiKImQYjYYqAggojwlyavtQzYoZNmUZgEcsMKlgyDbmtTU1nXERgYgRMMCVT9jZdoveQ2icsRYJnW1sTkP9tIyDnQ20wWvsChDJPIqvPlEY9F9GD/d60Ot024vqpNuUsVyZG1TQmSGFxCmZyhSBnNeo24NOpnfZLbmIYD+HbV98d/h0iidqixTuud5qIR9vYxkOyDoNc8A95ZaLx0J+IGVoYN0Kam3pAR0r96F6cSHNUFU/Eh1wadoN3IWKEEVX7N5WMygKCL/LUG1x5O+V6Pa8twbveVKDn3fXnsk9i+qSDN9gt6oshrnpeilqzOW6b6Tf3oh6+2p/KNv4uizveuCHe2JZ5TGyiaE0iWmqKbNJN5/DgsAeHB9/RP9/2wPf9bssb6L3nfMgbeFyYfxzWULgwOEdF/F0VSes8VIUb601zFKh4aAniuOQqql/z8VU5u67rRmsycrxyXvNKu5sVSWrrbWW9dZ06mvxuT5N7mtzT5J4m9zT5GE0e7mlyT5N7mtzT5J4mH6PJf+5pck+Te5rc0+SeJh+myQhnLE/Mnir3VLmnyj1V7qnyIaokK2GYK24Km4GTqvhDqludsRCPMv4LUvE1paQ0qsXuPJ3LixVwgmYp1a0dJSUTyBIm0KJcxjyMHU1hRJSSMkHjWchctZqW2TttmWtZAdFk8Vwl3sCLjcn0IAhYxv1QCi0T9KUqfB17BNKwOSGssoBksru+VEVfMYMJT7npT/PwFmmspiy8lbMZD7HPopSLfiKX1s1p4C/s8DptEybmpGaR4YVV2+t5CZsi4fleqiIIE+5o0VEXDXyaSWXgfiIAAMpE5lHGe67gWIoZn+cuOzoRK5gpmcLLhrCXrynjSBoasmddG96AwGVbQqf7uqrLMj4WtG6FWNasO++0BHVtDwmayujjaABu7ryGIKiTrwCN1Otk4rKe0CmXWBrNXEQ44wKjrhPYTH62pW5kVZ3oZuGT8itF78tp2rOrF6zgDbAl4y0L+Ns5544bgLXK5YC0EU9E97VHKeFy5N/KxogLZvgCm4OdsfCWvDllXBDAcvA7EzExE7f/uDMTzz3O0vVPqd0vmaFgGXcDDxNvzk2cT/1QpkHtEP25pNrWArNchLa3TpdcbGLW6sDgDUy89eNNSVMTD4KgHAb4CA+MrbO8RdQyhxPaLntA8pPju+5DTEzbrwdvoGUI/wSXG15OjVjGj52hdjU4Ohu7txu+Ti1Vj/idmq1l+NXkOBv7w21fKYfO/4GFt3NFW5BOt9fwnQ236fqjOwxzgw4pn9n+/vYGBE/cOE3MLDX+j5niwsw6UvsXJkKlejApN4iUvAdKs5M53z2K7t27AXyzmEzExLOKdZ/o4Mc8SVy6v9qFNtq71quJWDX9/qwwsb2mUfk+MemDZCdVceNeToTls7rAV6gNlPWOMk6Lfua4z9bMLOCqgnsiH3kBQ5r4ZAxanmNJUjRI25YldpUoecJucqvVIUtY4QbMr1YUWiVYxjVNKxJ8gdgmVj8r7OUHBgnXhrZ/LElA5xlhwmiDheuLK75lpBZBNxRve7AjG6sGTalPhVvN+xd2OpU8keaNpQGtfVhuYhSmPOJY61CRVNWMrFGTMLq5E4ZSRXa1sNtZkkILtlvsodoaQCYTHhY+tRq5ia/dTREWxrYPSNHEMrIXTDIlF5z2eFNM5LJnLyPZ3ZVrCSZmhiRpZriecdRuH2DFUN2QafSdvsdr/X5AplC19RnA9nbls0eDhSFqfWPkLdra2kex4EqKq4n3w+jofHR+c3n6y+hk4l2vh8HehwIGJUE42zF3l8oaszw8kCmrKWHrNLAcVSS0QVXANBFUWW3gQL6AY4XM4MOdMK1LfTJ+w+stQKPHxk6g7qDbWhBveARv4GX9VPH8S3hBLP/04rG5mpYSN4q2xX7GykFdGFWUpnHmcfz42EW1unbTQuUW4aaJr1Or39vUpTQXWgKDNY/RoGEDkGWwzsSrK7SYvR6J/r92ABjAN9oSM3wD2LUb27u+jm77kQxtuKCxFaUQBp+7M+vOW3adbnXPzu1m2/fkxtun6s0DwxM7wa2rbbSA7LgF9wk9ffLucLtPe2fO5Epcuh4WkkfQaV9kg6mMii4dDOdy0267Vn9z11jRv44R/3oTfqoBH7Rd5jYFO/2uPY0etZm7FFkr83Us9mQvz2avxxyO4lR3BgXdt3W2uKVz9UNH0563YEmODx1RSdWq/ZoU1m325LAnhz05/D+RA9V2u+e1qaxtTOwNvKA6EAT3tW1WQVMNHdxvaLXy6qjeBeU3XJJhyjQP1zkPxy9UsrYBnUdoFKd2r92u6Yq2qkrakL+iqrNELm03rS36cRl7bRX+3grlxUWkmB9hKstIXuCEBvQvaRLKzCkgZ7OEC+r+CGwpVHZ326syi0A7LIUzhToGu63X0GEJZ+7I8q6UcuM2/u/IEdtFny/ffewgKMLvnbtKtFM/zVCMh3SIEaWzXlJ1sptt94l2MK5RI4bsjE7mV8WRxewEb2exZHn64hpQRJmkY3YhcxCIEUG8akZf6SRxi8V1p4K0XC4tFgpF0TIThFLQhlYHGSpNR/C+M1nfYrSR8addZkeI+TNx16HhfoILTP56NSifI2aySjCy0C62mDJOQ1pGDb4vI9Prr0II2YV7520F5l/AmOLmUR6648pQhjml2xz92NBEkkCWTxMeurM9bQm4NspGJG0c/ehsrH04ar+gQggZJbiSgrJpTlmMykMpgwVLeARnpTHAuZRzVh/OXI9WCh3vU6lNUrhQPhcwVXKpXRxkIl68gIvhL5q+leEaolIDcIpOUVcHVt1IUnKXdmuMoPs0Zd1hI5+prXhrDGozk0kilzQfKWKVsznqAcH4CL+Wz+V57CMM5VIkkkUkAL7kj0Q0B+SZ/j4S2n7rDzYLPv/vGUTsFktoh0yZlmGusnzqR7ioZ1xZEJShcR3UYYjuTttenY+Ohr+NagkbQXAd3QbTRE6DlGmDqgyK6/L/IGLKBE6En0bdpm39k9FluyuRz9H4Us3bDLEurlGfqsJ3QZqg+5xopRG4hdeiHSX8jqtmVzHe+Vlad+WeP9Wyz4AWLaSdaN/Kza5q0Q92t85nfBVPmMttPyjR/swWrN1VyhYo2p6gkakw9tdvAqYMn7HQBDqmRSSoY+DdP4/2PVuwB/yW0Lpj3Npvs/S9bpvW+m1VXPlE0Mgjdp/TtrQCuhWriXkTbYc+L4UZmjDufinsftn8q4B3wlsqAOlw9tPZhis6ZFxvsEWruDUTN6z+p0FncbbDna3FXXKmhbbI+AbQsqQ6RTScN9iefX8erYW0kynO82nR7krl02KOqW4jbpYG9KM1354VLXX1wNw7p9xKq6uQojTa57LubV1U/noQ6TOh1btXOErP8RDp9sdgfcw9ylgYI7zyD7ZuTtDcY/a1tXHZVge/jo9HJxej/iv/wI9NmthTCqpUn84uUC24TfUFRurG3ZVqy0nhJ1Ta7WMTMobd32ZSm5SJBq6nw/Sbh/DGBb7/vS/cyyMB5YAoicft0c6a+748wK+vopCNBq3wRusMT283YxPXPY9ShSTk/p7u5/2uktWKij/kqOzFHAr7KW6vcNl7OVzbK37eYMYSjY+YsnNenmy78PRn9jvVLAuZKBoBS69XhiYbmtpv678E2Od8gv8FEDfNvbpe9bwYWUShj3WMls5CWTMmu3WJtBW/GY5+HV2OvJ4NeDQ+7l+fIqvYytX9bnj3966GPXytVmu0ZRDgerVa/Rf1BsJm +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Deprecated: use setProject or patchProjectWithRevision instead + +Irrecoverably deletes an Enterprise SSO Organization in a project by its ID. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-project-api-key.ParamsDetails.json b/docs/reference/openapi/delete-project-api-key.ParamsDetails.json new file mode 100644 index 0000000000..883e9164b6 --- /dev/null +++ b/docs/reference/openapi/delete-project-api-key.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "The Project ID or Project slug", + "in": "path", + "name": "project", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "The Token ID", + "in": "path", + "name": "token_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-project-api-key.RequestSchema.json b/docs/reference/openapi/delete-project-api-key.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-project-api-key.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-project-api-key.StatusCodes.json b/docs/reference/openapi/delete-project-api-key.StatusCodes.json new file mode 100644 index 0000000000..43a11f043d --- /dev/null +++ b/docs/reference/openapi/delete-project-api-key.StatusCodes.json @@ -0,0 +1,60 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-project-api-key.api.mdx b/docs/reference/openapi/delete-project-api-key.api.mdx new file mode 100644 index 0000000000..7591e4b717 --- /dev/null +++ b/docs/reference/openapi/delete-project-api-key.api.mdx @@ -0,0 +1,37 @@ +--- +id: delete-project-api-key +title: "Delete project API key" +description: "Deletes an API key and immediately removes it." +sidebar_label: "Delete project API key" +hide_title: true +hide_table_of_contents: true +api: eJztWutz2zYS/1dwyHQizVBkmqb3QZnc1LXUVn04PtudfrA8CkSuRMQkwACgZJ6j//1mAfAlyXnVvQ831QdbAoHd3y4W+wLvaQI6VrwwXAo6phPIwIAmTJCT8xm5hYowkRCe55BwZiCriIJcbkATbkIaUFmAYrh4ltAxTezycyXfQmxOCv4LVDSgBVMsBwNK0/H1/R7HqxSIX0BmEyJV80tn5ZoGlOOsgpmUBlSwHPCXm0EDquBdyRUkdGxUCQHVcQo5o+N7aqoCp2qjuFjT3S44xvhK3oIgs8lxNgafLnjyWXxucLIupNCg8fnzZy/wX5/3NC8MatLPI0wB0SAM2aYgArKSisAdy4sMApwlSxX7WU7DSUgQ/k9XV+dEG2ZKTWKZgFu4R5vruTBVwWOWZRV5/uzrkO4CmsCKlZlBaLEUBoT9yooi47Hdz+itRqj3HVEP9acNEwlTCXmtKvLz5eszazWglFSIJWfWRgqFVmK4U4h9ekQldlEN+2BVAstyfbhqgsMEJWBcaGJnES4cby4F6omjDkipS6sAIQ1hG8YztszAGnfKNDGSLIGAwMEEMXv1ezkTZtiSaSAsYYUBRbZMk9LOxqUrLhJiUiCQQY6qDPbNInhI7DOWA8Kzq60K0PgOEaABgjaQNPZAYllmiZVniTtfiuRBvose00MlNr9aVa5KZVJQXWUSKSxOwUypgMhVi7oP+PXSHuAtNyme6a+ff/PiW5JI0BYt3HF9VEU8OcQ2m6B2GCkFf1fWKppNwrlYgYWxENIs2g2dKvWDe3AmzUk9PBfvSmnYAu5igAQSnPZvHJn6AYQvypyOr+lRujSgfQr0Zl+AgN6N1nKEZEYoAx0fJ/XFEHcBzUFrtoZDNf3mHrTb19qTXxMe07jzHQv0HYc0T9GjKCgUoGvqkuy6nMGLZy8C8uLZN/jn64CEYTjsWQM+p86G6JhyYf75ooXChYE1KPTP9ZBcet9uuLHWtAYBisfWQZx6X4XzW5987U/XTbuocUbOr1y0fqXPZrezzrArt6X1o2NqGWmIS8VNZaOXVNUfUt3qgsXgI9z4+gbdvga1eTjGoYc8A7OV6tbukpIZKTImwKLcpjxOnZuCBF1KzgTuZyVL1VvqQ5+2nmtbA9Go8VJldExTYwo9jiJW8DCWQssMQqmqUKcUQRq2RoRNCL1Bs5WqGimM7jznZrQs41vAvVqy+FauVjyGEUtyLkaZ3Fozx42/tNvrpM2YWKOYVQGXVmwa0IwtAfF8J1UVxRl3btG5Ltz4vJDKkPu5IISQNmMI3MCpFCu+Ll1qMRc7slIyJ087xJ6+nIu5QAkN6rOdTV4RAds+hcHwZT2XFXwmMG7F4Ge2zAc9QkPLIQNTK31M3Ml5SaLow2kLGfj4iltZigRWXEAydNRsWjFL9qnVuciDa2sJ7v35C2xYIjvyirAt4z3RwiOZ2MCp1gvjFe3BzMXwJcUcyW/lj7KzhYIZvoHu7hUsvkXzzBkXCMzv5mAu5mbuEoo7M6fu5ypvvkrtvskCBCu420kyp2tu0nIZxjKP2h0erSXOtpKvShFbboMh2szceCnI+BWZ18a88D5nTkkUee2S9+TDW4XEvBIcMf/jA8TqnUJgc9M3vvEr0hMuPIPtniniIlbwUyf8sQUn5zP3dM8gcaUK0AnjsoZGWG/z+SycHNl3vx/h9yy+XStMFAbDoLGD2gSG4fQO4tKAQ8hXls8/XhHBM6fzuVnlJvyhUFyY1UDq8NIkoFRA5j57w+yVYJ6JunrzYVRv3ozJV5v5XMyplWj4EQ4/lFnmEt46R+ysd6t3c7HrGvF5ZVIpOoaMfu5BVyRVtXAP58J6m3YgVKAN8fNOCo4huXCeyc4sLOB6gvuFxvGETPD0ojYweKYSqWgi7VqWWR/uD7tNQWvfXWSschsV1v4efTgruMYzgoQvAfpuLywqm/4zknFtMDljWUZ0WSAmSPZ8ZFuShdat9NxnR/C+6TqXYcXAk/KpcOtD/MSeHn/o87LjuMHqh5UmBWF8AWK1g0NS8f/so0ZiXBAWx1Il1pfbZBOpYDh1oZjUgZsUMuNxFeKqqTvW2tVKLE4tD5KDSWViS6xCyQ3HDGwJmdwGGJJd7uNWEpMyg5Q0M1yvOGgXpS0ZnBszDaGT97SR73tgClRfnjE5TCY+ezdYHIPWC3uIcbYOQWy4kuJ6Tr+fnlxMLxZXr3+Zns3pTbMNU4E1DCPeMTjdMUF4HRh9ao+qrI+EndPBclJ7nz0fRZhGz+SnjR3IJ+RUATPwMBOmtZen4AveBugOx06cbhkMe0GNvCJP94LBU/IEvfcnxIEmHC54goTq78cpdYOAXakqL6wT2Lm8BpjvprQzunL6aL2ooeOzW6gGfRe94ImXFqz/IY0bQp1Dh7t1QIM5bSf0PHOryNG/jnMek6+0da3kKwJDmzjejXRyO0pkbMvxTqqHLQK+djXh8RbQYFg3gVy6eNDF2S+kPrND1G/OYADoNnBmh2XxMQ6dVtAePdvRMaUSV47IRvKEDPptFrKUSTXEkmot9zVyNCSbu068/b9Sz4OaKVw4PmovB6b/6Tp5bIW4ht9H6D+OtWB75s6A0FwKJ+ctlpMPVWQB3bCshIcqMxSkXt+c1WbN32f27zP795l9hDOLs1222GjCym1SOqZRnQBH9/7bLrIIdXRfI93RtqV0ic111+FeMs3jpuHuTjmONHJhuo17srSpZH+mGzqYKjHffI5TV5ncWja9DPTUN/56g7/3+khplSgWJpBL30aKHNEI/6IksSycAHK1yrhA9ifEjpJazS798C1szEAUrBTo1OU1mgxYxpnLyN94KguX175Bm+oPfT59d00lsL1ML9wkTERfFyBmE8zRhTc7ayGoN7vuE/Vg3KJOA9MpHdWvqhOL2RE+vEKRvrjgmoBIColVZCVLIgAShHjdbf35FPJmUEPabrcWC7ZN0NlHsRSY8OmoAKWxwhw5lY0sRtuW/bjJHOlvfibuti85ymAD2f9eDLxMECtZ326x2IY8yBnHLfVF8Xe+Ldrc9yGyS/eMHnSFn5AZNm2TMnaF/0TGJd71uDLNVt5ZRopymfHYla4YmLk2ynbPbBP35HymQ3LSf4CDJGZ4u5JVeJXjhIXE11yMbFjGE3LulUGcSTljDcm542ipYPWaS22yyvWRuSBLJbfalflz8eQJuZz8oufCXoolXgLiBF2Crusx3bkh4+7Op7OD7u6xYdi5TNOWvFUGrlnJLJNbPI/YkCnZGvQYYbwnv/rfvl55TyZyKzLJEiRAvuSDJLob8kif94h21PuQ/YHP/zwCieNkEe2EKdNTzHVRLsMENu2J8wORb+PqqK2yh0d1e30xPZn8Nm0p7DVsdXIbLTO5jHKmDSjfwNX+f5QwZSJHIsyTYVe34dn0qs9KlGswoVTrvodohlvUr1UVuh5ENHxMtNIIOMBr0U4zfsdVl1UKd2GRt6zc70/V7COgBQvpKNof5T6rlvSD7Jre+19iCWt5aAce7c9sw/qscrYB0bcEDUzFadg8iZgyfMViE+kUg0jUtniHfx7tW7ZhD9gtonXFVGO3Rf5W91Vr7bYerm0i6lxiDR9TtxgBXcTqYt5HO/gDg8oKTJwOvxT2yC//S8A74j0RCMpw/tP5nik6ZFzveYvecO8k7mn9T4Mu0uKIOVuNu7uHHtqq4HtA/UhdNHSMNzo8fX8erYV01FNclMuqz0qVy2oNue4j7o5G+KV33h4VLbJ64Oxd4NVBj1WMvRIdctlya4b8tweRPhJafTzC4e0TjwFfPRg3NetJweIUyPPw2cG1PZ49Zh9bHfu1Ovp1djo9u5yOnofPwtTkma1SQOX69eoS1Ibbm6zISN15caJOObEJBEq7PDZDZdj8tpDa5Ex0cB3vWe8X0503xj7/fUGfpuO1A94bcVtuWRXc+xq6eTcBcY873YO6lhs3Jf9NQPEyCtfc3+P7Wb+rbLfD4XclKPtiBva/FLev8Nj3Mri2r3jR8YplGj4g2eDCF5fDj1wcPCSUH2Si6jTuaOBbdLVc9r3ELwXV6Wh8AYRGjbubXUBTYAl2FZomJJYZRbfpePByYK8TMpn+Or2a0sD2EjovRjYFWt22uL4/juv+3s2wQu12fZiIcbf7LxG/hKw= +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Deletes an API key and immediately removes it. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-relationships.ParamsDetails.json b/docs/reference/openapi/delete-relationships.ParamsDetails.json new file mode 100644 index 0000000000..401a8055d1 --- /dev/null +++ b/docs/reference/openapi/delete-relationships.ParamsDetails.json @@ -0,0 +1,46 @@ +{ + "parameters": [ + { + "description": "Namespace of the Relationship", + "in": "query", + "name": "namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Relationship", + "in": "query", + "name": "object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Relationship", + "in": "query", + "name": "relation", + "schema": { "type": "string" } + }, + { + "description": "SubjectID of the Relationship", + "in": "query", + "name": "subject_id", + "schema": { "type": "string" } + }, + { + "description": "Namespace of the Subject Set", + "in": "query", + "name": "subject_set.namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Subject Set", + "in": "query", + "name": "subject_set.object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Subject Set", + "in": "query", + "name": "subject_set.relation", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-relationships.RequestSchema.json b/docs/reference/openapi/delete-relationships.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-relationships.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-relationships.StatusCodes.json b/docs/reference/openapi/delete-relationships.StatusCodes.json new file mode 100644 index 0000000000..e5884f66df --- /dev/null +++ b/docs/reference/openapi/delete-relationships.StatusCodes.json @@ -0,0 +1,113 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-relationships.api.mdx b/docs/reference/openapi/delete-relationships.api.mdx new file mode 100644 index 0000000000..08c6f7ab79 --- /dev/null +++ b/docs/reference/openapi/delete-relationships.api.mdx @@ -0,0 +1,37 @@ +--- +id: delete-relationships +title: "Delete Relationships" +description: "Use this endpoint to delete relationships" +sidebar_label: "Delete Relationships" +hide_title: true +hide_table_of_contents: true +api: eJztHGtz2zbyr+CY6USakSg3zd0HZXxT11Zb92H77HQ6HcujQORKQkwCDABa5jn67zcL8AFSlC05Tj/cyB9sCQR2F7uLxb7oBy8EFUiWaCa4N/T+UED0gikCPEwE45poQUKIQAOREFGcphYsUV7PEwlIM3AaekPPTrpszEmopDFokMobXj80kJ3RGFRCAyBiRvQCiLva63kMJ31KQWZez+M0Bm9o/pg1Xs9TwQJi6g0fPJ0l+FBpyfjcW616TVTn048Q6B3wCLNgNyQF2B3QFDzdDdFVaqg7PdkBk7JrJizcDdeakHLk5Ar0E6gUaP9F5LUbypcQ3W4Yt5LiTc+ToBLBFSh8/ubgLf6p0zGKE52Rch6hEogCrslyAbxHZkISuKdxEkEPZ4lUBvkse/5Cn7xfAPn5/fsLojTVqSKBCMEubMBmasx1lrCARlFG3hx863urnvf24ADJCgTXwDV+pEkSscBscPBRIZkPzjbr9CNypSkPqQzJuczIL1fnZ+To4pSAlEIiHTHVPloGifZDM8sM87SFHWZRQfLaqhCm6Xx91QkOE9wBZVwRM4swbnEzwZFHDPdPUpWazXOhCb2jLKLTCAjlIVlQhaZvCgQ4DoZIc876fJ8h1XRKFRAa0kSDJEuqSGpm49IZ46HRJYggRlb2mirR27RtPHNInlltWIBKt06BhE8pKA1hqQskEGkUmv1MUeopDzfindSQrjOx/FaxcpZKvQDpMpMIbujkVKeyNBIGQZ3g/EgvmV6Q0xPy7Zvv3v6ThAKUoRbumWplEQvXaTs9Qe5QknL2KS1YdHrij/kMDBkTLvSkEuhIyh/tgzOhj4rhMf+UCk0ncB8AhBDitP/gyCgfQPJ5GnvDa68Vrtfz6hC8m+YGet59fy76CKaPe/CG7aCeTeKq58WgFJ3DOpt+tw8q8VX6lK/x2zhu7cYE7cY6zGO0JhISCWiWXJCuuem8PXjbI28PvsNf3/aI7/vdmjbgc8/qkDf0GNf/eluRwriGOUi008VQadM100ab5sBBssAYiOPcVuF8PBJMQohCs6frplpUGiNrVy4ru1JHs0JI9X0bWD9ZpJ55OqNppPemcm8q96Zybyr3pnKTqUQuQZBKpjMTAgqZHQUBKPVe3AL3htc36BlrOscI0XNjTCTnvi9k1pdUQ8RipvvTNLgF5MMtaNGnYcx4PxJLozzIzivDNBtsRpTP8fRnCVwZ8ryeF9EpRN7Q+17IbBBEzBobaxCQnXEipCYPY04IqUVVRwnr2dFjwWdsntrQd8xXZCZFTF47EF+/G/MxDwRXGhWqmk0OCYdlHUKn+66YSxN2yvFKCCCf2aCgU4PWNWgi0KQMsobE6uY7Mhg8Gl2TjjDiolGXdPK7DC1xykOYMQ5h10K2UnbBbo6kt4VZyNiF+ljovC3cPCI7DV3Aj4bKO0K+An22Faed6HF3FOdPsPyLgF9uwfsdERTa+5CbtZ657cmKHBK6pKym1n5Llqhjj1Wpw/kxs5qXfylUJv9aSrr+3ZXP2pNzF946Q8a8+87DvEBuNX4SjrXgVLM7cA1FQoNbvC9iyjiyIDccnTEf67H1CO/12LNfZ3H5USj7SSTAacKsvSBjb870Ip36gYgHlR3pzwXONjyepTww2DpdNE9jXfKLDA/JuMqLTfKLY+yRwSCXMvlMtrUGhjgrfwPXft4AdCtbgBAL+VmYxbcNULe0BQi3VAQLuPy6AfK2xsAB7epUDYn7YFuet5+sOrZzh/nN0a3EsA2Sy5o81se3lMxGVHys6xff8JDUVN4/g2XjGsRFNGHH9ki0LTi6OLVPG/eg0bAe+la4rITh127Pi1P/pMX45EfV/4EGt3OJQUCn2/VLyXXKc9X1LZs79kR0S+idQp27fqFfYafUxHLQ1ZdOiw65E3NMTfG7U0rs68Lr+qN7CFINlqdsZjjzj0PCWWRtx1jPYu3/mEjG9awjlH+lQ5CyR8Z5GInZRoJ5QZT7hy34+OHDkHxzNx7zsWcE0X0CzY9pFNksZRGxOuvt6tWYr1yLfJHphUmxFlYZPcONLpyQ2cQ+HHPjoFUDvgSlST7vKGEYICT2DjAzE0NwMcF+Q51+RU7w0kOWoPIvBEJRpNB7Ewvnd6QJiBdaJ2o4GCQRzaxq+YkUKCzlC5nRhCk0+Aj4CqDuKfpJZnK2lERMmaNNo4ioNEGaIGy4lVWVxTe3cc3jdDZeP3H2KjTbQCuwLbnFjfTKZJrzGyxOHV8XDH9oqhfAdZ4OMdzBISHZf5tUIzDGCQ0CIUPj/prQF6FgCKJA3oEkRRhBEhGxIPNx1cjaKWUT3DRYGBwkBr0QocmLJ1LcMYwHpxCJZY+kypKXWziiF1QjJEU1UzMGimQilRYMzg2oAt/u97jc3w9AJcj6foakHtrsLAlq1k40LsbZygd+x6Tg12Pvh9HR5ehy8v7819HZ2LspRTDimE2hJDdjlm+UE1bEEbmlRjYWx8HMcWg5Kgxmw6wSqtCY5tOGlshX5FgC1bAZCVUq30/CJqyKZxyMzbCmwtJtOIPkkLxec21ek1d4J+3k1VQuJYKsezUVvC0dGtclRXBNh6YCuLUv43ilExYi0OrbOtjtHRkXrgI9qXG29cEWXN507zeRVQxfH32K+dvicOXQNv60TDZ7MYhLyyxXfav+9vKrMVxVz12dz4OdSa1uXjkUh1XEk2vmYR7zlLp1WMY9jm4cVh977aI9bB3ttYjmcH2o18rdw7bBXBpg7k9SXqNoN8DhmblAO2OvmlBzLxrGoP/vNrYNyTfKeAfkGwJdb2VSQyq87YciMPltJ8uDOXc2t0nW9saETrdoTbCZopbegmZucrfOhSq1NqORAvRimn0FjyN4tF9hM3SnEP04/CdaFTZjKB3bJ1E81aTwJA7XO95dIvUK/jbIzp8jmt3RXD5XRo+jMu0FOpX8vQV6J1hIOvWaP5mKMOti4noumsekNTjS904wsT8z+zPz/31mNh6XxMaerTdL437f5Zh83TPyVQ/Ii58O25j2CIIvPht1d2hHQeyos45DtYtMnoPleeJ5ucsEa+T3GrhCURidv4XMG24q3fW8OxqlsF7Cw+0VK0vPrpy99/D2t9X+ttp7ePszsz8zew9v7+HtPby/0cPD2bakUp4Jcwb0wht6A+PCDQoi+zo1HVjY9oVlG3tIUokVu6LE9JAXliYqSuer1jLTwLh+kmFrn0nwuUtsr13egOtVBas1nvyFpRzsrT0DvRTyllxYKASh+OQvkZKActt/yjTWoJBz1+6KY8GViOCmUxAf2AEk1leLQUH8IEilBK4Hc9B9pSmW6bp+zryidHWFvcB2P1OqWFD2B6MI7EgpY8SHlmlqak31mXZobarAgtQbnDqLxNKgqZWojvM+xdrgHzXRLLJQUj+EWBQbtEAH+Nu83yISuwExm0WMI/ojYkZJoWM2v5t33GKKV8JMgloQU9pSpEMjRm3J7kMOZWKLXx/QttaHdodvX03j2A3rXdpJWK06T4CfnqA8OWrA6QmxHYjYOYkftuSDtoucfkvLdGR/o7VxreNb5NVH9/26TKSEA4RIYk3xsJp2C1mleMvl0tCCpwODI9REzKirQQJSYdGib1nWNzSaLtKnVUZmfwp5ayzhUcJ+xQBsR7rJsgDQj+AOor9/G9j7zGeiaMangQkRIaYsMqbUVM2/t3Ks3uBCyq7sM2+tifUVOeVaijANtOkMOBFBiq3p1sSa0nwUkSSdRiywtW20gkxpaXrFjNE5ujhVPjmqP8BBY3QEjzLsPLebhTAvzFJyRyMWkoucGcSqlFVWn1xYjAYKlrdjoXSUoXxCNF9TKZbK9gGM+atX5OrkVzXmpoc/zHdA7EanoIqirXIa+nMT6EjQvlFWInR6/5UBb5iBa2YiisQSzyN2bKR0DmqIZHwmv+Xf84LQZ3IiljwSNEQA5Dk/CMIVyAv9fEZq+7Uf0hzY/ecFQLSDRWpPqNQ1xlwn6dQP4a46cfnAIG9aVIOqFN9t5e315ejo5PdRBaHRnqjC28E0EtNBTJUGmbcrqvzvIKRSDywIPw67Lm/9s9H7OiqezvGdTTmvW4hyuKL6XGa+bVQYdF+SWqE5rNFrqB1F7J5JF9UC7v0krlDZ79ty9gWoBUNSK7U/iSaqCvRGdGWn6VfRhLlY14Oc2l/oHa2jiukd8LomKKAyWPjlkwGVms1ooAdqgZfIoOoB6345tR/pHd2gt0itTT6WepvEH1WdtUZvi+FCJwbOiwHdl+Qt3oD2xnJpblLb+RMvlRnoYNF9Ltn9fPlXId4Cr22B4B4ufr5oqKKljKmGtagN105ig+tfTHSySFrU2XDcNifWqM0S1iA0HylCBkd5B+un78upNSS1WorLdJrVUcl0ms0hVnWK3dEBfqidtxelFlFtOHuX2FtYQxVgVUH5TDhRWTGUf9pI6QtRq9pvOGxPZQHgm1LDMpY/SmiwAPLGP/B6jUgYzx41jw2P87Vq8Nvp8ejsatR/4x/4Cx1HJkoBGavz2RXIO2ZaXQdaKOc9r8LlxMgZpLJ+bITMMP5tIpSOKXfoamtlaobQzuutO/1zkNw/x6ZE7ChlJs4ye3/IEwfXnnGZTW6injq46XnYlYpTHh7wtdE/ZLRa4bD9HwzmP4kwZd41zfMZj1D9VMatlVJbiHJTSUXVytSptsf+aEbuEdRlZumZeJ9I1j2C2ck2PRP3U3m8R5DXUoXPRP9EZm8L7M1/XPIisn8WFS+tBs8iolUjbqr8nHmJs+ctgIaYqCorwBi5Ji7xa6/H1xKLJ6PfRu9HXs+kp5z/oFLG/EUm7Lp8RHnmgH94sDNMqLxaecVe8pTNzWq1+h9BB0xt +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to delete relationships + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-test-login-flow.ParamsDetails.json b/docs/reference/openapi/delete-test-login-flow.ParamsDetails.json new file mode 100644 index 0000000000..2562fbf844 --- /dev/null +++ b/docs/reference/openapi/delete-test-login-flow.ParamsDetails.json @@ -0,0 +1,17 @@ +{ + "parameters": [ + { + "description": "ID of the test login flow to delete.", + "in": "query", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies. A captured test flow requires the ory_kratos_test_flow\ncookie set by the OIDC callback; a flow still in the initial\nchoose-method state does not.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-test-login-flow.RequestSchema.json b/docs/reference/openapi/delete-test-login-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-test-login-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-test-login-flow.StatusCodes.json b/docs/reference/openapi/delete-test-login-flow.StatusCodes.json new file mode 100644 index 0000000000..f3f5ca2fde --- /dev/null +++ b/docs/reference/openapi/delete-test-login-flow.StatusCodes.json @@ -0,0 +1,219 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-test-login-flow.api.mdx b/docs/reference/openapi/delete-test-login-flow.api.mdx new file mode 100644 index 0000000000..bb5872d4e3 --- /dev/null +++ b/docs/reference/openapi/delete-test-login-flow.api.mdx @@ -0,0 +1,39 @@ +--- +id: delete-test-login-flow +title: "Delete a test OIDC login flow" +description: "Deletes a dry-run OIDC test login flow. A flow whose debug payload has" +sidebar_label: "Delete a test OIDC login flow" +hide_title: true +hide_table_of_contents: true +api: eJztWt9v2zgS/lcG7EsCyFKa5vbB97JB7N162ya5JIvFIgmytDS22FCkSlJxdKn/98OQkm3ZTq8/sgccYD8kNkXOfPw4/EgO9cQytKkRpRNasT4boESHFjhkpu6ZSsHZaHACDq0DqadCwUTqWQzH/j/Mcm0RMhxXUyh5LTXPIOf2Ro0RFaS8dJXBDAx+qoRBCy5HePvh+ARSre8FgkUH49oXez8pl3LM0/t/AvcObpR1QkoQytcRSjjBJaS51hZ7BbpcZ2AddwjCQkbg+VgizITL4WNlnW8WLI0GsCccpNwYgRaUhvPRKAKuMl+JZ4VQUPAaZlw5cBr4mKtMKxBuP2YR0yUaTjSNMtZn3hdeoXXviZZfpJ6xiJXc8AIdGsv6109r3I4GoCfe1xqd5CzYIz+C6n6q0NQsYooXyPpMZCxiDYsZ6ztTYcRsmmPBWf+JubqkWtYZoaZsPo/WXb+9ujqHE8+5pcFbjIxH4jF0xkib+u7ecKftHdW4Cwx+5aDBtjG7UdsGLdN+JNyi3znyDM2y4wEz+1Jnb4kZW2pl0dLzw4Mj+tclYFiUroZFPeCG+qEczHJUEUy0AXzkRSkxolq6MmlTKwxMFsMVxS7xSNArC6nOMDRcsy3sjXJ1KYiXGg4PXsdsHrGjgwOClWrlUDn6ystSitSHVPLREsynlW528ZNz67jKuMngzNTw2+XZKRyfjwCN0YZwFNzTWBoKVCcCGf7pFjp8oxbyRis/oTdbDfw8px5woWwz7YUKvoVWxJGg/kNlK995pR3wBy6kn5U01XJuKdzHCKioMCPMDfVNPzPu+JhbmpK8dGhgxi1UvjY1nYhmxqLEgqiM1kMieq7bp7zwQuFbewoozDYR0FxA67xyhViAVFcy8/0Z06hXKnvW713H6SaJi19LKieVcTmaVTJBh/mjOM3UVjm8gy7gs/FHTF2QvNEAXh++OfrHYmIBPgq7lSKRbWIbDYgdDpUSn6qWotEgvlET9DDulHZ3ywEdGvNLeHCq3XFbfKM+VdrxO3xMETPMqNq/qGTYFBB8VRWsf8222mUR61pgt+sdiNhjb6p7ZKZHfWD97aa+G+I8YgVay6e4SdOH8GA5fMt4atrE2xgPunFHurFp84TUxGBpkGRp1eSq3OwdHRxFcHTwhv68jiCO4/1ONNBzFmKIlg3lfjpaQhHK4RQNLRBtkfbBQ1WE89E0RYVGpF4gThqtovrLxee6mV23y0YLMQq6crHUla6bOVnq9tvb+jU4DTL5ZieTO5ncyeROJncy+SWZPNrJ5E4mdzK5k8mdTD4vkxlOeCXdTip3UrmTyp1U7qTyOakkYHxqfWQY792P/WNP0zUAdyhFIVxvXKX3SB0MyeFeWY2lSHu5mOY+MoirS88ImbolfhwqK7QKCfF7rFn/OasRe+Cywu3WKc0bUseL5LvPt7uc9VliUU56Fs2DSDHxifWE8taUN0bz0KbjKyMpxexcaftJ8lQaTeTcWVlN53Hzy8ba1LwUNk51kXhMRlDken1ebRJCqVlfWCl5PTWNPHWZ/lNXxi8dp+hm2tzDebACZCWGP3UFKVdBXoVr8+bXqy1OtLJa4u1eCz4NBQQ2tnnSgk/SyhhULpmi61nHjcNsP6bhvyUq0soIV1/SUhf6M+ZWpIvlj6gPJYv4IX80hcbIDZpuzVC0UVXzyuWHVJUuA7wbKtFG/Nvr60kzDTuFv3eGJq8zw+MMC912MBhN6K+/DNBl6ICeTKRQ5P4YfGl7j5H5zH67oAg1BYMTgzYHp+9RWdjjUnDrE/h/NVbueJqitX/t021Pp+jb7YcLI0Vizy5CJeAKzkqki6gTrRRFwGgAV1SdePPtvpIHFxqtyEkgneg39bHHHAxvbmg0VBbB0YYBVVZqoRzUugKFmBHETuCRttxjvQy82WzmsdDsyHRqKRJTLJ1NSjRWKy57gbKex+hF8r+HjKn/0ObeljzF41K8I5X4Rtwwaw30JD6g/N93g5Z2NdHtXpOnfq+JBRc0pLYqS23cz2EclxdchOwyPGMbGv0KRsoZnVUpFdyogU4r2nmFfQqFLpcSgkz6TZ6/xBTW0UXlA3rROT4f0ZVf9wEVetHRSta0sQqdxexG+e0MhwcuRQbnDRkQQioEawznwaO3QndkhbZO1jQ+GcnX2OiZRWPjG3WjXr2Cy8E7e6P8FjVregCho+PmvjFYWuwdGglcGcFw/bZwuLK1td68J8Pf9Wop9Yzmo+RqWvEp2j7B+Azvm98QPp9hoGfK31hfDt7B93zIxOqAvNDnM6HtdT6wXvDtnxcwsd0soR1w4zrEXJfVOM7wYTnjmoKk5Ok9jUpCd8ypFKjc/lZury+Gx4MPw6WFqXB5NfZTVps6sdl9MpZ6nBTcOjRJsGWb/0nGjUuCibjI9le5jU+HV11Xqpqii7WZdhViUbxEfWbq+CR42H9JtNop3MDr0Q6leBRm1VWOj3FZLF2F31/L7AugRQ9pK9pf9bqrpeln3QWzvan+WyJhqjfjoEH7G3/gXVcFf0DVjQSL3KR5vHiScOPEhKcusTktIoSh1/L9w2g/8gf+TNwS2ku/PCzitiw+2i61Pm7b4jYmkp+XNO+/JLe0AoYVaxXzOtq9P2hRmaBL8/3vhd1rmv8t4IPxTheA+nD+9nwtFAMyYdfUolPcmYlrrP8w6DIvt4SzZ/y8dvnKMkRo61KsAW1K2iPDSvAmm7Pvx9F6SFuV4qIa111XphrXUyxsF/FqaUJfOvPtRdGSq2fm3gW9TNZxldIB1sZCr5zK2qLm27NIXwit3b7CsYhJkSIlAvpPi41mydMc4TA+YNHaSZjmHvePPcdNW5u8H50MTy+HvcP4IM5dIf0pBU1hzyaX4axNZ2+n7Uoao91y0skZjQ37WMn9aXwesVJbV3C1giu8cQg8vIrmXyhbvhm3fpZeSePuXlV8/lXF5lzi8NElpeTCny/9mD81KZNrtpoyoYAhxqgpDdRtxHJtHVV7eqKM8O9GzudUHN5L9O82CuvTyKw/4dLiFwZq76I5Mu/DV74CuRV/yB35NyHbPJHPCrUJGko4zaP2DcJvg/j/8H7kF0hZvCW5JCZqk210citXk2sbtx+d1Npg+H54NWTz+X8Axd4Mew== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Deletes a dry-run OIDC test login flow. A flow whose debug payload has been captured requires the HMAC cookie set by the OIDC +callback; a flow still in the initial choose-method state is deletable with just the flow ID (it carries no PII, and the admin may +want to abandon it). + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.ParamsDetails.json b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.ParamsDetails.json new file mode 100644 index 0000000000..09535fa635 --- /dev/null +++ b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The id of the desired grant", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.RequestSchema.json b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.StatusCodes.json b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.StatusCodes.json new file mode 100644 index 0000000000..c77d7a2a06 --- /dev/null +++ b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.StatusCodes.json @@ -0,0 +1,96 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.", + "properties": { + "code": { + "description": "The status code", + "example": 404, + "format": "int64", + "type": "integer" + }, + "debug": { + "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.", + "example": "SQL field \"foo\" is not a bool.", + "type": "string" + }, + "details": { "description": "Further error details" }, + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + }, + "id": { + "description": "The error ID\n\nUseful when trying to identify various errors in application logic.", + "type": "string" + }, + "message": { + "description": "Error message\n\nThe error's message.", + "example": "The resource could not be found", + "type": "string" + }, + "reason": { + "description": "A human-readable reason for the error", + "example": "User with ID 1234 does not exist.", + "type": "string" + }, + "request": { + "description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.", + "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", + "type": "string" + }, + "status": { + "description": "The status description", + "example": "Not Found", + "type": "string" + } + }, + "required": ["message"], + "title": "Error response", + "type": "object" + } + } + }, + "description": "genericError" + } + } +} diff --git a/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.api.mdx b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.api.mdx new file mode 100644 index 0000000000..d18e6b70f0 --- /dev/null +++ b/docs/reference/openapi/delete-trusted-o-auth-2-jwt-grant-issuer.api.mdx @@ -0,0 +1,41 @@ +--- +id: delete-trusted-o-auth-2-jwt-grant-issuer +title: "Delete Trusted OAuth2 JWT Bearer Grant Type Issuer" +description: "Use this endpoint to delete trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you" +sidebar_label: "Delete Trusted OAuth2 JWT Bearer Grant Type Issuer" +hide_title: true +hide_table_of_contents: true +api: eJztWm1z2zYS/it7yHQizVBk4jq9G2Vyc66ttE5b242dyXQsjwKRKwkxBTAAaJnn6L/fLABKpCQncZv2vlQfbAkEFs++Lxa8YxmaVIvCCiVZn70xCHYmDKDMCiWkBasgwxwtgtWlsZjBq7cX8D1yjRp+0FxauKgKhGNjStQxXMwQjo9AGLAzBCURNNpSS8xgMUMJlSqHMtXIiRRNcWRBY84Jg5mJIh7KoTyVKYads8hN5MaoVLh1wm0GC5HnIBXkSk5RwxiBj3MkyAXqidJzt+7V+ekJvMUxXKhrlNB59faiC2daTUSOQzlRGk4PSjuDvfgJHOYCpQX6jdKK1GECLjM3pLT4rx9xjMcsYqpA7YaOM9ZnHu+FF5SjuvdqYd1kLx8WsYJrPkeL2rD+5d2G/El6IgM1ccgzNEJjBlMiwCImaErB7YxFTPI5sj4TGYuYxg8lTWR9q0uMmElnOOesf8dsVdAsY7WQU7ZcXtFkUyhp0NDzvSf79K8NYjAvbAWrecA1giGxkAIjIInhLZ8XOUY0S5U6DbOCvrwV/HhxcQbGclsaSFWGfuEGbWGG0laFSHmeV7D35GnMlhHLcMLL3BK0VEmL0n3lRZEHlSTvDUG9a7C6wYPWSt/HA3AJ6CZ0MJ7GUEoetEu2NuYZkETR2AjiOO6CStNSa8xI4YUmlVvh5Ud8bW9O3DcYZxEL8mL9/Sf7ESPT5Ja0J+13+yyq1SSkxSlqL4FxOd2mfETDIKSnIJQkV7kgh50IzMkxQE0sSpDKAt4WypCXKSi0spha4FMupLGQI78WcjqUBqURVtxgk2jcRMzOf/05UB+yiVJDRrsQfQ5jpfJ4jb82M4JvucjNNgMvS21nqIP462nLiLmBz+lxS/6fFBOZDrEL2abUyEAFGR+UpnSW5/i54SJ3EYQcfsYNSW6MgJIGs7ZUSMcZt3zMDQLPeGEpIHFDxhSC0ERIH+Iwxzk6D94S1D1sn/A51jHUi4r8fRtBsFPMVo4IqSrzzPEzJpcrZXbvvqPWpttCXP1ai3IS9NcQJijpcEpuS4117HIbtAGfjt+TDS6EnVGKeLr37f4zyBSaYK3C7BSRyLax+QzDoZTiQ1mL6PgoHsoJOhgjqexordCB1i/9gxNlD+rhofxQKstHeJsiZpjRtF9pZBAGCL4s56x/yXbSZRFrU2BXmwxE7LY3VT0i0yMeWH83qd8NcRmxORrDpzsC0S/+wVp9a3sKa3Z6r49do93B7ZBCucZCI8XTJslmrO9QoIP9J9/Sn6c+jsYPD4TL1ZByxkNThHXWNEWJWqQuQByGJHGPtVzM1iZCAfONwUmZ+1RgdSXklNxVZJTyJxXccC1UafwSA0JCI/NArqYi3Sm2e9UwaErcR+wA6LFpKmLTtx/k0Rq52eXGBzAr51z2NPLMGZqf6LLxSnetzd8YV1utvXTDSXcyHyLRbuGHh0H87ZF1zqrzFWlfSxeWhQSlM9SkH6t5ikMZtMJTrYwBg/pGpAhcpzNBKa7UaNbh3RPm8ObN8VFbwtk/cfJsf/y0h+nTZ7397/C73jhNx71ne/vjf+2lT759ht/d7xufzPnNB80tT5SFl7vVt2wWcZcrS7pam/tWImz7xXLpsm4TUdNB3A4G01ILW7m6U+nqIE3RGFcVs/7lFRWHlk+pLGXK1a60/21P6aqnucVczIXtjcv0GsllZ1WmeY9ncyF7uVq4QEeuf+7Y9cVtzuWUZFMVeO6QsYjlfIw567P/KF0lqau3WcS8qZPrzwulLdwNJQD4ynzvoBCR/32o5ERMSx1qnyVMtJrD4watx8/JxFJFVU7anA0vQOKiTaHTfV7P5YU4lsZyOnb4mau9Oy06XbdBjhZE1gevwOeQJJ8o3aETCloy41JmOBESs+4a6F0wnciVFLCEF8AXXLRQxZ89XHS8jEQ2lN3nbBmt5P+Dashdcir3miIveHpNWWLOhasngwo6Qzm0Q1+A39oh8z8n89VXZfw3VaDkhfDyhyGbCjsrx3Gq5slaL72potmO6UkpU7dbp0uKHlqRQf8FDJnIRsFdhgySJEgXPsInhEsEh7at6v4LaIGKT3CxoXhaxAsRDny7FhycHfunG/qnlTqiuEnLVjTiYC9nx/HRZzUVhBp/z9PrqaaY0OlGILJuPLjFtLToAYqJ2+YfL0CK3ItqaCdzG78stJB20lEmPrcZah3BMIQIl9XoOEWSe/cAUO/e9eGbm+FQDpnjrvuZ7V6Wee4PeXVUaqz3q5dDuWwa4lllZy4o1sZIseXeGKB0NfIPh9L5+Xog1pQ8wryDQlA1VPiY4GYWDnA9wf8iQ3kER+R8LuPPEGaKqBhQbi3PXeEffNVV/zNrC9NPkiLnlddTXGhFEdfESle8EIbsnAifI7YDTlxULslyyIWxZLs8z8GUBWHCbCM6rdsCsYsKrcDVYLxtxt7jHRvkP18Kt3bER86xguPOy0bIRN9y2e6D8FYfZI2aiFGllKZKZy6KugqCqBycHbs8jRrqFASFykVaxbRq4D3e+P4AT2duD5ijnanMHdwLrW4EFb9jzNUigtJ4eCFWgJ1xS5QMt8JMBBrqMmlPhuam3GDs+T1c8RdaWC1++tBOiw/WBHdrR9Z1ml6AMjHKG6GVvByy7wcHrwevRxenPw1OhuxqpYIBlTvAIcQELzcuQdTpKEQ9EmPtDm5OA8tBHYU2YhVwQxEqTOt7kI/g0PXf7t+EGxP4KcRIrNNiY8d1dlzT79YJCF7A43UsfwyPKJJ/PozTYqurANND9WELQtwKSfmTPcj16ib6kD5HoYs5UiPS/N7o/cKOHICRbyp2RBbYQBdTYBVaSJbYwOaCSmfI1hNaoXcloN6/v3DrPnxjXPiEbwC7bOmqL5Nd9zKVuoqzUUdR60tM/ZH7SxqPnW7devSVWbN9uHlgfUhLst169P1FavdeeJo3SmTQaTf9YKyyqku19FRt8vEFmdPeNpLk/4Wpe/kpfHrbqZvPG94XMfPXqYeaRLeW2oNKekTXWLH+fQeCiN3wvMQdBwPK//XSlTWvpv9t1X9b9V9p1TTblxYrJhxCO2N9ljirTRxTidvNJO8Xtjd2qSbxLJnkTmRLqlddTeP5KjWVs3X9dReqrpHJy+lyZw2WOBfQgloyLrg3l/j2QrgDYetqbktOv1Gdc6orOEG7UPqa7rVck5WoxPCbKiHl0neihaUCjeR52VxxqKRROV51avCpHyCwsZklNfjE3YFIm0zR9ozlVMN24yDRuq47p+sYz8+YG5GurmhIL35kpXfaj+zLC7c90w9tTVXOyGjqJFcLt02rfjsMHcvW4JuWalx0ijOcq5pBTzShv6TUVBWeATWZ5EKia6G5Uajtzif60MKiXK9xotHMwNV9Bjo8F9zXs+8ClZGvDN+RO7SHHk7fXztK6nSy16GPxiWcFiiPj0ifkizg+MhfeJLc3LovlIP1ixqdVy90Ev9Gz2irB6ZCad68QK5UCRIxI4gtw6NS8xqrteEtFguHhbyDkgRZIpVWJilQGzqf9bzIeg6j6yd/3mR09Vbpa1PwFA8K8RMlogfihkVNoJfjDeZ/PRvU15YTVd+H8tSlSpxzQSoNR8r/eD2u74YJ2bl/xra6g4/gWFqtsjL1x+YjlZZ0SeUPOu7cmudQlONcpP7gR6FRGKtd/8gFnYOzYxPDQfsBDbqgo2ReuTt5xyxm4dTC4YbnIoOzIAzwJuWNNYYzv6OjQme/uTI2r0g/1BiGsVYL4w/JQ/noEZwf/WTCDWgWOAj91zGa+kRjGld7IQQ2NOhvq1cbNm4BjSO/6pRPVJ6rBfkjtTNKPkXTJxgf4efwO5wMPsKRWshc8YwIwO/5EImmQr7S5yOh7bU+sDnw8M9XILGbLKE94tq2BHNZlOM4w5u1x4WBJDQyTbI+p3Z3yvby9eDg6JfBmsJGy9Jk18k4V+Nkzo1FHVqYJvxPMq5t4knE86zblG18MrhobyXLKdpY6Wk7QqyG16hPdRX7U3zS/ZpolZW4hdehHeTiVujmVjO8jYv5eiv/+0sl+xXQooO0E+0PanOrNel7t1t1n/8US5iqbTsIaF/xG97eas5vULYtwSBdXMWrJwnXVkx4ahMzoySSrBuk3T+O9j2/4ffYLaH1h7CV3Rbz96YtWme39XBtE0nj8qX7NWVLGdBnrCbmTbSdt5RUJmjTWff3wu6F5X8KeE+8xQIQD2c/nm2YokdGF6wtG2kNtzxxQ+p/GHQxK3aYs5O479y30FaF2AAaRuojQ8N4k23v++NoHaSdkeJ1Oa7aW+lyXE1xbtqIm6MJfWn521dFS1vd43uvqfHe2iql9oqJhWqcyuqh8O1epF8Jrdmd4ejuRqRIV9D91Wn+oODpDOkFShZtnITJ97h77GQc1prk5+PDwcn5oLcXP4lndp67UwrquTmdnPsrfTqOW2Uab3zUJSednFEbX8fmJAxX3xbK2DmXDVwP7x1vHrAb7x/+/W7sQ9+NDUcYutSgGynhjqLOPO5Cw+WSuVMFzSVOWcR804VFbN12oRdffeOFRawv3DtWdONFy+/u6P27NzpfLmn4Q4maXm+4WvdW/Eu2wrhX+Fh/wnODn1By53U4g3c/dVlxH3NhkMuq0Q9lUWh/iowtr5YRmyHPqOGxaqnSCahotlC33nRtda2OBj8PLgYscm2Oxlu+K3HVHZXLu92I7u78DKf05XIFMBz9r5bL5f8ADF/KIQ== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to delete trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust +relationship. + +Once deleted, the associated issuer will no longer be able to perform the JSON Web Token (JWT) Profile for OAuth 2.0 Client +Authentication and Authorization Grant. + + + Request + + + + + + + diff --git a/docs/reference/openapi/delete-workspace-api-key.ParamsDetails.json b/docs/reference/openapi/delete-workspace-api-key.ParamsDetails.json new file mode 100644 index 0000000000..e5bb20c286 --- /dev/null +++ b/docs/reference/openapi/delete-workspace-api-key.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "The Workspace ID or Workspace slug", + "in": "path", + "name": "workspace", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "The Token ID", + "in": "path", + "name": "token_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/delete-workspace-api-key.RequestSchema.json b/docs/reference/openapi/delete-workspace-api-key.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/delete-workspace-api-key.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/delete-workspace-api-key.StatusCodes.json b/docs/reference/openapi/delete-workspace-api-key.StatusCodes.json new file mode 100644 index 0000000000..43a11f043d --- /dev/null +++ b/docs/reference/openapi/delete-workspace-api-key.StatusCodes.json @@ -0,0 +1,60 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/delete-workspace-api-key.api.mdx b/docs/reference/openapi/delete-workspace-api-key.api.mdx new file mode 100644 index 0000000000..05d9b70a91 --- /dev/null +++ b/docs/reference/openapi/delete-workspace-api-key.api.mdx @@ -0,0 +1,37 @@ +--- +id: delete-workspace-api-key +title: "Delete workspace API key" +description: "Deletes an API key and immediately removes it." +sidebar_label: "Delete workspace API key" +hide_title: true +hide_table_of_contents: true +api: eJztWutz2zYS/1dwyHQizUhkmqb3QZnc1LXUVn3YPtudfrA8CkSuRMQkwACgZJ6j//1mAfClRxOnzn24qT7YEgjs/nax2Bf4QGPQkeK54VLQER1DCgY0YYKcXEzJHZSEiZjwLIOYMwNpSRRkcg2acBPQAZU5KIaLpzEd0dgu/0OqO52zCE5y/guUdEBzplgGBpSmo5uHHZ7XCZB6CZmOiVSt3zotVnRAOc7MmUnogAqWAR3RTTWHDqiC9wVXENORUQUMqI4SyBgdPVBT5jhZG8XFim63g0Psr+UdCDIdH2Zk8Omcx4/ic4uTdS6FBo3PX754hf+6vCdZblCjfh5hCogGYcgmATEgS6kI3LMsT2GAs2ShIj/LaToOCML/6fr6gmjDTKFJJGNwC3docz0Tpsx5xNK0JC9ffB3Q7YDGsGRFahBaJIUBYb+yPE95ZPc1fKcR6kNL1H39acNEzFRMzlVJfr46P7PWA0pJhVgyZm0lV2gthjuF2KcHVGIXVbD3VsWwKFb7q8Y4TFACxoUmdhbhwvHmUqCeOOqAFLqwChDSELZmPGWLFKyRJ0wTI8kCCAgcjBGzV7+XM2aGLZgGwmKWG1BkwzQp7GxcuuQiJiYBAilkqMrBrlkMjol9xjJAeHa1VQEa3z4CNEDQBuLaHkgkizS28ixw5wsRH+U77zDdV2L9q1HlslAmAdVWJpHC4hTMFAqIXDaou4DPF+8gMmTDTYLn+uuX37z6lsQStEUL91wfVBGP97FNx6gdRgrB3xeViqbjYCaWYGHMhTTzZkMnSv3gHpxJc1INz8T7Qho2h/sIIIYYp/0bRyZ+AOGLIqOjG3qQLh3QLgV6uyvAgN4PV3KIZIYoAx0dJvXZELcDmoHWbAX7avrNPWi2r7EnvyY4pHHnO+boO/ZpnqJHUZArQNfUJtl2Ob1XL14NyKsX3+CfrwckCIJ+xxrwOXU2REeUC/PPVw0ULgysQKF/roakNR6cwo21phUIUDyyDuLU+yqc3/jkG3+6bptFtTNyfuWy8StdNtutdYZtuS2tHx1Ty0hDVChuShvDpCp349zo5hbdvga1Ph7p0EOegcHgZXdJyZTkKRNgUW4SHiXOTUGMLiVjAvezlIXqLM2VRNzaeq46EmrUeKFSOqKJMbkehSHLeRBJoWUKgVRloBOKIA1bIcJWEL1Fw5WqHCqM8zzjZrgoojvA3Vqw6E4ulzyCIYszLoap3FhDx62/shvs5E2ZWKGgZQ5XVnA6oClbACL6TqoyjFLuHKNzXrj1WS6VIQ8zQQghbZ0O3NCpFEu+KlyaMRNbslQyI89b5J6/nomZQCkN6rSZTd4QAZsuhV7/dTWX5XwqMHZF4Ge22fc6pPqWRwqm0faIuBP0moThx5MY0vOxFre1EDEsuYC472jaFGMa71Ks8pKjaytJHvxZHNgQRbbkDWEbxjsiBgezs55Tci2UV7oHNBP91xRzJr+xP8rWhgpm+Brae5mz6A7NNWNcIDi/t72ZmJmZSzDuzYy6n8us/iq1+yZzECznblfJjK64SYpFEMksbHZ7uJI420q/LERkufX6aEEzU8tBRm/IrDHvufdDM0rC0GuZfCAf3zYk6pXhSPoff0Kw2jUEODNdgxy9IR0hgzPY7JgnLmI5P3VKOLTg5GLqnu6YKK5UA3TOuKymETRbfjENxgetwO9N8D2L7lYKk4hef9Cyisog+sHkHqLCgMPJl5bbP94QwVO3AzOzzEzwQ664MMue1MGViUGpAZn53A5zW4JZKGrs7cexvX07Il+tZzMxo1a2/ke4/FCkqUuJqyyytd6t3s7Etm3WF6VJpGiZNvrBo65KqnLuHs6E9UXNQKBAG+LnneQcg3bu/JadmVvA1QT3C83kGRnjmUaNYHhNJFLRRNq1LLVe3rsAm6RW3j1PWem2K6giAnp5lnONpwYJXwF0nWKQl7ZAYCTl2mD6xtKU6CJHTBDveNCmdAuss+k415bgXSN2TsSKgWfmU+FWx/qZPUfeDWRFy62D1Q8rTALC+BLFageHpOL/2UWNxLggLIqkiq2nt+koUsGA64I1qUI7yWXKozLAVRN3wLWrpliUWB4kA5PI2BZhuZJrjjnaAlK5GWDQdtmRW0lMwgxS0sxwveSgXRy3ZHBuxDQETt7TWr7vgSlQXXlGZD/dePRusCgCref2IONsHYBYcyXFzYx+Pzm5nFzOr89/mZzN6G29DROBVQ4j3j043TFBeBU2ffKPqqyOhJ3TwnJS+aEdb0WYRh/lp40cyGfkVAEzcJwJ09rLk/M5b8J3i2Mnijcs+juhjrwhz/cCxHPyDL35J8aGOlTOeYzkqu+HqbUDg12pSi+2E925vxZA34Np5rRl9vF83oiAT++g7O267TmPvexg/RGp3RLuAbQwWIfUm9FmQsdbtxU7/Ncx/iPylbbulnxFoG/Tzfuhju+GsYxsEd9KD7GxwFeukjzWQOr1qxaSSzIP9H92S7DP6DB1WzsYHNrtn+l+UX2IS6uRtEPP9oNMocS1I7KWPCa9bpOGLGRc9rEgW8ldzRwJ2+a+FZH/D9V0VEO5C9kH7efAkXiMbr6EYlz78CM8nsZ6sNlzb0BoLoWT9g6L02PV3YCuWVrAsSoPBanW12e4XvP3Wf77LP99lr/gWcbZLuOsNWKlNwkd0bBp/IQP9fdtaFHq8KFCu6VN8+oK2/iul75gmkd1a995ABypZcO0HfdnYVPS7kw3tDdVYt76EqcuU7mxbDqZ7KlvMXYGf+90rJIyViyIIZO+YRU6oiH+RUkimTsB5HKZcoHsT4gdJZWqXdrim+WYuShYKtCJy4c06bGUM5fZv/VU5i4/fovW1R16PH13MSawkU0v3SRMaM9zENMx5voC++LTsbMS1Jtd94l6MG5Rq1XqlI7qV+WJxewI71/WSF+kcE1AxLnEarSUBREAMUK8aTcZffp526sgbTYbiwUbMhgIwkgKTBR1mIPSWKkOncqGFqNtAH/cZA50Uh+Ju0mZhymsIf3fi4HXFmIpq3s0FtlwCBnjuKW+uP7ON2Drm0VEduWe0b3+8zMyxfZwXESugTCWUYG3Sq7csxV8mpK8WKQ8ciUwBm2ujbJ9OdsuPrmY6oCcdB/gIIkY3uOkJV4aOWEh9rUbI2uW8phceGUQZ1LOWANy4ThaKlgFZ1KbtHQday7IQsmNdu2CmXj2jFyNf9EzYa/fYi8BcYIuQFd1nW7dxXF3u9TaQXfLWTNsXdtpS94qA9csZZrKDZ5HbOwUbAV6hDA+kF/9b1/nfCBjuRGpZDESIJ/zQRLtDXmizwdEO+x8yO7A4z9PQOIwWUQ7Zsp0FHOTF4sghnVz4vxA6BvEOmyq9f5B3d5cTk7Gv00aCjutYB3fhYtULsKMaQPKt4a1/x/GTJnQkQiyuN/WbXA2ue6yEsUKTCDVqush6uEG9bkqA9fLCPtPiVYaAXt4LdpJyu+5arNK4D7Is4aV+/2pmn0CtGAhHUT7o9xl1ZA+yq7u6n8RS1jJfTvwaH9ma9ZllbE1iK4laGAqSoL6SciU4UsWmVAnGETCplXc/+to37E1O2K3iNYVWrXd5tk73VWttdtquLKJsHVV1n9K3WIEdBGrjXkXbe8PDCpLMFHS/1zYQ7/8i4B3xDsiEJTh4qeLHVN0yLje8Rad4c5J3NH6XwadJ/kBc7Yad3cYHbRlzneA+pHQd99bxhvun76/jtZCOugpLotF2WWlikW5gkx3EbdHQ/zSOW9PihZZHTl7l3gF0WEVYR9FB1w23Ooh/+0o0idCqw9HOLzF4hHgSw6jum49yVmUAHkZvNh7QQDPHrOPrY79Wh3+Oj2dnF1Nhi+DF0FistRWKaAyfb68ArXm9kYsNFK3XtGoUk5sEIHSLo9NURk2v82lNhkTLVzHOt67JXXr7bTHv6PoE3W8wMAbKG4LLquEB19Jt96DQOyjTi+hquhGdfF/O6B4tYXrHh7wfbDfVbrd4vD7ApR9EQQ7ZIrbV4bseyBc21fK6GjJUg1/Il3v0peY/U+4gDgmnB9komy19+jAN/Ia6ezbkJ8LrdXh+AwQtTK3t9sBTYDF2GGom5VYcuTt5uTeK4mdzsh48uvkekIHtq/Qeh2zLtaqFsbNw2FcDw9uhhVqu+3CRIzb7X8BWCy51A== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Deletes an API key and immediately removes it. + + + Request + + + + + + + diff --git a/docs/reference/openapi/disable-my-other-sessions.ParamsDetails.json b/docs/reference/openapi/disable-my-other-sessions.ParamsDetails.json new file mode 100644 index 0000000000..f4e89aedb6 --- /dev/null +++ b/docs/reference/openapi/disable-my-other-sessions.ParamsDetails.json @@ -0,0 +1,16 @@ +{ + "parameters": [ + { + "description": "Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.", + "in": "header", + "name": "X-Session-Token", + "schema": { "type": "string" } + }, + { + "description": "Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that\nscenario you must include the HTTP Cookie Header which originally was included in the request to your server.\nAn example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`.\n\nIt is ok if more than one cookie are included here as all other cookies will be ignored.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/disable-my-other-sessions.RequestSchema.json b/docs/reference/openapi/disable-my-other-sessions.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/disable-my-other-sessions.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/disable-my-other-sessions.StatusCodes.json b/docs/reference/openapi/disable-my-other-sessions.StatusCodes.json new file mode 100644 index 0000000000..89ee26639c --- /dev/null +++ b/docs/reference/openapi/disable-my-other-sessions.StatusCodes.json @@ -0,0 +1,182 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Deleted Session Count", + "properties": { + "count": { + "description": "The number of sessions that were revoked.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "deleteMySessionsCount" + } + } + }, + "description": "deleteMySessionsCount" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/disable-my-other-sessions.api.mdx b/docs/reference/openapi/disable-my-other-sessions.api.mdx new file mode 100644 index 0000000000..ca89d9976b --- /dev/null +++ b/docs/reference/openapi/disable-my-other-sessions.api.mdx @@ -0,0 +1,37 @@ +--- +id: disable-my-other-sessions +title: "Disable my other sessions" +description: "Calling this endpoint invalidates all except the current session that belong to the logged-in user." +sidebar_label: "Disable my other sessions" +hide_title: true +hide_table_of_contents: true +api: eJztXP+T2rYS/1f0nOkLzIBJLtekIXNvygOS0Hy5u3BpkobMnbAXULAlnyQD7vX+9zcryWDzJUmbpE37uB84kKXV7mr3I2m18pUXggokSzQT3Gt6bRpFjI+JnjBFgIeJYFwTxmc0YiHVoAiNIgKLABJN9ARIkEoJXBMFSjHBiZ5QTYYQCSQiTJVIjMcQ1hknqQLpD3jf1Q2ppoRKIFxoEkIEGkLfq3kiAUmRoV7oNb2QKTqM4Fl2rCcgXVvl1byEShqDBqm85turNUH6YPnL+zoTU+BkPgFOAifjSIqYcMHrQynmCiQJIgZcK5+0VuKYZhOqCCUjIWOqiRiRi2cnB29edZ/Bsx+eLd5PHz1JHh+Gl8enh6eHnah/Qt9foBgM+ZgADUF6NY/TGLym97ruOKobjryap4IJxNRrXnk6S7CK0pLxsXd9XdslVFuIKQPy2ND2yRkOFo6XSiBgNIoy1PQojcrylsfUSE+JAjkDWVcsBEKTJGKB0bxPenYsB1wFwKlkgmQiJXGq0ByCKA3BsPL47OykzA+ZT1gwIUKyMeOGmTlVeZuQMG7aSbhMQWm0kUyk0vHhD3iLE1jQOIkANU2XI+HabemPqSa5EDI7n0qqhTp3LY7o7fvs+OfWMPw1HEf3br24vH36SyyfxMH7jg7VjLXPflnci+/T+9nj3sv+D6/o/bN7k9ll9uhMPX3M7p6yET949XKUtJ4s7ndeJbf6Pz2KoMfvzyYHbx4etm7fZeH9O9PXD8/GvXE87x3Phj+3+kEmF/eyn6O7w5NfeHtxcA+Cw1enHU3PYN6+3U7GaQidnw/en57yPm2f3OXZnQX94fLp4/rpy/Gby/A0Fa3zpw9vJ5PF+EX75agn209Pj6ciev09n935Fc5HR0cX/oAPeE/jmIspYSMSC4nDQTkRHEhg1YOetVT7BCQQat1XoCO5WorMWRSRIRA25kJaB9xquVbpHzTYdzVPgkoEV6Dw+cGtW/gvEFwD1/i1YGKN9wqN+qpAr2ztHYsISxdui5Rr9HuJAKGZ7SMwpRuNzyZAeBoPQaIZOZNQFp7mqAsJMzG14lrH9poe4/ruoVfL5WJcwxgkemJeJIbvIUAmNNMRFljYepbluGSZvMYmZYZ2VKx5h5+lJJRTacpDKkNyLDPyU//4OWmd9AhIKaQDLX9DbebpJrmuaZQP4karEIbpeNtIDdMxQQko44qYWoRx27dBkxyiUpUaSEDEpzPKIoR2QnloMFYLNETgWGhGxiGBkxPniyFVQGhIE41IQxVJTW1sOmI8NBgBEcRgTGXNQGu7xH5OY0D2TGujAjT6TQ4cakGIKhKpDNDZ0ig08gyBjETKw539npc63VTi8tdKlaNUGmctKJMIi4Sc6lQakFxyXWb42NgqmTM9Ib0OuX1w5/B7EgpQhltYMLVVRSzc5K3XQe1QknJ2meYq6nX8AR+BYeOcC32+GtCulA/tg+dCt/LiAb9MhabnuHwABKWulKdY0nUFyD5PY6/51ttK16t5ZQreu3UBat6iPhZ1JFNHGbzmdlJ/mMXrmheDUnQMm2p6Zh+shm9lT66Nv03jSlOdqvNAhFtotkWIdpdIULg4KZC0zQg2I5XDW4c1cnjrDn7crhHf96sla8DnnwV0Y+AgWWAAou2wCuujSzAJIQ6a9a53q0ZLMLK48mKFK+VutuClofXIdmph8vYeJvcwuYfJPUzuYXI3TIYwommk91C5h8o9VO6hcg+Vu6ASGaNjZSxDmt7N2C/qQmZ1STVELGa6PkyDKaCANrhUT9JhxIJ6JObGMFBVfaMQG4SMKB+jZ2cJ9E3XXs2L6BAir+n9KGTWsDFGjKIYZ0dVxYmQmlwNOCGEPHS8tBJWsyVtwUdsnNqI6IBf28jdzQK1mw8wHhQIrjQayqo2OSIc5mUKleqDvC5NWI8j1AfgahZ6r5QoVU0XEWiycAEME75sEmtzD0ij8VdHXElFmJGmUZVU3DSIIJ7yEEaMQ1i1Ati41zbO/8SwKvlTo6pkH1T9hKAqIV8rpPopppk75ZVD4Zo9HrkmR4TOKSt5q7/9TKRiAaPkoQ5ELGcDXn3g4bGCg6lHogBPnGo2gyIyJTSY4uQTU8aRQYdUlQEf6IFdXi70wLM/R/Hyq1D2m0iA04RZJycDb8z0JB36gYgbK/CqjwXWNhoYpTwwvVWqiIcDXRKFNI/IwCsVnTurHnik0XAeTX4j3xAUoRTOeAz79vtH+N4D0R6IvjYQob+haRaXC80jUvJZ/znM1xYP2IgmrG19eluD1knPPl1bQWBL3AbWiKzhehMbLyn5y5XHSc/vbEc3Bzj+f2kwHUvcF1WqVf91EQ8qJXSo+taUKlYdVb+7gCDVYKVgI8PFv44IZ5GFm4Eexdp/mEjG9agilN/XIUhZIwO3jS3528XHeb64aJLvZoMBH3hG5upHenmYRpF1gnzDXGhvW1/jR6OxrGAd/WJH/03S2XbuhDQ2mRCpRiZelCl/gpRFJkEl1QG/Lk4zJ5meCF6YanCJvXMhjL5uHw644WBV4McihEj59iztPM5yNMCtToqJCpbEDpnXqUlEKNeklbCuyWowi2xTMzHKySvYX+g1N0gHZ20LuUAmQllvdZ5lYg9ukjcBiInWiWo2GklEM2u3fiIF7lKUL2RGE6ZwTkTCfYDyCt5PMpx6CCURU2b6QSdXaYI8Qbi23F9lRPhmOVHaCRQEL/u0XSEYMXCG+lR280kb+e5yDJ5Q4lzURggowrrbXriYAm7c8rE1dQpMtXIsWMMNg2wJc9WaltsbpC2BatjdCVXKVsW2bLXNKfRY3O2seqi6VVRuW+d2GXBEbq4V5ZP4TXIDp/Bvbd2xWvYh7+V1xybL+yXHfsnxZyw50Cq1zJwbW1d2swqJM0crR/VVJXTP5Yx3VPLpfDOE04FpvpwUKmsOe7T2u+aYPnLrg1V3BusrAxehdd2KUTE+Uv/Pzn6bZi4skrP0ikK4py6Tbjn1oE6hucnIqkLJ/z6RH/KdMiyR7whUvWsT5lLhtB6KwAThC+EqPBhgYxsJ3pl8V6nm6Xc26uUyhEqLr42w5Ho47q8GS68YaRzRSAEuWZwoQZ7s9Gky7NHzo+j57xuLO50H/1AItcLZz68Jplts1uTc6VTyM2upW9e+eCYwFuvOvWufpReFrdLe0/eevvf0v5WnJ3a/vX0q37JM2uHj5cVSyUP+9i6+9++9f/8t/buytdSPw6o50oaFBm4vyKArTyFDT95+pl3zZjRKYevZNnpP3ni5U1g22O8Y9uuIPc78o3Fmv2PYe/re0/9fPH2/Y9jvGPb+/c/07w/uGJBEDHoiwuUVVePaeuI1vUbu73hKb2zCunsq8RA/Pye+cqfD5ypKx9dbz4obZusgGaKJOXAoNrEJyu7Wgrc6dd5wuDdom3gh4TnouZBTcmKpEKTikzciJQHlNmmf6dxK3xZbtAVXIoJ3lZz5wBYgs76aNHLmG+61Bo0x6LrSFM/aq77Tl4IglUxnfbxAYeUZUsWC5aUKHApbsgQQ7A+BdghUgizXtEUbVQVN9eQAq44iMTfdYImQ7FeDCm2X3F0qfFkamkkWSuqHEItcQEu0gZ/mJrdIrABiNIoYx+5bxJSS3NYsbDmIQOSSMJKgJhZ5FanQiFFlkhQuHJVzGgSg1AXOEuWi30/fvg6C4xUC74XDKcrJcQK818Hx5GgBvY6dP1Bvpt0n6sHOU8Ukdat0VL/MWoZnS3jzmoxAXF/DcYRlDhAiiyXDw5yEKWQrw5vP54YX9A7cXKMl4hGfaiQgFR6X1q3K6tqmMuUX7z9oMjJ7JeRUJTSAVsKe4Ab+d/JN5jmBegQziP58MfDCCB+J/AYTDUyIAWLKcEhd6suPdhxXbydAzvr2mbeR+X+D9LiWIkwDm97TEUGK93lsaozJr4kiYsMfJn2HhjHjTGlpcmIN6LROerjwKD/AQgM6gkcZgrUVFkKX3kKJeXEKOXHKINakrLH65MT2aKjgrBALpe16wczNbtmjzOsebtwg/c4TNeBmgRE6CYgVdAgqT31RhVtQDgILI4jrE1h1WLgwpQx5owxsMxJRJOboj5jEldIxqCay8Rt56n67E+rfSEfMeSRoiATIH/lDEsUB+UJ/vyG39dIfWS/4/X9fgMR2sshth0pdUszbJB36IcxWHucKGi45WzVWCU3Vrbp9+6Lb6jzrriispWGrcNoYRmLYiKnSIF1atnL/GyGVumFJ4JqhqFv/efes3BVPx6B9IcdlhFgWr7g+lplv070a1S/JrdAcNvg13HYjtmCy2NUEFn4Sr7qyvz9Vs1+AWzAsbeX2kVjvakV6Z3fLjPqvYgljsWkHjtuf6IyWu4rpDHjZEhRQGUz85ZMGlZqNaKAbaoKTSGOVFlr9fG7f0xndYbfIrQ1eL+02id+rsmqN3ebFuU00Creuql9StzgD2hmryPM6t5VXOKmMQAeT6h9lu+6afxXmLfGSCARlOHl8smaKljOm1tCiVFzyxDWtfzbTySTZYs5G4zZfucRtlrA1Rl1JvmUoGG9j0/s+n1vD0lakeJEOs3JXMh1mY4hVmeNiaQO/lPzti3KLXe3wvRcYtCh1FeDBlPKZKOzK8iL3bSenX4hbtX2Gw4x1FgBeL20uQ0OthAYTIAf+La+2thNG36PmsdGxa6saT3vt7vN+t37g3/InOo7MLgVkrI5HfZAzZrLfG1qowuXYfMmJO2eQyq5jI1SGDdgJpWPKC3ztTKJc30cXXgzwbbzuz63+MXEck86Z2cUZzV65SMRbbynMu5qHmepYdnWFV/dfyuj6GosvU5CZ13z7bhVrwF/XtfxNZuYlgVZLeQTlA6r5BuKTWxVjT2U3XyOYn+Wao9vfL+b+lYL/5xngX/mVgh+w5eWLBUsmbJ/hfjkppipsvMmkFMHsdJ92z7re9fX/AMLeddM= +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. + + + Request + + + + + + + diff --git a/docs/reference/openapi/disable-my-session.ParamsDetails.json b/docs/reference/openapi/disable-my-session.ParamsDetails.json new file mode 100644 index 0000000000..eb64f5e14c --- /dev/null +++ b/docs/reference/openapi/disable-my-session.ParamsDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": [ + { + "description": "ID is the session's ID.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.", + "in": "header", + "name": "X-Session-Token", + "schema": { "type": "string" } + }, + { + "description": "Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that\nscenario you must include the HTTP Cookie Header which originally was included in the request to your server.\nAn example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`.\n\nIt is ok if more than one cookie are included here as all other cookies will be ignored.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/disable-my-session.RequestSchema.json b/docs/reference/openapi/disable-my-session.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/disable-my-session.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/disable-my-session.StatusCodes.json b/docs/reference/openapi/disable-my-session.StatusCodes.json new file mode 100644 index 0000000000..e3cf93f896 --- /dev/null +++ b/docs/reference/openapi/disable-my-session.StatusCodes.json @@ -0,0 +1,166 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/disable-my-session.api.mdx b/docs/reference/openapi/disable-my-session.api.mdx new file mode 100644 index 0000000000..0712e0ce60 --- /dev/null +++ b/docs/reference/openapi/disable-my-session.api.mdx @@ -0,0 +1,37 @@ +--- +id: disable-my-session +title: "Disable one of my sessions" +description: "Calling this endpoint invalidates the specified session. The current session cannot be revoked." +sidebar_label: "Disable one of my sessions" +hide_title: true +hide_table_of_contents: true +api: eJztXH932rjS/ip63bO3cA6YJM1tt/TknssLacv2R5KSbrdbehJhD6BiS44kA94s3/09I8lgA0nb3XS3977wRwKyNHo0Gj2SxiNdeyGoQLJEM8G9ptemUcT4iOgxUwR4mAjGNWF8SiMWUg2K6DEQlUDAhgxCokApJrhPzsdAglRK4DpPJAHlXGgyACJhKiYQ+n3ec89CqimhEgjmCCECDaHv1TyRgKQIpht6TS9kig4ieJW5Yl7NS6ikMWiQymt+uF6D3+0Q5iDaAvcV6XZQLsPHCdVjr+ZxGoPX9Fjo1TwJVymTEHpNLVOoeSoYQ0y95rWnswRzKS0ZH3mLRW29sh5oU1XepHMxAU5mY8CWWzUOpYgJF7w+kGKmQJIgYsC18klrqSVtio2pIpQMhYypJmJILl+dHrx/d/wKXv34av5p8uxF8vwwvDo5Ozw77ES9U/rpctmqMdAQ5Kpdv9QdorpB5P2hRrWFmDAgz41s7F6mULVgup5GUUZSBcM0Kre3bDam9ZQokFOQdcVCIDRJIhaYDvZJlxM9prrPVQCcSiZIJlISpwotLojSEAyU5+fnp2U8ZDZmwZgIyUaMGzAzqvIyIWHclMOuBaWJNnKlw+H3eYsTmNM4iQA1TZc94cptqY+pJrkUMruYSKqFunAljuj+Y3byc2sQ/haOokd7b672z36N5Ys4+NTRoZqy9vmv80fxY/o4e9592/vxHX18/mg8vcqenauXz9nDMzbkB+/eDpPWi/njzrtkr/fTswi6/PF0fPD+6WFr/yELHz+Y/PL0fNQdxbPuyXTwc6sXZHL+KPs5ejg4/ZW35wePIDh8d9bR9Bxm7f12MkpD6Px88OnsjPdo+/Qhzx7M6Y9XL5/Xz96O3l+FZ6loXbx8up+M56M37bfDrmy/PDuZiOiXf/Lpg9/gYnh0dOn3eZ93Nfa5mBA2JLGQ2B2UE8GBBFY9OICXah+DBIJmHEVE6DFau8mlyIxFEdIAG3Eh7TjfarlW6bca7EccsioRXIHC5wd7h/ivbMTHcaIzssxnYCpkJjTWGo6y3ABqmEukMnC5ciYyfGYMQWmqU0UCEYItuCabqT7XWcICY4cHe/u+t6h5h3t7CCsQXAPX+LVg+Y1PCmFeF5pZxo+VK015SGVITmRGfuqdvCat0y4BKYV0NIFqTCQSpmZWGebpFnWYQjnkjVIhDNLRZqkOJhNsAWVcEZOLMG7rdpxvSSFVqWk8UjmdUhYhZxPKQ8NqWmDXA8dE0/VO9a6dOBEMqAJCQ5poHNtUkdTkxqJDxkMzKiGCGFVZWzeJ2k3Nfk1jyKcDqzc0s00EjicgXNoCCUQahcRNXkOR8vDGei9KlW4qcflrpcphKs3wKCiTCMs9nOpUGlpaoi4DPhl8gkCTGdNj0u2Q/YMHh/8koQBl0MKcqa0qYuEmNjtZUpJydpXmKup2/D4fgoFxwYW+WHXosZRP7YPXQrfy5D6/SoWmFzAPAJAGjqU8w5Rjl4DweRp7zQ/eVrlezStL8D6uN6DmzesjUUcxdWyD19wu6g9DXNS8GJSiI9hU0yv7YNV9K3tyZfxtGre8cYG8sSmzjWwiIZGAtFQUWaSbyuHeYY0c7j3AP/s14vt+tWQN+NyzNoTrGa4fHq6gMK5hBBIn+TxJGOPBLEwbaxoBB8kCQxBtx1WYf7Uq+uBG18dVoSUZWV55s+KVcjULlFRut5H1zFZqaXJ/R5M7mtzR5I4mdzR5M02GMKRppHdUuaPKHVXuqHJHlTdRJQKjI2UsQ5raTd/P60JmdUk1RCxmuj5IgwlgA607p56kg4gF9UjMjGGgqnpGIdbHGFE+wpGdJdAzVXs1L6IDiLym928hs4b16qHfwgx2VFWcCKnJdZ8TQshTh6WVsJpNaQs+ZKPUujr7fGF9ZfcL0u4/QQ9MILjSaCir3OSIcJiVJVSqT/K8NGFdjlQfgMtZqL1SklQ1VUSgCQubxBraE9JobHhR+33rRyUVNxMhj6Y8hCHjEFatjLnzOhqnY1Hc3+0nJRVhrIVG1VsbYL1V25D/hc5Q8pf6QsnOFfoFrlBCvpUj9EtMMx/Y147Ja/bdyYIcETqjrDTi/fUXJhVLNyx0vFMapC7Nguvz6hMP3wc4tnsmCizHqWZTKBJcQoMJzmExZRwxOsKr9Hlf9+0qda77nv05jJdfhbLfRAKcJsyOc9L3RkyP04EfiLix4sD6SGBuo4RhygNTW6WKtNrXLCTNI9L3WHjhTLjvkUbDDV/yO7nhZRCWLanBiikl3SDxO2IybIWzPQPffv8M7h2P7XjsW/MYjlU0zeKKpXlESuPdfw2ztfULFqIJa1s+2Fagddq1T9cWMVhS1nCxi8WWMvzlsue063fWadERlP+/NJiMJG7HKtUaYWHV/6XIA5USK1R9a0IVq4aqfzyHINVg0bOhwfA/R4SzyFJUXw9j7T9NJON6WBHK7+kQpKyRvttBl8bZ5W2ILy+b5Idpv8/7nmlr9TPyn6ZRZM0+36UXytvSiz5fFBn/NNNj84o9Z31cNN+4tMWhYx/2ueGEVYIvcYi6fK2E4aYosQtdkzMxgPMM9heazT3SwVnPcg6QsVDWXJ1pmf2/mySNE2CsdaKajUYS0cx2op9IgTsF5QuZ0YQpnFBQcA+gvIr2k8y8zqMkYsrwL1q5ShPEBOHaknsVdOCb6bi0Gi80vGzUdno1zUCK/lK4+YyHuI85OjAocfZqd+kUec0t8d2+HjdPeW+YPAVQrXxIrA0cM7QT5rI1Ldp7pC2Bari5EqqUzYpl2WqrUaixuONY1VDN1yLkiNxfzdr3yT2cqW6bsM3KJWfoCzt9HpH7a0mbAr+r+Xq11ELs5fl6E/Juqt5N1X/FVI1WqWXmRr9lADf3mMrEkMRZ3kdqlas4+PNdx0Wc5X1TYWFtfcgerf2uOYxHbjq1wsFMFmQ5Z2CroADPzBaVvrfKUBoBBeqp/2sTV5P8oMwkSH4gUPUWxjmkwkk9FIFxXRecPOhOZyPrP90Si1ap5tFo1ktUjCpbdzZ+Jkot969sxKPh7OzkllYin63i72a+UkuGNFLFpgR5mM+XtWFHhZ+lwn/cmz/oPPkv5UPbOPv3WzLjFps10WY6lfzcWupUsJBUyiFgZCDCrIoO+pFY54zNfYeeF7YNd0YgO/rY0ceOPr57+riRORK79d6+4iguq76IMu6EL8prtdvl/6fRxY4rdlzxvXPFbUsNjBSZa+BmT2aIYAIZDtrt77lr3pRGKWx9340DJS+83ActC+z2Q7sFzY6kdiS12w/t6GNHHzv62O2HdvuhHVfsuOI7W2qYY8Ex6LEwlwaYM7yGGPTYa3qN/O1V45qFCwxlMDZgGSOVGOmQv5q/di/kL1SUjhZbX883zO5IMmQi88aoWMTGZbvDGt7qRf/GAHuPtojnMF6Dngk5IadWCkEpPnkvUrw9wZ5VYDq3yg/FEm3BlYjgYyUHH9gEBOurcSMH33DXMjRGoOtKUwxvqPpOaQqCVDKd9fDciG3PgCoWLM+SoOptypIwsD4k6QFQCbKc0yZtZBU01eMDzDqMxMxUgylCst8MC7RdTHsp8W2pa8ZZKKkfQizyBlqhDfxrjoyLxDZADIcR41h9i5hUktuWpSlHCchUEoYS1NgyrSIVGjGqTFzIpZNyQYMAlLrEiaac9PXy7fUWHE9OeG8cL1FOThLg3Q72J0cL6HbsfIF6M+W+UA92XirG5lulo/pl1jKYreDN00ECeXyNt5GGOUCIEEuGh2EgE8hWhjebzQwWHB3oP0BLxJezqpGAVPiquW5VVtc2jCo/4X+rycjsnZATldAAWgl7gT6Kr8RNZrmAegRTiP76ZuA5GT4U+cEtGhgvCsSUYZe6aKN/235cXYOAyHr2mbdx4OEe6XItRZgGNqKqI4IUjzHZaCQT0hRFxHp4TMQUDWPGmdLSxPAa0mmddnGhUX6AiYZ0BI8yJGfbWAhdRBEl5hIYcuqUQaxJWWP1yamt0UjBWSAWStv1gZmL3TJHmXsl7t0jvc4L1edmQRG6FhDb0IG7ZMZKWh7EcRRY6EF7ScOywsI5MWXEG2VgmaGIIjHD8YiRbikdgWoijN/JS/fbxRb8TjpixiNBQxRA/sgHRRQ75I4+vyPaeulD1hO+/nMHIraLRbQdKnVJMR+SdOCHMF2NOJfQcMHkqrGKIatu1e2HN8etzqvjlYS1sHEVThqDSAwaMVUapAsjV+5/I6RSN6wIPw6rRd36r4/Py1XxdATaF3JUZohl8gr1icx8G2HXqN4lWqE5bOA1aI8jNmeyWNUY5n4Sr6qyv79Us3eAFgykrWififWqVqJvrG55AuCbWMJIbNqBQ/sTndJyVTGdAi9bggIqg7G/fNKgUrMhDXRDjXESaaxiZ6t/Hu0nOqU32C2itf75pd0m8SdVVq2x2zw5t4lG4bBZ9S51izOgnbGKmNfRVt7hpDIEHYyrfxR23RX/JuCt8FITCLbh9PnpmilaZEytsUUpuTQS17T+p0En42SLORuN26DuEtosYWtAXUq+ZSgYb2Nz9P15tAbSVqZ4kw6yclUyHWQjiFUZcTG1gV9K4+1O0WJVN4y9N+ikKFUV4Ls35TNR2JXlSe7bjUjvCK3aPsNhWD8LAE/VNpeuoFZCgzGQA3/Pq63thHHsUfPY6NiVVY2X3fbx695x/cDf88c6jswuBWSsToY9kFNmjgg0tFCFM8H5khN3ziCVXcdGqAyzvk2E0jHlBVw3B6Cub6QLFyL8/XcXuqU/BupjkD8zWzij1mvni/jgFRrSZOZwMp4PwCfX13hpwVsZLRaYfJWCzLzmh48rd4O98NDqJveT3KKPyhu3La3eFFl/E2aXSHlWeHfs1dyLYhZ6i4+LWn5729eB+g5co1ubbJu2eXXisvXmqsSvbubuGsX/54H83/gaxVtseXmZYsmE7TPcuifFwJCNu2RKHtXO8cvj82Nvsfg/1GfHOQ== +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. + + + Request + + + + + + + diff --git a/docs/reference/openapi/disable-session.ParamsDetails.json b/docs/reference/openapi/disable-session.ParamsDetails.json new file mode 100644 index 0000000000..d39fa7cdb4 --- /dev/null +++ b/docs/reference/openapi/disable-session.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "ID is the session's ID.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/disable-session.RequestSchema.json b/docs/reference/openapi/disable-session.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/disable-session.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/disable-session.StatusCodes.json b/docs/reference/openapi/disable-session.StatusCodes.json new file mode 100644 index 0000000000..e3cf93f896 --- /dev/null +++ b/docs/reference/openapi/disable-session.StatusCodes.json @@ -0,0 +1,166 @@ +{ + "responses": { + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/disable-session.api.mdx b/docs/reference/openapi/disable-session.api.mdx new file mode 100644 index 0000000000..599ccc311a --- /dev/null +++ b/docs/reference/openapi/disable-session.api.mdx @@ -0,0 +1,37 @@ +--- +id: disable-session +title: "Deactivate a Session" +description: "Calling this endpoint deactivates the specified session. Session data is not deleted." +sidebar_label: "Deactivate a Session" +hide_title: true +hide_table_of_contents: true +api: eJztWm1z2zYS/it7yHQizUikk+bugzK5qWuprZvW8dnudDqmx4HIlYSYBBgAlMxz9N9vFiBFUi9t0rr3yfpgS+Bi98FisVg84ANL0MRa5FYoyUbshKepkHOwC2EAZZIrIS0kyGMrltyiAbtAMDnGYiYwAYPGCCUDuPRfIOGWgzAgFXVL0WISsAFTOWpONk4TNmKJMHyaYtWHDVjONc/QojZsdP2whel0TAqdXd/huYHTMWkV9DjndsEGTPIM2YiJhA2Yxo+F0JiwkdUFDpiJF5hxNnpgtsxJylgt5Jyt1zckbHIlDRp6/vLoFf3rAphkuS1hIwdcExRpYbVAOYCZ0oD3PMtTHJCUKnRcSdUegKsFwg9XV+dgLLeFgVgl6Dtu6RYmkrbMRczTtISXRy8Cth6wV0dHBCtW0qK09JXneSpi59LwgyGYD61hdvGTcWO5TLhO4J0u4cfLd2dwfH4KqLXShCPjlhyaa5ooK7wz3NM97nCdasg7vRKcFvPdXmNqBhoBF9KAkwIhvW0XQlcUc8JAYQo3eAohvuQipVgBLhNYcANWwRQBJTW60KpcX42T4m/KDQJPeG5Rw4obKJw0dZ0JmbhQwhQzcuVgOyQGh4Z9xjOsA9H7jUJuFwEFHxqLySYWIFZFmrjxTGnWC5kctHvbMbrrxM2vxpWzQtsF6rYzQUmHU3JbaAQ1a1B3Ab+bfsDYwkrYBZyO4cXLr1/9ExKFfgHjvTB7XSSSXWx+mXIopPhY1C46HQeRnKGDcSuVvW0mdKL1d/7BmbLHdXMkPxbK8lu8jxETTEjsP9QyqRoIviwyNrpme/WyAetqYDfbAxiw++FcDUnNkMbARvtV/WmI6wHL0Bg+x103/ewfNNPXxFPVJ9jncZ83bilv7Oo8oWyiMddIaamtsp1ueq+OXg3g1dHX9OfFAIIg6HeigZ4zH0OUSaX916sGipAW56jZer1pUi54SERYF01zlKhF7BLESZWrSL7Jx9fV6rppOm2Skc8rF01e6ZpZk6buuJ2u771RnyZfPKXJpzT5lCaf0uRTmjycJhOc8SK1T6nyKVU+pcqnVPmUKg+lSvISxoUWtnS8hNLlcRyjMVfqDiUbXd8QgWD5nGgLJhKUlkRvKByULoeaW0xFJuxwWsR3SD6409wqM+RJJuQwVSsXOuTMS+cyz3+kXM5p7Zc5XjpwbMBSPsWUjdg3SpdhnAqfanw6IGdmudIWHiIJAHBaQTnOxcC3nCg5E/PCkzCRXMNMqwyet7Q9fx3JSMZKGkuh1EjDG5C46mro9V/XsjwXp5I2gxgryZb1XkdT35lI0YJIRuBD8TWE4Q7DE0We44FetVdRpi1kgjMhMek3QB+qeBx44mkNb4CvuOigCrp0U887RCSR7L9m68HG3d+rlpslt2KJbQ/nPL6jZZZxIQlA5fFeJCMb+Y303kbM/5xlm6/K+G8qR8lz4Z0NEZsLuyimQayysJmE4VyRtBvhrJCxs9br07xGViQwegMRE8lttcIiBmFYORI+wQGmjJRFtjunozfQARSc4WprhqkTz8WJB7yvw/H5qX+6Nc3UUw8oYVC3jY5gExjnp8G4OymV/4JveXw317Sh9foDEEk/mNxjXFj0eMTMaf3HG5Ai9V6J7CyzwXe5FtLOesoElzZBrQcQVXUFsXQQV8Tm+8MY3r8fwVfLKJIRc9j7f6D9uyJNPalXVy6t/r73OpLrdoidl3bhCM86zChLHFzMSpe3/mEk3XJtGgKNxkIld5wL2ihyv7SdZO4A1wL+F4XBMxjTGvIUL8JCkRYDyvXlqauJqiXnCqOFtbkZhWGe8tJPS5BrRdnTBEqXPBeGIpgUXyJ280aQl47i5JAKY6lk4GkKpsgJEyZbSaahgAO3uDv5pzXwbpD6teyGQSvjc+HWS+yZI2arJZkVrcyHzj+8sAsKF18WO+9Qk9Liv9uoSZmQwONY6cQlQ1cCkRbaigzqJWqotxPIVSriMqBeE7+WjeeDebxwNiBDu1CJo5FzrZaC6oIppmo1gMJ4eFUWALvgljQZboWZCTRQqkJ7NSQbc4OBH+/JZnzfIteou+MZQXeL++KZ4K7vraXOJG0ClEuhlbyO2LeT44vJxe3Vu7eTs4jdbKZgIqmq5lClAO83LkHUu0pVbJIb6+XgZFpYjuscs5WJgBvKP5XYyIN8BicaucXDRrgx1XhycSua3a1lsb3JNRb69eYCb+B5k6efwzPK0r+foqmj1WUF0gMdb25egNd3LM3zNrp6l7ut9PZEUoFBlxtgkyLIJ9iy4pJDL2KNQCdjtgY6/PeWkRF8ZVzCg68A+2ztKh+T3A0TFbujW6uEoeOkmPvzw84dUK9f3wL5Cqh9m7Ndav/B7VBdO+zcA/nLHltoeeU1LpVIoNe9gYGpSso+1cdztQ15e8uy963d6dHwfy76g8Bzv8ns9/cmPD4L8OOh/T1f00n13qIkfR7NHZZsdKiIHrAlTwvcV0zTVlv33YThRv4pHJ/C8XPCkaT97ktA3RWuQ2cXbMRCF21hZc+EDyJZU+3m9ncPvtBU2tW1yENVgdyatJiv99YjoYtRLcgjLm22u/jDecXYsaay2XHGb7TnExl3hnal9B2cey1AWgL4TRUQc+kJK2GpWCHHXbd7nChpVIo3vRp87BsIbGAWYQ0+jAutUdpwjnZoLKd6rh9UrqtrnEsiD/14ptyIeEMo0gT4ls3kkj0KlqkrSrqSvmlHVFHl8pJEZ6laOTOdWuakIjY6jb90pmZRJpoHCWaqHqBXGtJfmtRY5X4AajZLhSTzx+BaoQ4wv1lWFB3tlxpnGs0CXA1koMdTwX1t977ScuurpPcU892mL9fv362QRJ+xCy9EZc27HOXpmOZTUgScjsFTFkS10JfP9IP1nVoEjXc6uX+LC9mhiFVVprZfJClVARIxIYidwKOy6w7LJvBWq5XDQquDsjhFIpUnJsxRGzqrDL3Lhg6jo53+OGR0+avSdybnMR7n4i3tFF+IG1a1gmGKS0z//8MgslTOVM3e89jtZZhxQVNaHa++8fPYvBdDyC79M7bDej2DU2m1SorYHyHHKi6Iy/ZFvzvDpSnkxTQVsT8EUQ4UxmrHkrikc3x+agI47j6gRpd0lExLoqr9YDGpKngOS56KBM4rZ4APKR+sAZx7i04LnYMyZWxa0vwklL6mWq2MPzBG8tkzuBy/NZF0pH9SjQD8QKfVi0te04aNrVJgawb9mzobg63LAuPUO2dQn5lKU7Wi9UhH+4LP0YwIxif4qfpdVdefYKxWMlU8IQXwZz6koj0hj/T5RGiHnQ9sN3z55xFU7FdLaMdc245jrvNiGiS4bFZc1RBWdJ0JmzNbf69vry8mx+OfJ42GLWLOJHfhNFXTMOPGoq6IOlP9DxOubehVBFnSb/s2OJtcdU3JYo42UHrezRCb5gb1O10G/kQb9h8TrbISd/A6tJNU3AvdNrXA+yDPGlP+9+d69hHQooO0F+33attUo/qguQ3H+rdEwlztxkGF9ke+5F1TGV+i7EaCQa7jRbB5EnJtxYzHNjQL2kTChizs/3W0H/iSH4hbQutPSZu4zbMPputaF7d1cx0TYes+of+YvqUd0O9YbczbaHu/0qYyQxsv+n8W9rDq/reA98o7QwAaw/kP51uh6JEJs5UtOs2dlbjl9b8MOl/ke8LZedyz2B20ZS62gFYt9ZGhFbzh7ur762gdpL2Z4qKYll1TupiWc8xMF3G7NaQvnfX2qGjJ1IG1d0EkdMdUTASICYRqncrqpurbQaSPhNbs3+HoHkPESFero82R/Tjn8QLhZXDEBlsnYVp73D12Pq76mvCn05PJ2eVk+DI4ChY2S90pBXVm3s0uUS+FuxMJrTKti+G65KSTM2rj69iUnOHq21wZm3HZwrWPSd0+Qrfeh/nb3oSvanliuumaQrgzmfPTQ0UxXDNXXjtSwZMMbMBGwr12QDcdJPHwQK+k/KLT9ZqaPxao6Yr6puER/Iv0nmVJ2GjGU4O/M9zeRXXe7B+iqA9hrxq5LFvMHBtUPJxI2PpmPWAL5Akd7DfkHlX6eZvM23n/qEPDjCc/Ta4mbOCO8603+TdnpJo5uH7Yj+jhwUu4o8V6vQFYHXFv1uv1/wCCJ8Xg +sidebar_class_name: "delete api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Calling this endpoint deactivates the specified session. Session data is not deleted. + + + Request + + + + + + + diff --git a/docs/reference/openapi/discover-json-web-keys.RequestSchema.json b/docs/reference/openapi/discover-json-web-keys.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/discover-json-web-keys.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/discover-json-web-keys.StatusCodes.json b/docs/reference/openapi/discover-json-web-keys.StatusCodes.json new file mode 100644 index 0000000000..fa7b9fdad6 --- /dev/null +++ b/docs/reference/openapi/discover-json-web-keys.StatusCodes.json @@ -0,0 +1,130 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + } + } + }, + "description": "jsonWebKeySet" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/discover-json-web-keys.api.mdx b/docs/reference/openapi/discover-json-web-keys.api.mdx new file mode 100644 index 0000000000..0a59fcbf36 --- /dev/null +++ b/docs/reference/openapi/discover-json-web-keys.api.mdx @@ -0,0 +1,37 @@ +--- +id: discover-json-web-keys +title: "Discover Well-Known JSON Web Keys" +description: "This endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and," +sidebar_label: "Discover Well-Known JSON Web Keys" +hide_title: true +hide_table_of_contents: true +api: eJzte2tz6ri27V/RpWvXSaqA8A5kV986PIN5PwNk0UULW7YFtmQk2casnf9+SjYQIOR077N73w+3Dh/WsmVpzqmpKc2hIeVnTENcZdgRmJLYS2xiYg4Q0RyKiQAMCZcRDlrjfg/M0Bq0UcABQzsXM6QBQYGHGNYDTAzQdxBRaqBKCUGqAEoNTOgWEQ4g0eJLgnWACFxbSIuDftkVJsgkU6A1m4CyqiLOj7WT4NoCFRKwRsDlSAM+FiZQLYyIABZeM8gw4sDCW7QkPwjVUGLjb3mCcfjbgymEw1+engwsTHedVKn9BF1hpp6u6j0CaFNiACpMxHhySZakrGmyN6rLBbXB9qK/HOiYcQFUhqCQdWD4GQngYQiEiaIvqMUpmaF1GwVjJAB1EIPSufElgUST9QhQKdGx4TIpRTb00VrHxEAsKS1LrhmFmgq5WIX6T7VDMcCDlouk6zFRLVdDoYCjIQTaKBmLx85KFS32EtMwV6mH2KdhPBaPMcQdSjjisZefsUwqJf9TKRGICPkIHcfCaijkacNlbPyMcdVENpRP10FzGR5gjEQsHnOYtEHgSLw072uzDuYCUP06uuQYTEx07CbVw+4tQwnLGHAggzYSiAEsAwtAxmBwKwM8tGbtxyUJRfAkqARAQzp0LREPpVGmIXYS3Zq1I108jC9MwtJIrkYRXxJCBcC2YwVS4bmtw5COGCIqOsaQMJEdB9ASJnUNE1z4jy+JtHDWlr7hYUirJqU8HEXIOTYIgMBGkITxQC+M1CmTb5gtieMyh3LE4wDrQENczkA51lggO3TutcuhZXz1+CT0JbSMZQw8QMugDAvTfrx0q4aIwLqcWKEfTnUAlpGhIU2atCQuR9F0PAZfEoDzoPFotnKTupYGEJZzS85hhgzMBZILR+TlJVHKvTJYfsbPGBsECpchuWiAOlFZEJoOyic7ZBBEgliwJIgLuLYwN5EG1gH40ZqVfwM01AZPE8WEQs4gAbFci0CVWhbmmJLEkowQx1xAIkDvOHHQHtqOhWIvsdE4ky/E4jEROPKVCzlZYx/xmMo86djPmoPENzW163qTVa+oJApNlO0W4fM87c1EYfKq7HP7yup1kO2uc2P+Pi7nvARlXutwGOGh2bFGo2KawNlirw/LC5HHvKYUVtVMp7TWZjTXaAw2r8OG16OjeWLFK62goqyYlZhUDP6+oFOrvMm2SpmZvchgsi4nBn7Q0jlUlJqKFpVqAs0Te1x1C7vubvuOs11/WG50CuuuNqh3U4dcq6L6jUn2TcOzsjKauuXqbOizeXdXeM7sn/WuCxXYxM/z2qsh0liYmWy1o8NR3W5t3dJgqKrmWqzc+iJh7lhjUSBiIsY5B85mw02xsO90SrlxYqIXvMJ+2ymliwO9M+5PdoV59bD3rIZ/qLR2ZYeUzbW/62ycgWlMX1O5em3EdmxcUfOLdKWDPFJQnLyZLpuI84qT9TvboXFYMYrUrUgEa+/Qnmzq464LDeLsOl5/8rwoeUhxjUzXH7TelczbRj2M1LR36PJMfs4aw2LNmQaJdU9ziqWJ7ZXnviqmXdzSjKZFW34mW/VSWUOZlrc1wie7d3vrrBU9oTLH6LUb9nCwqtfaFBWd1WD+/m7o6xHD2R6tv70OnrvbQlB3i51Ny6xa5jus9DbuzM8k2lZF75ezxnPJNvUK2SoEoXy7X7JfR/nUbrBNvyW6lE0XvUmj+67YqW2jXkCLt1mj4reanfbCbE6zuRrF7fTbIMG9d6eaccvdRq+8mrbqfrdUHWbWxR3KJfKoBAO/6/mqW2ajbbmStyuK3of9FqRZW3e37XL9bjQ71+H8muOD+VYtLGApKNLWrLRSOpvc3nUcN2Ud8Kr5/DbZjov7TX6szbMqracothf+XsEZZE/KLkpN+zCvOUbjNai0cmpRDDNvjVwqMx+5Rrs2GRThdmE2aF6Uy8/PQ7Tq2cJdvKvZatbOKpnca+bVG+X5uLafBuVe5rArdnRSqk9tXmCLbH9dXCDc3k5wZZO6253ddXd4ySo3S7phVDhtjIp9qGZGq3rG8DPFDJtktq/9sukpllWf1NNIZ+WC6U6nXlevqF2HFK0dmhW8w4EsFvnxeNh4drpadQUNJUtei8raSVem61Rrihkc9XZTvWOqw/VKK702cjXzGT3nZusRp+sRJe5msuil91U4KEz6hfTGm7F5opMuiv3cz5Vyw5VqbO91B133pjwsV+5V296MIfQNw20Er2zWht5zeZ57a0+Nuw2x9l062WJNppMtCoBSe7xO0WEmEBTYUKgmgIA7SMU6Vs85A/MlOdaLh9kOE7kiqygumx3TZJRgIZAQh+oRKDsma3jKq0uiRXhK2sGoZUnEc0xLXDBXDdPKJ54IjY5ShLTBJUfTkJYEYCZB2lUlDiC7gKGXmuNAw3qIBcSSXNp2ghcSBo6b/WmnJgUADXOBiSpuFCQBeOgTtCTH4ZFJ0jexan6Kj3puY8MUoSSpgEP7a38A1pdEmCgAJvTQhYBlbCuC02jJQX48dW/tirCLKiUca+gI79fSnp2LPWjJ5tASiBEosCdbBBFE+AQ6wOVHRGsnHyPXHy07grEQtQEVcpTgiHAsBYEoyK6zb7qQymo6SkG9qOfypbvpdSuCb0PytpPfApwQYVCDQcfE6ifcWRId2tgKLjYeR6QTB9yVoczBMjYal5cxiTeWsXp1GUueNR99GkGgJflvMBC4hUASv04CB/07gc55aD6N/dMjMxqX7w0GuV5YvMmO7afBcGCtMim40/PbedOvvTNkJdrUU5wif0Z+i2qZ+rxpFcXMGlWyqxGys7m2X9F3Vnv46qTJDpqJfLqZax2Yu0MptTHIF81BXRGF2Y55xG5V53vSc5VKPovnK3c6nc+btWYFwUF1PKK91qEX8A1tZVMTZcrbFYyZWYHPeiabH8zXbdzUXLWDvLfCQG3vW3l1UTz0M8XCrtWpzMYDO9FXkOfvuMLHSjOXGwq7xDFt4K25XXd8uvNn/dFreZEiVmHuvfUts1zTOpvKeDcuo0m6MXCrtSqZ+4dqbVTslZRGZaVstLFobKsJ9iYy7XxloQ+0lJoNGs7Ka47SeTTSUodWcT589mmlWnwjHKqFukg77XG+5MwLmXyhNpi5xWlNq/ep1S4PDFVbGZmeU34uqGXYWG3USTG1KbVZ/eAXJ16KtCqviLvVzaC3eeWr9kHbzibTuchkm6Q0bHFNTXffXThL4d28gpzmQl/QXQ9ZhzeB0ulnkav4b05qO+0WfJRSdsG8asF3o68Ux4lZreJnVn1Ps4so37PNRXlt1d9oYKjz4iJXoM3Cuo1hdai3q41aVx0ZVdNGz2VaTwfv7ws+WMPXVVbZDFg116l0m0O/yLolbbZpFRV7g1XvPe2U7ZS2T7Sb1UE2yA/e2mxfqenpw7jPK6Ntf7ypFCeDfo20uodCYqPlzYl43zvvA39AFa0KyeQ9+14ruKOKM7FrvnBGr3YhOx3ytJ1vzAb+OjXJKI274OAG6hR66+3cr82mJk6gUT5fNdZ65rmxHdZqMwXafVhjKbZJ71J6Wm/UD+lZvrxKlRbea6rUwF663M8kasWRVTTG6bftIYNTh+p4R4KgWE5l8vO+OvJwv9t+Jsq+nus3V4M639KiJhS2zk7sesaczr3q1j74pTqfNNKdYaX/Wi1gl3cmc+Qo1fS+5G6r7cb70NMMUe+vh/ntQSv1zF1C1Xb2GHXfOnQ/6GjpteXht0npzS4mgnSmKhYOajX7UKmJt0HHqpgtXKGD9szIevuxnZvvFQv3+kjfIUOxuD1RYLbrjAuzmVVtZ4OmCUVqmGCjfW2vBfhNe135h5bnpBR/lfFt/uygxMDoDRbedNYstRxzNsi3s8XFrl7BrcZ8eM/xN6AsVU43bKc/G5XSq1F55uwYmo2h14Pv6xKZozau0FRt+Fo5ZDO19a69GxbHOVhp2euR2VJVsal2NhCTBPZckXt+FuVp1z60/LdWrbbLdN8bfrU0TOTeFu92Y5prtrAIhu740FygQm606SXqq94wlZnMzNfs8HVWYHRXUPPPaqnE2JTXJ36rhf1xsZt30vkudg/5bA32N17C3e0a5YYe+L38bLtvrhmsqJum6OKhGwzXw9222jATFJLm1l/0UCB4z5y4GXto+6N8bZRh9D1DBrixqRYI17aJ8nM9O8763cNi0fCfN956NqOLGS15lVxq1V1kFqnGYjjeqbWDWlHU3SolCIFcz77Ncg1tX7CLqdGhv840OLHIs9eel+87Ht8gw6C7cgotNg/G+JAWtGG017O3REtTspthLnDcElt3Z/ssG7Yqui1SDbo4GFPlvf7WqKv9nY/sUa+YPtBaGcJEZZtqz3qvtU2r+V7TanbDnGXLvWdLSTjufruym++vrXSa7YNRsZ/PzztjlB0P7JHe9t+VQjDN5N733rDdWChCs7Rp+/XQLyiwcJi0zfLbaHqvOy5HX7HBlCPwsIw57tqKEKjM7svY4y0mOFMdEmPRCEmBz1bJY/YMG1/DXWQ7Fg0i6ISJJmERAr6JZPpfEngh5AyOJeZFR6KDGECDAsrE/smrhiDvxIssCSVhnSR4+4SlKrVtSqwALGMch9zOucFjBE8QUWUxOjMqj9dZneO7qH9/HRR6MdtvZWuZfSNdMYqeuy6JDkobze7h7bmAihOXl9xB0xu91e8Oyj6vfgfY9vnQvnkynyoBVbJYeuQ81YSYXOK3C4QTfpOQnkrYTBmwKUNg0FbmlyI4+DFqVPOZYuq3I/D5Ij/cATDkMMQREUiT6A5GlOKZYLxsFCGmqGMSt9ehai5J9A6uGMQQVa0hR4VcAhGVyqh6GCM1RMs5KVcalyvkir+BRCLiGqPqLrNOLR5BrT4CP5TJNDkvlFLJdKmU++1LPyOrkhF7+uXj0W2ngJIRGPWiOx1PJIyUpSG/vSQX7a4Ixi8DeiwIuyrfg+tw2a8a9cPILdnZQrPTWwkXFfKlTs+ZzwpONRgLvF1s2spMycM7SfhDMtTROUPs5Uc4oSPIH+1F4yHB+du5GV1vkCqJZ4FFqHxzJru/WvrxZ5pJHvtDVr2O15sK8nNILf8L9HmdMcq+cOYoLP228lcGQH5YaWjt3iF+w1agJj8CheiU2aFpkmzvy4UDehBb8nRGhq+GPGBTLRz8b9VcSP9O2WfZt3JMHLnrnoAmlhvqJWkiy4kWZpd/buCizWcoBajQ5Tf0rZwEDGmYybOo6agjZ6KcXNCyqB8R519M4gIKl6/knPtqU3MyGYBxWANUZY0LbblUOh6LnBp7iWEiCrlP+TKbGIj9t1EXdiM8Fcvci7nrz/GYgAaXk8JHlrUl1CdyIuwTlAUJBgWysI1FYu2qWyTtMQONwUSUehImNsyYrCx7OQ7tl6J+xixIDOm3wEHjUHUsHrPgGlmxl9h/UhY8RQdvsXiMU5epYc9shzIBfi4JAADMTsaUHRyPiqqXB1dL8gF0Rm3wHxfi/uPvcoQl5yBujrl+BQT51xIeHv9+qgsdrByJomPNS/UPV6IeL3T8BNEgx6NE+wF+BdCH+Epg8s552cPj32Mf8bOXXumFdyI+5NIxDlS30EDAhjicYkdHPSzJUiyjVWIvJCkiX3X7/Eh59EQdRKCDj0edy9jFIean6xIGlbUfpQLdJWqo7eFRDoeUce3Nl1/BldBkD/k3vpWNoIOrkdJ7DcoDJfp641/ZUp4mxgGLyxkpG58lJT8HZqAka3dce/RHsgLVrcGoS7SHx8dkfY9UV6DILnl4zBj4P78Cgq2wh2IpdFskGw7DROgPlCfHQkOMxSUXEy4KfnjQCi1L5rzf/8iK339/AX/zlkuyjIV9ePwDHQ3XskC4JpzOUS/aR60/5D9PT+cKUfT/fk/5C7g6NJYNv2qmrpCaR9fi/rBjl3Yh7jwuycdlKA8CYYYr9Cmc5Sry7VynLFhFH5ck1P9ZkJQpw+JJme1WPlrLs+uVZGyPTW96eNuaIX6uWnZwfa8iJ1o2wppO6IpThehNBvovoIb0T1xjUimFAxq2hVZ4jnjM0Fyi8tO9AMeCQRRsSYdRuRzzJGUBdDCX80wKHiN0vSYlnSCE6xBYx5NraFmAu460CWk3C9gZssp7Bbdr20XHr6dhtHCG3fgVLGN/1tzTQiDtrhOJkyE4zquIvYTkzKyfSPDyQAGnsQzrXBhVPk3fm6keImMHH6u9RNb+AqrhxYfvlUDOo6qyLf5cuC80Xq3fnyrCXsmWggVHdZHKU6iHC3+iLVveXiQ4VZbSzpPw1ysbzmv96jJsuVx1Tq3DUHtYHhHFUQrVrxJO4v/el/MSTrxLYZG0S4uOX1EY8OAc99LT6OWrGZ8Vrha4P2UN+BsPDQJ/A+gx9hGCBkkxaFQNIedF8pdw9bSHvH+F5OFRQlYZ5BJA/CbhurwsNIkgTusWJhv0VubdXCD2F0v/P6XAiRaybwy/Hd8/Lfrh6i1pa48hBEN7IWlySiL0tEWB3PDch2DxWLjVugvF5Ep8anweinOD/x2SPz0kMpptJEwqbzwZ0R0kKMzYS+wpKXFyIpwdT+H9qnBDFo9xxDzEogF0mcx9p+X253GRXXHLNT7uLrlP4SgxLDdNp+s35ybR9uG4L4x9Lt6xW2S/oC4DfRaAHhI+ZVswiKQAKSUJFtQNrwvpmGgAixO38OOyRZUSTi30eeVNjQqksUluPp2Mf1JdJs8AnwwkElxAmbIek0fPcaS6DItgLLeoUX/WkGP1vG2VgxCVnHcxUp8c5TWCDLHrmlHRl6oUhnuYl58x3aJ+dE/JFSZl+BDml+px63VVOL0amnAKJTVk01MHI6Hh9T45qCp1og5QXbcwCU/DQVj6eXExXDrlG+Ih68aQzhA3gYhuLD5AC0Me5vrfj1JWMLyl+LuM0uuif15+dEGPyBP12CiqJFPnNxcoQ/pCPvxJP4io0cVuM3K6dD8LosuWkeCvXBw9Hitf3sAMqAsIkqQYuQ48mdq3KPgMPN/3Q1vk7JDrmIxEmaz4k4MYl3AsEbksEdoYUpB/HDIsmFG25Q5UUdnBks/5Z+0G/klAwkIesv7fd+MjHsNEpyeOCKrhao5siOWQHhHkf0bjGIvH5DVOGVYDBYyjb7EvnMAvQCGCUc1VI5Rco6prIyIihBnCVMs6Ec4SBUPNxkQeJ4fb1XDRKQ8UngTl6w+yMFx0QkZZHjCHnUXaESWG581YA4OjM67u7ybBINIYSpHctE25OJ2jYwLWjPr8dNf2l1/AuNbmkrLEHGjHHoCoo+sjGx9JuuSnZOnFCEZ8/FnhZ1XIQ/GnS5RAl7dCfDkf5d7HhQbiL9KMf4DO8f2Itf4BatQnFoWaFAD+Jz8p4nJA/qLfP6S1iasfuC34539/gYj7YqW1NcjElWN+OO46qSHvc8YdC56OvAl/+twXPN717Y9RvVzr1u9e85YMCde2T2uLrp9sKG9bHBkTfvz/SYNMPEUiJHq49G2yV59cqyKugUSSMuN6hTgXf1rdZ0Ey2jU9Pf6V1lJB0Bd7Q2vrFt5jdqnKRPukY3+qit7/rGf/AmtRaNJda1/prapP0d+qO5Nd/5ZIMOjXODha24IevFZlQw+R60jgCDLVTJ6/PEF5dAJV8cRNmUSePtmUx3/d2g304DdxK62N9gnnuHXsDb92bRi3p+JTTDxd0LGPf6VvZQaMMtalzbfWPsxkUtGRUM3H/6nZiWPzf4vxkfCrLgDZh0FzcBOKkWWY36wWV8VXM/HG6/+y0Y7p3Ann0OMRzXdlbeDgG0OPJactw0XwPn2dff+6taFJd1eKkbsOrlUxdx0YyObXFl+WPsmHq/n2l1orVX0z90Yuv8lwquQAeBLTi13Zqej49K2lf5G1/H6Gk0QvVhGJ7kecgKYDVRPJP8iKxW92wnLuwfBz6ONjW/7UUar13rieyCRTSVPYVrhLQczmfX2MmIdD0vhJUH5xynWCnHLnjBiPcKwlnRGxBZQLG5ILu/6Q47vdT18cwf7vX7L9f/GXbMdtlCSyJQmOw+1wGKI/j/zOj9gFvxOLxz4Znt/iMUmkyyo/f8pbFVNmfXzI4p2LWBDRTCcOR759xGMmgpokM86cnhxT55LD+3Kyf8U8vdYnsY+P/wI5yYmo +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. +This endpoint can be used with client libraries like [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others. + +Adding custom keys requires first creating a keyset via the createJsonWebKeySet operation, and then configuring the +webfinger.jwks.broadcast_keys configuration value to include the keyset name. + + + + + + diff --git a/docs/reference/openapi/discover-oidc-configuration.RequestSchema.json b/docs/reference/openapi/discover-oidc-configuration.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/discover-oidc-configuration.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/discover-oidc-configuration.StatusCodes.json b/docs/reference/openapi/discover-oidc-configuration.StatusCodes.json new file mode 100644 index 0000000000..663b66a3ae --- /dev/null +++ b/docs/reference/openapi/discover-oidc-configuration.StatusCodes.json @@ -0,0 +1,237 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Includes links to several endpoints (for example `/oauth2/token`) and exposes information on supported signature algorithms\namong others.", + "properties": { + "authorization_endpoint": { + "description": "OAuth 2.0 Authorization Endpoint URL", + "example": "https://playground.ory.sh/ory-hydra/public/oauth2/auth", + "type": "string" + }, + "backchannel_logout_session_supported": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP\nsession with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP", + "type": "boolean" + }, + "backchannel_logout_supported": { + "description": "OpenID Connect Back-Channel Logout Supported\n\nBoolean value specifying whether the OP supports back-channel logout, with true indicating support.", + "type": "boolean" + }, + "claims_parameter_supported": { + "description": "OpenID Connect Claims Parameter Parameter Supported\n\nBoolean value specifying whether the OP supports use of the claims parameter, with true indicating support.", + "type": "boolean" + }, + "claims_supported": { + "description": "OpenID Connect Supported Claims\n\nJSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply\nvalues for. Note that for privacy or other reasons, this might not be an exhaustive list.", + "items": { "type": "string" }, + "type": "array" + }, + "code_challenge_methods_supported": { + "description": "OAuth 2.0 PKCE Supported Code Challenge Methods\n\nJSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported\nby this authorization server.", + "items": { "type": "string" }, + "type": "array" + }, + "credentials_endpoint_draft_00": { + "description": "OpenID Connect Verifiable Credentials Endpoint\n\nContains the URL of the Verifiable Credentials Endpoint.", + "type": "string" + }, + "credentials_supported_draft_00": { + "description": "OpenID Connect Verifiable Credentials Supported\n\nJSON array containing a list of the Verifiable Credentials supported by this authorization server.", + "items": { + "description": "Includes information about the supported verifiable credentials.", + "properties": { + "cryptographic_binding_methods_supported": { + "description": "OpenID Connect Verifiable Credentials Cryptographic Binding Methods Supported\n\nContains a list of cryptographic binding methods supported for signing the proof.", + "items": { "type": "string" }, + "type": "array" + }, + "cryptographic_suites_supported": { + "description": "OpenID Connect Verifiable Credentials Cryptographic Suites Supported\n\nContains a list of cryptographic suites methods supported for signing the proof.", + "items": { "type": "string" }, + "type": "array" + }, + "format": { + "description": "OpenID Connect Verifiable Credentials Format\n\nContains the format that is supported by this authorization server.", + "type": "string" + }, + "types": { + "description": "OpenID Connect Verifiable Credentials Types\n\nContains the types of verifiable credentials supported.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Verifiable Credentials Metadata (Draft 00)", + "type": "object" + }, + "type": "array" + }, + "device_authorization_endpoint": { + "description": "OAuth 2.0 Device Authorization Endpoint URL", + "example": "https://playground.ory.sh/ory-hydra/public/oauth2/device/oauth", + "type": "string" + }, + "end_session_endpoint": { + "description": "OpenID Connect End-Session Endpoint\n\nURL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.", + "type": "string" + }, + "frontchannel_logout_session_supported": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify\nthe RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also\nincluded in ID Tokens issued by the OP.", + "type": "boolean" + }, + "frontchannel_logout_supported": { + "description": "OpenID Connect Front-Channel Logout Supported\n\nBoolean value specifying whether the OP supports HTTP-based logout, with true indicating support.", + "type": "boolean" + }, + "grant_types_supported": { + "description": "OAuth 2.0 Supported Grant Types\n\nJSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.", + "items": { "type": "string" }, + "type": "array" + }, + "id_token_signed_response_alg": { + "description": "OpenID Connect Default ID Token Signing Algorithms\n\nAlgorithm used to sign OpenID Connect ID Tokens.", + "items": { "type": "string" }, + "type": "array" + }, + "id_token_signing_alg_values_supported": { + "description": "OpenID Connect Supported ID Token Signing Algorithms\n\nJSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token\nto encode the Claims in a JWT.", + "items": { "type": "string" }, + "type": "array" + }, + "issuer": { + "description": "OpenID Connect Issuer URL\n\nAn URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier.\nIf IssuerURL discovery is supported , this value MUST be identical to the issuer value returned\nby WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.", + "example": "https://playground.ory.sh/ory-hydra/public/", + "type": "string" + }, + "jwks_uri": { + "description": "OpenID Connect Well-Known JSON Web Keys URL\n\nURL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate\nsignatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs\nto encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use)\nparameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage.\nAlthough some algorithms allow the same key to be used for both signatures and encryption, doing so is\nNOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of\nkeys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.", + "example": "https://{slug}.projects.oryapis.com/.well-known/jwks.json", + "type": "string" + }, + "registration_endpoint": { + "description": "OpenID Connect Dynamic Client Registration Endpoint URL", + "example": "https://playground.ory.sh/ory-hydra/admin/client", + "type": "string" + }, + "request_object_signing_alg_values_supported": { + "description": "OpenID Connect Supported Request Object Signing Algorithms\n\nJSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects,\nwhich are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when\nthe Request Object is passed by value (using the request parameter) and when it is passed by reference\n(using the request_uri parameter).", + "items": { "type": "string" }, + "type": "array" + }, + "request_parameter_supported": { + "description": "OpenID Connect Request Parameter Supported\n\nBoolean value specifying whether the OP supports use of the request parameter, with true indicating support.", + "type": "boolean" + }, + "request_uri_parameter_supported": { + "description": "OpenID Connect Request URI Parameter Supported\n\nBoolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.", + "type": "boolean" + }, + "require_request_uri_registration": { + "description": "OpenID Connect Requires Request URI Registration\n\nBoolean value specifying whether the OP requires any request_uri values used to be pre-registered\nusing the request_uris registration parameter.", + "type": "boolean" + }, + "response_modes_supported": { + "description": "OAuth 2.0 Supported Response Modes\n\nJSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types_supported": { + "description": "OAuth 2.0 Supported Response Types\n\nJSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID\nProviders MUST support the code, id_token, and the token id_token Response Type values.", + "items": { "type": "string" }, + "type": "array" + }, + "revocation_endpoint": { + "description": "OAuth 2.0 Token Revocation URL\n\nURL of the authorization server's OAuth 2.0 revocation endpoint.", + "type": "string" + }, + "scopes_supported": { + "description": "OAuth 2.0 Supported Scope Values\n\nJSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST\nsupport the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used", + "items": { "type": "string" }, + "type": "array" + }, + "subject_types_supported": { + "description": "OpenID Connect Supported Subject Types\n\nJSON array containing a list of the Subject Identifier types that this OP supports. Valid types include\npairwise and public.", + "items": { "type": "string" }, + "type": "array" + }, + "token_endpoint": { + "description": "OAuth 2.0 Token Endpoint URL", + "example": "https://playground.ory.sh/ory-hydra/public/oauth2/token", + "type": "string" + }, + "token_endpoint_auth_methods_supported": { + "description": "OAuth 2.0 Supported Client Authentication Methods\n\nJSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are\nclient_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0", + "items": { "type": "string" }, + "type": "array" + }, + "userinfo_endpoint": { + "description": "OpenID Connect Userinfo URL\n\nURL of the OP's UserInfo Endpoint.", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect User Userinfo Signing Algorithm\n\nAlgorithm used to sign OpenID Connect Userinfo Responses.", + "items": { "type": "string" }, + "type": "array" + }, + "userinfo_signing_alg_values_supported": { + "description": "OpenID Connect Supported Userinfo Signing Algorithm\n\nJSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].", + "items": { "type": "string" }, + "type": "array" + } + }, + "required": [ + "issuer", + "authorization_endpoint", + "device_authorization_endpoint", + "token_endpoint", + "jwks_uri", + "subject_types_supported", + "response_types_supported", + "id_token_signing_alg_values_supported", + "id_token_signed_response_alg", + "userinfo_signed_response_alg" + ], + "title": "OpenID Connect Discovery Metadata", + "type": "object" + } + } + }, + "description": "oidcConfiguration" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/discover-oidc-configuration.api.mdx b/docs/reference/openapi/discover-oidc-configuration.api.mdx new file mode 100644 index 0000000000..d34c562f02 --- /dev/null +++ b/docs/reference/openapi/discover-oidc-configuration.api.mdx @@ -0,0 +1,39 @@ +--- +id: discover-oidc-configuration +title: "OpenID Connect Discovery" +description: + "A mechanism for an OpenID Connect Relying Party to discover the End-User's OpenID Provider and obtain information needed to + interact with it, including its OAuth 2.0 endpoint locations." +sidebar_label: "OpenID Connect Discovery" +hide_title: true +hide_table_of_contents: true +api: eJztPP1TI7eS/0rfpFJrV9njfbm8vAqpvXoE2ITd7MIBGy61przyTNvWMpYmkgbwbfjfr7ql+fIHYGDv/fL4AWyN1Opu9Xdr+BKlaBMjcye1inaiXZhjMhNK2jlMtAGh4ChHdbgPe1opTBycYLaQagrHwrgFOA2ptIm+QgNuhnCg0v4Hi+aFLdcdG30lUyRQKeixE1KBVBNt5oL2BIWYYkqApHJoROLgWroZSNcDqZKsSGk36Swc7RZuBt/FLwFVmmupHGQ6YSg2HqqhOtZ5kQkDmRwbYSRaJmEJ/ySTqJwNsBG0TJO+H+x/ttB5I67EKXOk24Op7tNz6PyiM6Gm3Z6nws3Q0JaviUMwKbIMMmkd6EkFfqphhgZ3YOZcbncGA52jkmms0A1SvMJM52jsIEHj5ERiOoh6EQ0xOYdptBOVfD2SabKn1UROC/806kUGba6VRRvtfIm+e/mS/iRaOVSOPoo8z6TnzOCzpYP9EtlkhnNBn9onfuj5YCGT6tLSOVi8QiOyissWOsRHvBHzPEP4NNCicLPvBk5fovrUZZbgTa4t2tbJagW2yHNtHKZg5VQJVxgEkU21kW42t0Ml5lpNS35GvSg3xAMnPWG0jTbyfxncqERnlYRaMHabK0gYvZh8OPkt6kWBgGgnKs8kz8RianSh0libRWxnA20W/dkiNWKQF+NMJiWt9DvqRW6R03rrjFTT6LYXjUVySfqiMBtleqoLN7JoLeFb0b4G4bZI/iySy/6ehwK/MRQ49VDgBP8spMGU5PtnrTMUCq5EViDYHBM5YV28niGxkDXw6BgSoSAX1oIAK1PoBIzgcL8Le5mQc5CK54a9zuggWQNTVE5OFvzw5HioypWskR56DIeT+lx7PEq7BMAWRGZ1qV0p7XS473ewIK0tMIXxIsCqOTr2pG1i6dNYWa7ehodhSwuETj/gAx6fXuCHKRCkSlnT1LRcEq+lKiH22FEujJijQ7MFTcxZSwbXL218ehpphUUyWTTs0YMKvSeQ+HDCKuwDiUTEm9Oj9yCMEQsggyakon1FZV8JWS9q78UcbWvIgpsJ58lccj7vdv+AMYIYZ8gmrsjzbDFUzCp2EzG81w49ALJ2uZFXIlmANt48gUFhtbIk8NLCXE5nDpR2DFUB3sxEYZ28QsaUGCQdztmMrRiNMMBUMuN0iqNkJrIM1RRHc3Qznd7NyMriHb/dO2gyUqcIeyUoeOdBPYSxx0brCbzFBZPPcA5uSO6nCB3apQsfT17v/eOH//zhAghjqDCGgHFtFoaKdZysQcsiWzRXaLbkjkE2SyKzlQ8YpUZM3Mg7vjtl7Hc0ciL53PdqQJVrIM7seXZYFpwPJ7+VMnXP0nidP2giW3Hjydi21PwhGrIBTu2OH3w8G4KFpp8XY7Ky7Acq+Fc1Ag2WrLr4xCxyp6dG5DOZjMZkatT0QRrwIMbtNcHDzx58qRVttlZSUHOyhRwE5FaFnRWG4ht6SmzISZW2FfImH2whHT47+acMdUuqPSpfh2gvQo8l7jWvXlFgD9QbcrmNyK9Fd40OPAy7M1q8ghyDJCav148a220YSQPScWC7AZl36EQqnIDOPlkiePmyWxOsx58xcevOJ8UrmeBo+zB8nxd+vWjcI+a/rTs5VGkVht+Bb/sgKXUto+6meyCPUEYVxxQ8XM9kMiOnfxJCbTQkdCDAYCoNwXIaDP5ZoHV1SFKmxhQxZHo6xRTIblag18rgxGjlnpxgvCYoXyXDkNZCh8N64xPBlYTjzwLNog4sbTPPGCqfaMCaPIO29FnKOh4URpJ2FxbTByUkQ/WwjGR9ZLv2FJ7I/SdF7r+enR33x8Ji+oSUZGqEciM2SQ+LNesw8xdaWtu4h4QkNZh6MYT4O+iItE0it/MlMh1xPWJEPgnTUVkhGYlseu8J7eNEFJmr5AJOg2PbbdQqhqr6xnLHeYScrhTIKuF6AgEUBIlsOvL8eVRKdQ8tDzmyN+enlYuvqzbQEdk0nFx32b+ymFJoQB9LFIbKaUDFSUMjWZMKBLw5P9uST2xs7mXEIU8jX8MnpziwL2wZrbDPAa6JoVcdpYOp0gYmRkznqBwkep5rRZ/qzPIYhLVIWigs1yX9VgT/0Ns1iSYeqsNJ40lZzFu0Y5KQTXq9f/fh9Iycg7eOichIwmhLT3KYZdAVRoUU6xzHr6WaoonhbFbWXu6CE6yiB7XOEk6MnnukKuTjx3rrdQ7t8/WlJet97wGeY5b13yp9rYBl9RzHlJ3a8kgbidrR8QvbmgSn6ODjm/O3F5DqpKCjDAxKmtFYKduXuOjYbih6kW6zk7oSmUyFw6Gqape2ZI8vhJ2xjrzl3ajAwNwPO/CkUw4uX1gSfoqqycX5zXplFGHQG5PxAk6ObakpNLmMIGx5fB5aDOfkGMfazWrlpApsawvLkOciRRBXQmYUEvZAcMmnQxz6YLE7VJVbLiXCwsnBf384PDnY9+X/LPPQAkEGJ2hQJZhWhHPhnh0OAopkRvNfWC7mK3K3hRVTjMl4upkupjOwet4sAtMe+tqfh5gjLSeY48AXwqKiNRxCm9wepJp9nQZph+r90RmcHOwdvXt38H7/YL/ntZQoy9BasJgUBuuzu/l7UgcnZZmoNO+5Lx/B/8R/f/kjGMwNWlTOtxxAT4aKmROmpeFoaLUPQ8Z0CERQ8HOsmdbJLKNdAjQmh5/MhUso/NEWS4aH/gBxd70afrFZMb2Nc6MpirekiyKXNk70fBBfkw5dkg4NSO9i7gWsUUqDU2mduTfAX/KaCyXmMoE9bnnASQPI04J9kc6lGvhOynp0WTFGPnN5Lod5EgL2I4b6L3KbbSRsb6hqO+HpGPsQ9hQTZvQP8d9o3+WSsTYIf4tfwkf/IKaBC5Z621a+yv6QjlHIHWLyNjOk5XDfo+tNRad2pmWqU+mRTwU4gJdLiysLMlSrEDisr6FsFxiUMB5TYi/J/QqV9RXmPCZUb/DnSfR9ODn8ijS2j++xdEqDoya9TeP0IEIl+YgmxU3LtA2ppgQm1KJFYzDnpZvwtrzvEUVOpdeKtoUmLTWnNvEiZDBznW6foZ2E1fCOVm+fpLV2f8Y8rYL7qLyzouqRqWdr97upqtybl7ChKntJpRv3E72X1in2oMzg/CUBLvdxAlaOt7EPu2/Lvatw4+FBdbizsG25aE3svK4a+sK2WFatxrs6HzbRjzjQU1oFvzMrtj9Oakj98I/vf7wA3n31QD09jUOlsC8M0ikOVfMY/RWNJqw4BN2WI8Nkpik0o66f0yDSKwrOLPqItnHVoYkLXqEqS1my0WAtq1dbHb8tfMRzv+5sCnJOPYTt9KdcVKe3oZC9QXN+p8wpTAllN0o1pLkmbpFy+ARxO9n31ZGHi/0z1pt567UtghZOXCnfrn3bbIFzFE1PfNrOKrdFA3c9gNXGTdkHaXPJq4bOfWojDA6VD8BHFhODbpRr63rQHhsLK5Plwc/XzltAbqE7HF3iIgza9THsj3dEsFuJSGHRUGfy4TnMh7BiU1WBnh/S8zu7vtW+jyk+ck+gwmMl7Xh44bGCUfqZLZ1Li4pnSKjupumhmdTHN+enF/fmUx/fnO9erGZVK8cHd1YiCczZxZa9txAlptHOx7I42dt0de2+ntqKlWsUzDab/zuiqofWle8poN8j4hd1B3K5RlDVPcse5Grj8ZZbjU2R0itXHnkKF+mfcNXxwBhtVq4gII9unLzaXKQHoxTHxRrd5lWwTw/hsL4jQQJ/pLJFXYwjmUvxCii8XmtTym0a0DdtVo9thDNbaww9gF9Do/NXzHJfGKXDbl8GZCiQiMIu1aHOOMUJbU+yntJygMRVPd/HXg0VnXCFHZEWruJErS045Rl8C6m52/cv/1bfGoikcj98X8OniuMUje+HtySslk4mg73vd+vkrv24FzkxtaTWJI8k5Dd9ihCMcJjJuXT9cZFcIqHCQUPfBw39mZxSV/qmTwSeMuoE5UtEV4iJZYsc/Q3jqBdlYoxZtBP9U5tFXfKyujAJEzXn6PTLUAEA0FXg3Vz2/LeWhgzVrS9Ov2hAevETnWuilaVWRmM2vAKF120Ine5P5VyRy0NlnVAJhplh504LSrcB/gv4U+0BXzS4hVcgroVswYo3XmnudH+KbnsVh37RDc4oQdfqmkzJRXIp6NqZkKxZgUmdoRq6oTcON24Y+a+TefVRW/+J4nyRS88jGEZT6WbFmEumNe/6U02zu7TBpFAJ79bp0lEQjDY7d15BC2j8Hq+XCKRFIpchSlu3YPf40D9d4jKtJHPbA9MjRaTFFaSYT+b4MN7fyNvAkJjuxvp4t9Ptxgc3mBQOPWJywoD/4xUomTGJbugmcxe/zo1UbtLRNj51KRrTg2EwG5zUJCLLyC9/uheNT5924Nur4VANI6aie88mr+lWPRuD0tU01vvVt/RrMKgmeAX4tBmFHVgZIxCrOHBHfRidtAHfT2MTRbR5d6hum3J9vHAzttKlbJM52aj02ixG/uFQMQL1QExuI7MxGaZRWxTD4jWELsMwVB8L03dzeXCTYN6YmTNHygn+G8n+N9Qul9W9r5m2XOL1qYPIOPQPvppbV2vSrXXdCgJ8iti2U3Hur6PWYSF1pOowr016fckkZrPUsncNwtvq4Y0pk/EKhuuyw7XolraB8D6gN1dAQNA0X/gU9J5LMKIhnt09PoTyRHlOA6ndUqOXtJ+yJpHLMG3HY/sNXe+ijtvGTYS1fiqtlbUxb+xY2vQaOhNEi5xZhJ38bpuiunoOAan08FVr18rsj1bFlcxPCYIlrDMMIUUARZmhx7P/X3fA2WGtawLz0JpohafIcg6VuBODcWcVjXpCy9I9CBv41jJC8C1gN7rl0MGml/1UJxxzNkIAilfL1uZdb/106MoeSzgFExcU89NFgDMf6ay+JEQXfPQy9DuchLtp+IStt8q9ZdtAzNqD32qPzspIPE+7HKThjUNFt8d8kHWJi2hnU6TWizjzWRuxkZ0uF1dnVS3495k935mRPvi6VLQTTflYcuFm0U7Ualn7cmy/hQK5SV+R5cMuTNbshQdDPbqjJ84naviKLGtic4lPRkKWGdUOIFrOE/7QhYEjs4D36K61uaSXJ7hCSlBi+EMXfENyIlXKDVDfy//YXLGnldUZXnRK5BM/UJYiS+QHSWEMKjeYoutbJ8jtdePARL7MIN3ilO8xMT1ckquSYG4p8UiVE9F+/JoVCuPvUdUz/dDKVF8FpamTTF+vvpq3FxK51uCH1tGwusUpznVVa229WOe7BwRETyaZVMjvovpKellg8XY49NPIFBucGLQz32bhgpAU/p3PTwHKSCQJWvuJBLc9tD18/4KmkiS0ZXdx9fXY8kJVVR1+IB98ibmZu3qmE/vNYpdx9oBXMuYzzb1YLupWb8YudMGv1hKKLcGj8OASF7XgXV9fMy6kHWTzSBLJ89kBvaFKIV3fs6zPOHJX/n6RMYtzbS5tLhLczeVbsqtb4g3XJYB+Ri/M/v+TQbcN1USXFSeRsOXHuZB0pCEK/ac/x6gXKcGwCLNQBI1WKgzfwKFyRqdF4iPt/XA9zUep5ZUr75Y4kua7MKFnfIVsdHaPD20Mu+0HNMhGR1OZiV5KY2KpF+2jUX+fDY4DM8CLlBfWGI79jgyFb45p67KFLzdLBWOjr62Pq4fqm2/gdP+tHSq+UVdesKtK+7aMQm272sU19foEfcOh2rCeKiyDr26RTjSVkkgfKYsqxBTtDqHxF/wWvofA7S/Y19cq0yIlAPCYHwLRPJBn+vmLsO23fmB5YPufZwCxHixhuy+MazHmY16M4xSvao0LA4NQjrGDOrforuXtx5OD3f13BzWEpcKLTS8H40yPB3NB9yhCIcaGv4NUGDfwICiQaPI2fn9w1t5KFVN0sTbTtoWohmusj8wi9pnXoPuc2GpH7/ov4cvYHmTyRprmVjO8ifN5vZX//lDOPgO2yCitxfYXvbxVDXrjdlUN7atIwlSvykHAlv59Q3urubhC1ZYEi8Iks7h6MhB0y1IkbmBn5EQGdV2m+3RsP4srsUFu6382UcltPv9s26xluS2HS5kYNMq83efkLXeQGKUmzsvYds7JqUzQJbPuY9Huh+VfBXkPvEUCEA3Hvx4viaLHjF7abslIa7iliUtcfzLS+SxfI87McV8wbGG7yOUSomGkTBkawjtY1b6nY8sorbUUJ8V40d7KFOPFFOe2jXFzdEAfWvr2rNjSVht076SwSx4uoXqBjaVuZGXlUPi0EdNnwtau93BUMpYJKst5Vhlo5iKZIV0jof5sK80g3RP8mHkc1trBb4d7B+9PD/rfxS/jmZtnnKWgmdujCV10klx+HjhtGz2zMuSkzBmN9XFsRszg+JbuhcyFauC1qVi4nEY3+rj//r9D/8r/OxSSHipdU9lbcvLKAvUlFGY+Ro3CTJUIL5VmLnoRVdFp9pcv9HLiB5Pd3tIwv1jlS0Zl8YW+3faiGYqUqhBV4Y7SkrxZqFtp8LeqR78cnEW3t/8Hy0tWBg== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +A mechanism for an OpenID Connect Relying Party to discover the End-User's OpenID Provider and obtain information needed to +interact with it, including its OAuth 2.0 endpoint locations. + +Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of +clients go here: https://openid.net/developers/certified/ + + + + + + diff --git a/docs/reference/openapi/exchange-session-token.ParamsDetails.json b/docs/reference/openapi/exchange-session-token.ParamsDetails.json new file mode 100644 index 0000000000..ac26e3598f --- /dev/null +++ b/docs/reference/openapi/exchange-session-token.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "The part of the code return when initializing the flow.", + "in": "query", + "name": "init_code", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "The part of the code returned by the return_to URL.", + "in": "query", + "name": "return_to_code", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/exchange-session-token.RequestSchema.json b/docs/reference/openapi/exchange-session-token.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/exchange-session-token.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/exchange-session-token.StatusCodes.json b/docs/reference/openapi/exchange-session-token.StatusCodes.json new file mode 100644 index 0000000000..c737a03856 --- /dev/null +++ b/docs/reference/openapi/exchange-session-token.StatusCodes.json @@ -0,0 +1,918 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The Response for Login Flows via API", + "properties": { + "continue_with": { + "description": "Contains a list of actions, that could follow this flow\n\nIt can, for example, this will contain a reference to the verification flow, created as part of the user's\nregistration or the token of the session.", + "items": { + "discriminator": { + "mapping": { + "redirect_browser_to": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + }, + "set_ory_session_token": { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + "show_recovery_ui": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + "show_settings_ui": { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + "show_verification_ui": { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + } + }, + "propertyName": "action" + }, + "oneOf": [ + { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + }, + { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + } + ], + "type": "object", + "title": "continueWith" + }, + "type": "array" + }, + "session": { + "description": "A Session", + "properties": { + "active": { + "description": "Active state. If false the session is no longer active.", + "type": "boolean" + }, + "authenticated_at": { + "description": "The Session Authentication Timestamp\n\nWhen this session was authenticated at. If multi-factor authentication was used this\nis the time when the last factor was authenticated (e.g. the TOTP code challenge was completed).", + "format": "date-time", + "type": "string" + }, + "authentication_methods": { + "description": "A list of authenticators which were used to authenticate the session.", + "items": { + "description": "A singular authenticator used during authentication / login.", + "properties": { + "aal": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "completed_at": { + "description": "When the authentication challenge was completed.", + "format": "date-time", + "type": "string" + }, + "method": { + "description": "The method used in this authenticator.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "organization": { + "description": "The Organization id used for authentication", + "type": "string" + }, + "provider": { + "description": "OIDC or SAML provider id used for authentication", + "type": "string" + }, + "upstream_acr": { + "description": "UpstreamACR is the `acr` claim reported by the upstream OIDC\nprovider, if any. Populated only for OIDC login methods when the\nupstream ID token contained an `acr` claim.", + "type": "string" + }, + "upstream_amr": { + "description": "UpstreamAMR is the `amr` claim reported by the upstream OIDC\nprovider, if any. Populated only for OIDC login methods when the\nupstream ID token contained an `amr` claim.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "AuthenticationMethod identifies an authentication method", + "type": "object" + }, + "title": "List of (Used) AuthenticationMethods", + "type": "array" + }, + "authenticator_assurance_level": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "devices": { + "description": "Devices has history of all endpoints where the session was used", + "items": { + "description": "Device corresponding to a Session", + "properties": { + "id": { + "description": "Device record ID", + "format": "uuid", + "type": "string" + }, + "ip_address": { + "description": "IPAddress of the client", + "type": "string" + }, + "location": { + "description": "Geo Location corresponding to the IP Address", + "type": "string" + }, + "user_agent": { + "description": "UserAgent of the client", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "sessionDevice" + }, + "type": "array" + }, + "expires_at": { + "description": "The Session Expiry\n\nWhen this session expires at.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Session ID", + "format": "uuid", + "type": "string" + }, + "identity": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + }, + "issued_at": { + "description": "The Session Issuance Timestamp\n\nWhen this session was issued at. Usually equal or close to `authenticated_at`.", + "format": "date-time", + "type": "string" + }, + "tokenized": { + "description": "Tokenized is the tokenized (e.g. JWT) version of the session.\n\nIt is only set when the `tokenize_as` query parameter was set to a valid tokenize template during calls to `/session/whoami`.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "session" + }, + "session_token": { + "description": "The Session Token\n\nA session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization\nHeader:\n\nAuthorization: bearer ${session-token}\n\nThe session token is only issued for API flows, not for Browser flows!", + "type": "string" + } + }, + "required": ["session"], + "type": "object", + "title": "successfulNativeLogin" + } + } + }, + "description": "successfulNativeLogin" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "422": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/exchange-session-token.api.mdx b/docs/reference/openapi/exchange-session-token.api.mdx new file mode 100644 index 0000000000..f28e7feef2 --- /dev/null +++ b/docs/reference/openapi/exchange-session-token.api.mdx @@ -0,0 +1,37 @@ +--- +id: exchange-session-token +title: "Exchange Session Token" +description: "Exchange Session Token" +sidebar_label: "Exchange Session Token" +hide_title: true +hide_table_of_contents: true +api: eJztPf1zG7ex/wp6eZ2I8/hhO25fh5m8KSspDlPFVvVRT5+ZocC7JYnoDrgAONGso//9zS6A+yCPNm0pddqhf7B4AG6xWOwuFotd3LtI5aC5FUqOk2gYwdt4yeUCLsEYoeSVugUZdaOca56BBW2i4Zt3UQIm1iLHt6JhdLUElnNtmZozuwQWqwSYBltoyVZLkExIYQVPxT+FXFCLeapW/agbCXz95wL0OupGkmcQDSNsPEUQUTfS8HMhNCTR0OoCupGJl5DxaPgususcGxurhVxE9/fdj0AKEjZbU6F7nlrFri/OdiFUNvp4rH7ExiZX0oDB+mdPnuCfWEkL0uJPnuepiIn+g58MYv6uBm97SBceHJsrzc7UQkj2bapWht0JzkbnY5wrjVNqhesS+xKygOlK2OU2zGMlLRfSMM5SYYhaPMY602V2yS2LVZEmbK7SVK2YXQpDkzeREzm2LOayS5jAW57lKXRdi5VIUxY7yIwzDXPQIGNgVhHZ70CLuR81geuyWAO3kDBuGrNWGNBfmonUsBDGOj5lSlOdRd4MDY3jV5pDCxkNPRE40kxIbpXGgoznOU7M8F2kIREaYjudabUyoKdWbRNnLBPEEgItsKPrMWHs6TIDFghMTGWWaoVMjoOO1R3oNSvE1pw4Cm/3N6JyRz6ervjaYAc3LbjeIEm2Stmxx+W1sEsH7MK3+otrdKUuHW92I5BFFg3ftFLix+4GK3ejt72F6uE7PcSZxOIh/d9395sC5PnrizPknNCepsG/w6yKNnG9v6+L6JtA7fYOq5Gq2U8QW4QmbIoFcW0wW8PAARiwU6XXU897U2LI93CRYyIeeJWtuGHCmAKSLuMyoXHV9AEyE/JYYcCJlWN4FDde2CVIS2AThoMFY81D+ax1PDcT2VreMteXYF/pdX3l2GK2dpLtw24PRuK+G+0xWfQGQ2Lv0DD7s9v7xvleZtseAnHbUq2mQatMC/GbVVebiCIHbRS1zdtSrS58i+vxNuNsjn4vnvnEbu+7ERINR9ykhEjaNdT4JHBJSUcC0I3mSmfcRsOoKESyzTvdqNDpbq3XBpSW3rnTCHc8LQC51YDtNhWkWzlretK9gXYOu2q8a9e5iHmarlmBok4KRnIr7oDFqQBpDRugaUG9m/4HBUAk+2tVT3iBNsxuSSJafjTMUmgMWCvkwjy60ATAjyU0NUSD0NSKdnDvpW+xS2jqo99baD6h2wcITUnHxxSaBtD/IKEpCf+IQlPBLIWmbqM/uuA0NgCPJDwbCAcB2ijewc1/r7XaJUibFNlbmB6AwgOEamuT9ViCtQX4tydc3cghyWcpTHmSaDCmfVy+0rGwN7hnYYyQMCGrTe8+Qtza855S2OCAR5TuJlyC6Zlp/dK5ODxYNJElvJq3+HgO0n6Q9oO0/ztK+5Zn9OCPOPgjHu6POOyjDvuo34Ly/+3uow7uuYN77t9aQn5199xvVEIO522/xfO2Pd/Ekfp2XGu+dgd1zlTaZgB2WVpR2yxzB+0scwfMWG6hz8ZzNucp2cOlQYYyKxVLlVyAZg5OTSpnSqXAaa/dsJqn3LbPhseQjarW+HglMjCWZzkqnNcYZUEKpG7LN61ybgnfrEit6M15bJt2e3ipMJAQqIkMVqfIwMVx4FPKjWX+9e1OjqC/6FO7q1dX5y7oIl7yNAW5AGofKwwUsJB0+nX9m3ALPeypTQk30ZxmYJcqadnijaoYhuoNpQ1bLUW8ZCvQ4MenGnjvjiDYAG+EXBQp1034DmZSaNJETZIOWIpBGv1tBuM7FpYmaG5MoTnGTqRwBylGXKCOUhJwmBME83QSdd2vZ/hLaffw1STqsxFbisUSNJNFNgPNMuDS7/uERU5dcp2AnkjaxUnGreXxrVuQcKa0yoRnbx7HqpC2j/z2AiRoXJO6JQpMZHkqwqYS8dugRI1niF6rpUiBjUZnz5qv2pXybY1jp4nMuTErpRP238RWHbbkd8BmAJJAEUpXiqXAtWSZ0sD4TBWkuIwnnGF5CtwAWwJPGK4UzKohW1qbm+FgsFqt+kqv+7HKBreaW2UGiYrNIFYyhtyaQawhwcHw1NR0Oefpk6hLFHB/nrk/X5Ge89pp1JjQUTmhZzShR6PRWaeN6UtBadUMr4M8blB5h7DtL2tOuNpZ09W56Quukga71ufquKLY1TqHc18+kUok8Wbtq/HJ8URaZfPNGpzwiUyVui3yqYFYg91sckaVE7mCGWIjN+tfwwznQE4k6aON2mOVAFY71G9h3Yb5LawnMtdqjjy7We+KJ9LwLN2svBz9cDaRCdyJGFqRO6Eqj5+gmrkAPZ0LbbZGOi7rv8XqiUyFvC1N6M3WwdY6E/KWvbcS55GZHGLBU1axOtqewLAPpzNJ/2N7CsWCxZodNWzfTp+xsXULoPVSLuxSOE6tiRBzSzgT1kA677uJ+eA4jl34XRC+wGno2hBJjMysbB51owazRN0o8EWEQkUg/Ew7pYyTF3UjnL2oG9WmCleCjQlB6HWSe5DV8z6W3EFEDiLya4oIeRYXXIp/8vZ9D+ryV7UWTHilPt+yCduWiFyrO5GA3gaMPIoGCE4pC80+EnqRG6uBZ1Met/Rw7WtHxxfBK3rDY33D4pSLjGnIlbZVgG8Axpz0BJS6TMwZl+s+O1d5kZLpqmS6JhRpEGS1+QXPlNbvRJYAxyfeHevjXNHClnVcWg8qqsFl7xvcD7XBZb+hwWX1wZVW8tYom/uv+1ZTSCj5gzMnSok2ZIE27Rlvjmzu/Wowz7zJf3RtIOmwti5MtL0nbNgt09LMnpK1eLDMD5b5bsvcLVUtG0S3UOHUGbYUxiq9ps1omjKQSa4EOutWS9yG1h0GgfC7d54OMIuVdukECSVSKMZ3+i/aXKEeCq4hOmHjk338nyLffaI6Ph/589SQY0H+yDYwqYp3rEUvQLEzFXYvmwNEqONz5vtp1ajoWOILn06xoU8N6BFWfQjBj3KR+mlz1GxzN8HbXGgwH/TonGK7dbv/xsNAr83eW7e2OQ997TnbJEl23eL7kOxNqP3xqE04SSq9hJbCGV7p4TT1MpVA2sF1TIMhzzVnR8si47JDDnHcVL7S621nic8OaaXosasbWWeiLSHNQaP5VcSWzQWkzvBYqFkxn/NU9XOV70/TunZBr02SCOyXp+cNBLdQKs24xmDJfpyLeNOAbMvamQtKVAlc9/3lq5cXfPUDGMMX0ASLiUP9WiVp65XSt4atIE3JwmQIoMsu/3bmDvcvV3yxAN1vW1o/H7kr675N31SV1fhriUuFFD/jmUmtGcnUprWecRsvwXyMDROet8QZ4dXyjABPEOwK179EzCntyVKnpCNrzHTwlBy2gQdPycFTchCRz+wpKfJk51p37ep+pbXuDnT7qeTfXYXLmzW1pFkqDaZsOaw+uzYwL1K3kaf07ZBn7cwI5hKKG5gJaf/4vMJKSAsL0G6zvsPuDbZcjaBuN7SP6ZOmjSlzqcVux9zqG6IBCMNCp612Cry1oCVPp22W76mvHJ/Q7Emmcme5sfBaLS6k7MYFXwhTnhMii05kvQ1tvGQFxayNhYwOVynOA9vWu8gKY2mcZJ5MJI+1Mo4kHqSA9rDWtmG54dTx+dJsWz5u442bp4D0+ITojbI0A8cl5NVJmsXKgPREAGkK3ILMC1toQLHKcm7FTKQID99EimbBh4gzmGCStpgV6HLC7S8YZop4iVndxyq+1YrHy5O/9PfZimRgecItn/IkEy1C8rJI01/JJqbfwrCX12dnGNnbw7sAijTF3yHnf5eQYLvvjZJVz43B5MUsFfG/+WjqzmUveo3pfL67h3KpDz3gwK+vxycuQMWHgnmPQ9vWKqjvUWgSXJROoGwV5A0tWoaiWggASnBdt5QbgeY+bKaB304XKTdmOld6uulXf5Rxf87t1tYg2r3Wn22NxCi41v3ZnWi/B6ThyHGvu8bv8egExgvKMribNreBaKGqDFklRx8JzjB1uGhdxi+oPGjrV3rNXoJFmWXujeYCRy5fldHJep9dgmWztVt3XMSOfydHK8BY0F8zwoIpyV5dXpKQY3RKCqFlAnmq1hkqkP5EQtGLQVrNU3Z6fex+TSQ3gvek0nYJGNYzMoK/xKdTjvZgYXpUfH1ZPq+Anl8DPkPBTq8dEHoVW7Dry4lcpGrGU/aC/tT2IRUS6Ixt9B2hJ69X/cKO8M3Ct6TSqBs50HttHj7jkO/DpTCtlsklVVULeWWGoAZnrhp1Vd04uuOpSIJh1Fj8rebCthsQHonWIFbXDcb6eTRqEa3BW11zVm916K3KoF/ngE6VhM21ysj6cAI+ZNh5G2oYQdeCFRa3WDgu4M5ZNWV0LPrZ40KjkyVdY9AdzOcQ40GIC7tjBM2F7E2kaJSO/VP9zCAUhJZ7sdlHdBWGPfXml1eo7aqwtlBgrB8dxQCJMzM/p/2yfF7I2Bm2TTO55sqi+WpxXrl5rLnSZAtfsau67YtKfpbSTT5u2eqyTCVivnY2RwIYbuRfRTpQdkc67xnQdPiQcSlBe6AyL+xm9K3nc7RNF7is2y3BSGCOJ5IE/abi8Jt+y17FDfGz7/M2UsTaDJu/l60+2rQp09fCubBxft0dh0lbPfn9UW3qK5RDlx/lkq+OM1Drrl0ommuP4ubuioqG0bMnT5/3njztPXl69eyr4bM/Df/wx/7//OnZ/z3oxMMF/O+zxUBZLPYh0CU1dBs53CnB2xggYU//iPsozWO8Fw33OO701njXRiasj65wLovLv515Ft5CZptxd+DwIU5uozxF7PqXHpf8pXW2O9OSmqDa9t2yuVJ/JgaNVbZbWqBt51vmLYp5XRpoGeCpBp6s3dFzCaM22oY5XgvCDm3/RbrYm63bBEsgFeSvKiMeSqsp4wKXUJNRbmk1f6FiTxu4Isod2VOe/d9jF1dq4FMs47Z02coqahgn5RpVO5wvPRf1jTCdD7K/0iljqbDaXEMuj/WDR7BjYwo68t8jnN6BpDj6a1NQRg78XPAU4zriVBlaFG82g/pv9l8oKORG/LON969CVSMVlApcyP33r686my7CENHuL+sTxoUBYRJRGc5/EwBNublhdPMhKy97pGFjcwo1oJW57JjhXGNwUQh8xxwlclbeDHzHg9VS8UzcPDQnKaRvVJkcO7Nla1NLJMOhj8pZtCGZFru+4ykdzqlaBnSs1K2ALpsVFIXj11eyjbwS/+7q6pxijJT2boCJ/A54AnpIfdVrhmwGXINm//XOd9AjDO6Dc24LL5ofz2docZRpXV1ad7DIZ8S44t99kLKBdu8jbxHHYMy8SF9SWhndKhnd32/5dnc07EbPn3wVPexaS2O5TLhOSLzJ2MOhg9ZKMyc820EBVNvi96WXwrWbW28lMCsWbbExs2JRGVzUigm/iUEhqjmGnezjhPA7LlJnJsmE1iG3awOJhRR1X6lr0vLc8hkGO/GE50HCChlM6rnwaffglpc2LbFj2HiTR1AOjm54fek2Bj45n9L0jSo0hRVhap13Ac9VIVutJQI6bXS6TcTyqSLlvMC9tq4TkyknTJKjZ7ncdGIHTYRfuZMd8m6OT9jTZ189/wNLFBhvhgnTSqLdfnMeXOWOROOT/kTOgdCYSmWn1YSeav2tq3ip7CgUT+TPhbJ86ixASLDZ37Dk1BfU1u1WuFE3akLYa4/5uCiSQ9p5c7fIFBzM5fRV/OTfaXc0kC3hLshtuWM2abizK5DuNZcmdvT8yfMue/7kK/zvaZf1+/1Ogxuw/kEHWAuMjRQxKYhjr6s29aWTrpoZUiojp1cuKr2yYXNs60uC9cJ16tTk84OaPKjJg5o8qMmDmnyPmnz60EvSD2ryoCYPavKgJv+z1eSzZwc1eVCTBzV5UJMHNblbTSYw50VqD6ryoCoPqvKgKg+qcpeqRMT4whBnaOqd5v5tT+l1DzM0KKKhNyviW8ABulTPnoto7mWQiCIj3kBqXRJN3MfiUo6f3KJUuUvqHVOD+Ayz7KM/K70elFm5Tt6RWhnedMDeTSRjjH3r0RnloutKjimvodD+AO6eos7YlzVoX349oRQdDCCK663ZN0zCqgnhqPN1aMtzMZao7WPwLWu9HzUgdaiLFCx93w6ZaMgcx33NBoNP/CgeO/ILFqrbQvpYp47rx71+pT6ir13futvZTyDEO8/8XVoT2D37hvEVFw0K9du+FnjkpijQxM9YHfWJ7HxNtz96znihahzhrrasM0PO41sU+YwLOs/1zHE0kRM7cYv6WzuJ3OM8K38q436pHCTPheMLNokWwi6LGeUsV/zSWyhsTQTAKA7q7aiDLDixYSxs+A2bROFp6iV/ErHBwM8G+4V94sRjP3Uiub7qJR/f367Jx0FObFMsht+wBqH6L2G1IST4Es/FsSNk2wuj87Gr3ZAUNziTd5nuomrFl0tI/VLCzsf90zaO8nPc/wuPbxcaDYCjTqc/9vNwFCak07+okeuoTrtO//QtxIUFNwoxJyx+9w2TInVzPLHzzPa/zbWQdn6kTP/SJqA1XqPhNKvLruJpimS/+RDONzdD9vu7yUTixR+gdecDfXxbpKkLLgiWYe199zaGDdjBoGzglN5Na+9Ddtl2WI8QtlFQhUUULppwPzjCOoJg8s5E3tel+nxtl3QxRZBsXEd2qnq8nNxVTiT1XxX06doA06/CD6ZOSUzdPTYewo4BbwLTGM7tXxnlAo2O3K0i1DInyoQG7gnF5Qt2gioyiOxSGRdQE3LKXPAraVQyssMNCXnK145l+7lWuBIbvDGB58KgBkLAlwDNJaqfu7t6ap/kTFNmitxf/9MU3OrTrJT62FzqagNvCrPTyjQM1DP7ohtUJOJ9KnGDwJmXTmcFYxxpWD+9QkLjJEwttakhNQpKYENhYDQlz4VvNnTYfsFcNszuTrgxrim+K6p1vNZjfTmveuhUixYZiewb9mX5EBTvl+wLVLsP0fHVUhi+J4s9NUs+qrv3qXjszOq1p56jYJDkzTCp0AJJUiqYbxp0LFf75lcEjko6dTeG1qnAkhwdTfwOz4NX87px1fvfdvhD0jF1WA5YHVNfCyTMrJRp5CIYbmNRNWgo9X2QYb83hA/7PYMOXUr8tmeS2x7efoI7i5qViy4FsXB7yB1fVj7qhG8rO1O59glkn8K/ufXadk182peXm98wRrXd+NqxWzUf0v97PrK80Td9JJk6dX21KnLcxC3UJk3brQX7trbcf34C0w3Rn4vCrvO9SZy7RXsH624I/m7ahi9lV2P717Fu7UPdn9b9I3PuUWtpP0s60faWvF09Ry7VXWKJozVeyTHctTcvA/Pb9+hIsfB+qbpqwfwHFXZQYQcVdlBhe6owBBEuDY8WpH5ybpfRMAp5AGZAxO6FOcDtH+g7uuPrzTv3iZVyB/LO7zumJi0W9627kAFpK02JKSFnv3zFuXf9mU9U7We2yPcPVehGVva5g8IQSp/9QxUU/09HHqKM/39Tf+NYSaNSqO7Di10B3YlnloOA/MAnqQ4WYHvGcu0+f+BoZyAutLBrSg3ztw5w4y6JoCMpSliikpIdsD/kdZdf0GzpiraaKkxMoYgByhygQ7B6ssKxd403Cq8bU7NcJ5r3E8hUGKADOsD/KaFH5W4Aaj5PhQT3zQQsZYHtnGD4Qx4UCw1zDWbpciAMO+Kp4Ia2vzceypQT892grDaLPh4+gshB4gFMdOEaUVJRDnJ8gvMpkQPGJ6z87Dq9tycdXFZK3cXviO4+9TYinK92feet+q5emX29VgWT4C7fbTAe7nZv4X0XMZY3MOKFAeih6DmSuQwUOrj4MMvo9Wu8YiTnMYxy8VdouRfyA3i7O0oQQM/dkvsvHwYet8m5Cue/PCarxqXOYUoLOVX+7OYR7+9wehgxu3R123ccfcHG0mqVFLFzHJ2ouMDT0OoeHPTXOKOLHEN0hY2ge64wKRxJMDofmz4bNSuwkJQO5QHN6GZfTPdNvOMk5GCde2Iwx1KOWfvs3PVIULgGlimDefHhcw3+KzyGfANffMEuT/5qfDp94kfA3EBnYIJTxdTOkL0KrM2gy+MuO6wdNxsCT8SghU+lqftSE3oHC74AQ/lSv7Az/+y36L+wE7WSqeIJAmCf8g9B1Cfkkf79gtj2Gv/YZsHH/3sEEO1gEdsTtA7qhHmTF7N+AneVxPmCgT9kMYPKVdZppe2bi9PRyQ+nFYSN4xST3A5mqZoNMo7XlPjjFeP/DhKu7cCBQPuhTtv+y9OrZleyWIDtK71oaoiyuMIab411jsRB5zGxVVbCFr6E7Wkq3gpd72oJb/t5VnXlnvel7CNgC4RSK7Yv1GZXFeid3ZUnY78KJyzUNh94bL/nd7zZVcbvQDY5wQDX8bJf1gy4tgKvJx+YJS4ig+q8ofNwbH/id3wH3yK2br9c8m2e/WSapCW+DcWBJwa1A+vOY9KWbpwllOo4b2J7hN9Lcxe3dD4V7Z5//VdB3gFvDIHhGM6/O99gRYeZMBvaolHckMQNqj8Y6XyZt7AzUdwdhDWwXediA1FfErYMNeYdbEvfw7EllFo1xUUxWze70sVsvYDMNDGulw7wR0PeHhVb7GqH7F3glRyNrmJ0h5m+ULVdWSjyv3Zi+kjYmvYVjm7EjQGDc4blhn+U83gJ7Fkfv1bQ3Amj7HGqJhr7d83gbHx8+vLytPes/6S/tBndNmVBZ+bV/NLdsoN7b6tMLbQomJxR7drRCLP3Ddm3uTI247KG105H5EaAnbe18QAQDw+dC8bfN+XcAGUOOuHTdAT82I3wCBIbvXuHcYfXOr2/x2K6iYDcA4kwFKzoHUFbGJRRndHRhd8Edj71gK7aPDQH5NyldbdQ8LC6r5g+Morvcd+8B70t31GF44+VwyQavvnxvhst6c6Cmi8ZtxJ53Xe8FSLbcPS8OL2K7u//H2ZyiU8= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Exchange Session Token + + + Request + + + + + + + diff --git a/docs/reference/openapi/expand-permissions.ParamsDetails.json b/docs/reference/openapi/expand-permissions.ParamsDetails.json new file mode 100644 index 0000000000..a91d6008c5 --- /dev/null +++ b/docs/reference/openapi/expand-permissions.ParamsDetails.json @@ -0,0 +1,30 @@ +{ + "parameters": [ + { + "description": "Namespace of the Subject Set", + "in": "query", + "name": "namespace", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Object of the Subject Set", + "in": "query", + "name": "object", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Relation of the Subject Set", + "in": "query", + "name": "relation", + "required": true, + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "max-depth", + "schema": { "format": "int64", "type": "integer" } + } + ] +} diff --git a/docs/reference/openapi/expand-permissions.RequestSchema.json b/docs/reference/openapi/expand-permissions.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/expand-permissions.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/expand-permissions.StatusCodes.json b/docs/reference/openapi/expand-permissions.StatusCodes.json new file mode 100644 index 0000000000..981d1a2ea4 --- /dev/null +++ b/docs/reference/openapi/expand-permissions.StatusCodes.json @@ -0,0 +1,240 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "children": { + "description": "The children of the node, possibly none.", + "items": "circular(expandedPermissionTree)", + "type": "array" + }, + "tuple": { + "description": "Relationship", + "properties": { + "namespace": { + "description": "Namespace of the Relation Tuple", + "type": "string" + }, + "object": { + "description": "Object of the Relation Tuple", + "type": "string" + }, + "relation": { + "description": "Relation of the Relation Tuple", + "type": "string" + }, + "subject_id": { + "description": "SubjectID of the Relation Tuple\n\nEither SubjectSet or SubjectID can be provided.", + "type": "string" + }, + "subject_set": { + "properties": { + "namespace": { + "description": "Namespace of the Subject Set", + "type": "string" + }, + "object": { + "description": "Object of the Subject Set", + "type": "string" + }, + "relation": { + "description": "Relation of the Subject Set", + "type": "string" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "subjectSet" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "relationship" + }, + "type": { + "description": "The type of the node.\nunion TreeNodeUnion\nexclusion TreeNodeExclusion\nintersection TreeNodeIntersection\nleaf TreeNodeLeaf\ntuple_to_subject_set TreeNodeTupleToSubjectSet\ncomputed_subject_set TreeNodeComputedSubjectSet\nnot TreeNodeNot\nunspecified TreeNodeUnspecified", + "enum": [ + "union", + "exclusion", + "intersection", + "leaf", + "tuple_to_subject_set", + "computed_subject_set", + "not", + "unspecified" + ], + "type": "string", + "x-go-enum-desc": "union TreeNodeUnion\nexclusion TreeNodeExclusion\nintersection TreeNodeIntersection\nleaf TreeNodeLeaf\ntuple_to_subject_set TreeNodeTupleToSubjectSet\ncomputed_subject_set TreeNodeComputedSubjectSet\nnot TreeNodeNot\nunspecified TreeNodeUnspecified" + } + }, + "required": ["type"], + "type": "object", + "title": "expandedPermissionTree" + } + } + }, + "description": "expandedPermissionTree" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/expand-permissions.api.mdx b/docs/reference/openapi/expand-permissions.api.mdx new file mode 100644 index 0000000000..12a19ae23b --- /dev/null +++ b/docs/reference/openapi/expand-permissions.api.mdx @@ -0,0 +1,37 @@ +--- +id: expand-permissions +title: "Expand a Relationship into permissions." +description: "Use this endpoint to expand a relationship tuple into permissions." +sidebar_label: "Expand a Relationship into permissions." +hide_title: true +hide_table_of_contents: true +api: eJztXG1vI7cR/itTHoJIgLS6Xq9vClzUsZXUTeJzbQdF4TV01O5IYrxLbkiubdWn/14Mua9aSWff+YoCtT/YWi45M5wZPkPOUH5gMZpIi8wKJdmY/WwQ7FIYQBlnSkgLVgHeZ1zGwEFjwqmjWYoMbJ4lCEJaBRnqVBhDbwI2YCpD7fqdxGzM/OizugsbsIxrnqJFbdj46mFDhlOeosl4hKDmYJcIF/nsF4wsXKBlAyaoz6856hUbMMlTZGP3xw1hA6bx11xojNnY6hwHzERLTDkbPzC7yqizsVrIBVuvB5uc33k+j2arXIfP43le6PTxXEsrPJXvNlopvx/GmNklaw6eK51yy8ZMSPuHt2xQUhPS4gI1W6+vibfJlDRoaMSb16/pT6SkRWnpI8+yRERO0NEvhqb60OCQaXISK/zoaCmSWKPr09bO5RKhfFtqSKoYB5ApY8QsWYFUEsnrhMXUsDGLhI7yhOuedzxsuN6lRuzX0+Fa8xVbD5hz5S7z84a7k9O2ZK5drjOu48CVjS8do8GmdQalJ3VItT3y43Qq39g5mcfTMt4TpyLuUiu89OR4O7lQhnIi7BJ16c8XaEFVTyfHEHEJM4RMq1sRYxzsk8Cg7TrNUwzQXlSfqP2PEHm86vcSWjdX9VUL2RpwU7C6roZX76ywiaNX6f35aDbx360b12/bmqU3zfUahDKXzj004qmK8Wd6CiXeR0lumi8mZUsoCW60wcg23580GkOZIJ9Xr35EPg+lW8xTq6YN76m6OO+8VLVThjJSaZZbjLf2PypeNgdIVb8/VZZmZjKMxFxg3Jhf1cYGDGWekuadDui5nKSD+HpCbMBoRqyApI1ZsAHbJiyhuaLfDTkaViwca8Duhws1JEmGZC82Zv+/FtlcEU5Vexx/eyhha6LTdv5dPQfs7RNDZHdRGctlzHUM7/QK/n7x7hQOz04AtVYafMgOOmHKve2Sm7hBZQjvjIpxli+6o46pGWgGXEgDrhcI6XkLJQO4pL2jMJCbnCcuOFvgt1wkfJYg0C5yyQ3tKWcIKKnRIT/e89SFYDfPmFs+4waBxzyzqOGOG8hdbxo6FzJ2wIIJpqTKLWC8Y9oUGEg8N9qpgLCwKwH5BhqLMalI5TpCiFSexG4+M4S5ymW8k++0xbSrxOqpVuU81y5aNpQJSnr45DbXFZg6Bm2Biyh1J+wSTo7ht29+9/b3ECs0Tlq8F2ariraF9ZNj0g6HXIpf81JFJ8dBKOfoxJhKZae1QSdaf+dfnCp7WDaH8tdcWT7F+wgxxpi6/YNaJkVDAxG30mUD1qbwKDh7XhHXA5aiMXyxJcL95F/U5qv9qRizfTtjuc3NNFLxFppHKia/yzQalLZJ0g8DGga9t6/fDuDt69/Rr98OIAiCfssb6P0j9u+7oW6BErWIHEAcFVi1CZd+dV3Xgyow8rhyXuNKm802wKQR33umHibfvsDkC0y+wOQLTL7A5G6YjHHO88S+QOULVL5A5QtUvkDlLqgkLWGUa2FXrtag9OowitCYS3VDGeera0pmW76gUgSrKxkkzP1Q6dVQc4uJSIUdzvLohlKR7AatGvI4FXKYYizy1HkP6fPCac2XNRIuF7T8VxleOPkovcNnmLAx+6vSq1GUCI82HhFIn2mmtIWHUAIA1EmEw0wMfNuRknOxyH2BJZRrmGuVwtcNel9/Q+nXSEljyZ/q3nAAEu/aFHr9b8q+PBMnkiJChEXPFv9ei1bfMUnQQpVNHIN3zG9gNNqXgYVeEbwIenMZ41xIjPuemjdrk9TOJOxeOmWqsklpTx52L62U3x9TjWQMMk9nqIkW9JTzN570d44tFftQLLiBi0OwhgPgd1y0NB50ymQ9b+9KvYX9vYKKh3KWxWMpaCj73zAq+RQe+L1qeJ7kVtxi0+kyHt0Q+KRcSJK6cMJeKEMb+u3FvQ2Zf5yn1Udl/CeVoeSZ8N4HIVsIu8xnQaTSUe2Vw4Wi3k4t81xGjluvT64e2mqSMD6AsE5QTwsUChmp3FsSPsA+73IC+SdHy3/eQWinbxGVUrmeTvm0g9Ie3yJapWWIloPQ3h//9Oc+UXBP8AEaDkUqCm176Y4PoKXm4BTvNhYyDeKZOPJm2Dbg8OzEv91Yy362JhuAHlCIoMEVpaCBAmcnwaTjp4WDBN/y6GahaR/T6/eDyka9ypr9wOu7523SD0ql9Url9oOfCkX1So31g8k9RrlFP0ExdwL+5gCkSLzzhHae2uC7TAtp5z1lggsbo9YDCItN6d0SJUQ8SchU7z8ynffvx/DVbRjKkDld9D/C4rs8SeBvl5dn1d63Md6PXtOv0ajq4CH7fZf1GCZb08c0viuAyi0JcN6m+rHpNaVDk/VDuW5CxdnKLn0dooALioA745TSq6l/GUrHvm4IUhVjYoIyIT6tQ+vUakQoSOya8SY5jcaWYw4zQbuqzIdA1zNzqik7+CdaR6/gmPCYLE/LcqmIioFyrbkDRAHf7hSxtDYz49EoS/jKO3OQaUXuagKlVzwThoCNCF8gtuNrkK3o1AQcEmEcqvAkAZNnJBPGG8G4vgMRuEDRitONibdXuQd6Nw1CpceKWyLvK3AVdQ8Rad7YIaDTD8/tEqUtzpBOO9SktPj3ptRETEjgUaR07DYN7rxAVGjfZlDfooZy7wWZSkS0CmjUxCOoccpCHi0dD0jRLlUMXNdVYZhhou4GkBsvXoG9YJfcEiXDrTBzgQZWKteeDPWNuKGSI3U5qub3LXKNuj2fMbT3g0+2BHdjp5YGU28ToLwVWsmrkH07OTyfnE8v3/0wOQ3ZdWWCCRXMgEMBnF5vXIIod19FDCE1lqvL9WnIcljC8waUAzcE3UW3sRfyFRxp5BZ3M+HGFPPJxFTUu8AGx/ZmsObR39inwAF83QngX8MripUfjd31DofItGN3TWNP2G7uiojEZtiuieyN2MVuauruxsAB/P4PQN5uu4Gaelq9KjTttT0pL0w1b5B0r0rVQ0ibVXQ4aBmhANAGfJo6og7K7WC9E6zFPqg+9WtODhh7YZGTKDiqeXurP/xLl+nYBY0mJU+qKXrxFh02QwXR5JM47spQd2hF6I+LAl8ZJw18Bdhna3dSM/HNMFaRSzY1TlyUABMLn/HYdhmt1y+vo/kz25YLZZtpgifdNWnf0KJAu3l3bD/5fVdQdtJu3BDbT33/zZSd9Mu9WU3fH4w69BuHpGaQrQ5JXSbuYpnNtbz0hLdvDyj3sVCbxt2yNbX3jf3jf8vSc56YL2bqTeLPbutNBl1jlzmgNv0tRB5vzMxvO7eu1hb0PcWIX3KtfsGF+oyrdBp3LNehflWu0etPXY297c1BGvdd/g3vLUp/9ZdsdoMrNt6VWxuwW57kuDXHRnMrB1dwXw14gf0X2H+B/RfYf4H9/wnYJyL+RO9KQNYZ0C7ZmI3K6Q/dxVAz8vam9JLLGXgT55qyT2V+46HIakxNki/WW3McIxcKtKBinCmui1dDfHWsKJmzOlvSUcu/KI9A1fBTtHdK38CZpwJEJYB/qdzdXHcVY2EpAUKmuWqOOFLSqASve6XwkW8gYQOzHJXCj6Jca5R2tEA7NJZTjqgfFKor8yYXVL3385lxI6Kqok928S2VmYkfraqZS3S0e/qmTldF2ZA37jsfibpzbFr5kaOisthq/LllmuUq1jyIMVXlBD3REf12XytRmZ+Ams8TIYn9IbhWKP3OHwCLGjmdATXONZoluLyKgR5PBPf5ovcFlanPvLwnZGg3PZ2+/86SpPo1O/edKFXyLkN5ckz2lOQBJ8fga4ZU66QPj9SD9YMaFVKvdFL/RjGyc0dDFamv5jeyVioHiRiTiC3Ho1TODa5qx7u7u3Oy0OqgzRJ5Ih25zShDbWjxD73Khk5GV/f9uMvo1T+VvnGAepiJH2hD9kS54a4kMEzwFpP//jTotoKcq/L6DPff/sCUi8R9d8KlbP/q7Vh/W4oku/DvWKfs/ApOpNUqzouL8McqyukyicdwlxdOEsjyWSIin1ilva0wVruCnAOdw7MTE8Bh+wU1OtBRMlnRXRE/WYyLrCCHW56ImPImThngXco7awBnnqOjQrnVVBmbrMg+McHXTKs745PQoXz1Ci6OfzChdLdu4mIG4Cc6Q1NmDE3jCk4BgQ0LBi7JXDFs3NYxjrxTBo2ZqyRRd7QeqfqQ8wWaMYnxAX4snouM0Qc4VncyUTwmAvApP0SiaZBn+vlA0g5bP7DZ8PSfZyCxnSxJe8y1bSnmKstnQYy39YorGkZFZdiM6jxwf6tur84nh8c/TWoKGzVgE9+MZomajVJuLOqiJmyKv6OYazvyJGj70NRtcDq5bLOS+QJtoPSijRBVcy31O70KfJZ81H9OaZWV2JHXSTtJxL3QTVZLvA+ytGblnx+r2WeQFp1IW6X9Xm2yqknvZFeV87+IJyxU1w8Kaf/Ob3mbVcpvUbY9wSDX0TKo3oy4tmLOIzsySwoio7qe2f98aX/ht3yH35K0PhlR+W2W/mLaqnV+WzaXPjFq3OXpP6duKQL6iNWUeVPa3j8pqMzRRsv+p4o9LIZ/EeE98dYUgOZw9rezDVf0kgmzgRat5tZK3ND6ZwudLbMt7uw07gvtLWlXmdgQtGgpjwwN5x11V9/nS+tE2ooU5/ls1Wal89lqgalpS9xsHdGH1np7VmmJ1Y61d06F7RariBKNJhCqcSorm4pPOyV9JmnN9ghHVy1EhHS3cVyd4Q8zHi0R3gSv6WudrWMGrT3uXjsdF2PN6MeTo8npxWT4JngdLG2auFMK6tS8m1+gvhXu2sbIKtO4mVluOenkjNr4fWxCynD720wZm3LZkOuRhc3NU3Xjjvrz/IeJYi9P1XO6+iDcmczp6aHIMlyxjSyDu9Lq8gzXA0b3J6jPwwPdCv9ZJ+s1Nft/juD+I4Uw7ip5kdLaM5/eeXHG7O8tbe8S2uezm4msMv/t0t2fJMcjvra+TYgq3fX5EjzqG+/bZGhkxvZL4bs3/31F3f+6TgS5+70DtkQeU0akqj7QESlrzrXzzYlW/ur7ySUbuCRI439rVCfLMt9yVb3ictWg/fDge7gD2XrNSumLxMD1er3+Dzv9F+o= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to expand a relationship tuple into permissions. + + + Request + + + + + + + diff --git a/docs/reference/openapi/extend-session.ParamsDetails.json b/docs/reference/openapi/extend-session.ParamsDetails.json new file mode 100644 index 0000000000..d39fa7cdb4 --- /dev/null +++ b/docs/reference/openapi/extend-session.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "ID is the session's ID.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/extend-session.RequestSchema.json b/docs/reference/openapi/extend-session.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/extend-session.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/extend-session.StatusCodes.json b/docs/reference/openapi/extend-session.StatusCodes.json new file mode 100644 index 0000000000..a5b9c018a9 --- /dev/null +++ b/docs/reference/openapi/extend-session.StatusCodes.json @@ -0,0 +1,528 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "A Session", + "properties": { + "active": { + "description": "Active state. If false the session is no longer active.", + "type": "boolean" + }, + "authenticated_at": { + "description": "The Session Authentication Timestamp\n\nWhen this session was authenticated at. If multi-factor authentication was used this\nis the time when the last factor was authenticated (e.g. the TOTP code challenge was completed).", + "format": "date-time", + "type": "string" + }, + "authentication_methods": { + "description": "A list of authenticators which were used to authenticate the session.", + "items": { + "description": "A singular authenticator used during authentication / login.", + "properties": { + "aal": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "completed_at": { + "description": "When the authentication challenge was completed.", + "format": "date-time", + "type": "string" + }, + "method": { + "description": "The method used in this authenticator.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "organization": { + "description": "The Organization id used for authentication", + "type": "string" + }, + "provider": { + "description": "OIDC or SAML provider id used for authentication", + "type": "string" + }, + "upstream_acr": { + "description": "UpstreamACR is the `acr` claim reported by the upstream OIDC\nprovider, if any. Populated only for OIDC login methods when the\nupstream ID token contained an `acr` claim.", + "type": "string" + }, + "upstream_amr": { + "description": "UpstreamAMR is the `amr` claim reported by the upstream OIDC\nprovider, if any. Populated only for OIDC login methods when the\nupstream ID token contained an `amr` claim.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "AuthenticationMethod identifies an authentication method", + "type": "object" + }, + "title": "List of (Used) AuthenticationMethods", + "type": "array" + }, + "authenticator_assurance_level": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "devices": { + "description": "Devices has history of all endpoints where the session was used", + "items": { + "description": "Device corresponding to a Session", + "properties": { + "id": { + "description": "Device record ID", + "format": "uuid", + "type": "string" + }, + "ip_address": { + "description": "IPAddress of the client", + "type": "string" + }, + "location": { + "description": "Geo Location corresponding to the IP Address", + "type": "string" + }, + "user_agent": { + "description": "UserAgent of the client", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "sessionDevice" + }, + "type": "array" + }, + "expires_at": { + "description": "The Session Expiry\n\nWhen this session expires at.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Session ID", + "format": "uuid", + "type": "string" + }, + "identity": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + }, + "issued_at": { + "description": "The Session Issuance Timestamp\n\nWhen this session was issued at. Usually equal or close to `authenticated_at`.", + "format": "date-time", + "type": "string" + }, + "tokenized": { + "description": "Tokenized is the tokenized (e.g. JWT) version of the session.\n\nIt is only set when the `tokenize_as` query parameter was set to a valid tokenize template during calls to `/session/whoami`.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "session" + } + } + }, + "description": "session" + }, + "204": { + "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201." + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/extend-session.api.mdx b/docs/reference/openapi/extend-session.api.mdx new file mode 100644 index 0000000000..80acca5bf6 --- /dev/null +++ b/docs/reference/openapi/extend-session.api.mdx @@ -0,0 +1,47 @@ +--- +id: extend-session +title: "Extend a Session" +description: "Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it" +sidebar_label: "Extend a Session" +hide_title: true +hide_table_of_contents: true +api: eJztPWtzGzeSfwU3rlTEOnIoK9rcFlO+WkZSEiaKreixrj2PiwJnmiSiGWACYERzFf73q25gXuTQlhNncw/pg0Ti0Wg0Gv1CA3oIEjCxFrkVSgaj4ISnqZALZpfCMJBJroS0DN5ZkIlhdglsIe5BMgPGCCXZ5DRkkzm79d9D4DoVYOw0V8aIWQpT1/eWCcMMWCZsJFciTZmS6doDJrglRD63oF1JDrGYC0iYFRmwJTcs58ZAEkYyktctDDXYQkvDctAsgTkvUss4Ozo8Zi8VO1HSAjUyuZIGmJLMFHEMxoTsVZqAZq/0mr0Eu1L6juVa/QyxNSzj60g6yATskL36oQayEnbZwlxI+jpTyTpkl9TNkbIxOZyCtkzNqbiE5UkyA5ZAriHmFpIS3LywhQbGZcLMUhVpwqSy2FRDirQpciU7CCIWUmkwLEb4cWHFPfb4pQBjDbOqRXmeNTCUSUVMzo4PjxlorbTDRiGqJgbJtVAmZO0heWpU1bfqaZiYt2iQKDA0B3gnjCXUL8FqAffQajc5ZXOtMiq7HfpSM1wtFc/EbT3skN1adeWqb9nV6Q8sA7tUSRj0A5WD5sjakyQYBW7OvmnQD3KueQYWtAlGbx62dsLkFFm2gdDnBrk96AcCq3Nul0E/kDyDYBSIJOgHSF6hIQlGVhfQD0y8hIwHo4fArnNsZawWchFsNm+xsVt6g/VHh4f4J3Z8ih95nqciJtSHPxtE6KEBr43pmDWmpHHKVji4PMZ17+hB5cxYboH275ynpk19gWvEUiUXoJmDg3P3M5kplQKXwaYf8MIuQVpBTDvldne06yWUGLJx3Rq/XosMjOVZjlzwegnSCZ4SiRU3rAWfcUv4ZkVqxWDOY6t0s0XZqTAoNZbCRNIvIomQlRsBWMqNZb777iAHEC5Canf96vqCxSoBFi95moJcALWPVZanYCHpIVHmSmc48SDhFgY4Uk2pcs1bhBJKTh2Tmq7lTIUhEdHogftotRTxkq1Ag5+fauHdXD5iUwtZJ3gj5KJIuW7DdzCTAtHdJumQpWohCOoWg/G0e73boLkxheYyBpbCPaQs5hIlmJKA04wQzPMo6LtPR/hJaffliygI2ZgtxWIJmskim4FmGXCJq8pRnSCnLrlOQEdyjmNJxq3l8R1qEUUrpVUmPHvzOFaFdFLnW5CgeZqu+xUKTGQ56i8HHPHbokSDZ4heq6VIgY3H50ftrnalfFvj2CmSqLtWSifs34mtemzJ74HNACSBcjJcsRS4lixTKPNnqrCItvGEMyxPgRtgS+AJU/c0xRFbWpub0XC4Wq1CpddhrLLhneZWmWGiYjOMlYwht2YYa0hwMjw1QT8AWWTB6A1O/TDoEwXcnyP354vgbT+wwqbIx+PWgo6rBT2nBT0Yj897XUxfbZROyfC63I9bVN6z2R6/19zm6mZNV+eWT3iB02LX5lqd1BS7Xudw4csjqUQSb9e+mpyeRNIqm2/X4IJHMlXqrsinBmINdrvJOVVGcgUzxEZu17+GGa6BjCTJo63aE5UAVjvU72DdhfkdrCOZazVHnt2ud8WRNDxLtyuvxj+eRzKBexFDJ3KnVOXxE1QzF6Cnc6HNzkwnVf03WB3JVMi7qYYYGXoH8Utffi7kHXtvJa6jMxp5ympWZ8gdDMdwMpPkP7Y3VnMLizU7qMaep2rVCxmbWKcArd/lwi69OdbYQkzN0E5kwhpI56FbmA/OA1eqsflKTkNjRSQxMrOyedAPWswS9IOSLwLcVATCr7QTyrh4QT/A1Qv6QWOpUBNsLQhCb5Lcg6y/v93eUv3g3WChBoj0AHcUGUBPW+Rpi/xxW2TTD5RecCn+yZ3w7pLlrxotmPBCfb5jE3apiFyre5GA3gWMPIoGCC4pK5t9JPQiN1YDz6Y87hjhxteOTy5LJ+OWx/qWxSkXGdOQK42G6GxNdSUw5nZPiVIfPSsu1yG7UHmRkulKXjWiSJMgq80rPFNZv5GsAE5OmVV3INFNtFxItLBlE5fw/ZPL3je5HxuTy/4HTS5rTq6ykndm6Qu41nwdbDadppBQ8kdnTlQ72pAF2rZnvDlSwXS7ImjAPPcm/8GNgaTHuoYwwTZOLZ9C6WllZk/JWnyyzJ8s8/2WuVNVHQ6iU1SG4m1LYazSa3JG07SKudB20+2AQUn4/Z6nA8xipV3wI6HomGJ8b/xCdJjwHgrqEJ2wyWnTJygKkXTNVeRTniQaTAdWk4uxqyqDcnEqMAjTASZV8R5d9C0odq5K72V7ggh1csH8OJ0S1YCe8oUP/mzJUwN6jFUfQnDTDEG9QeK93ZY4Ndf4ZXPU3BV3/QDe5UKD+WBE5wzbrbvjNx4GRm0e7bp1rflVFRJ81GrTTrLrjtiHZG/K2rcHXZuTdqXfodXmLLsMcJkGmUog7aEe02AANwNnB8si47KHG4BCpa/0ejdYEmvYGyM7cXVj60y0JaQYyTZWF7FlcwGpMzwWalbM5zxVYa7yx9O0KV0wapMkAsfl6UULwR2UKjOuNVkfl4+3DcjdCSs5FwtSrp7rvr969fKSr34EY/gC2mAxzBk2KklaY0DesBWkqYu3I4A+u/rpvE+R6qsVXyxAh12q9c8jd23dd8mburKeP+NV0K+Q4pcCWAOG21Pb1nrGbbwE8zE2TPl9ZzsjvERgUSYkt2DYDOwK9V8i5nPQiCF2JRnZYKanSMmTG/gUKXmKlDxtkT85UlLkyV5dd+Pq/iBddw/adJrEf3cVTMOcdJijlW9embLVtEJ2Y2BepM6Rj5dcLsrDc2dGMHf82cJMSPvlcY2VkBYWoJ2zvsfuLW25BkGdN/QY0ydNW0tGFor3mDtjQ2UiRTlop52Cp9Ja8nTaZfme+Up3Gs0lU7mz3FjZDcMcnprVMO5gXpjqnBBZNJLNNuR4yRqKWRsLGR2uGrB9gtccIisMZR048ySSPNbKOJJ4kMIZI48y6OvD9RKfz82u5ePTGoBNSqQnp0RvnwFBXEJRnaRdrAzIKjvBFOiCuDQK3FZZzq2YiRThYU+kaFbGEHEFE4HIzwoMOaH7CwazRZaYvHGi4juteLw8/Tp8jCuSgeUJt3zKk0x0bJKXRZr+QTYxfRaGvbw5P+ezFAaYrVCkKX4uMxT2bRJs971Rsh65NZm8mKUi/l8+m2Zw2W+91nIe7x+hUvXlCDjxm5vJaUAuuBPNZcShy7Uqxfe4bFKGKN2GonBYVbUjZaxifhDcwU3ZUjkCbT9spoHfTRcpN2Y6V3q6HVf/JPP+M92tnUl0R63/NB3J0wI6/bN70Zkf1A7kuO6u8XsiOiXjlcKyDDdtu4FooaoMWSXHGAmuMA246FTjl1ReSutmmpzr0VZwFPJVGZ2sh+wKLJutnd5xGTu+T45WgLGgv2KEBSbkvbq6ckluQi5SKFsmkKdqnaEACSMJxSAGaTVP2dnNifsUSW4EH0il7RIwrWdsBH+J38442oOFGVDxzVX1fQX0/TXgdyjY2Y0DQl2xBbu5iuQiVTOesm/pT8MPqZHAYGxr7AAjeYP6Ew6EPQvfkkqDfuBAP8p5+BOnvClT2DotkyuqqhV5bYagBGeuGmVV0zi656lISsOopfyt5sJ2GxAeiUJ3nGi4YW4uz0s08KPHo8oQrIPVOwN6q7KUr3PAoEpCiYdkfbgNPmI4eBdqmEHXgRUWd1g4LuGuStakjU1x9rjQGGRJ15h0B/M5xHgQ4tLuGEFzKXuRFK3Sif/WPDMoC8qWj2KzjxiqnPbUm19eoHaLwoaiwFw/OooB2s7M/JKGVfm8kLEzbNtmciOURevVEbxy69gIpckOvmLXTdsXhfwsBTqFItXUZ5lKxHztbI4EMN3Id0U6oCsI6XxgQNPhQ8alBO2ByrywjPJ3ebria4ydlXyOtukC1brd2RgJzPFEkqDf1hx+G3b4Km6Kf7qfJ+YCqfY+w+bvVauPNm3cAI1zYePiunsOk3ZG8v5RY+lrlMshPyokXx9noNRdu1Q01x632zuOrByMgqPD58eDw+eDw+fXR1+Mjv46+suX4X/89ei/fteJB3k9jzrtwL1YPIZAV9TQOXIu/ToGSNjzL9GP0jzGPGj0cdzprfGhjUxYn13hQhZXP517Ft5BZpdx9+DwIU7uojxl7PpOn5b8lXXWcVbuWYuaoNj2w7K5Un8jBo1Vtn+3QJfnKxPK1q3S4ssxUA3wVANP1u7ouYLRmG3LHG8kYZdt/0Wy2JutuwRLIBUUr6oyHiqrKeMCVajJDCqkev3KikfawDVR7sme8uz/Hru4FgO/xTLePVRtWkUt46TSUY3D+Spy0XSE6XyQ/UCnjJXA6goNCWOKRyTVT4wp6Mj/Een0DiTl0d+YAnMsGPxS8BTzOuJUGVKKt9tJ/bePVxSUciP+2cX712VVKV6qtj7l/vvX173tEGGZ0Y5TcpFUSgPCu0RVOv9tCWjKzS37pUAOrC530LSxOaUakGauBma41phcVCa+xzxNKVhZ3TgpL5x0bITfcuAebDY74caqqh8cHR53BAHJR6pujDCukSzOsJV90up+P/WxlSp07Fs5SyZxlsp319cXzO0Xd6eBOm7BxisTdp2LmFjj6PB5iGgd/64LKji4sVwmXCfE+mQIjS8m/m6RY6zdA3Oq7SAHdSpR3umVwKxYdOWNzIpFbYxQKya8gY8M1giaun2BSpLfc5E6E0ImJKOdRwMSCykjvRZlJAG55TNMBOIJz0vuK2Rpbs6Fv3QFTvR27aA9036J17T8xnF0w8tHuxj4W16QVLzA4ua9sbkqZKclQUCnrUF3iVh9q0k5L9AP1U1iMuU2puR0ea10yHCANsKv3KkHRf4mp+z50RfHf9m6IfZxMWVehpEdiSanYSTnQGhMpbLTekHPtP7GVbxUdlwWR/KXQlk+ddYRJNjsJyw58wUNndYJN+gHbQiP8r8+LYoUrHWRzh0ylcHXavlqfvJ9up1wkhtTOlDdje+hNGlouBpkU9wcHB8e99nx4Rf463mfhWHYa3ED1v+uw50F5g2KmASEv/S5I6Xd7mqo6EoYOblyWcuVLX28K7gJ1rduUCcmj5/E5JOYfBKTT2LySUzuF5P+gv6TqHwSlU+i8klUPonKfaISqQRxoSmZ/c1DoPR6TM+WUCQlGL15i09JWL4wLv7gI0lvKZCl1wNMSaMQ7mBWxHeANHC57QPKRxmkakWsg8S8IpK5lzBSLhc+L/iKkMM8SD7DK0XB35ReD6srCE4cIDEzvNbFHiLJGKsSdsa56LuSE0riKtxrHJHcuLc9Pm9A+/yriPIR8bQkbrZmL5iEVRvCQe+rsi3PxUSiMojBt2yMftCC1KMhUnyGJhkxx4pfseFw562PKHKvfbCD8jEZq1gh/aFNr0b0wfNjn8Q027AXjK+4aGEVtt4dOXD0EEkke18Fm35F7W9Vg8qS+1O8isA5j+9wl2VcSBzfE/wgkpGNnB59Z6PAfZ1n1Udl3CeVg+S5cLRmUbAQdlnM6NJDvQaDhcLWNEEMA9NoBz1c1siKhI1esCgQydRvsChgw6GnI/uV7XkyBYFFtr2koxeshVD4ElZbC4ydeC5OHMJdHcYXE1e7tcrYE5V5n+k+Sg3sXEEKK+64mIRnrZXxRAy/5vHdQqNSO+j1mUh64dk7fEMHHFJiTkD/7QWTInWkiew8s+E3uRbSzg+UCa9sAlrj9TUnA1xWo39c6XYvCre3I/bZfRRJvGkHWvc+APybIk1dXK80Xhr9Xe8N/hoO63eLaOPdtocdlbFkbLw7miosjnbZBrF/Fk0kwOS9SG6anH6xtku67VVyO8qqvSJF6fXUVUaSBq4LQrqLY8Lq0RrXo5rLdnONWRC+0TgXqN1yW7fMadJlA/cNmfcZO8WNX2YtLJVxcegyFdOdGZOcIGuuvFiUp3zt+Cgs35TCi0Y8Fwb3HQK+AmgLuzB3V1zrCyF4bGqK3N+abW+j+gUjyhhuC83GxNtby0kgmgbu58eiWwqGZxRN9oKEjhPLkaHrMQ+kDhYpXSZZ1lgjMDxej/EyH0nw6lUt1J943o5n2F4HslylIl6H2OvMSSDjgtgc0zMLuywf98DYt79JnLAZpGrVxwNln9XqzvDwnBMhGW6FoYu7a1W4/F1qG3PjcjWeVaoH2NfANej2fEasrZc/eiU49Z26y8ovmDIhyHuhlXwTBV+fjS/PLqfXr344exkFb6slOJPoCnDmZZajG55/l6rQW8hIxnL3UJsGLuNSJm7JTzwF5rnwzUYOyWfMZfHtH4Qb4+eTi6moVXJjxKZmrkfolSqRvWCf19rlc/YMdcv7FQt2tHrtkXSIOmFU3yut63DMShC+aCHqtfTUj3Agkl7dj0TBQeS9ofIVuXnT0hj8ZxvAiARgE4YD0kTB1wLJIVaJI6Q/jHZHrxu01Mn7kGCfGcKDfcagF2zIMjTJ3QDvOaLV3TDx0N0WC+dfbT+WdtArn0tzBmLz2bNtT+QDz6iVptXOg2nuVTR8Pe7aQbyqj8UWahu9Lc1t3zWU9CfD9Tdgmjvd1knMirceheEnR+/A/w2zpEe+BWFFr+oRGnhDarTPc6jyJHY9CNTsZd+Ktxp5FU889v+Wx7BZ+RYXPpkYLwkruwxGwZA4qH7Y8UEkm6GbBFqBpPod7pT5WZkpD944mZq0WGw6TZUhsZ+mpI8yH77q4oINPgIZ1EbPDi3+geZAM+P5wkFhCCVk/1AF5a5RAA5fu3ABqjfNHidKGpVCfdc8dgV039wshyXyQ58AOlyAHRjLtXta0BGwNH8o7cpn9HPjLmBQgJSSgaikWlscD1llRvZKu6Ur2mmq0Kg5ovShVK3cRfGmmXPiAzWtwpvW0izXieZhApkqJ+iADvE3Jcuo3E1AzeepkODeI8RSVvKX020+5IjqTcNcg1m6nA3DDngquDP7bj2UqTOgbpHl20UfD989GioxHBhcukaUsJODnJziekrkgMkpcyGYMuHlkXSwrlMj4OSITvdR2rGd3eQZb8E2n1xdq4JJcA/btBgPLbI7eN8jB9XrBpiMj27MwJFsQDhSGO3DLKPXr/H6Ts5jGOfiB+h4c+EDeLv7Pwhg4F6g+ZdPA4O/cq7K0wgek5pyaWmjwHtef3PrWL/4iphdubrd+4PP2ERarZIidt7lqYoLjM3Xd8zQqXPXqJx/hKJQ0B1STLhGEowvJiZk43YFFpLQoRyoGXjXAfOInQPg85suPDGYYynHrCG7cCMSFHSRMmUw57x8CnGm1co4XzKSz57hW7rGp6onfgbMTXQGpjT8TeNEw4vAxgq6zKNqwMbhhyHwRAx65lilqVrhfsQgQcEXYEaIxq/s3H/3xvCv7FStZKp4Qm/9/pYfBNFckE/08ytiO2j9sO2Cj//5BCC6wSK2p/gYdZMwb/JiFiZwX+84XzD08UczrN25Xidt31yejU9/PKshbEUaTXI3nKVqNsw4XgHykUfj/w4Tru3QgUAjoknb8OXZdXsoWSzAhkov2hKiKq6xxhdZnLM77H1KbJWVsIMvYXuWindCN4dawrswz+qh3PfHUvYTYAuEUie236rtoWrQe4ergsZ/CCcs1C4feGy/5/e8PVTG70G2OcEA1/EyrGqGXFuBT38NzRKVyLAOO/Z+P7Y/83u+h28RW+cAVXybZz+bNmmJb8vikieGjfOR3qekLb3mQig1cd7G9uA1KhW6FNX7rWgPfPc/BHkHvDUFhnO4+O5iixUdZvjgfItHWsWtnbhF9d+NdL7MO9iZKO7i4S1s17nYQtSXlC5Dg3mHu7vv92NLKHVKistitm4PpYvZegGZaWPcLB3ih9Z++6TY4lB79t4lxqdbQ8UY2zChUA2vrCzyn/Zi+omwNd0ajl6biQGPikeVxz7OebwEdhTiS4BtTxj3HqdqorHva4bnk5Ozl1dng6PwMFzajG5yWtCZeTW/cjfY0P22yjQOukuTM2g86RFgZrwh+zZXxmZcNvDaDrJuu8+N3J6n/yry9F9F/i/9VxHvPuK5Cx6aCQoD+OvJLrj1JnAPfvTLux24r0bC3eWiCNfbfoAHcNj04QHTu250utlgMV1fwdyOOobl/j2JMJQhFozov3W8Z7sdXPpYR2/fycm+SZTXoeS6EfAN+j68K5Jg83bTD/CNUwwqVTFj9DLzZox4J5evFQi8GF+ffBe412sbzx9U7nkZtHrz0I3Qw4NrQV7tZlPh56MrbzebzX8DtV/hvg== +sidebar_class_name: "patch api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session +after the specified time has passed. + +This endpoint returns per default a 204 No Content response on success. Older Ory Network projects may return a 200 OK response +with the session in the body. Returning the session as part of the response will be deprecated in the future and should not be +relied upon. + +This endpoint ignores consecutive requests to extend the same session and returns a 404 error in those scenarios. This endpoint +also returns 404 errors if the session does not exist. + +Retrieve the session ID from the `/sessions/whoami` endpoint / `toSession` SDK method. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-courier-message.ParamsDetails.json b/docs/reference/openapi/get-courier-message.ParamsDetails.json new file mode 100644 index 0000000000..a5802b71e8 --- /dev/null +++ b/docs/reference/openapi/get-courier-message.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "MessageID is the ID of the message.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-courier-message.RequestSchema.json b/docs/reference/openapi/get-courier-message.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-courier-message.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-courier-message.StatusCodes.json b/docs/reference/openapi/get-courier-message.StatusCodes.json new file mode 100644 index 0000000000..c510431f0e --- /dev/null +++ b/docs/reference/openapi/get-courier-message.StatusCodes.json @@ -0,0 +1,230 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "body": { "type": "string" }, + "channel": { "type": "string" }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "dispatches": { + "description": "Dispatches store information about the attempts of delivering a message\nMay contain an error if any happened, or just the `success` state.", + "items": { + "description": "MessageDispatch represents an attempt of sending a courier message\nIt contains the status of the attempt (failed or successful) and the error if any occured", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "error": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "id": { + "description": "The ID of this message dispatch", + "format": "uuid", + "type": "string" + }, + "message_id": { + "description": "The ID of the message being dispatched", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "The status of this dispatch\nEither \"failed\" or \"success\"\nfailed CourierMessageDispatchStatusFailed\nsuccess CourierMessageDispatchStatusSuccess", + "enum": ["failed", "success"], + "type": "string", + "x-go-enum-desc": "failed CourierMessageDispatchStatusFailed\nsuccess CourierMessageDispatchStatusSuccess" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "id", + "message_id", + "status", + "created_at", + "updated_at" + ], + "type": "object", + "title": "messageDispatch" + }, + "type": "array" + }, + "id": { "format": "uuid", "type": "string" }, + "recipient": { "type": "string" }, + "send_count": { "format": "int64", "type": "integer" }, + "status": { + "description": "A Message's Status", + "enum": ["queued", "sent", "processing", "abandoned"], + "type": "string", + "title": "courierMessageStatus" + }, + "subject": { "type": "string" }, + "template_type": { + "description": "\nrecovery_invalid TypeRecoveryInvalid\nrecovery_valid TypeRecoveryValid\nrecovery_code_invalid TypeRecoveryCodeInvalid\nrecovery_code_valid TypeRecoveryCodeValid\nverification_invalid TypeVerificationInvalid\nverification_valid TypeVerificationValid\nverification_code_invalid TypeVerificationCodeInvalid\nverification_code_valid TypeVerificationCodeValid\nstub TypeTestStub\nlogin_code_valid TypeLoginCodeValid\nregistration_code_valid TypeRegistrationCodeValid\nverifiable_address_changed TypeVerifiableAddressChanged", + "enum": [ + "recovery_invalid", + "recovery_valid", + "recovery_code_invalid", + "recovery_code_valid", + "verification_invalid", + "verification_valid", + "verification_code_invalid", + "verification_code_valid", + "stub", + "login_code_valid", + "registration_code_valid", + "verifiable_address_changed" + ], + "type": "string", + "x-go-enum-desc": "recovery_invalid TypeRecoveryInvalid\nrecovery_valid TypeRecoveryValid\nrecovery_code_invalid TypeRecoveryCodeInvalid\nrecovery_code_valid TypeRecoveryCodeValid\nverification_invalid TypeVerificationInvalid\nverification_valid TypeVerificationValid\nverification_code_invalid TypeVerificationCodeInvalid\nverification_code_valid TypeVerificationCodeValid\nstub TypeTestStub\nlogin_code_valid TypeLoginCodeValid\nregistration_code_valid TypeRegistrationCodeValid\nverifiable_address_changed TypeVerifiableAddressChanged" + }, + "type": { + "description": "It can either be `email` or `phone`", + "enum": ["email", "phone"], + "title": "A Message's Type", + "type": "string" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "id", + "status", + "type", + "recipient", + "body", + "subject", + "template_type", + "send_count", + "created_at", + "updated_at" + ], + "type": "object", + "title": "message" + } + } + }, + "description": "message" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-courier-message.api.mdx b/docs/reference/openapi/get-courier-message.api.mdx new file mode 100644 index 0000000000..b0e412c234 --- /dev/null +++ b/docs/reference/openapi/get-courier-message.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-courier-message +title: "Get a Message" +description: "Gets a specific messages by the given ID." +sidebar_label: "Get a Message" +hide_title: true +hide_table_of_contents: true +api: eJztW21zGzeS/is4uFImq8gZr9d3H5jy1SoW49UmsbWSsltbGhUFDnpIWDPAGMCQ4in871cNYN74YsuJfbcfpA8ShZfuB41Go7vRfKAcTKpFaYWSdELfgjWEEVNCKjKRkgKMYQswZL4hdglkIVYgydlpREdUlaAZzjvjdEIXYN+oSgvQv/g5dETvx6nicMmKMgdDJ9cPNGdyQSf0alPCpWNLRzRnc8jphP5F6U2c5gIkthpV6RTohIqiVNqSh0QSQkjgcVKKUd0gM7GoPJJEbkmmVUGed4g9/z6RiUyVNJak3dHkNZGw7lMYDL+vx7JSnEljmUyhGVkzH/QIDR2HHCwRfEKM1UIuvidxHCRxdkqEceI7OyUqc5+CYCMy4JCxKrfEKlJJDpmQwIct4gdiLLOVGRHOLCNb8pqwNRM9eNGe8AdeOIIncvg93Y4ayb9VHYlLZsUKusIuWXrHFkAKJiRiCMIfJDKxCU2VtHBvE+r/zYrmozL+kypBslJ4wZOELoRdVvMoVUXcbsh4oXC0W2RWydRxGwxxixMrOJm8JgkVfAb3TnMSSuI4SJX8Rh4hVCSc2P5eT16THrjoHax3dh4nsVK88eAPTTg5P/O9O/uPMzWYckT0iIDWOLmhFNVqc34Wvd3bqCDT6AeW3i20qiQfDEdE8GE0vYe0suBxiczR/Y/XRIrcSyqxWWGjH0stpM0GykSXloPWI5LQqdZKk/USJElZnqPgbj+F4vZ2Qr5bJYlMqMM//Az9H6s8J3+9ujonuGolDXTm+9lb/BXHzQB/Lm/3WU/qHcUJ+xxVZZHjRZ/MJxfTxQKmHCZy2z0C5xu7VLJzDJTejI/aHaU3M9+ZSMe7bYgKxSE3UVA7EmY0y9kdrsHYetBJKab3KZTearmRpVt3PcD/h5r8jJyiVcBNRCVfKqRiiHJzWU6Y5CQYEYNWZGltaSZxXOZs4zUqKrX6AKk1kdIbVgqDBxIJXwL0TWJUbkimNGEkF8biuWJ5TkxVIibgO/azZJoVYEGbyJmrnmntLLx/zrxpcsvAg/5YuLXFeEaulkCChSmqjlEHJx9W2SVIK1IPBKWDTUqL/9lFjcSEJCxNlebOzq+FXToqJ+dnxIBegSYG0koLuyGlykW6iXDW1Jsm44QFLF06HqQAu1ScMA2k1GolOHAyh1ytR6QyHl4wasQumUVKhllhMgGGbFSlPRkcmzLjDdmz5oIC8gMwDbq/nglK+iRNwZgrdQfyi3eCubkzi5NxtIlAroRW8jqhP0xPLqYXs6v3P03fJfSm2YKptIiDBOvl5cYkEfWFGSwyirE+PW5MB8tJbSB3jClhBo1nGDbxIJ+RNxqYheNMmDFhPaWYifbi7q2+ub9bBsP6qiSvyfP21nlOnuGd8/gLB4lYvQl4Pea3YAlrDULdgcwbu/i6Bxiv8lnqcc4C+YHgw3ayswuDhOIpaIiorOOcjP/7AJGJs4hdOp5QF0voBWeYSGOfcENgso+gHdC7aT4HhHxnHBbyHYEh3d6MaHsinZPYd0kfIX46okI678Uu6YhKVjgDzumIavhYCQ2cTqyuYERNuoSC0ckDtZsSR3m/gm4RRy0Hg/0vX7zAP07DpcWPrCzzYFbiDwbBPXTolRodYiv87LnimwNcRjRdMinx2jnU51Scz5hj1xeDV39+4mw/I0vIS7RNVlepJZmAnDtbtFDzKstYrqJSlSiYTOkC6VHOLIytKNDf2+PMhSmZTZcefJ/zadNHjFUaiJCeqFONuaqst7vWQlFag5vDIRcrcA4bq3cpkb+wjTMYDG2uRD9DaSIywuSGLFlZggQ+IkqTD2jVkeatqZxxunVOsN9oC8UBkEFLaqxEQ6nBgMRwRtbYEJoByT2uoJctvjNbw/OK5h3vWtlqGoOMiRw44gzosiofunvG2ffuqlSaVqh8ox3t+P/baAfPKZ+wOXb97fL9uwu2DvLryY2gkkedTryzyFrpO0PWkOfe6iOBEbn8+88jJ4PLNVssQEctczXHyxyZC76/3KvOiRam3gxSK2R3YVXljvTemsKc2efINwaDzAFVoFF6/hguXhsOc+hqijAN4UROhV2CJgn1SpNQVJuEBsVBnyZoU9+FrdX40tH90c+VYdYnx176MXREQVYFnVwHzujZhq6b3cVhoL5QY5wwxrXRCf1GqLYjWpX8qOr/6vu+iepvu3fBtb8cOorT7G/PCvfg3uxq9Kg5REV/0bjOMJRpzTat7n9WyzSkohThwtnXQZAc71Pf3RAT0v7Xq5aakBYWoD+ltCe1U/LckMt64bXGfKyg8hrjQ6JSK9w9rypsziRXEvghParlkfZ0ITBAOJWX3KG1oXXNmYWZ79lFnEgNqVqB3syEXLFccIJZpIvQeObbOqP2x/xjZwQmpw4Se6M47BN0ww8PDpTxysuCh9Aj/I9OR0O4N/rw2EN091B3J/SQ7087PilwMraau/4rMPbSVvNE5moh9qb/jI2deRoWwlh9kNVFp29PWGyew4xxrjEEQd9oAV2A2H3ie9/4zo6e7iqEc/e6u99t6Iptr71uPbSBu80HG3eoH5G8szLVHFMPO0J1iA6KsKF2SFKPsuVP5+bp3ABv76Rdy4puL7rj3lWZA7mFgon8Fl2V23KpJNx2Dp3rw0sBO5z+BZvfvVIQyKHb7d/p8m/ue+vBtjfvyEdv7XW1ezn1LuI/4jDQLULry6HpGtFXXxiCHnRMJWeak/d64zx1lyzxMYoXXLQXnDQhQp+czynXIfLeLA7zanEgeMTmNqxyo7oBZESu0GMWhlSmYnm+IVJZwlZM5KjDLqRYMpfXnAMBiY0cMYc0TVgnvo3MmQHCOCsxNbVmhlRuNE7NRB2d5VD4LT4eGfUX8I4VUGcevNwwvbCPAPULDOZINfgcMgaYOXfrmQPJMLN5lO+sx3RfiM1/rSizSrsD243GlXQ4JbOYLQxBj2PQB/ze6aOP385OyZ9e/vnVfxKuwDi0cC/MQREdCrB8XoaRSoqPVS2is9MokRk4GDOp7Kzd0KnWP/qOd8qe1M2J/Fgpy2aYegLMmk61/ju2TENDN6A5RJeOaJ/C48KcrwqxDUWP5if6CQYvrE4W60jQ6W6GA5kCxXsBe0syxKM4jQxevXg1Iq9e/Bl//WlEoiga9rQB+z8fS2yPG7MFSNAidQbiTbBVuybXn67OddEYI29XLlq7spM22LeQjtZbz9Qlr/zjx5OpfDKVT6byyVQ+mcpjptJlkPxjpnto6T8c0sn1Db6CWLbAd5g6iYNI7sf4Rq6ZhVwUwo7nVXoHKII7zawyY8YLIccFcFEVTnkMvxtzlTpz1yn2QRMsFv7MHaoZGgxpeA3yL0Hdl5xdDf09r0T91yD/5GMrLa887V9a13uhdsEeKN2w950qjX8X5KUvb9gX9d6z4qMgf1O8g/A3KvjQqSfcW5BGKOkh3cGGTo5p34iuWF7BES3Ego96eqONzZQnrXzSysdqJQ7zhR0escNnl3RCY6dxcVhBXBdLxg+Cb12SAOtH/DIqjZVGda3LQ6hwmZm8WmwP1rvETlm1y+SY8L7cTPEXXPB6aVs5syeWf2FNCTq078Diwx0591QIUonIv1Tlcj/O6RMWi2FQYtfdGW+UNCqHm0ENPvUNCDYyy7gGH6eV1iBtvAA7NpZhvdAwCvKrr51LdMDDCzkzIm2cchS/b2m2Gfmh6sxd0Ut/pG/aG6qwMualexvJ1dqx6dXKvAnOQa/x197WLDdcs4hDoeoFeqIx/sZNTVXpF6CyLBfSp75cK6nVy9dDBDcXXxo1ZBrMkrgaG0MGLBfM1w7dBiozX4Vzi9rfb/py+r42V6ILSi/8IHwEf1+CPDvF/ZSoAWenxF/76K7gh0fKwfpJHSfHCx3Fv+NP7IVZKpRBCUNA8lJhvdtGVUQCcITYUzz0eO5g0yreer12WPB0oDlHTcQKFBOXoA3Wwo29yMYOo3PdPq8yevNPfNEuWQonpfgJNl+M2z+JI4FxDivI/++XgQGHzFQdATP/xOZTtRMayvf+4vexLZBBZJe+j+55js/ImbRa8Sr1JYqnKq0wHvTRk6sRzHNSVvNcpL7IDm1hSFivwBmdk/MzE5GTfgc2OqOjZL7BcM8vFp+SfRUZ8Snw8yAM4lXKK2tEzj1HRwXr7AplbL7B/eFovuZarY0vSEzks2fk8vQnk0gXOPOwAuIXOgdTV4+ZThQdTGBnByNXcNgw7ATcxpF3wsA5mcpztcbziJWmFV4FE4TxG/k5/B8KqH4jp2otc8U4EiC/5wdJdDfkK/38hmjHvR+y2/DlP1+BxGGyiPaUadsTzHVZzSMOq/bEhYY4VLebuK0JHB6U7fXF9OT0l2lLYaeO3fC7eJ6reVwwY0GHunYT/sacaRt7EuhDdGUbvZte9VnJagE2UnrRtxBNc4v6vd5EvmIyHn5NtMpK2MPr0E5zcS90l9US7qOyaFn5/x8r2a+AFhykg2jfql1WLemj7JqvJHwTTViofT0IaP/GVqzPqmArkH1NMMB0uoyanphpKzKW2tgs8RKJ29r14R9H+4Gt2BG9RbQ+XGr0tiw+mL5ond7WzbVOxJ2v4gy/pmzxBvQ3VhfzLtrBP/FSycCmy+HvhT0O078JeE+8twSCazj/6/mOKnpkwuxYi15z7yTuSP0Pgy6X5QF1dhL3X6rood2UYgdoaKlDho7yxvun74+jdZAOWoqLar7ps9LVfLOAwvQRd1tj/NA7b18VLbI6cvYusBy2xyrFZIiJhOpEZXVT+HQU6VdCaw7fcFjbIlLA9OSkCd5PSpYugbyMXuADeS/MwLPHXLeTcZhr4p/P3kzfXU7HL6MX0dIWua8Q04V5n12CXgn3FZ3YKtNJrtYupy+ZMd6PxVd74/zbUhlbMNnB1SvP342dO49JX/S1yOCY49ci8DstwgVYbtEPIW9wTZ2vjJUDIcXaZMMR+0S4jDx+QQbHPjzga82vOt9usfljBRqztzdtesAXzQvjHnzoJGO5gU8sZnARwsjhY77acGxFdX2j3HQScXQUcm6C0+3NdkSXwDjG7k0uD535spu723um66Vb3k6vsOYQQ++2ZrCJgerMwPXDYTgPD36ECx222wZdCGFvttvt/wLku3qi +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Gets a specific messages by the given ID. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-flow-error.ParamsDetails.json b/docs/reference/openapi/get-flow-error.ParamsDetails.json new file mode 100644 index 0000000000..a649f07de7 --- /dev/null +++ b/docs/reference/openapi/get-flow-error.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "Error is the error's ID", + "in": "query", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-flow-error.RequestSchema.json b/docs/reference/openapi/get-flow-error.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-flow-error.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-flow-error.StatusCodes.json b/docs/reference/openapi/get-flow-error.StatusCodes.json new file mode 100644 index 0000000000..7aa5f80a63 --- /dev/null +++ b/docs/reference/openapi/get-flow-error.StatusCodes.json @@ -0,0 +1,193 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "error": { "type": "object" }, + "id": { + "description": "ID of the error container.", + "format": "uuid", + "type": "string" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "flowError" + } + } + }, + "description": "flowError" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "500": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-flow-error.api.mdx b/docs/reference/openapi/get-flow-error.api.mdx new file mode 100644 index 0000000000..2329f41fe7 --- /dev/null +++ b/docs/reference/openapi/get-flow-error.api.mdx @@ -0,0 +1,44 @@ +--- +id: get-flow-error +title: "Get User-Flow Errors" +description: "This endpoint returns the error associated with a user-facing self service errors." +sidebar_label: "Get User-Flow Errors" +hide_title: true +hide_table_of_contents: true +api: eJztW+tz27gR/1e2zNxEmpFIN+f0gzJuz/Ujp3skbuzMzY2VsSFyKSImAQYALauO/vfOAqBI6pHX+doPtT/YEoDd/e1idwEs4PsgQR0rXhouRTAKLjKuAUVSSi4MKDSVEhpMhoBKSQVMaxlzZjCBOTcZMKg0qmHKYi5moDFPQaO65bEn0OFETESXq67KUiqjQZtqCrcsr1CDkZBhXsJCVsCLMscChWkJfjseEafrf/DkgOhGz/f2rmG4gsgct+d7e9AbC4NKsBzOUd2ighPi0HeMLJ5fpULgIpWqYKQ4xEzAFCGVlUiAGbh8rRbws2JGanirUblfp05Lyw6OZVwRRsvgXS8zptSjKJrP56FUizCWRZTIWEc3lktEphl600RpLuc6allu6IzVD4NBIEtUluk4CUbBDM1pLudWZjAISqZYgQaVDkaX92uT54Dx1nw91TA+DgYBp+4PFapFMAgEKzAYBTwJBoHCDxVXmAQjoyocBDrOsGDB6D4wi5JGaaO4mAXL5TsarEspNGrqf7a3R39iKQwKQx9ZWeY8ttCj95oQ3bf4lYoUM9xRxwrJia6YpeyqceT6Dg2pwqxboAJtVBUbSDnmCaRSwUxOqzRluQxLWZLh3HQGoyBhBoeGFxgM1tUYBNYuLQXl9D3Ghnp4sollfAwybbkhqcu4QNURWFXWmBuyqjLZqeVb1/enaLlsT+wlKfZusKbvIDDc5NSQrtxrSYRdlK3OQbC/9/1XTfl6akHQhomEqQQovn46f/0KDs/G3rROMVKx6yqrCdvm7LVLblAlOK1mm1TH1FzPogY7qp0JQrC5imuodMXyfAFCGmC3jOdsmiMwkUDGbLqaIqCgxoQw4x2jrOX1TJhhU6YRWMJKgwrmTENlRxNpykXinMrluU/6aVeBV6zATogDhfMmApp/1JSnFWpZqRghllWeWH3qVLdT7lVH6KYRV98aU6aVMhmqTlqVwuIUzFQKO4HUBfza+qRbUcbH8Ndn3+8/h0SitmjxjuutJtoRsDaeKsE/VLWJxsfhRKRoYVwJaa6aCT1R6tR1vJLmsG6eiA+VNOwK72LEBBMa9i9qOfENBF9UBUXXVr7BIOhyaEWgV2AQ3A1nckhshqQDRduDQlwOggK1ZjPcNNOvrqOZvsafPE24zeLaMFPpq1gmW3geyYT8rlSoUZg2S0cGRAa9/b39AezvfU+//jqAMAz7HW+g/ibLcWH+tt9A4cLgDJVNcbsS2gwFKh7bBHHkc9V6SnTR9a4hWiUjl1feNHllbZ3YzJGW10sn1KXJ/cc0+ZgmH9PkY5p8TJO70+TzrzxAPKbJxzT5mCYf0+T/VZokYGymrWcoK93O/d1QqsVQMYM5L7gZTqv4BklBV20altU05/Ew47PMegbZ6txaxNWNciZmFNqLEs+t7GAQ5GyKeTAKfpBqEcU5d5nERTvZqqCiHdxPBADAqQdzWPKBazmSIuWzypWuJmIJqZIFPG1xe/qCam+xFNqQpzSj4QAEzrscev0X9VhW8rGgXB+jH9mS3utw6lsRORrgyQicp72AKNqsjE0mtjYGvQRTVuWGEmklEky5wKTfAL337jawWRiWcABszngHVdgu0vWcOXgyEf0XwXKwMvZL2TKyYIbfYtu+JYtvKIYKxgWJ9/buTcTETNwqeWcmgfuaFquPUrtPskTBSu5MDZNgxk1WTW0dspmC4UzSaKtfWonYSuv1aVYnhicwOoBJwJMrHz6TAKLImxE+wo76IjGbmO6Mjg6gAyh8hfO1+SUiVvIjB3gbweHZ2PWuTTJR0lI9ADUgHES84hSunONsHL5sT4y3YfhPFt/MFK1YvX4/HCc9nvTDkzuMK4MOFk8t278cgOC5M87EpIUJT0vFhUl7UofnJkGlBjDxe4d5hlRHznOy1fUuENfXI/judjIRk8BC73+G92mV5/DjxcXZam/SonfUS/oVRasBLvCuO1JHsPpMozfFycqQuDddHju1aINAXfYnYtl29bOFyaRouTtlq50pRarFleucCCu3aQgLmWCuQypDXrns74la+qzTKNSmHnZYclrBSpeU7MjSKl4PcN/IhZ/AMUU/TR/5dya1Lc1KS8tyu1nzycJdV/iKf5mzhXOnsFSS0rqmGwBWck3RR4zPEbsZLywXtrrLIOfa0F6G5Xl9MYLJWnpsiv6hTUudzNlSvBtgLg9ZNSiqvxRunR4I9wldpAADHzn+ykcAr9Ox34TRSlfPoB3TAnVYB+ZaEAPTFLR+2MihfQKu+L9bCNPaDSVa3iwLLYnt1aGR0K/zMhzA0ybFPYUnlOA+nd2I0KiFB+mAvkRjb4WG5ImOWDf9JHcVkAcdsLRaXDUOTdmnobPe2Jv4Tbenl2l7xRv+vctgZAOxzcMxaUPwvWhDAVYRQXOAo03pzYBOVvsUCPhOWxzwHWA/WNo9ik5uhnQHRpu71laDTnV85rbxazdcvX59x+X2Ke2rqvX97ufuvvwKv3HJ5W6y6NbwwnE8bd9xzOQ6vu4aYu5aa8XDgd2EmrJcfwZr6dLspj3b7vVFIL8J4aeN2Vt9Coukb3eyeGdQaC6Fg3KDi2C0ays7COzF8PYtLS01NfXKyVYUj8726Gw0tECTSX+HbnGZLBgF3Zt4d+9OmxL7VMDBrhTtWeoF894vk1c6r2bLrYtmZJ1PcTpJa3/ZvSJxR1u7b6Bt/mr53TDD77JStpT1Cs1cqhs4c1yAuITwu6zsOwVb7uEGuCuHXLYpjqTQMsfmOULsGuyTBJ1FNfgorpRCYaIZmqE2jDYd/dDbTWNcKW4W51R6c/pMmebxqhxHpnctq2kleeQlU2QKVXeka9oYKlllsmc01D6HsAXAymRS8X/bHcKRLwt0Gt92piZbJIqFCRayVtAxjeg3TWosS6eATNOcCxJ/CLYVatdyS5wvcNEqpzBVqDMw8gaFhh7LOdN2t3btuVyxOEatr8nbu01fz989+BBUfAreuEG0+Xldohgf03wK8oDxMVzQcLKbpftCOxhH1CpvOKOT+dXi0GJ2jDcLrJKe9oDpPN2h1zkCMSGIHcejzdkNLj7xDiaWgjYVOipRadpQD53JhhajLdp83mXU4jepbnTJYjws+c+0BHwlbpjXDIY53mL+31eDSo0ilXXtm8V2kcKCcZpSfwb4wc1j81qHkJ27vmCjZvQExsIomVSxO+d03ia5g0aeg1tB7TmGJQUXXBtlyxA26RyejXUIh90OarRJR4p8QYVepywmfp/P6PkWT+DMGwOcSzlnDeHMSbRcmEIopDb5guYnofQ1VXKu0b8Re/IEzo9/1v6xWOI1AKfoFHV9BtCt+rlPga0ZpIo7NgJbpXZt2VtjEE0q81zOKR7pzFqxGWr7wOwj/OK/+z3xRziWc5FLlhAD+Jafj93HYt/EYxtbQjvs/MB6w9f/PACL7WwJ7TFTpmOYy7KahgneNhHnGyJfD9NRc7Lrb7Xt5ZuTw+NfTxoOa5UvndxE01xOo4Jpg8pXwrT/GyVMmcixoL1D27bhq5OLrihRzdCEUs26GWLV3KB+rRahO/dG/YdEK43ADbwW7UnO77hqi8rwLiyLRpT7/qWWfQC0aCFtRftSrotqWO8Utypi/imeMJObfuDR/sRuWVdUwW5RdD1BI1NxFq56IqYMT1lsIp3RIhI1VbD+H0f7nt2yHX5LaN3xZ+W3ZfFed01r/bZurn0iapXr+w9pW1oB3YrVxryOtvcbLSopmjjrfyvsoSf/U8A75h0VgHQ4+/FszRUdMq7XskWnuROJa1b/w6DLrNziztbirjzbQbso+RpQ31IfGVrOG21G3x9HayFtzRRvqumiK0pV08UMC91F3G6N6EMn3h4ULYnaEXtvKr22wsVU29Ahl61TWd3kP+1E+kBo9fYVjgr0PEa6mBytDuuHJYszhGfhXjBYOwlT7DHbbW3saXX0y/jo5NX5yfBZuBdmpsjtKQVVoV+n5+6cTeduI3XrWrXectLJGZV2+9icjGH3t6XUpmCihWtbvXX9CN16TfL4nwz/+/9k8Mceujqgawduj6/Wpe59NeYyaHML/HsRTVfcdHFBA+7v6enLW5Uvl9Ts/onB/u8D1/a9jK9efcIVem/8Wby/q8i/C6wrMtr6VV2OtLXtutgTjC7fLQdBhiyhqseqqEnHoLJdxNx42tQpUL08uQiWy/8AD/KssQ== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns the error associated with a user-facing self service errors. + +This endpoint supports stub values to help you implement the error UI: + +`?id=stub:500` - returns a stub 500 (Internal Server Error) error. + +More information can be found at +[Ory Kratos User User Facing Error Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-facing-errors). + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-identity-by-external-id.ParamsDetails.json b/docs/reference/openapi/get-identity-by-external-id.ParamsDetails.json new file mode 100644 index 0000000000..663e923247 --- /dev/null +++ b/docs/reference/openapi/get-identity-by-external-id.ParamsDetails.json @@ -0,0 +1,37 @@ +{ + "parameters": [ + { + "description": "ExternalID must be set to the ID of identity you want to get", + "in": "path", + "name": "externalID", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Include Credentials in Response\n\nInclude any credential, for example `password` or `oidc`, in the response. When set to `oidc`, This will return\nthe initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token, and the OpenID Connect ID Token if available.", + "in": "query", + "name": "include_credential", + "schema": { + "items": { + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string" + }, + "type": "array" + } + } + ] +} diff --git a/docs/reference/openapi/get-identity-by-external-id.RequestSchema.json b/docs/reference/openapi/get-identity-by-external-id.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-identity-by-external-id.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-identity-by-external-id.StatusCodes.json b/docs/reference/openapi/get-identity-by-external-id.StatusCodes.json new file mode 100644 index 0000000000..aecea0eb0f --- /dev/null +++ b/docs/reference/openapi/get-identity-by-external-id.StatusCodes.json @@ -0,0 +1,341 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + } + } + }, + "description": "identity" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-identity-by-external-id.api.mdx b/docs/reference/openapi/get-identity-by-external-id.api.mdx new file mode 100644 index 0000000000..bfda621efa --- /dev/null +++ b/docs/reference/openapi/get-identity-by-external-id.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-identity-by-external-id +title: "Get an Identity by its External ID" +description: + "Return an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) by its external ID. You can optionally" +sidebar_label: "Get an Identity by its External ID" +hide_title: true +hide_table_of_contents: true +api: eJztPP1z27aS/8oeOzexZiTKSfN6PeX6pq7t5qlNE9cfr/PO8sgQuZRQkwADgFZ0jv73mwXAL4lqnMZtr1frB5vEx2Kx2F3sLha8C2LUkeK54VIEo+AUTaEEMAGXPEZhuFld7S2MyfVoOFwul6FUqzCS2TCWkR7eKGakHkZSRJgbPSy7DAqNapDJGNMezFbAjQZ8Z1AJlsL4KIR/yQIiJkDacVmariaCiygtYoRIoQXDUg17GM5D0DLiLAXN5wK4gEgKgRF11D16NwsEhTqXQiONVmgu5rb02sOc1jCv4W2BagU5UyxDgyoM+oHMUTECOI6DUTBHM/YT+WZ17NEeHwX9oOqkg9Hl3Qbp6paQFdrADEGjASMtKuMjkAmUBIKVLGDJhK2eown6AScYOTOLoB8IlmEwCrA5tsK3BVcYByOjCuwHOlpgxoLRXWBWObXWRnExD9br/iZmY0/ZwwZluYBTT7OJmIiyCROrxgL0IZEK8B3L8hThOmdaL6WKr0EquJY8jq77mwsQwk8LFOXMy0bnC65hydMUlGWwiaA+XHAaBd4cFGYBz8J9OIgi1BrO5Q2KfqP8FBOFelFWMBHbQd/kKMZHcOgYgmhsGwBPgN0ynrJZimFJW7vuNXG3WSNoEpUbzDQ9oCiyYHQZlJMnduFxFPQDI00e9INUypsin2qMlF3IJc5YYRYi6AeRjNGyjdY3SGPnSiY8pTLNMhowxlseYdnesUfCUU0TrjRBS7m4mSqM5K3DnkDW71f9zdWvCphSbBWs11fEOm5t7Hye7e/Tv0gKg8LQI8vzlEeW/4c/a+KYuwYh2qx08ICKQWGuUKMwGhjsLYqMiR5QA+KpN2oVOoLlqAx3uEcKmcF4ysw2Zoeu7sAAJ3gLTHNUoI0qIgMJxzS2zDyXsyJJWCrDXOY0QiJVRvCCmBkcGJ7R6mwRtaGULMnimDvNddJCcAulSt5ak9U5RjzhUUPUwA65NWEpEj63Qs5NSih9d/bm9Slb/oBaszm2wdLihY1Ks2AGllLdaFhimsKSmwUQgD6c/fjKidHZks3nTgv6ScvZzxgZP+k/iNy1IHSQdVxX1vMHBinXhpRsIfjbAqEBAwzpnw1iQ8ZMtEBtFUQp7R+QpvJ9E6VzghdzKsq4YAY1zNAsEQXEPElQEYbUVROCDWYKJ6JULE31TPBOfPlEkL7ZrH0zPjqcCFJBmzXnb85PJqKllTabvLKVE1Gqqs36n3BGqldMBKmbzdpDGSNVO9RvcNWF+Q2uJsKru616VzwRpAQ3K88Ofng1EQ29uNngyFZ5/DY15mbjmle+peqJaOnTzdanvvwVFzfwi5W8EmOWbjEWjYFxufPTGwkGMzhfwV41dpLKZS8EGFsREtKQ7outkPo9tWkJOakkSwrTJHQL88F5HLr958+1hfWDd4O5HBDSA5IyaxY9isijiPx2IrLuB0Ue79zrLlzdb7TX3aLS3Fld7WH/6SpAYWL3MEcr35z2kTYBQrjQmBQpLMkAjxZMzEs/yJkR4Iy6FmZcmC+e11hxYXCOipyIDXOgX1kgpS3XIChN436mT5q2lsxaKOQIztAtLdGRWJoakElqJ8B15Th12imlnzTl8TYVG24ZrV7tczY90pKa1TDOY+HaYWWkZVHvtZQ+nJEEroKiV9pgFsI4Ie+nb+E1hyidQmeeTASLlNSOJB4kd8ZIhzXUYQTZ6TTxeaK3LZ+QfLtzcj9LpMdHlt4kSzN0XIKxtQRbxVKj8ERAoQuFGpLCFApJrLKcGT7jKcGjnkTRjP+P9SDsCsackJ8VBmPQRlJvXUQLYBoOZXSjJIsWR9+0GLEoeNw19wwNi5lhUxZnvENIXhdp+hvZxPaZa3h98eoVeZIDch6L1HqVpRe+S0io3Xdainrk1mTyYpby6E8+G6nmTPhl96LXWs7nu0eotvpyBJr4xcX4iOCWKnvK4lih1l2uVam+D8ompOMM48IJFMlF1XtbyxgJfhCS4KZuqRyBth82U8hupvOUaT1NpJo2p/5g8/4j3a2tSXQ1+wP3SJYW2Omf3fLuGFgjXnbpu7vGV7vZvGS8Ull65tpyA8lClRmxSm5WboXtgPPObfzUlpfa+o1awWs0JLPgerQ3OGq3kBnGwEUIZ2hgtnL7Tlakhg98n5ysAG1QvQCLBUgBb87OrJBT+DPFsmWMeSpXGSmQcCKwGEQojGIpHF8cuqeJYJqzgZDKLJBpAweas9f0dszIHiz0wBZfnFXvS7TvPyG9YwHHFw6I7Uot4OJsIuapnLEUXtp/DT+kRiLoB+2xg37gh3NPNBD1LHxLWxr0Awf6Xs7DHzjldRlR7LRMzmxVvZHXZghpcHDVpKuaxtEtS3lcGkatzd8oxk23AeGRKFS6C4uL01clGvTo8UAR55ILQyalwu4BvVVZ6tcEKagSQ6JkZq0PJ+AjoMG7UDPMdARUzqi4w8Kxzb1VwzVYwYYF0xAVioIs6QqEBEwSjExINpbhtwgW2oF9pnOGZunYvzXYsyooW96LzT5iqHLaU29+eYXarQobG8U5zxA4xeKtOIN+m4ZVeVKIyBm2bTO5Ecqy69URvHLr2AiliQ6+gvOm7UtKfpYicafbtvqQyZgnK2dzxJiiQd+V6ECuIKbJQKMi1xQyJgQqD1TkhXGnAyxdshXFzko+J9t0Ttu62RKMGBMuMLbQr2sOvw47fBU3xT/cz+MJJ6r9kmHzz6rVR5s2bgCM6QyMWlEovWXTfGAk7x81lr5GuRzyo0Ly9iTIOB/CqBUsmfbcQuaFP1YKRsGz/afPB/tPB/tPz599Pnr25ehvX4T/8eWz//5I+2WDq61GvY+LQbJY3IdAZ7ahc+TIU8J3EWIMT78gP0qxiA4Gycexi+J1V8ozbpxn5EMWZz++8iy8hcw24+7A4UOc3EX5lDY03+lhyV9ZZ9sr4NnGKWpS2+VhYiLl15ZBI5ntlhbs8nxFTKEB1HTM15AGuw2wVCGLVzCj0HsFozHbljk+kzJFJprj/U662Jut2wSLMeU2XpWhWci4aTVljNszykzThlSvX1lxTxu4Jsqttac8+/+CXVyrgV9jGW/gYWWwtopaxkm1R13Vg1eRi6YjbM8H4Xt7ylgprO3Q0HorLlW1XfeD5/vPP+EklBZLGyZipmKLjd2bDk7GgEpJBY6Dts8wbW1HmMp2Kk9qt3rFOCvm272OqLjeH2wr4N7m4lI041gFpVlYvVWdjdu9msTGGZkoqDAOW9rBMiUzbMY0iRrLDSqrTwpRWgAJ9+fx6KShi+F3TPs1yyozz9GNjue3MSAOQk3mgEItCxVRULNI4zJilchCdCp3C3TaGnSbiNVbTcqkINdANYkJ0ilwwSgQVtnINEAb4TcuEG2DMeMjePrs8+d/g1ii9rsG150k2h3mY2Vkz5FofBRORIIWjamQZlov6LFS37qK19IclMUT8baQhk3dhoUxNfuRSo59QUPNdMIN+kEbwr1M4odF0cbPXPBpi0xlPKxavpqffJ9uv8iqvqk949oOudC5TkPp1CBdN7AHP3vP95/34fn+5/TnaR/CMOy1uIHqPynePkeBikdWQRx6XbWpVJ10NbRmpYycXjmt9coHVaSF9dIN6gL7CStS86gqH1Xlo6p8VJWPqnKXqiQqYVQoMi8pPVSqlctntEmJwejyipLxDJtrZwd7S/TKGs1qNaDjb+suDmZFdINEA5dHN7BnX4MMY15klnuInmeWai4TNWVi7tOQzix+lHbBZpgGo+BrqVbDKOVO2ziNQPTMcqkM3E0EAFTngwc577uSQ3tmXLi82IlY24gePGlAe/JiYtMfKDgTNVvDVyBw2Yaw13tRtmU5HwvaDyL0LRuj77Ug9ewQKRqoc2FH4LjyBQyHn5JzC3t+Z6P3QvhwUs8N57ND62PsERyQh/NfT8pclCfwHp5Q2ol9oCwT+9BKKrElZQaJfaGFsw8+L8Q9u2QP+0z5Hvahkd7hADezMipYdcnfiR4fyPQF+J3zfOH3S/OFvfJgv7dzZUsOvPN6qW+3a1jDV8CWjLdYM9yRBr7nxKPmRy8vWxwzEb0XASVje+F8KRtCKZiPMVfymLPohvRyxrggTL187k3ExEyc5fXOTAL3mmTVo9TuSeYoWM6daMIkmHOzKGY2JbcW2cFcUmtLCgpS2NH2eqQFJqaeEoy+gkkj/XzqWWMSwHDoxQ/ew6dIHw24RTIa9/LKwb+blHnrdX2Nx5oQKZvCe3hkfGJ8WtaJaevi0VfQYo3wNS43NDN1Yjk/dKzT1eHgZOxqN9Qz9STC9EH1acenzhWksFLrJ+Pw5Q5p8owdfsOim7ki03Sv129IVy/c4oK9Lb7phcfvMCoMurnwxOLyb1+B4Knj7YlJMhN+mysuTLIndXhmYlSqDxPvTrikKZamxE/X98D8+noE/347mYhJYKfe+8Aw3xZpCv84Pz+pOKnR3/Ve05/hsL7MYrfc610IjKp9k/ptDywLQwOftqHdZ2pNzFDnvYlYB2trp+j4ZkAZ/mQDNqwNcv743Fn7u2/Q7PXKOzTOaum65rJpKT/oHZv2HRrSze3LIDVH1Zj8H9/2qeTp06dfPv9y/z+f/H2LYH9hvdha74SlGt1dGELj3K3tuBENnstNLt6pssy7hsL5E7J0uW8+csuv5BafcyooEdetO+XGj3b5cdUJWac/R2tWdq/Ua+NQ7VHNPqrZ/y+C86hmH7nlI9Qs1flzcKvtLBOYRTAKhlaFDuvE+eFsNSzZYXhXM8aafGxUt+WdbZsDF5QXV+9yJSm4N9VpMV+H/k3TZVaWc229Z6uLlT3+LjODqy4uFOrPR4I8ZSvnw2wt+b9koVq5nycOChCU+j68PR7gplzGy2aPQym0TLG+dRu5AnvzVi+GJfJDnwo3nKMZaMOUwbgXemqWAUqbgOJzm5l2qej2+MamRdiSio9pPBLdGTKFqt3SFW01laRZn9lEilQu3ZXZwiyk8jnThz6M3Cq8aC3NYhUrFsaYyXKCDuiQ/tq0AZm7CcgkSbmwmwjYUihZzHl1/kCEHDvlWdcQZ2rYYyln2orVtYcyZZbrr0nhtIs+Hr77soCgw4rg1DWyqQvdgmKTKejhnnQwrlMjHO6IbjPz25HnrQM5SclhZYKQz/EkpSfQXgZpMx7Fxm/wl657V/e8KS2ZIhEDR7KBxdEG+T/MMmr1E11kyFmEBzn/niyij8Tb3YQgAIMUbzH9/adBR1MikeVZKYuszeYSdEaBLnKK6X3t1rH+FAFhdubqtm9SfQZjYZSMi8gF4o9kVNDJYX3bhrIC3YUSq4utZuT2Nh2lnhIJDk7GOoSDdgUVuo9wiJQSpsBNljIq7XEcczmYcOKJ0doPQjhxI1ooTCFkUlP2rU1U5gJmSi41Km1zdT/7DM6Ovtc+aTf2MwA30Rm6AyMHqTr78iqwsYIuW7QasHE0qy14Swzqk8g0lUuSRwq9FmyOekRovIdX/h3c7z0cyaVIJYsJAPyaH4FoLsgD/d4TtoPWDzYLPv73ACC6wRK2R0yZFmEu82IWxnhbS5wvGPpYt6bI9NRFGXudtL08PT44+uG4hrAR1dbxzXCWytkwY3QZwke5tf8/jJkyQwcizOJek7bh6+Pz9lCimKMJpZq3NURVXGNN36ZwIc5h7yGxlUbgFr4W2+OUv+OqOdQC34V5Vg/l3u9L2QfAFi1Kndi+lJtD1aB3DlcdUPwmnDCX23zgsf2O3bL2UBm7RdHmBI1MRYuwqhkyZXjCIjPUC9pECIdBSe9PxvZndst28C1h66IBFd/m2c+6TVrLt2VxyRPDxtFt7yFpa79rYVFq4ryJ7d5PtKnY6yG9X4v2wHf/TZB3wFtTAJrDyT9ONljRYcb1hrZoFbckcYPqn4x0vsg72NlS/GRlFo1tiLBd5XwDUV9SugwN5h1uS9+nY2tR6tQUp8Vs1R5KFbPVHDPdxrhZOqSHlrw9KLY01A7ZO6XAQWuoiGJ9OuSy4ZWVRf5pJ6YPhK3u3uHsdzcipESWURWsOMhZtEBy4ukeXcvNINljttrS2PfVw1fjw+PXZ8eDZ+F+uDCZvdNmUGX6TXLm7vKQN26kbqThlCZn0Pi4QZASMax9m0ttMiYaeL1E6xhVqd7+k3HH9e35TYe6kYv4F/1mnfc76PB0mKeMW//R3/BzQZLLwN2ZLz/KYhMk+8FsFdSfTAj6wagRRbvqBwupDfW9u6M0xguVrtdU7L6eZr96x7XNffTxm19YmL/8d+c618jF+js/P1ceE9jD1jLo9JFE3zv1wYneJ+Vn7MK+vO4hVk18y1k1WGl9te4HC2QxhYyqExIidN48EdnKI27F/F4en9PFX4r41Je8K9e7DEhd3nWjdXfnWtjFWa8rLH3k5Gq9Xv8vjL3sTw== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Return an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) by its external ID. You can optionally include +credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-identity-schema.ParamsDetails.json b/docs/reference/openapi/get-identity-schema.ParamsDetails.json new file mode 100644 index 0000000000..782d0ce423 --- /dev/null +++ b/docs/reference/openapi/get-identity-schema.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "ID must be set to the ID of schema you want to get", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-identity-schema.RequestSchema.json b/docs/reference/openapi/get-identity-schema.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-identity-schema.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-identity-schema.StatusCodes.json b/docs/reference/openapi/get-identity-schema.StatusCodes.json new file mode 100644 index 0000000000..8ac5ac8e8f --- /dev/null +++ b/docs/reference/openapi/get-identity-schema.StatusCodes.json @@ -0,0 +1,122 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Raw JSON Schema", + "type": "object", + "title": "identitySchema" + } + } + }, + "description": "identitySchema" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-identity-schema.api.mdx b/docs/reference/openapi/get-identity-schema.api.mdx new file mode 100644 index 0000000000..cc85f66475 --- /dev/null +++ b/docs/reference/openapi/get-identity-schema.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-identity-schema +title: "Get Identity JSON Schema" +description: "Return a specific identity schema." +sidebar_label: "Get Identity JSON Schema" +hide_title: true +hide_table_of_contents: true +api: eJztWutv4zYS/1fmuCjWBmQpt83dBy9yqC9Jt+4jm0tSFEUcZGlpZHMjkVqSiuPL+n8/DClZkh/tPtLe4bD+kNh8zPxmODOcGemRJWhiLQorlGRDdoG21BI4mAJjkYoYRILSCrsEE88x5yELmCpQc9owTtiQzdCOqzWXbgkLWME1z9GiNmx4/bjBY3wCeWksTBEMWrAK7BxhfAIqrZjAUpWw4NJNztCygAnaWXA7ZwGTPEc2ZCJhAdP4rhQaEza0usSAeQJs+MjssqBVxmohZ2y1uqHFplDSoKH5FwcH9C9W0qK09JUXRSZiJ1n01hDWxxa9DUXxBXx/+foM1jJX/NT0LcaE2AqbeZgd5axWq2CD1uaKgB0eHH4Gtqs5grFcJlwn8FovPdDR+RhQa6UhVTrnlk6y0HSWVniNuNltcqduU627rV0JTsvZ9q4TGgaSgAtpwK0CIT1voWQIV3NhQBgoTcmzbAlSWeD3XGR8miFwmcCcG7KAKQJKGkwIMz7wvHCaJTkTbvmUGwSe8MKihgU3ULrVtDUVMnHmhRnmpMpg0y6CfWKf8RwJntvtVEB2t42ALBCNxYRUpEodI8SqzBInzxQhVaVM9vK97TDdVuL6V6PKtNR2jrqtTFDS4ZTclhrJkdaou4BfO+uEhbBz8ri/vvj68G+QKDQOLT4Is1NFItnGNj4h7XAopXhX1ioan4QTmaKDcSuVvW0O9FTrb/3EmbKjengi35XK8lt8iBETTGjZv2jktBog+LLM2fCa7aTLAtalwG42BQjYw2CmBkRmQDKw4W5SnwxxFbAcjeEz3FbTT36iOb7Gnqo94S6NG8ttaW5jleygeawSsrtCo0Fp2yT9NqBt0Ds8OAzg8OBr+vPXAMIw7HesgeaZtyGKQtL+/bCBIqTFGWpG4WpfaJuhRC1iFyCOq1hF65ugfF15102zaR2MfFy5aOJKl82OQOlovfJMmZtNeZnZL6HyS6j8Eiq/hMovoXJfqCRgfEbJ+DrZJD4PA6WXA80tZiIXdjAt4zskAe80t8oMeJILOcgxEWXuTIOUdelU4hP7jMsZ+faywEvHnAUs41PM2JB9o/QyijPhQ4l3d1JWXiht4XEiAQDqymFUiMCPHCuZilnpC4yJXEGqVQ7PW9Sev5zIiYyVNJZMpVkNRyBx0aXQ67+s1/JCjCUF+xirlS3uvQ6lvmORoQWRDMGb2kuIoo8vXaBXXVL0u5QJpkJi0m8keKwMMXDxGVZwBHzBRQduuFVj9byyRDKR/ZdsFayP4pVqHYHkVtxjW/sFj+/IxXIuJGGoTqM3kRM78Zfog50w/zPN11+V8d9UgZIXwh8ETNhM2Hk5DWOVR80BDWaKVjsh01LGjluvT2c+sSKB4RFMmEhuK++aMIiiSsnwHj5ex8RnYrumMDyCDtbwDBcbhkGbeCGOvSy7NozOx352wzpoJ13yAeiAogltXlMK11Z1Pg5fbR1cpePwnzy+m2m68Hr9AETSD08fMC4temAidYT/cgRSZF5zE5vmNvy20ELatKdMeGkT1DqASZV3LOYoIeZZRop885sw3rwZwlf3k4mcMCdB/3cYfFtmGXx3dXW+Tm5a+/3uFf2JovUC77hvtlkPIefFtT/vG4qdOuUxPrr92wBUaQnARZfqbwvXxoam6E/kqu0j50s7V7LlJxQF90YqpZe3fnIiHfNmINRoLFTrRoWgW67wccutLJwk9QL/i4z1GZxQHKBjItueK6JiQLm9PHMJXRU2XFY3t7YwwygqMr70NhMWWlHoN6HSS14IQy5IhC8Ru0ExLJaUxQKHTBhLTsSzDExZECZMNiJo07gJXYDqBNeW4F1X8sHIiUGu/aFw6xhBuE/JDoBD5R4+7eISRB2xq0SNbsP6NNyaFqhR7YIb7grckHtWy4Ye7TM41sgt7mfCjfFLaa9obo4Wx/YF0nDo18EZjuB5E+eewzOKcp8c4oim1csKv5fhFdr1LdbuRzVrCNbaJY86stC1clvnA7eecU8k/Wazs9jepEreKyIqbV+cg3/soDJ03tcm5Cm1wVSz6HwG1q5Dh4XDbQjNgk6Y+10k8JVxYOArwD5buazHJHeDRMWuJmvlLlQnipkvDHY1Nnv9urXps592H3IzjX6Clme3ten7l9SdvermfgGbqU3oO64d+9C6Yf6X5Nh9GZBchY/T28eyZbQfJNCfeipUtD5YlEYo6UHd4ZIN96XcAbvnWYl7Um+6u+rta9tdb/liw/91Of5PbZhmcrRzVT3ncQjtnA1Z5Gmb6FEkK0qaUN/XT3tKTTlVnQQ8Vlf/rcnK2WpnIhA5W9aCOgguJre3+JK+6vOxJqXY0sSvqtSuhXeGdqH0HZx7KkBUQvhVlRBz6dtcwoLwbaDr9o5jJY3K8KZXg4/9AIENzTyqwUdxqTVKG83QDozllEj1w0phBuNS10br5ZlyI+J1G5JU7EfWJ0v8yFqmyDXq7ko/tLVU8dLOX9DSNFMLx4ZGlBb/dlnPcdUO6Qz+3Dma+TLRPEwwV7WAnmhEf+lQY1V4AVSaZkIS+xG4UahNyN/GVWOPLmSNqUYzB6vuUBro8Uxw4zLQNxWVWx7HaMwbMvju0MfT908jJTXd2IVfRAnd6wLl+ITOU5IFjE/gipaT3ty+D9SD9ZtabR2vdFK/Xo4cZk94u7GsoDQIlhq3KJNCUSFAnigRE4LYMTxKOO9w2RjeYrFwWMg7KNqTJVL+Y6ICtaEiYeBVNnAYXbPq901GL39R+s4UPMZRIX6gG+UjccOiJjDI8B6zP18MarHKVNU9fx67Ow9zLuhIq7rmG3+OzbNiQnbp59hWr+wZjKXVKiljX7udqLikDrive1zxlGVQlNNMxK42c5ezMFa7/ooLOqPzsQlh1J2gQRd0lMyWFKK9sJhUtQuHe56JBM4rZYA3KW+sIZx7jo4K1wi5MjZb0vkkFL6mWi2Mr9Qm8tkzuDz5wUyke1SQVBKAF3SKpq5rTOu5QRUCWydITxqwYdh6xGAceacM2pOqLFML8keqqUs+QzMkGO/hx+p3lb6/hxO1kJniCRGAT/kQifaBPNHnPaEddD6wOfDxnycgsZssoT3h2nYUc12U0zDB+8bjqoGoavSZqKlW+zt1e31xOjr56bShsNHSM8ldNM3UNMq5sairFp+p/kcJ1zbyJMI86bd1G56dXnVZyXKGNlR61o0Q6+EG9Wu9DH0tH/WfEq2yErfwOrSnmXgQus1qjg9hkTes/O8P1ewToEUHaSfaV2qTVUN6L7t1d/YPsYSZ2raDCu33/J53WeX8HmXXEgxyHc/D9UzEtRUpj21k5nSJRE2Xrv/5aN/ye77Hbgmtr6bWdlvkb01Xtc5u6+HaJqLWU4r+U+qWbkB/Y7Uxb6Lt/UKXSoo2nvc/Ffag2v6HgPfEOyIAyXD+3fmGKXpkwmxEi85wxxM3tP7ZoIt5scOcncZ9+7iDdlmIDaDVSF0ytIw32va+z0frIO2MFBfldNllpcvpcoa56SJuj0b0peNvT4qWWO3xvQuqZTusYuqVmFCoVlVWD1Xf9iJ9IrRm9w1HDxBEjPRAdriu10cFj+cIL8IDFmxUwuR73E07HVd7TfTj+Pj07PJ08CI8COc2z1yVgjo3r9NL1PfCPYyIrDKtx8l1ykmVM2rj89iMlOHy20IZm3PZwrWvUbxZRrfepPmwl0Gr5Jya9tTwF67IcoI/Vs2C6+rtGwI7FO6lA3pUQBOPj/RCys86W61o+F2JesmG1zdNP8C/PyqMe6eFDVOeGfwNyL2Lqm7sf0KTfZ801SCXy1afjgVVS04kbHWzCtgceUK1+7rVR8l80W7tbb2Y1OmvvDq9YqvVfwDyMtWB +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Return a specific identity schema. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-identity.ParamsDetails.json b/docs/reference/openapi/get-identity.ParamsDetails.json new file mode 100644 index 0000000000..cff238a70a --- /dev/null +++ b/docs/reference/openapi/get-identity.ParamsDetails.json @@ -0,0 +1,37 @@ +{ + "parameters": [ + { + "description": "ID must be set to the ID of identity you want to get", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Include Credentials in Response\n\nInclude any credential, for example `password` or `oidc`, in the response. When set to `oidc`, This will return\nthe initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token, and the OpenID Connect ID Token if available.", + "in": "query", + "name": "include_credential", + "schema": { + "items": { + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string" + }, + "type": "array" + } + } + ] +} diff --git a/docs/reference/openapi/get-identity.RequestSchema.json b/docs/reference/openapi/get-identity.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-identity.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-identity.StatusCodes.json b/docs/reference/openapi/get-identity.StatusCodes.json new file mode 100644 index 0000000000..aecea0eb0f --- /dev/null +++ b/docs/reference/openapi/get-identity.StatusCodes.json @@ -0,0 +1,341 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + } + } + }, + "description": "identity" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-identity.api.mdx b/docs/reference/openapi/get-identity.api.mdx new file mode 100644 index 0000000000..8b7df41604 --- /dev/null +++ b/docs/reference/openapi/get-identity.api.mdx @@ -0,0 +1,38 @@ +--- +id: get-identity +title: "Get an Identity" +description: "Return an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) by its ID. You can optionally" +sidebar_label: "Get an Identity" +hide_title: true +hide_table_of_contents: true +api: eJztPP1z27aS/wqOmU6kGYly0rxeT7106tpunto0cf3xOu8sjwyRSwk1CTAAaEXn6n+/2QX4Jcr5qttep/YPCQUCu4vF7mJ3seBtEIOJtMitUDIYBydgCy0Zl+xCxCCtsOvL3tLa3IxHo9VqFSq9DiOVjWIVmdG15laZUaRkBLk1o3LIsDCgh5mKIe2z+ZoJa9jkMGT/VgWLuGSK0PE0XU+lkFFaxMAiDTSap4b1IFyEzKhI8JQZsZBMSBYpKSHCgaaPv+0SmAaTK2kAkRRGyAW1XnmYsxrmFXtTgF6znGuegQUdBoNA5aA5ApzEwThYgJ14+oNBUHU0wfjidotLk0OWFcayOTADlllFaCeHTCWs5AFbq4KtuKTXC7DBIBA4Nud2GQwCyTMIxoGIg0Gg4U0hNMTB2OoCBoGJlpDxYHwb2HWOvYzVQi6CzWbQocRz76DBPSHZiefLVE5l2YXLdYPJA5YozeAtz/IU2FXOjVkpHV8xpdmVEnF0Ndhmcsh+XoIsZ1x2OlsKw1YiTZkm2ZlKHCOkQCzs9X5hl+xpuMf2owiMYWfqGuSg0X4CiQazLF9wGRPS1znIySE7cIuOvKUOTCSM33CR8nkKYclTWtsGUzvLHzSZKixkBh9AFlkwvgjKyaNIiDgKBoFVNg8GQarUdZHPDESaFnAFc17YpQwGQaRiIDEx5hpIYLRKRIpthmeIMIYbEUHZ34lFIkDPEqENQkuFvJ5piNSNox5B1r8vB9urXzVwrfk62GwuUXTc2tB8nu7t4X+RkhakxUee56mISMZHvxiUmNsGI9qitH+POq8h12BAWsM46y2LjMs+ww4oU6/1OnQMy0Fb4WiPNHAL8YzbLmUH7t2+ZQLhLSHNQTNjdRFZlghIYxLmhZoXScJTFeYqRwyJ0hnCC2JuYWhFhqvTYWrD8BDL4lg463TcIrBDUqVvrcmaHCKRiKihaoxQdiasZCIWpOTCpkjS96evX53w1Y9gDF9AGywuXth4aZfcspXS14atIE3ZStglQwADdvrTS6dGpyu+WDhL5yet5r9AZP2k/yR214qwg62T+mU9f8ZZKoxF41pI8aYA1oDBLNqfLWazjNtoCYYMRKnt79Gm8vc2SWcILxbYlAnJLRg2B7sCkCwWSQIaKcShBglsCFM4laVhaZpnhHfs26cS7c3229eTw4OpRBO0/ebs9dnxVLas0naXl/RyKktTtf3+Z5ij6ZVTieZm++2BigFfO9KvYb2L8mtYT6U3d533rnkq0Qhuvzzd//HlVDbs4naHQ3rl6du2mNuda1n5Dl9PZcuebvc+8e0vhbxm73wpKjXmaUewEAfE5Y6Pv1AxuIXFmvUq3EmqVv2QsQmpkFQWbV9MSur31Ka347QSnSRIk9AtzHvnceD2n7/WFjYI3g4XaohED1HLyB16UJEHFfn9VGQzCIo8vnOvO3fvfqe97ga0Ec7raqP9l3vBNCS0hzle+e64j7QZELJzA0mRshU64NGSy0UZ6zg3gjmnrkWZkPaLZzVVQlpYgMYgYssdGFQeSOnLNRiK0/gw1ydNW0tGHgoGe3NwS4t8RJHGDuiS0gSEqQKmnX4KvLWgJU9nIu5y8ci/nBzS6tVxJSuH+ZiMIpISjYtYhHFUWUUi6qOWMnazCsFVUMzaWMhCNkkw+hkQvCaKMhh07slU8kgr41jiQQrnjOzwhnY4QTSdJj2PTdfzCTG2O8OwsyR6ckj8Rl2ag5MSiMkTbDUrA9IzAaQpNBiWFLbQgGqV5dyKuUgRHo5EjmbifymCoBWMBRI/LyzEzFiFo00RLRk37EBF11rxaHn4bUsQi4Ki3M7cM7A85pbPeJyJHUryqkjT38knpmdh2Kvzly8xkhxi8FikFFWWUfhdSoL9vjdK1phbk8mLeSqiv/hslF5w6Zfdq15rOZ/djaHa6ksMOPHz88khwi1N9ozHsQZjdoVWpfneL7ugjbNcSKdQqBfV6K6VsYp5JKjBTdtSBQLtOGyugV/PFik3ZpYoPWtO/d7m/WeGW51J7Or2J+6RPC1gZ3x2I3bnwBr5sgs/3HW+vFvMS8ErjaUXrk4YiB6qylBUcrt2K0wIFzu38RNqL631a71mr8CizjI3or3BYb+lyiBmQobsFCybr92+kxWpFUM/JkcvwFjQXzGiginJXp+ekpJjijOFsmcMearWGRqQcCqhGEYgreYpOzo/cE9TyY3gQ6m0XQI3lu0bwV/hryOO/mBhhtR8flr9XgH9/hnwNxTs6NwBoaHYg52fTuUiVXOeshf0XyMOqYkIBkEbdzAIPDr3hIhwZOF7UmswCBzoDwoe/sQpb8qM4k7P5JRe1Rt57YagBWfuNdqqpnN0w1MRl45Ra/O3mgu724HwRBQ6vYuK85OXJRn46OkAGedKSIsupYbdCL1XWdrXBDCpErNEq4y8D6fgY4bId5Fmud2RUDnF5h0eDnX3Xo0wjBSbLblhUaExyZKumVQMkgQiG6KPZcUNMIK2T894ltBsnfhfDfGsGsqeHyRmH4GqnPbMu1/eoO42hY2N4kxkwATm4kmdmXmThlV7UsjIObZtN7mRyqL12pG8cuvYSKXJHXLFzpq+Lxr5eQoonW7bGrBMxSJZO58jhhQs+KHIBwwFIU2GBjSGpizjUoL2QGVeWHc6wNMVX2PurJRz9E0XuK3bjmLEkAgJMUG/qiX8KtwRq7gp/ulxnkgEcu1djs2/ql4f7do4BBDjORf2wlR6y6d5DyYfHzWWvia5RPlRKXk6CbIuhrB6zVbceGlB98IfKwXj4Onek2fDvSfDvSdnTz8fP/1y/I8vwv/88un/fKT/siXVZFE/JMRAXSw+hEGn1NEFchgpwdsIIGZPvsA4SvMIDwIxxqFF8bYrFZmwLjLyKYvTn156Ee4Q0xXcO2h4nyTv4nyKG5ofdL/sr7yz7gp4sXGGGs12eZiYKPUNCWiksru1BXZFvjLG1AAYPOZraANtAzzVwOM1m2PqvYLRmG3LHZ8rlQKXTXx/kC32bmuXYTGkgvJVGdilipteU8YFnVFmBjekev3KFx/oA9dMuSF/yov/O/zi2gx8ime8RQfpYO0VtZyTao+6rJFXmYtmIEzng+wHOmWsDFY3NbTp5KWqvptB8Gzv2W84CcXFMpbLmOuYqKG9af94wkBrpZmToO4ZJr3dkaaiQeVJbWdUDPNi0R11iM31/kC9mPA+l1CymccqsJSC7FZ1Nk57NaqNczJBYmMctqwDCSW3fM4NqhrPLWiyJ4UsPYBE+PN4cNqwS+DvmPYrnlVunuMbHs93KUAJAoPugAajCh1hUrNI4zJjlahC7jTuBHTWQtplYvWrZmVSYGigm8xkyhlwyTERVvnIiKBN8GuXiKZkzOSQPXn6+bN/sFiB8buGMDtZdHeaj5eZPceiyWE4lQkQGTOp7Kxe0COtv3MvXim7XzZP5ZtCWT5zGxbE2O0nbDnyDQ0zsxNuMAjaED7IJb5fEil/5pJPHTaV+bBq+Wp58mN2x0Vk+mZ0xtVNueC5TsPo1CDdMEYHP71ne88G7Nne5/jPkwELw7DfkgZ8/5vy7QuQoEVEBuLA26pto+q0q2E1K2Pk7MpJbVfeayIJ1guH1CX2E16k9sFUPpjKB1P5YCofTOVdphK5BFGh0b3EclCl166ekYoSg/HFJRbjWb4wzg/2nuglOc16PcTjbwoXh/MiugbkgaujG9LZ13ApFkuSHeTmKfHM1Z2mXC58EdIpUYdFF3wOaTAOvlF6PYpS4WyNswfIzSxX2rLbqWSMVaeD+7kYuJYDOjEuXOXrVG4on8ceN6A9/mpKxQ+YmomavdlzJmHVhtDrf1X25bmYSNwNIvA9G9h7LUh9QpGCZSIeMyeLX7HR6FMqa1nP72P4u5A+edT34F0taH1oPWb7GM/89+Oy8uQx+5U9xiITesCaEnpolZBQS1kvQj9woejBV4G4Z1faQc9Y3UEPjWIOB7hZg1HBqlu+Jj68u66XsT+4qpf9cUW9rFce4/fvXNlS4m69FRrQ5sw27DnjKy5aohg2Crt7TgVE7HWhIx1T2f8qwDJrr3gvVEPhJPfZ40rXch5do8XNuJBIlde93lRO7dT5VG/tNHA/k6x6VMY9qRwkz4VTOzYNFsIuizkV29bqOFwo7E3TxvQDYev1UcOnVsRs/JxNAxHP/LJPAzYaeZViv7JP0SgCvM0axHNx6eDeTsvK8/p9jX+DBJRdkYQHYeYpLd/Utu3p+DlriUD4ClZb1hUH8VwcOBHZNWD/eOLebplYHImMGTA9wD0bB1eQwso0H0/CFw0N8UIbfsuj64VGh7LXHzAR98POivc6MtIPj95CVFhwdIuE8P7HcyZF6uR1apPMht/lWkib9JQJT20MWg/Y1Dv/rsSJpynKztUdVF5djdlnN9OpnAY0tf57QH9XpCn759nZcSUpjfFu9Ab/GY3qKyW0LV41kY6r/Qz7dpGpwiKykzaEu6bQpABM3p/KTdPyHK/tUsmG9UE/4s7dXun1zL2cSkJbN4RUk2/C+oDHDannsj1A43mo77WfC/Q9c+csUM+cJl12cL9QuB+xQzTQ5fnlUhlKlVdFWe70iOw5xVrlFYM85WsnaWGuFTpkBq8c8FwYtIQI+BSg7YmE+doVlFWl4XiAYoocaYJ4y22pL/NQ7WDbo2lMvK16bougaaCF/VByS1P9iE7AvGknE1xidsetzVo4JYk72KR0WW5VU43A8KAtipSOyb2iqAqhoHeLJ294muU9VJarVETrEEcdOetpnCnlWKiFZs1loBnXwHKtbgSGGnNI1WqAR0u+vs3ZXTzxQEiGW2ESAQY3C1fJR30jbtyp7aPKLwT2LXANuj2fMWt7zR+9EpzGzixZ2edMmRDkjdBKXkyDb4/2T45OZmevfzh6NQ0uqyU4khioc+atmuMbnoSVfqqPX5GNpf5QnwYt+6XN3LKveB7Ec+G7jR2Rj5ir57kbCTfGzycXM1H7yw2MTbe5xtAvnRf2nD2u9/vH7BHu9p+81Tf8oMaNKfacXTzuNldIL9kj9lIYe2GsvnzY4xt7PPLT6rWXBycTL4CO3muTW77C1a12nOctkUC/dVYuW0/Egx2r9Lzb1K+Bk2XuTX3qyCNRSTMqG37dxDKm/agJwYFoUunfAm0KrNobUBlg3MVdd2ht7HeTwD4zRAX7jEE/2FAIbeLrIV4+w/REIxTGvKRYuERU+wJnr19e4XRhdPO25XbC5l6udravcOI23r6LWKtFTcH/8zgUW548efLlsy/3/uvx111G/X0VvrXeCU8NuKuYSMaZW9vqJvFmECzUtqS2/G37tuE1/wXEtgzsHiTikyUid759137V9v6DJOGPEoP2TWqPv9r9e8bqMIv7DwLxSQLRKx+Ihxt/6UXiTSC39ng5b3xXIrkq0dmRUMaFLAdXW2ijpudhK33YSv86evKwlT5IxMNW+iAQH7GVYkdfbEkyQYJgl8E4GNE2OapvZ45uRbzBxCrl0pyk0KWKKu9367N9M5MWi83O3N+IdldN9ZTlVbNqiDtb9wU3QZ1F7Kz1vzG/1rxMdOygMIRSf0SJ6k2ELdfvojniQEmjUqg/4xK5BvqUi1mOSuJH/m7FaAF2aCzH3Gk/9Jwr84lU0ewvy3Hj7jZSPRDV2VJLJcmID9VyTgnAdk/X1OmqcB99SpW5qVq5b7A084YHvi6h1XjeWprlOtY8jCFT5QQd0BH+S3WoKncTUEmSCkkuA6NWVsqWy0/4ChtMUWgvs5RvNKzHU8FdHvXKQ5m5jOQVqmu76ePhu89RSax+CU5cJ6qF3a0hVJ2LDx/IB+sGNeorHNPpqme7lKFT4aV8Spgqzv2lIbR7Euh2cVvwMMV5De/6flD14SC854ZJs6Fj2ZBopKqR94uMXv+MN2NzHsF+Ln5AH/cj6XZXaxHAMIUbSP/4aWCtk0xUWXzHI/LCXcX3OPBHGd+4day/bYWUnbp33av5j9hEWq3iInLHNYcqKrAUrb6+jack7oayO3BAKyjo8wx4lwlZsH88MSHbb7/ARvflNpliBb7PxeMVHZdRd5d62LFnRmsjCNmxw0hQ8MwhUwavc9HNNyHZXKuVcYczU/noETs9/MH4W2CxnwFzE52DKTPpplHA501gYwXd9aMKYaPWzxB4YgaOSVSaqhXqI567FXwBZoxk/Mpe+t8+ofkrO1QrmSoeIwD2KX8Iorkg9/T3K1I7bP2x7YaP/7sHELvBIrWHXNsWYy7yYh7GcFNrnG8Y+RILM6rPR/o7eXtxcrR/+ONRDWGrmMLE16N5quajjOPtWl9cYfz/o5hrO3Ig0Hto8jZ8dXTWRiWLBdhQ6UXbQlTNNdX4sTN3ejTq3ye1ykro0EvUHqXirdBNVEt4G+ZZjcr9/lDO3gO1QCTtpPaF2kZVg74TXVUX87tIwkJ15cBT+z2/4W1UGb8B2ZYEA1xHy7B6M+LaioRHdmSWuImM6pP8/m+n9hd+w++QW6TW5Xcquc2zX0ybtSS3ZXMpE6NGNWD/PnlLH0ojkpo0b1Pb+xk3Fbpv3P9Usod++O9CvAPemgLDORz/83hLFB1lwmxZi1ZzSxO3uP6bic6X+Q5xJo67EpMWtetcbBHqW8qQoSG8o672/XZqiaSdluKkmK/bqHQxXy8gM22Km60jfGjp271Si6ju0L0TzB20UEWYuzWhUI2orGzyT3dSek/Umt07HH3ILQKsjB5X+Yr9nEdLwOgdP8zQCjNQ9zi9Jh77sWb0cnJw9Or0aPg03AuXNqOPJFjQmXmdnLrL4Rh5W2Uadd2lyxk0vpYVpMgM8m9zZWzGZYOuraP07ei5cZPl7/UxYx9bYJULligJihH9ZyFc0uMicB9aKr/kR7dqBsFY0D0GrHPCPre3eMflXKebDTa7T+vSJ5CFoYsxPgnzDr7/7T9KvHMt3EnMzjRgeYRD5Q5lAukjmd478YmG/ifVAd1FdXkHWK6bdFaziYPN5WYQLIHHmO6pTquQsXnzdKpzqayVm3txdIZfgcFsTf3FnypsLpNJF7e7ybm9dT1oMTabijqf9bjcbDb/BzrtXy8= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Return an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) by its ID. You can optionally include +credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-json-web-key-set.ParamsDetails.json b/docs/reference/openapi/get-json-web-key-set.ParamsDetails.json new file mode 100644 index 0000000000..953d632a94 --- /dev/null +++ b/docs/reference/openapi/get-json-web-key-set.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "JSON Web Key Set ID", + "in": "path", + "name": "set", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-json-web-key-set.RequestSchema.json b/docs/reference/openapi/get-json-web-key-set.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-json-web-key-set.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-json-web-key-set.StatusCodes.json b/docs/reference/openapi/get-json-web-key-set.StatusCodes.json new file mode 100644 index 0000000000..fa7b9fdad6 --- /dev/null +++ b/docs/reference/openapi/get-json-web-key-set.StatusCodes.json @@ -0,0 +1,130 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + } + } + }, + "description": "jsonWebKeySet" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/get-json-web-key-set.api.mdx b/docs/reference/openapi/get-json-web-key-set.api.mdx new file mode 100644 index 0000000000..1e0bb64412 --- /dev/null +++ b/docs/reference/openapi/get-json-web-key-set.api.mdx @@ -0,0 +1,42 @@ +--- +id: get-json-web-key-set +title: "Retrieve a JSON Web Key Set" +description: "This endpoint can be used to retrieve JWK Sets stored in ORY Hydra." +sidebar_label: "Retrieve a JSON Web Key Set" +hide_title: true +hide_table_of_contents: true +api: eJztW/mT6jiS/le0dEx0VURxHwU10RvDjbnPAurxgha2wAJbMpJsY97U/74h25xV1dMz070bsTH1w3tgS6lUKpX55SfxI6IhrjJsCUxJ5CUy1jEHiGgWxUQAFRKwQsDmSAOCAoYEw8hBoDltgRESHHBBGdIAJqA3nIOGpzEYW5AFKYLmqNcFU7QCLeSBh+a09QgwBxA0oQNH/oCgt9oiVYAuFVCODh5kn0egQQEBF8xWhc0QEDoUgCGLIY6IkCJU5lmCbhi0dKyCHfJioHhSKRxEDv4P5XAkAF3LntyXcK0x5gBriAi8xkgDKw9gOVskACSaHBJgLXaZs7QQB0Labm0TVc4GGlh40mi+iT7qzAOrrikD4/bIF3tWYEx3iHDwwG1VB5CDnoWIUgFlSog0mFIBwm/x+OT3g4ZB3WAtMNlIuSyqoTUmSAtGghy4yDBikacItRDzra1okZfIBokmp2SKVi3kjZCIPEUsyKCJBGI88vLtx5133JhIWlupRJ4iWL6yoNAjTxECTRR5iXBfFkN7GzOkRV4Es9FThKs6MmHk5UdEeJbfTEiNI+/v32VjblHCEZfvU4mE/E+lRCAi5EdoWQZWfdXjWy61+XEl77fVlNNicuYCB+KlVT52a2MeOMRVdy69eawj4EDDRvKt0BFY+BIWEXC2lu93BEDGoHcvI3D/BfFF8BgoeUBDa2gb4smXRpmG2Em09OOgIXCx0DHxnwZyNYr4ghAqADYtw5MDnvtaDK0RQ0RFAJqUbGQ38wlAQ+jU3ujgyn58QQK3D/aw3OSqTilH0l0h53hDAAQmgkS6k6BXSkp3FTrCbEEsm1mUI/4E8BpoiMuFlh6GBTJ9496aHBqbjxYf+7aExmYRAQ/Q2FCGhW4+Xpv1tAl5YIdTG4ClZ2jBDloQmyPfXH4jPyKA86KFO43r1DY0gLDQEZNRjaEN5gKF8UvoaEGUYrcIFhf/GeENgX70kPusSvxdLENV8aSHdIJAEPMWBHEBVwbmehAzvjWnxe+A+qPB0IP8MCT9GmIig1CZGgbmmJLoggwRx1xAIkAXmkgaEx2gaRlyqwxHqWwu8nS/c54iKnOkYS8t+9EvWmq37cbLbl6J5hoo3cnD51nSmYrcuK4cMofSst5Pd1aZEX8bFTNOlDKneTwO8UBvG8NhPkngdH5YD4pzkcW8ouSW5VS7sNKmNFOr9bf1Qc3p0uEsuuSlpldSlsyIjksb/janE6O4TTcLqak5T2GyKkb7rtdcc6goFRXNS+UomkUPuGzn9p397g2nO+6gWGvnVh2tX+0kjplmSXVr4/SrhqdFZTixi+XpwGWzzj73nDo8rzs2VGADP88q9Y1IYqGn0uX2Gg6rZnNnF/oDVdVXYmlX51F9z2rzHBFjMcpYcDodbPO5Q7tdyIyi43XOyR127UIy31+3R73xPjcrHw+OUXOPpea+aJGivnL37a3V1zeTeiJTrQzZno1KanaeLLWRQ3KKldWTRR1xXrLSbns32ByXjCJ1J6Leyjm2xtvqqGPDDbH2bac3fp4XHKTYm1TH7TfflNTrVj0O1aRz7PBUdsZqg3zFmnjRVVez8oWx6RRnriomHdzUNg2DNt1Uuuwk0htlUtxVCB/v38ydtVLWUZVZm26rZg76y2qlRVHeWvZnb2+b9WrIcLpLq6/1/nNnl/Oqdr69beplQ3+Dpe7WnrqpaMsorXvF9Oa5YOrrEtkpBKFsq1cw68NsYt/fJV+jHcom8+641nlTzMSuVs2h+eu0VnKbjXZrrjcm6UyF4lbytR/lzptVTtnFTq1bXE6aVbdTKA9Sq/weZaJZVICe23Fc1S6y4a5YypolZd2DvSakaXNt71rF6qfebN26cz3D+7OdmpvDgpenzWlhqbS3mYNtWXbCOOJl4/l1vBvlD9vsSJulVVpNUGzO3YOCU8gcF22UmPRgVrM2tbpXambUvBikXmuZRGo2tDetyrifh7u5XqNZUSw+Pw/QsmsKe/6mpstpM62kMvVU3Rlm+ahymHjFbuq4z7fXpFCdmDzH5uneKj9HuLUb49I28el09rfT4QWj2CisN5sSp7VhvgfV1HBZTW3cVD7FxqldvVfUHcUwquNqEq1ZMafbk4nTWZfUjkXyxh5Nc87xSObz7Gg0qD1bHa28hBslTep5ZWUlS5NVojnBDA67+8m6rauD1VIr1GuZiv6MnjPT1ZDT1ZASezued5OHMuznxr1ccutM2SzaTubFYeZmCpnBUt3sPpsOup1NcVAsfdZsd7eG0N1s7JpXZ9MWdJ6Ls8xra7L5tCPWvkonO6zJdCJBmlJ5vE3RJyRrQiGhFeAWUvH6hCKBRL8LErZ78rMdJjIiq+hJdgvTZJBgzwDSx1hhsoanvLogmu3DMakHo4ZBHcTCtHQBpRc84SsdpAipg01C1ZAWA2CqI3LbiAPIQmB+P/IT0PDaxwJiQa51O8ELCdxGjd6kXZECgIa5wEQVdwPEAHjoEbQg4fLIJOnqWNUv4oOZm3ijC1+SHIBD8+N8AF4viNCRB3TooCsBi8hOeKfVkov8eJreyhb+FFVKONb8LC0oWEl99jZ2oCG7Q0MgRqDAjuzhBRDhAnSAzXGIhGKPgelDzUIwFlQLKuQoyhHhWAoCgZPdZt9kLpHW1igB1/l1Jlv4NL3uhPelS95P8kuAc1snnOHOgqyhiQ3vsuInpPMETlXCIjIcFRcRiTcWkWp5EYmdRw5tGkCgBfkNDATuIZDEr2PPQn8m0DkvzUXZ370yw1Hxs8Ugt4HFGe/ZYeIN+sYylYD7dXY3a7iVN4aMaIs6ipXnz8htUi1VnTWMvJgaw1J6OURmOtNyS+u90RrUrSTZQz2aTTYyzSOz9yih1vrZvN6vKiI33TOHmM3y7EC6tlLKpvFsaU8ms1mj0igh2C+PhrTbPHY9vqXNdGKsTHirhDHTS/B5nUpn+7NVCzc0W20j5zXXV1uHZlad54+9VD63b7ZL01HfjPYU5Lh7rvCR0shkBsIscExreKfvVm2X7t1pb1gvzhPEyM2c156hFytae1sa7UdFNE7W+na5UiYz91iuDPPdglIrLZWtNhK1XTnKXkWqlS3N130toaa9mrV0GsNkFg21xLGZnw2eXVoq518Jh2quKpJWa5QtWLNcKpur9Kd2flLRqj1qtIr9jaotN6muVXzOqUVYW27VcT6xLbRY9ejmx06CNEt1xO3ytt/d1vmyddR20/FkJlLpBikMmlxTk503G04TeD8rIasxX8/pvouM46tAyeSzyJTcVyuxm3RyLkooe29WNuDbpqfkR9FppeSmlj1HM/Mo2zX1eXFlVF+pt1Fn+XkmRxu5VQvD8mDdKtcqHXW4Kesmei7SatJ7e5vz/grWl2ll22flTLvUaQzcPOsUtOm2mVfMLVadt6RVNBPaIdpqlPtpL9t/bbFDqbJOHkc9XhrueqNtKT/u9yqk2Tnmolstq4/F28F667t9qmhlSMZv6bdKzh6WrLFZcYU1rJu59GTAk2a2Nu27q8Q4pdQ+BQd3UCfXXe1mbmU60XEUDbPZ8ma1Tj3XdoNKZapAswcrLMG2yX1inVzXqsfkNFtcJgpzp54o1LCTLPZS0Up+aOQ3o+Tr7pjCiWN5tCeely8mUtlZTx06uNdpPRPlUM30Gst+le9oXhMKW6XHZjWlT2ZOeWce3UKVj2vJ9qDUq5dz2Obt8QxZSjl5KNi7cqv2NnC0jaj2VoPs7qgVuvo+qmp7c4Q6r2166Le15Mpw8Ou48Grmo14yVRZzCzUbPahUxGu/bZT0Ji7Rfmu6STuHkZmZHRQDd3tovUcbxeDmWIHpjjXKTadGuZX2GjoUiUGUDQ+Vg+bhV62+dI9Nx0oo7jLlmvzZQtH+ptufO5Npo9C09Gk/20rn5/tqCTdrs8Fnhr8DZYlismZavemwkFwOi1Nrz9B0BJ0ufFsVyAy1cIkmKoN66ZhOVVb71n6QH2VgqWmuhnpTVcW23N5CTKLYsUXm+VkUJx3z2HRfm5XKPtV5q7nlwiCaeZ2/mbVJptHEwhvYo2NjjnKZ4bYbrS67g0RqPNXr6UF9mmN0n1Ozz2qhwNiEV8dus4ndUb6TtZLZDraP2XQF9rZO1N7va8Xa2nO72enu0FgxWFK3DdHBA9sbrAb7XbmmRykkjZ077yJP8K4+tlPmwHSH2cowxehbivRxbVvOEa7tosXnanqUdjvH+bzmPm+d1XRK51NacEqZxLIzT80TtflgtFcrR7WkqPtlQhAC+Tr9Os3UtEPOzCeGx94qVePEIM9Oa1b83PD4Dhl6naWVa7KZN8LHpKC1TWs1fY02NSW9HWQ8yy6wVWd6SLNBs7Q2RaJG58fNRHmrvtaqam/vInPYzSePtFKEMFraJVrTbr2ybTbeKlrFrOnTdLH7bChRyz7slmbjrd5MJtnBG+Z72eysPULpUd8crlvum5LzJqnM28EZtGpzRWiGNmnVj72cAnPHcUsvvg4nn03H5ugjNphwBB4WEcteGQECldl9EXm8xwRnqkNiLBogKXDpFQuzp9/5Fu4i0zKoF0AnTDQJixBwdSTT/4LAKyFncCwxLwqJDrIJSFTKgIMYXnshmgL8xIssCCV+mxh4vcBSlZomJYYHFhGOfW7n3OExgCeIqPIxOjMqj7dZneNPUf/h1inW+XSvma6kDrVkaZN37FVBtFFy0+gcX59zKD+2ecHuN5zha/XTRTlk1a8A2yHr6zeLZRMFoEoWax0YT9UhJtf47Qrh+O8kpKcSNlMGTMn89lvK7FoEB9+GtXI2lU98D4HPB/l+BXCmqpEm0V1Iap8JxutOAWIKJiZxexWq+oIE38ENg+ijqhXkKJeJIqJS6VUPI+Qz1iAj5UrlMrlM/juIRgOuMWhuM+PU4xFUqkPwTRlPYrNcIRFLFgqZ7x/mGWgVC9jTDy9Ds50cSnpgMIvOZDSWMFI+XWPGxYJc9bshGD8saPjAn6r87t26y2FZqx6HdsFM5xrt7lLYKJcttLvWbJqzyt5I4N1821KmShZ+koTfr+nsb/6GDiB/UIs++QTn93M36p9tSDFY+INvzzz7R03ff083yWO/y6a3/nrXQL72qeV/gz6vMkbZB84c+U+/bPyRAZAvlhpa2Z8Qv34vUJEvgULWlJm+apJs78nAAR2IDbgKqk4NOcCkmr/4Xw5zJf2rwS7PvpSj48BcnwloYFlQL0gDGVYQmOVJyylYB8WnLwWo0OZ39K3cBAxpmMkDnMmwLXei3Fz+2U1AnH9QiQsobL6Ue+6jTo3xuA9GfgtQli2uRsskkk+RwKiRlwgmIpe5yJfZZIPYb3qdP41e0RZ66jOfu339FOFItRmW5e+3HxHKvKKqIs79U6zIy7fv8nRHwI08UIps3Z3cJYcoZV6UQYEMbGIRXdnqDklldXmcFoWaiUnURBq2zYhsLW0w8mcXHEsZkGykVT0LBYeJkaeIAVfIiLxE/kaZF1cNLD3/KcKpzVR/3qZFmQA/FgQAAJrurmjhp+BLmZI13tgs9MF3sGbUBD9fCfr5r3LlJRfh17SX1uAXQJB7K+Hh8a+nttDCSkgghS2DgR9uhDz60g0kJKP0Egbyv4J4/JPzNvAQbnCZ020SnvM9XtT7AQK/eQpy9zv4BUAX4htdYvcHfw+BIbjkrR7/Gnl/Opu4Tq9MG1At11a1oLqDGwRMiP3dG1r5YUEWYhEEoIOQfIv8ujbPHykPPlELEWjhwMpgEdlgodurmErN+MX60Q2Vrf1JyvNVf7SHR7mWCyFJuJdfJNRAYhlugUUExOOhHcHfwSdmlKIW4nYpX34BN+rEusi9W1jZCVq4HKj7WYdiXwne3i2x7CmPOJ8Ae5JhQnY+S4pJr+grsfr9soQGjJWgutswahPt4fFJLtNjrHpAqi1QoBNe+zL/6xdAsBHYZSHWpojVLIaJWD9QHhsJDTH2JMkhP0q5klRUoWFII/36hQa//voC/uIsFmQR8dV+/Aeia7ZhAD82nc5zr/oHvd/lP/H4uUGw2379MPILuPkue30cltpCDju8lfXVZK51Qdx6XJD3a1/ve0L3s8PJ32WQ+jKSUOYtg5cL4g97eRCT6crgMZlply5aLXfIW0pHDbveTey+N0P83LRo4epBRVYQmvyWlm+BU4Pgm/Tnn0BFRoMTptIp969DUCu4j+CfYYbBg8vooQth8Zd43DKgFzhXzGJUpgIeo8yDFuZyI0rBI4Ru417M8vxSAQIjPDWHhgG4bUmdkHYXJC+XCmJ+mLqJn1cTv91tQUzypyH39+9V9xQpfgrAdbBVTfsqcgfoEtpCl6k75Ir9mxS20CnDx3utpTBJsasqZZofzM8UbLGvAI6Ygxg4pUFgUQOrXkz2qgYBiQd1FZRMrS10YCKhU80vlixGHSxx+AoZ1H06E+kn2l3yqFIShwJzvyb0qM0CMbKt5EhjwXzL5/mVEGSI3c7nBdym5n96JaDfd+nfPZGteQwRBzNKvi0ipWpxWB0ux71WtbuIfD8vQZXIIgmCMJAFdoPkfKxyOgGRZjxtJr/NlS7FU5i8C6l+WWThsNlLoORPoMyQrDC+HARyHs7Hwkt8yc5XI4ZJ+iL88ZwfwS/g56tM8zP4SeaZr5OM7CaYF2oXaDg83aOCH3pdmsnBzyHylxtlZfpe3seWB5kVLt39qPCwCIFnKEZe+/CnFv3vz0S8+LHxWkgg5VqV8C3yYxI4hya5Fujl4/CXBjfp5je1AH/hviLgLwA9Rt59uCiZJ42qfiVyhfpkFXOiFj65z/TweLrRFMDGm9tJt3j7HuN+ftXp9kZTcG1J2IyMA1nN+2JsQ+9V/JjixeEqmf8f62sFGfCjWT+62+9T9U/Q8+HmW8zUHv0iBB2EPCiiJNBnhzxZ8n9eZzxFfLLh83pDAoJT77PbnXv8x/3+434f3U92CXJ6oK+vnNAjL5G471txeVIe/8GReJdI0scLgeI2k0DzhG1+hIhmyQ178/4pvon7vsiwZEdO9+zOXQKeICSAIhek9MEOc4kheswDXSRcynagH0gBUkoMzKnt3wtcY6IBLE4k4rfrHmVKODXQ94eT8mrwQCob43r8pHxctZk87I9vkIhyASU+fIyFRjthppHkooL5rCDH6pmfkvYPnpzXVY4nvWXlg5zblsGjD00p9MmKlx+Rtbwr6zNi19ioHHIsNw8nN0vjR4qYhkx6mmAgNC7/lYuqUiuYAF2vDUz8ay/AfwpO/hUkQfkNcZ9eZ2jNENfD+7zyDiSGAVb8NZSyDFDXr9Lfbx/98/KD+79EXp2JDINGEiZ9vF4cUDeSIJIffqcdRNDpilYKjC7Nf8cJfSDdaQh7ry+fe9QGBEn2m9w6noRxO+RdHM91XV8XuTtktJaeKGEHj1uIcVn7RAOTRX0d/bOGf+wyzJtStuMWVFHRwpK4/Wf1Bu5JQNRADjL+96fxLm9nr+mJDIaqn7OQCbFc0rBc+1uwjpfb21KzUfAu8oH8+wkoRDCq2WpQklaoapuIhHf4/ZrQME4nS35RJQOgvDfik0d+0Cn2FXnl/vaFfOgHHf/oSN4k8SeLtLAi8C+WYA30Q2OAwKUCZ42BfjCiL0XWVSbl4nRhBhOwYtTlQQG6ID/9BEaVFpdnE5gDLZwBCCa6Co/dAknXRLR8erWCwcHbecBLU8h98afb0mAtr3+5cj9KosGGG8RfpBp/B+3we4ia/w4q1CUGhZoUAP6VPyniekH+oL+/S22jN3/g/sE///cHiPhcrNS2Apm4Mcw3y17FNORcdlz4IB6ymDx+qQEfP7Xtt2G1WOlULxLu+Equ7eIrg67iJpTXqkL+kof/xzXIRDwQIYHDtW1j3er4dihib5CIUba5jRDnxxete8yLBRVy/PGP1JYKgj7o62tbNfABs+uhdHSIWeZlqOD777XsH6At8lX6VNs6vR/qIvrL4c7U85/iCRv60Q9CbeUvpG6HMqGDyK0ncASZqsfOb+JQnpFCVcS5LpNI/EJdPv772m6hA7/w26vfc5381jK3/Na0vt+eHp98In51vvL4R9pWZsAgY13rfK/tw1QmlTUSqv74r6odDbv/KcoHwm+mAOQc+o3+nSsGmmF+Fy1uHt/sxDur/9tKW7r1iTv7Fg849RttPQvfKRo+OZUMV84b/7j7/n1tfZU+jRRDe+XdDsXslbdBJr/V+PppXH642W9/qLZyqC/23lCS2jdDqZLq4DFMr6qy06Pw05ea/kHa8s8znDxVwSoiwUWoE9C0oKojkIrJCxe3lbDce9B/7ds47MvjbaVc7Y6q0VQsEdOFafhVCmIm761HiDnYP6GJC8qvjrNPkFNWzojxAMca0hgB60C5MCG50us3CNr7SvrqlsV/fjz7//zHs2FpJQ8y5CkU9ktk321/hHTPt4hf7chLQfInpk+RF8lIfX+KyFMs+frHD3mdasKM93f5eG8jJq9NfL9wOsHPbjGXn7XIyxoaHP2Gzz0Mw9r/8bMTiK+UPt0/It4VFxpoHbJo79/fnyI6gppkWM58qiy5rGv+9MO9ohsmrF4dy5tRkiC53Nc6V6on/ubbj8/1+fEjaOGv6Pv7Wb2QaPj+/v7+P3jBQ0k= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. + +A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a +JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this +functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing +user-defined keys as well. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-json-web-key.ParamsDetails.json b/docs/reference/openapi/get-json-web-key.ParamsDetails.json new file mode 100644 index 0000000000..29086a72fe --- /dev/null +++ b/docs/reference/openapi/get-json-web-key.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "JSON Web Key Set ID", + "in": "path", + "name": "set", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "JSON Web Key ID", + "in": "path", + "name": "kid", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-json-web-key.RequestSchema.json b/docs/reference/openapi/get-json-web-key.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-json-web-key.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-json-web-key.StatusCodes.json b/docs/reference/openapi/get-json-web-key.StatusCodes.json new file mode 100644 index 0000000000..fa7b9fdad6 --- /dev/null +++ b/docs/reference/openapi/get-json-web-key.StatusCodes.json @@ -0,0 +1,130 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + } + } + }, + "description": "jsonWebKeySet" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/get-json-web-key.api.mdx b/docs/reference/openapi/get-json-web-key.api.mdx new file mode 100644 index 0000000000..f0956cfc50 --- /dev/null +++ b/docs/reference/openapi/get-json-web-key.api.mdx @@ -0,0 +1,38 @@ +--- +id: get-json-web-key +title: "Get JSON Web Key" +description: + "This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid)." +sidebar_label: "Get JSON Web Key" +hide_title: true +hide_table_of_contents: true +api: eJztW3tz6riS/ypapm7dpCq8H4FMzdbljXk/A+RwihG2wAJbMpKMMZl89y3Z5hkyd+bOubtVu8sfCZbVre5WS/3rlngPaYirDFsCUxJ6CQ11zAEimkUxEYAhYTPCAQQck5VtQAbqg04bjNECNJALVEoExARpABPZCYkIUATAHGANEYGXGGlg4QKhI/kSQKL53y2k4iVWwQa5QCmBhw3WHiOhpxC1EINSFEULvYRWSNQ5JWO0aCA39BSyIIMmEojx0Mu39xvJrwQbIAGUUugphOUrCwo99BQi0EShlxBHIvQUYmhrY4a00ItgNnoKcVVHJgy9vIeEa3ndBMNkFfr4ePrdkb4aZYO1PzXKd9mZW5RwxOX7RCwm/0kLIyLkV2hZBlY960TXXEryfsHv940hjcekcQX22W+Qyz+TNTEXgC6vJpnPyIwMdQR20LCRfCtncOZxmIXAaU7krEMCIGPQveUBHurjxuOMeCx4BBRcoKEltA3x5HGjTEPsyLo+bvhjceBgoWPitfp8NYr4jBAqADYtw5UDnmgthpaIIaIiAE1KVpLMfALQEDq1Vzq4sB+fESnhuCFtw4EKCVB1SjkCggLIOV5JdzYRJFjyoRdCLimTT5jNiGUzi3LEnwBeAg1xOdHSibFApmfca5NDY/XZ4kPPltBYzULgARoryrDQzcdLsx5XEvftcOwDsPQMDWlSpBmxOfLM5XXaIDcCwGnSOLA50gDXqW1oAGGhIwYWCDC0wlwg5q9foaMZUfLtPJid/WeAVwQKmyFv7ZaJylxPdJA/yiGdwGfE3BlBXMCFgbnuL/xv9XH+O6DeaDDwIKFDcdw55NZSpIaBOaYkPCN9xDEXkAjQhiaSxkR7aFqGXCr9QSKdCT3drpynkMp20rDnnt3wFz21637DeTurhDM1lGxl4fMkvhuLzLCq7FP7wrzaTbYWqQF/G+RTuzBlu/rh0Mc9vWn0+9k4gePpftnLT0Ua85KSmRcTzdxCG9NUpdJdV3uVXZv2J+E5L9TdgjJnRnhYWPG3KR0Z+XWynkuMzWkCk0U+3HXc+pJDRSmpaFoohtEkvMdFO7NtbTdvONlyevlKM7Noad1yK3ZI1QuqUxkmXzU8ziv9kZ0vjnsOm7S2mefE/nnZsqECa/h5UqquRBwLPZEsNpewXzbrGzvX7amqvhBzuzwN61tWmWaIGIpByoLjcW+dzeybzVxqEB4uM7vMftPMxbPdZXPQGW4zk+JhvzMqzqFQ3+YtktcXzra5trr6alSNpcqlPtuyQUFNT+OFJtqRjGKl9XheR5wXrKTT3PRWhzmjSN2IsLvYHRrDdXnQsuGKWNvmrjN8nuZ2SLFXiZbTrb8pide1euir8d2hxRPpCav0siVr5IYXbc3K5obmLj9xVDFq4bq2qhm07iSSxV0suVJG+U2J8OH2zdxYC2UZVpm1ajcqZq87L5caFGWteXfy9rZaLvoMJ9u0/FrtPrc2GbdsZ5vrul409DdYaK/tsZMIN4zCspNPrp5zpr4skI1CEEo3Ojmz2k/Htt1N/DXcomw0bQ8rrTfFjG0q5Qyavo4rBadeazamem2UTJUobsRfu2G+e7OKCTvfqrTz81G97LRyxV5ikd2iVDiNctB1WjtHtfOsv8kX0mZBWXZgpw5p0lzam0a+fNebrWt3rqZ4d7JRM1OYc7O0Ps7NleY6tbcty44ZBzyvPb8ON4Psfp0eaJOkSssxis2ps1dwApnDvI1iow5Ma9aqUnUL9ZSaFb3EayUVS0z69qpRGnazcDPVKzQt8vnn5x6at01hT9/UZDFpJpVEqpqo7vppPijtR26+nThss80lyZVHJs+wabKzyE4RbmyGuLCO3VVne60Ozxn5Wm65WhU4rfSzHagm+vNyYuUksgk2TGyqnby+UwyjPCzH0ZLlM7o9Gu1ay4LaskjW2KJxZnc4kOk0PRj0Ks9WSyvO4UpJkmpWWVjxwmgRq48wg/32drRs6mpvMddy1UqqpD+j59R40ed00afEXg+n7fi+CLuZYScTX+/GbBJuxrNiP3FSuVRvrq4299RB19rke/nCvW6bmzmEzmplV9wqGzfg7jk/Sb02Rqu7hFj7KpxssCbDiQ+uHq9DtBcJBAUmFKouMdsFFPNiBuYzEvR78qIdJnJHVtGTJAvCpB9gPcQnQ6/EAsdgDY9xdUY0WwrrgTxGDYPuEAvCEhfMVr2wcsYTntB+iJAy2CQQDWkRAMY6ItedOIAM+ercjvwENLz0sICYkUvZjvBCwsNBrTNqliQDoGEuMFHFzQARAB46BM1IMD0ySDo6VvUze19zE6904XHywC00P+sD8HJGhI5coMMdumAwC22Ee5wtOcmPR/UWtvBUVCnhWPOitKBgIeXZ2ngHDUkODYEYgQLvJIWPtC+ADrA5DpBQ5NE3fSBZAMY81AZUyFGYI8KxZAR8J7uOvvFMLKktUQwus8tUOnc3vG6E+6VL3ir5JcDxEAZdMWjpWD3DnRlZQhMb7nnGj0jnCXBbujIHs1B/kJ+FJN6YhcrFWShyGjmwqQ+BZuR3MBC4hUASvw5dC/07gc5pas7C/uGZ6Q/y9yaDXG8su+GW7Udur2vMEzG4XaY3k5pTemPICDfoTrGy/Bk5daolypOakRVjo19IzvvITKYaTmG5NRq9qhUnW6iH0/Faqn5g9hbF1Eo3ndW7ZUVkxlu2I2a9ONmTtq0U0kk8mduj0WRSK9UKCHaLgz5t1w9tl69pPRkbKiPeKGDM9AJ8XiaS6e5k0cA1zVabaPea6aqNfT2tTrOHTiKb2dabhfGga4Y7Cto5W67wgVJLpXrCzHFMK3ijbxZNh26dcadfzU9jxMhMdq8dQ8+XtOa6MNgO8mgYr3TtYqlIJs6hWOpn2zmlUpgra20gKptimL2KRCNdmC67WkxNuhVrvqv142nU12KHenbSe3ZooZh9JRyqmbKIW41BOmdNMol0ptQd29lRSSt3qNHId1eqNl8l2lb+OaPmYWW+VofZ2DrXYOWDkx3uYqReqCJuF9fd9rrK542DthkPRxORSNZIrlfnmhpvvdlwHMPbSQFZtelySrdtZBxeBYrHn0Wq4Lxasc2olXFQTNm6k6IB31YdJTsIj0sFJzHv7DQzi9JtU5/mF0b5lbordZKdpjK0llk0MCz2lo1ipdRS+6uibqLnPC3H3be3Ke8uYHWeVNZdVkw1C61az8myVk4br+tZxVxjdfcWt/JmTNuHG7ViN+mmu68Nti+UlvHDoMML/U1nsC5kh91OidRbh0x4raX1oXjbW29dp0sVrQjJ8C35VsrY/YI1NEuOsPpVM5Mc9XjcTFfGXWcRGyaUyl1wcAN1Mu3FZuKUxiMdh1E/nS6uFsvEc2XTK5XGCjQ7sMRibB3fxpbxZaV8iI/T+XksN91VY7kK3sXznUS4lO0b2dUg/ro5JHDsUBxsietm87FEetJR+zvcaTWeibIvpzq1ebfMNzSrCYUtkkOznNBHk11xYx6cXJkPK/Fmr9CpFjPY5s3hBFlKMb7P2Ztio/LW22krUe4seunNQcu19W1Y1bbmALVem3TfbWrxhbHDr8Pcq5kNu/FEUUwtVK91oFISr92mUdDruEC7jfEqudsPzNRkrxi43UHLLVopBjeHCky2rEFmPDaKjaRb06GI9cKsvy/tNRe/atW5c6jvrJjizBOOyZ8tFO6u2t3pbjSu5eqWPu6mG8nsdFsu4Hpl0rtn+BtQFsvHK6bVGfdz8Xk/P7a2DI0HcNeGb4scmaAGLtBYqVctHJKJ0mLb2PaygxQs1M1FX6+rqlgXm2uISRjvbJF6fhb5Ucs81J3Xeqm0TbTeKk4x1wunXqdvZmWUqtWxcHv24FCbokyqv26Hy/N2L5YYjvVqslcdZxjdZtT0s5rLMTbi5aFTr2NnkG2lrXi6he1DOlmCnfUubG+3lXxl6Trt9Hizry0YLKjrmmjhnu32Fr3tpljRwxSS2saZtpEreFsf2gmzZzr9dKmfYPQtQbq4si5mCNc24fxzOTlIOq3DdFpxnte7xXhMp2Oa2xVSsXlrmpjGKtPeYKuWDmpBUbfzmCAE8mXydZyqaPuMmY31D51FosKJQZ53jUn+vuHxDTJ0W3MrU2cTd4APcUErq8Zi/Bqua0py3Uu5lp1ji9Z4n2S9emFpiliFTg+rkfJWfq2U1c7WQWa/nY0faCkPYbiwiTXG7WppXa+9lbSSWdHHyXz72VDClr3fzM3aW7Uej7O928920ulJc4CSg67ZXzacNyXjjhKpt/2u16hMFaEZ2qhRPXQyCswchg09/9of3VPH5ugzNhhxBB5mIcteGEEx0OZoFnq8xQSnUofEWNRHUuBMFQmip0d8DXeRaRnU9aETJpqERQg4OpLhf0bgBZMTOJaYFwWFDrICGhRQBvYdYnjpBmgK8GNdZEYo8fpEwOsZlqrUNCkxXDALcezVdk4Ejz48QUSVzehUUXm8juoc30X9+2unWGaTnXqylNhX4oVVdmcvcqKJ4qta6/D6nEHZoc1zdre267+W707KPq1+Bdj2aU++SSQdywFVVrGWvvFUHWJyid8uEI73TkJ6KmEzZcCkDIFuQ5lcsuDgW79STCeyse8B8PnE38sAGLIY4ogIpEl0B/2S4qnAeEnkIyZfMYnby1DVZ8R/BlcVRA9VLSBHmVQYEZVKr3oYINVDyynJVwqXyqSy30E47Nca/e42M44Uj6BU7oNvynAUmWRysUg8l0t9/6SnL1XEr55+ehmY7ehQ0gN9LVqjwVDCSNm6xIyLGbmguyowfprQoMFTVT671+6yn1fKh76dM5OZWrM9FzbKpHPNtjUZZ6yiOxB4M103lLGShneC8MdlOfubt6B9yP8UFLtlgfP7iYwu1kiVhWeBhTf4+lzK/yTpxx8hk3XsD9n12l9vOsjXXmn5L5TPy4xR9qlmjrzWLzt/rgDIF3MNLew7hV+PCpTkS6CQJWWmJ5ostnfkxgF3EBtw4WedGtoBk2re5H85zAX3rwY7t33JR8e+ue4xqGGZUM9IDRmWvzHb/JzA+cmnxwWo0OY35Vu5CBjSMEOqAKN+U65EubigYVDHL5x/EokLKGw+l2vus0y14bALBl4PUJQ9LkZLxeJPId+ooZcQJiKTOvOX0WSF2O96nadGJ28LPXHP565fP4U4Um2GZfr77T1EmZtXVcT5kG4QCb18+y5PdwRcyWOr0NrZyFWyD1PmhhkUyMAmFuGFrW6QFFZ3NQbDUDMxCZtIw7YZkr2lDQaedv7hlwHJSlrVtdDAEyz0FDLgAhmhl9A/KHOjqoGl5z+FOLWZ6ultWpQJ8D4jAABQdzZ5Cz/5D0VKlnhls8AHP8CSURP8/YLR33+WMy9rEV5Oe+4NfgEEOdccHh5/PvaFFlaCAlLQ0x/44YrJo8fdQEJWlF6CjfxnEI3eOdUDD8EClzHdJhpayhPIR598g7UvyX+H9CjtO/Bd7skP+x/gFwAdiK/UiFwdSz74BuRIBKaU1RXy+HNInhsGk1SlF5PjF2su58WC6gauEDAh9tZ/ME8PMzITM38L2wtZsZGPS/P0lXL/G7UQgRb25wnMQissdHsRUakZPc9feEVlb0/XpU1Ub7SHR+kNMyHLeC+/SLCCxDxYRLMQiEYDU4LfwJ2JkJQbrPmUG6z9EUqPiszEtQu9/AKulIi0kXPjUJIIWrjoK3mPIN9V/Lc3riUp5dHqE2BPcnuSxCdOEemNXSVSvZrTwOaRAlQ3K0Ztoj08PnlzDLyT6vIeqbZAvlR46XH9j18AwYZvz5lYmiJSsRgmYvlAeWQgNMTYkyxLefujI8uZKjQMaaJf78nw668v4G+72YzMQp7Uj/+Eb8U2DOBticdj5At6n/pD/olGTx38Rf7r9bAvoH4ZTyXJ5zGpLeSY/WtGd9W4lAJx63FGPi6XRtcVuheOjstD7opfbl2UuXP/5Yx4Y54bIjI+GjwiQ/vcQYv5Brlz6dcB6Y1Wt9QM8VPXvIXLexVZ/l7o9bQ89Y8d/CfpyD+BktxDjiBOp9y7/UA9Wmh4h6bBlsPlnqMLYfGXaNQyoOs7VsRiVMYeHqHMhRbmct1KxgOErjfaiOV6uQkERnBMDw0DcNuSMiHtZlc+35WIeJvb1YZ9ofj1MvO3ME8Nuaj/qLjHjeUnH837a9S0L0KFD2ehLXSJFYLitLSObKIMH26llsxkTV9VKdO86HGq+ea7CuCI7RADx7gLLGpg1Y1IqrK/C3E/kYOyNGwLHZhI6FTzsjOL0R2WwH+BDOo8nSr3xzq/LNxKThwKzL0k1KU289nIvrIoG/H1LZ70KyDIELvW5wVcY4E/PRPQo50LSSx78wgiO8wo+TYLFcr5frk/H3Ya5fYs9P00BWUiszIIgk3Mtxskp3Oc45GLNONxMXl9LmTJH/fHm73Uy8MsHHR78YX8CRQZkinNl4NAzgN9LDzHZzhwMWKACs7MH0+BFfwC/n4RmP4OfpLB5auYFMRgSXQRk74g8sORJBHMDdTxVaoicdX1/E6KeNpCf7lSSUKD+eUO9HCKGWd6b/N4mAWAOOAjr6N4Fgj/5y2PF2/7vGTgc7iUI3iLvG0LnHYvOV3o5fPQ5w5XgehLCcDfuCcE+BtAj6EPD77KSphGVS8zukChMqs6ljpur3A9PB4vcfkY9upC1jX4vwXc9293XV+vkmHl6vbVn2B5j513JUtegBv6fOq3ieaK3qp7AyPE/gIr/O/S3fID9+fpvvb/P6b1j1b5B+v7cPUUMbVHL+lDeyEP5ijxddsgV5ZY7ud1TyGvuHM/v5OaHKlPy+pE8f/L6/+X1/+95SVJfMjm6+0pKvTQSyjqrZ2ovHkRfedIfETfN1j7kOmCBwp9U9hMZhNHAPsewNY5N+zVx10QG/VWHMOy5na8vXki8atPQVkxdIbDnywxlUCxw1zQRsKhbAO6PhcguUTAlNrebdMlJhrA4lia/nZJUaSEUwN9fzgKr/oNUtgI16NH4aOqzeQVkugKiTAXUCYBj5HAdEdgPJAVTl+fBeRYPVU95Sz4LaeZleNJ31t4SPa6p9/0qSuFXgns5T20NKjjX3O9BMDFoHJ31Ti6mhpvP4xoyKRHBX2mUflXTqpKLV8BulwamHiXqYDXCo5e5sMY+YS4d2jD0JIhrgMPOHN5sxZDPyH4NeAy96H1r3IFXTf9ef7+xXUiL2SF+n4niYU7FiJKSc4nkR6glIBfEJRlR/nlD9pB+EQXxUrf6NL8N5XGT0c5NMhtLi/1u9QGBMkzFXLteBKrb5B7djzHcTxZ5OqQMUl6ogSOPGohxmWCG/ZNFvZk9E6w/rnLMHdM2YZbUEV5C8vjgD8rN3CODMIG2iHjv1+ND3nnf0mPRwxQ9SIzMiGWUxrk5P/w5/H8mwAp2cB/F/pUUv4JKEQwqtmqX3coUdU2ERF+pugl/oZxPK/0Mme5DcrbSF5B0dt08l2FR0D++oVs9DYd70BS3k/ylEVakPZ515WwBrqBMYDvUr6zRkDXH9HjIpNnk3JxvIaFCVgw6nC/yjAjP/0EBqUGlydemAMt0AD4ii6Cw1yf0+Xxhmy9mEH/OPc04Lkr5B774x18sJSXCh25HmU1yYYrxF+kGL+BZvAc5D2/gRJ1iEGhJhmAf+UjWVxOyA/6/CalDV99wG3Dn//8ABb32UppS5CJK8N8s+xFREO784oLGqJBZZtHz4n+413bfuuX86VW+czhpobNtU10YdBF1ITysl5Q0+bB/6gGmYj6LCR8uLRtpF0eXg9F7BUSEcpW1zvEqfksdYe5Eb8MEn38kdJSQdAneT1pywbeY3Y5lI72Ecs8D+U//1HL/gBpkSfSXWmr9HaoM+svhzsdR/xbPGFFP/tBIG0d7uD1UCbcIXLtCRxBpuqR05solCfvUBVRrssgEj3Xpx//urRruINf+K2U1s/5Tn5rmWt+bVrPb4/NR5+IXpzaPf5I28oI6EesS5lvpX0Yy6CyRELVH/9VscMB+b9FeJ/5lQpA6tCtdW9c0ZcM85vd4qr5aiXeWP0vC23p1h139izuH5xcSeta+EbQoOWYMlw4b/Tz6vvr0noi3d0p+vbCvR6K2Qt3hUx+LfFla1R+uVpvP1RaOdQXa68vTy6uhlJlQYdHML3Iyo5NwbcvJf1B0vL7EU4enWEVEf963RFoWlDVEUhE5DWe60xYrj3ovfZsHNDyaFMpltuDcjgRiUV0YRpeloKYyTvLAWI77B3DRQXlF5ckjpBTZs6IcR/HGtIYfg2DcmFCciHXbVH9Nn2+uLDzP/1L5ADuyxMUefyFvbTNM+V7UIj4FvIQuLz+JH9M+xR68esuL7Jc8v0pJE/RZK/3d3l/bMSMjw/ZvLURk/dEvp/LDf6vmTGX37XQyxIaHP2OZR76QVr6eO8E5CvZjxeuiHtRjPSFD0pG3i+d/7IU/6oE0mof3z+eQjqCmiw/nEqqMh+xLkuon65yXRWLquWhvIwmqwfnK3KnNO5Y3Pj2fl+e93e/h5f9fHycxAuy8O8fHx//Be+mU7g= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid). + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-login-flow.ParamsDetails.json b/docs/reference/openapi/get-login-flow.ParamsDetails.json new file mode 100644 index 0000000000..2752666d58 --- /dev/null +++ b/docs/reference/openapi/get-login-flow.ParamsDetails.json @@ -0,0 +1,17 @@ +{ + "parameters": [ + { + "description": "The Login Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/login?flow=abcde`).", + "in": "query", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies\n\nWhen using the SDK in a browser app, on the server side you must include the HTTP Cookie Header\nsent by the client to your server here. This ensures that CSRF and session cookies are respected.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-login-flow.RequestSchema.json b/docs/reference/openapi/get-login-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-login-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-login-flow.StatusCodes.json b/docs/reference/openapi/get-login-flow.StatusCodes.json new file mode 100644 index 0000000000..ef3984d3ce --- /dev/null +++ b/docs/reference/openapi/get-login-flow.StatusCodes.json @@ -0,0 +1,1724 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This object represents a login flow. A login flow is initiated at the \"Initiate Login API / Browser Flow\"\nendpoint by a client.\n\nOnce a login flow is completed successfully, a session cookie or session token will be issued.", + "properties": { + "active": { + "description": "The active login method\n\nIf set contains the login method used. If the flow is new, it is unset.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the login flow, this\nrepresents the id in the login UI's query parameter: http:///?flow=", + "format": "uuid", + "type": "string" + }, + "identity_schema": { + "description": "IdentitySchema optionally holds the ID of the identity schema that is used\nfor this flow. This value can be set by the user when creating the flow and\nshould be retained when the flow is saved or converted to another flow.", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow started.", + "format": "date-time", + "type": "string" + }, + "oauth2_login_challenge": { + "description": "Ory OAuth 2.0 Login Challenge.\n\nThis value is set using the `login_challenge` query parameter of the registration and login endpoints.\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.", + "type": "string" + }, + "oauth2_login_request": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "refresh": { + "description": "Refresh stores whether this login flow should enforce re-authentication.", + "type": "boolean" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "requested_aal": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "session_token_exchange_code": { + "description": "SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed.\nThis is only set if the client has requested a session token exchange code, and if the flow is of type \"api\",\nand only on creating the login flow.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method to sign in with\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the login challenge was passed." + }, + "test_context": { + "description": "Admin-test extension of a login flow. Populated only for flows created by\nthe admin test endpoint; included in the flow's API response so the admin\nUI can render the pre-scoped provider and (once captured) the debug\nround-trip result.", + "properties": { + "debug_payload": { + "description": "Contains the parsed claims, the Jsonnet mapper input and output, and any\nschema validation errors. Bearer tokens (id_token, access_token,\nrefresh_token) are intentionally excluded to limit the blast radius of\nthe debug payload leaking through audit logs or admin browsers.", + "properties": { + "error": { + "description": "Populated when any step (token exchange, claims decode, Jsonnet\nevaluation, schema validation) cannot complete.", + "properties": { + "message": { + "description": "Human-readable message describing the failure.", + "type": "string" + }, + "reason": { + "description": "Short classification of the failure cause (for example,\n\"access_denied\" or \"traits_invalid\").", + "type": "string" + }, + "step": { + "description": "Machine-readable identifier of the failed step (for example,\n\"token_exchange\" or \"schema_validate\").", + "type": "string" + } + }, + "title": "Classified failure of a step in an OIDC test round-trip.", + "type": "object" + }, + "id_token_claims": { + "additionalProperties": {}, + "description": "Claims extracted from the ID token.", + "type": "object" + }, + "jsonnet_input": { + "additionalProperties": {}, + "description": "Input JSON that was fed into the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_mapper_url": { + "description": "URL of the Jsonnet mapper that was executed on the claims.", + "type": "string" + }, + "jsonnet_output": { + "additionalProperties": {}, + "description": "Output JSON returned by the Jsonnet mapper.", + "type": "object" + }, + "jsonnet_stderr": { + "description": "Anything the Jsonnet mapper wrote to standard error.", + "type": "string" + }, + "schema_validation_errors": { + "description": "Identity-schema validation errors produced from the mapped traits.", + "items": { + "description": "One identity-schema validation failure recorded while evaluating the\ntraits produced by the Jsonnet mapper.", + "properties": { + "message": { + "description": "Human-readable description of the validation failure.", + "type": "string" + }, + "path": { + "description": "JSON pointer to the field that failed validation.", + "type": "string" + } + }, + "type": "object", + "title": "loginFlowTestSchemaValidationError" + }, + "type": "array" + }, + "userinfo": { + "additionalProperties": {}, + "description": "Claims returned from the provider's userinfo endpoint, if any.", + "type": "object" + } + }, + "title": "Diagnostic payload captured during a test-mode OIDC round-trip.", + "type": "object" + }, + "provider_id": { + "description": "The ID of the OIDC provider this test flow targets.", + "type": "string" + } + }, + "required": ["provider_id"], + "type": "object", + "title": "loginFlowTestContext" + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the login to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "title": "Login Flow", + "type": "object" + } + } + }, + "description": "loginFlow" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-login-flow.api.mdx b/docs/reference/openapi/get-login-flow.api.mdx new file mode 100644 index 0000000000..521fe6ad79 --- /dev/null +++ b/docs/reference/openapi/get-login-flow.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-login-flow +title: "Get Login Flow" +description: "This endpoint returns a login flow's context with, for example, error details and other information." +sidebar_label: "Get Login Flow" +hide_title: true +hide_table_of_contents: true +api: eJztvWt74riyKPxXtFnvPp08B8g9nWTtWWcTyIVcCZBO0k0fImwBCrbsWDaEzPR/f58qSb6ASadn9cysszbzYTrYslQqlUp1168Fm0kr4H7IPVE4KLSHXBImbN/jIiQBC6NASEKJ4w24IH3Hm3yQxPJEyF5CMuHhsEj6XkDYC3V9hxUJCwIvIDYLKXckocImXjhkAeGi7wUuhVHKHdERh4E3kSzAHiVhLz6zQhIOGaEi5KVqq3lMLM8bcUZCj/QY4cJyIpvZhAtsFrDniMnwgySn7XaDVFXbU0ZtFpQ74tgLSOWscm/aSTL1IuJGMiRMyChgJBzSUA8hCQ0WjkC8IOlkwh2H9Cl3cA71PvYaSYYf9NSUSjAlRIpkwZgFJcltRqjvyyI2g6fcYpIIxmyYXRAJ4glCieW5ridI6Pklh42ZU7I9l3LREYBGGMl80feCCQ1s7I4Ly3O5GGTwMEQ8QNMwvZ4HAPXj4+OT7Ahfssj2SpZnM7N6HRF4UciC8oCFKx/WcMk/FAmVU2GRfiQsWD2yErDnIgmYXCW/doTlCRniKpJfCJ1QHhLL4UyE0MkF9HDseBP4pqyAWvmgkP5hFTp5Lj9HLJh++YCU9XUVAAyYLAdMYFsDA7xe7Yhvqwg/tEJCNWvk0ikuC7EjJBjJxiygDgkYlZ6QZdIeMvKItFnm9iOxqACi8gQjXl9hRTIpuSe61AkYtaddOqbcoT2HPR7g1xFQK5dEvyeSDwQSSxk/dvpdvbBdgLXLXnweMFt/jPjhSOfwlJgFlUMvcux4GpQINgGokLwuPaTKeN8YqPteJGxCQ/LlOpiS84CGniS3AB7i++vKMAx9ebC2NplMyl4wLVueu2Z7llwbYds1gLakoV3DDbgGsyshslcRuC/YX5MNuAwDNXrNsyKXiRB//f5BglSfq+VCseD5TP2q24WDQppqCsWCTwPqspAFsnDw5dc5XsXUlAm0JvWaogtGxtSJGG5BJP+4E9hhTJJ+4LnkEWB6JLfNC3IDJJhqJZkIgYqmXhR0BPV9h1sKByusPCiTR7U1/g/08AvtWTZ7xJlwAArpuVAsCOqywkGB24ViAdYX1r1wEAYRKxakNWQuLRz8WginPrSSYcDFoPDtW3F2jqldLWF6d0MmSCRhw8Pub9XOgV9Rw3yAzxSBmxhOA9MB/hOzP83msME86+wInHxviu/VTjaoMP0NWcBgRyFjAV4qFTNFpg3Eo7dShrsGTAKLZ3aMKMUOEkwpOApvYecroFL6npBMwvvN9XX4B48jEcKfqcVae5KAwV9T/eUcdV7vCU6egPkBg6lnz7oyqaR+wQ7mgoechgw3IOCoU6jrR5oWK406WSPmfAPK7BQ6Ij5Se1Pg9IpFwoJeC4tlxoRRLA/4MYwiI8tiUvYjx5kWCZ3BLcFTRj0JvRET6oSC81LKSCHbD2CHhVyhjFohH7M8ZDCi3mlQXBYOPVsfc5KFeOhTLiTOOt0GWKNdJvU+vjFTEGxSJDyEPyMhGUzWp1JOvMAm1YDZTIScOrI99VlDP+8Ij9vW7Nvreq3aEaEX+rNv2tftRkc4njeK/K5kVsDC2SYX+LIjJqxHo3AoZt/fsV4FnsNBZrPZt1XPZvBagT5i0zzIR2zaEX7g9bkz10FDPe4ISV1n9mWrcnnRETYDDpkLXA1fafg4vulzFnT7PJBzM63H74/hdUc4XIy6AbO8MXC3mdZN/fyCixF58yUceQT2LqcOseKGBPYmgTGUSIJEAe2Rt7PBFOQEPTYe3mVC6kgNwguRYlB61LJW0m+8I3kIJ0hZLcx35wErVSgWmIjcwsGXgqE0OF64bRWKBaCfQrGQIZZCsWDoolAsWKoLvdJq48DiAUeirlMoFlJLBUxsZkGg9zTKdZfJ76/FGYZWLLyUBl4JgC7BbiwcFJZbZLlF/sgt8q1YsAIG51eXhvOnQFW9q4RqTkPm+CBAhEFkhaTPmWOjVDXwelG/Tx2v7Hs+nDFKRi0cFGwaslLIXdg1M6d3saCkX5k78pF6p0aG+UInZOW2XV0lE5B54rNF9xIfOCiYyxDOvQmXQ5BGPDifCBfFjlAiNX44pDJWJvUh/n7YuT0Pc72WlhsMgB/gwOPPESP1WpmgvOazAEYxQlty1hdRQAWVJ9MNj5VQ1fS2/kGS56yUekBAAj9YW/svIAItaJdR0C7jV+WId6PA+ceaklP/C9USbv8jPeUoQvk0Z7ZAQOG0u0h2qusGLXxPPHxOHWdKhp5jq1nUa8Tr6/mo1kR1p8RFEAwkszsiltOVxIVimZLgtcID0oeWSHGxkR6QjA1GcX2psDtCa1Q9kDhBXIFNlCEfLomkY2aD6GR5YsyCUG1PKpSlAqHIRQqKVLnUW8dX7yBeGdLgh+jOA7a32cUV7VpD6jhMDHLkN1AFr4EPks3yupZEq6Z5OVaYFV4BByxMqRGPM/0/zlKbWcm09oayviJQI93KciwuoiBqeUq7Y8jJSAzkJn577TNRryHurZBQMBeZ11rVWDNtGoE35mDa+S6OtC4NGMpKvm8gr14zC5ccIWbGaoK619zhlTCfsyTxclSxhVKEkK+HnuEJqUVLoaTqCQEcXm1ncisjivJ/0thKuuyIAROIZcWdUzqQJJMht4ZkQpUaB9aayGVKnUs684LZgS3q0x53OCAvT4kAnaSLGkfXnGZvIaCCH5A2qigt/QEQpXqBz81jsxTxKWkwZmZJ1PBK4QGK+0QdbmsepJD8+DQJHxGhj55PnyP2WNbP8FzrURtWmhaJZIwstGQouiqBxLX2NAlLatwSjtsRLRbG/CeGFXRjAsdtwG2m5jFwvB51YE9gcy7Io24OuE2j8jGXvKjjeBNmdy0vkF0v4AMu5PeJjVTUZ6R63WyRa/WZ0jdRa3TBuHTbvJBkBZkyO1hbG3oy/HLge0H4dVUTDiBTAwBL4NIRUz0akyiInThNha01pYUafqAPaUB6EFBcWub64bSYsk98kKpHNTUg0T4fRJrFrDzCu27l4uL67qjWvW7WT+pXrcfVjjCKLlIHFzJk1M4ZTrJQDWZmoTGoZub7YGeMpbPvA1TuiEMGdk5jQWZizANPgGGMjGnAwWJIFNBHV5XDi6PaI7m8bbXNORZ65BGMQI+JeSr0yMQLRmgYCZkrcywfMVngvJAqIpszYeWdBHOUoJvifhMKESWHy5DYrM+FoWHTo1RQadsPWjzj9TeGSrX1YAplAl3qT4nDXY40MWSGDSEXmQI3Ndx9niOE3owXwWIBHN5oS0nOFpLY9nAbwxw6wusjHZcVNSOur67bxlwBdBwy6VNLMTI9BNif9LZ3p8rMjvue+hzNlLJIFr73PRnKH1yscOgF/BVJqIvS+iCgIuxmGKnD+wAo2qxE5KDx2VgMfRqGLIDl/b9f1kv7X//3ipC/RfI3V/4mf3N/G67+f3Oso1gIeYgzvYocp6YJ+E1wuP0vA0rA+gGTwz8bnh61RtaQCsEckCe8KOwax0BixJ3bcdmz85Bao1JVdQKSmBeFpKWNdE3dCbrAPM9hVGiKRv2xP4XdOBkylERhFzUbRA+srawU7LlkxVj96rVVUnUod/OcZGrwjjC7zIg3U9O16QWlM3h23UgE1hxcRAE3cruS9DyXhyGzFYu1WZ9GTphs0T51JEsdaj014wWIjgL+u3B726wDOpsNNOYjkpTwSY1nrtmIdUJUmQl8hvNEazc1PSk8aVXjuvGGtNdNqeN/6V7W4OSpp3MHQeIgUQIvd90oBMjw3BSefuwrWdsGc/Ptbb22HRuVYznzLcwoc/53gbmiLjPgDCOXihL41fD4hB6M+J24IHqMaCU5PrDRrF5CndCOAAyS4SdvQaktgN+Hs4UNDaTahBZb2Wc2nLKtJP48OEYZaHwvYRHF0XAIoqMA9yShAzhVSKpbLsmI+eCjAWPFUMnzLmx6YRu7kDbzIKI8PHO9N/USPdPuW8aXBZMm2ihDKvH8lQ0IxIMoCJgInSkCJSMfxEbt2eRhStGkzoROJVnPqLxchLvbCcxchGzAghTQ+bxgFky989Wv22ZdiQXABRQWUOogE9YjPh0wTdhKCE+8qrQHWz+hNcXYNKmlBVXSOr2+vagRm0vfoVMlJiHLUdJjTIvosoferBEuU5/K4UJyBDHFCt8j0VdVUyPGoYTr9fVUZWKKwiMEcK4UPviG+MzzHeWF84TkPTC4xgKomncR7JXcQiMOc8GZTm07YFLOCU7M8f9b/yx7weCHRKG3rI/zM0YbD/ieaYjMIrFPmsgUY22RIXX9LNOAQBXdwfvtLcrW3M3KJX8lg38DoD9fXHsDmL9IYOsHngj/WYntGDr540Q2LiVZQethoKIr5iS4GWubJD3WEfHh8qOCWx5Ofp7ktqD334fkf0Z2UzFC6vClgvA+YC8lvYFmmkE9YhkcVcaoCWuRI0/P2j4vKw+Zwz4eAiBjAnl8AuoYrFEgBaCAEosCAtfRhg5dLpi2r2iG5XuhEiadKXEjJ+TArDVIknDjt3C8wQBMGFH4d8L7hHEVWicTWimSnhcOjcUh98RR2xUev+fQOYHWBPxIcvbgSdpil+jukmmhLWs7iCQrk2oceAWK+0Fyeqe9VmrQA/I4L2s/dkQlzXwIeLXi9vPa5GNHzJBh3QWzBDczW7Hh2LTgVPmP1QPyyPXrx45oKo6mtQIzRobPQfcxFlS7oxfYGwN2QB6jQBxwFvYPkJTkAVrIDhBZJUDWARgVe4wGLMh0pJya2al9ty/NmnHSP3Qimxn/pafcDBB//sn2NBnlbIez1vUVuWM9cs6mpIURA1lL+IhNcz67AOOa1yfpz2U2OE1v/A720CmkuA1HP0i8yzIgrJzdna92BHYhy+Rwaji3YuNeYCeOi7O7czWWTLuRVb+2B9sZJHdA/BQGjL/1A9ZnAZrzqOsp46BbJNQJh140GGbcC2h9g4FaLJTorrOGnicxBpNKCJEklLiMKiOjlwJSCZ+MBx3hR4HvSSaLwNNsJuGwzRhDZ5wPziA/fKkDrzoFskKdgRfwcOiuptFqPDtSm4N1GwLKBxqB+17QEXDsxIfqiE3LJLE6quPTBG1q7tszTjFzFCHbr1euKqST0E+LDwQNIe4YDoIjYQVTBJ1UDBxABNq7Nu0IkGd7DkcdsDclX87uKl/BbN+DWDFFQTqAWQdlUVL1HIfDgVEC1iW5DKlWs7Pie7O1ubObq4oEY0Bs0rJRWtDSzrZrd6/26qXdU7Z1uUc/3m+M78Ld9kn9ZfvlsHvS2Lrsbbfk51Zle1zygvHZ62uT3wwvnGZzb0PQu4eX/k3lIdzhslbf7VY3L/Z79p23fXzceDq5OR5fec37Ulcenk0P693AKbUPB/Lzg3frVJ62zvY379yHTS56lVJjMj3rS1qv1yz2cFgtsfvSC69Gu8+Xz6PPfOtyclM5vtjtXdqNo8v11+2zQ2ty3N76ZPO7Sr15G1WqdzeT4P7yeffj5svH/mVE6/SUf7yvnQzCDR4ON7eqF33aPHLPRtF+48ayhr2wGx09lIbPwfHDrgjbYWvbp3d3N097uy8XF/vbrVK7vzvefRld7G/sNfoXrev28+599fVl7BxPXg/Pniu+qAx7k+eLJ78xHNyerG8f1ZrBc9A6tHYeNg4v2Fjs1v2d4UZlyKQ89LcmF6ObwWs38Jg1CkvT3vj1vP101LqM6ED4zxfj6/bHh/0xq0eDzctJ4+xzffPTk/XatDbGr5dyc+c+OL7Zq/m301Lvyvb39tvuuHI/scLbS35mD04d72yyuVUdr28N6reVUU3I9vNnd+T36v2SFfiDq/Nj96bRPaqde2zP7zbuP38e9HvNgG9deUefThofL0e706No7+LpbFh1hp/p4dVTdDfZLJ07h/3rytbg47477B+KUV0wtnN+ve+eNHfWnxujjU+lSy+4fbhqH19+rrvro+OjXfbw6e74cHJ2enH+MDy93dquefx841OjJMef/epmVLk8vqp0b8+OJpf71ZvN3t4z2y7tsH06nVyOJ1ZUCZqjyuGOe1jvX9PrM+ptuf1odF45yqVmP0vOJ9uycT+ydh/o/nTPO7vb79YvnrZfIt+P1p1X3j39+Kk9au29PO207Pstyzta97j7MHmp803mtisRW7+9pju2Pzg+mR6ebVt74c3mp+Pt9c37ZjQ4r7Ube3T0MDz2dsJK5ePHG9a9csPo4bO1Vd1yt+qb2yebJ+PmjmzVXm6nlavN1+e9i77YP7p15W7wsHXd23tg/HzU5odP67nTec5OR+47ldP9/mBwKL3j5t41tTab3aPNwWRzbzNob45OrivDcd1xjtpHG6wfVHaH0e3t+LJ/aF36Ys95Zne749dX8fCw02rdHH/0L+1qlw7qW+Jkr97zNw5ve+tntzygzavn2/7F0Lrpde39k+Pt2vAj+7h912tKr9f0RPTUfrjaeKnSxm77enfjaXwX3JcuNvbCl/vJ9v72TdcajHKDhrKzqdxUDvOajWbWkE4Gg+h4ehLcndPxx8r99qfz20Huh3mmU3WcjLgNxwkEtYFakDmijVPapSG4SbUuyK34zECpXLVTzi3wUVJhsSLaZdQxqQ5Yip5Brw/fxoc1NedqR2jbJsAReI4D5j99LKnILDhWEnkCgTaKXEdEQoMGMboqHCnTKBWVMDtykdi8j7JA2BFp2Ix40WKhMYrBuWlzGXJhhTMDlAlZuQaBXy8PUV45a5h0r2bu8sEwjNNpJGhzs/MhvI/exSkZ0jFLddApjMKpWS1Y5FUzvV4U4hQh9oErhRG1qY4AJX1MHXQBOCBKUoh/lka/Swf+x6EybnlVoV5DpoUxZXm0qGQlyYTkGEitiCx7+m7srm/ZfbZO+3v97Z393ON1FOYEU+gxZye5UMBBCcMbBNQfcisRdzqiT13uTJMVN5JOEWLNh2Cz7hSarUqnAPJGp3BU7RTK8cgap0oE6og3ZCAyKwKB/Kr0yD9O0ImXJgH23SvTbFXyFkNkGcu4/Ry83E5vGk53c50+93dG96eT2ueAOaVzb1z39+RHNjnz7M2j+1NnL7xzmodb3SZzt7bPJ4f9Z+f85sTfEM90WNrZON0+ew2iZ7ZuHTd29oaNo3q4e/ccjIV7Vr1/EVdR/XBni993o9vb+/vT2ukho41qq+ldnb1eTeWTd7a13q7fyvNDzoPhIf3Y39zaadz3zvmpHVkXbPxpt2Gdv5ztWA97r9ebe7vPZxeHd62GW7qus/HkWdZlq366vX0TuvuSe8d8NBz1Libe8+TuunlSeVgXzu79+NO1M6zU7Iunw9Zzq8LaG8eNqFqrivvJa7XW3Lvarx8fdutPdis8HlVLwadw83zn8KHfsNetremx3x2fNjd2WNNefz3bu7/5OPEOq3ufhKTW7lG44Z+3dvb9+93Nnd1a4y7au63ZR9eec15pDCy7O9i88isfd60KPe4+We299af98+DodbLXHq+Ls8MTJqPqU+Pq6UR2z1/t0V379j7c3DoV+zdn0rY2Lj9H9G6dP98fMv/0of/gPV8x5/VTyDY2Pobbh5NP/vro9nJ3wtbrz9P7qkM/D67re63SXe1wstm9HtvuHtu5cocPlZ5z9MmbDqz7vYftXe90t3fOafWmf149rl1azUF16LKPFe9oY/r584Ns9OhJd6v+1Aiq2xeHl6c3k73gct++ezrbq7tP3Bp/3vAr7rr9Ujo/rTa2pjuNT+fBy2Gtv/HaupaHzdF16+lwr924romzy9fd0pO9M2yHn1/8z41Jw6vbVSran7c+13aj5qHfdmuT0G+euLtbtzdyw905vmtMeuvtzfpxrnAwI+rsXvVG95Pa3e2Ql1hzZ6c66PU3Px6Pbmq1uzp1r2ktWA+eNp7X+xv946PXjbudSnd9/2F8sr5/zMcblevNUm2v6ewNWhufRq+bfP212noW0+leZX1z5/7aao759eX5R1F/Odq+Pu02juTI27PDetDbartHm8Pb+3F15L5O9o9k+3jj4ubw+qS6yyN50b5nfr268bIfjarnx59vxvYgPLru3eyMXu39q+FzybKf3Ra7/HThvTQu7I2eM+af2vuf3L3SdGOzGj747Oz0mtZr4afGhXM4POOHXuP8brA1fmm52/cvdYdfXbP+MxvUHem263Tr0m/t3t051fOt6emQhus3paD5Unuxp/yTfdKdvJ6N/fX6pLs5ceVHn5Uag6vGw/j27nT/zB/eNXbOt/Yeno8O+dnx/U0e4meEsvXKxrHrX9819ze6zcqd/xywuxYdX9HPvX1xz875obdeuzk5fN3arPWez59v9lrb9PDM7TWHZ5YVPlUvnigXJT6Owu2PH8PK7aX7ejb5dFarPW9efj6eVPdvStufHj67x7fbp2c8nN5ErdfTB7a73Xy6Kh11r27WN9t3w5Otm5O73cB73rV2Plr7+0FwK4/ak7MzPmntXe74GzuXPHrd2arR66dxKXp+Pq4c96eTq5270ctpL6CH1tNpeMlvoulN7+Z5VD0eljwqTkeThys2DeXVsB1tujfupLlTa24G3udN0eDHT9VdIe1RqfLxaKu1Nbl8fXg4nnx8Gvfu7ryHO29/fLi93r182HxYP364aT1btVfrsG49d9dDIajsb3262z62X3bdvfXm63Vv81gKR3wcn99X8hHPZyTD6WXX3z0L7qct/roReseD897dp9KZXd96utme+tF+0Lu8e9kKbs4O+264fuw9vA5u65+PPh0fWdfPE+Y2r/Y2Xr1ahdLS4Wj9/O7qpPZ0dvq5Ztfc4+HdVuXqo1Mv+dHLqOuefj4529gIXqbNveudnfuLFttqNdxm/3zyub47vd3c/vwyvjk/fqiHtmPfnp+8Xu/W6e5r+3xY+dS8zZtOJHOc67eSkZVOwY96jpJA4XTvFFZnZYLY1AEylqckKZJ8VdanJ36cFXeZ6zveVPsihA1iETNOD3B2poY2wjEGdGlDhxgQm4YUDvYxC7TPBIU8YxfpCE9gmzL5lIilKiPamZJOQXK07cQfrCrxhAkLHrPYorKaPdUlz5X6X7JE0d/buj7bqm2+HG8cDvbGUW8/vGAbg9PL108fd9leO5L7UeN03Px0lLsoLzvWIoHtZQfhuy/vrO9jWBsoCYA8a0gh2TadmxpLOPgORHplJ9fRmo3z+n26C0m+NI+rO5t761+14DPXP8kkF4B7HrpHkSw2MKY/0n4t5VEuE3JErWFHaGd6xoKo42gl290uMUxAsclKi6kU8W3oF4Db3t3e+0pKJWVrVM2jwDFfrJLaUZN8qbdvy/e7++vljf397a9z81RQlZX1dO6lRpshKKBANQsTdYkeMZXvk/rux6Itp1lyeekeH702o313a/f04qobRmx3Z//iyr+/2/Wr01bIRw9P5/W7+g7NOYS/pfOBv+CGViK/0kWLaOBMcsVUrk/Kcg1prXesd86m85B+e89nYMfWFu93xlnMmsHBWQfmbPDZaUOubvpBzjf+cnZ3/pXYOn08ztvRfcOGlkmFBW0kbmHEBSaQmn2huBU018rwilxNtQWmIzP+t5hV6IzvZFDF6IwGC+496kgvDhlFC248n4S1oJa6IleLqeBoZHVaYdSAoFMQvyFxtrKZlxkf9XB01ekJqSIPM2PhCC6F8hGmGgEEZQH3XgHs3sqMBhjrO82jm9t686im0gEcR3UW17XQ5n27IwwK0lydUWsIH3yQ6fOCDliZVIwPQHpuyoSu3XyJ1o7qqRdHZwMUMNeOSC1JdrpFYnuwrNID+CF+t3lUvb68PLqqHdWgBIVOJXYgaFgyK1Ip6GoRX3aseW+tyi2CRAsVzkYUC46Zoc6PMFYXE/Sml0aZbVQUZJDiKjrAWKWbJRFpOBt40xHKIBQOwbxjosKybGeO2zxNwq5yA/6lPjjw5b+TIYD33vjuK+mAK0Nchh3HkTjQee7kXRZSOPeRD2vIgIU06eSSSaC7bHI+8LFy6qWKGfCCkSQThjmA4RB5UJG0bi5U1F1rQgeDTPKQZo+QPDQRLHjHlK+hHSZQwB8651MfjDo4w0wauzQWudmOcpHgew63pu9EfgMbG/SrX3nBb4gZFTqP/rjZMEs/4GNqTYkaPGbQwGcp5AYAED0myVBvbZuBDIiZDl4woMK44C3PcZgVyiKy4CIIHMiwFe5tLi0H3HuQ8SQhSVCJeflokKEJKQmYzQNmYWxJjovVpLc0PBmWmrptKqpERSsYGQdTAyBI0eEJu1bhGoqVc3UMxPkNQ13d4UjYJSiF8kFXWKkMsDwG0KQaEpmjXviOWDSBFHuiffw/Ua0wKbXHkhzRGdfndyWT76BpjnhiVBkcmQfwe9b3bKI3zCAkChwZn/hWTM/ZpIpUzoROCoKgQgj4/sGZpQPK/krGmAfJnx+hkAfFXxR0l84CzazJd4PAalNBXW4l1JhKJ02nBCnKTF6m8gRNVrDxwEQ+SHtFMgCHBdYeg8opCe/djIUulVyP53U2hdgUZAH3P/x+A8pcvpXBx5sRzO/Hhhax088ycc4wP2D2P4yG/Akg3+uqY7GrZdJubqjFzByammVeq5oELS2fVxKHA4iZLdACWl9BZkyFXihrPzJbo63FAqMR9LP9y7g4Uxzk5zizbTpCy/tcGtSa7gP2hEwbY00wcl2V8dKOEIxY09C9iagF3DYfNXPHUaoXI1aq3J4AJcpSypmSnFWAFJD89ckEc1cKh8Sjy6LWUMcc6npI0oggUF9DpuR+3alkCBme0iqzIAw4G2MnrhkGM9nR4RZrO+giNAnRHXHdUJE/WqlVM8mZodKU5iYYu6D0993Up930xuoIECVUiYv4OP3Rw1KpY++OfmzqD/IDILPinelclf0wUfmxJKFjIi0qVJCRfpwJWUzlzVbnKtRdMaajlGaTtbMhjQfANFRwfL0WJ1gmZ/htsw5xjnYcwWhaV1Jp1bPNTdsUEG/EYf54EKK0PP89WUMtaAfYwD8yUnjKEATueGqBww8IBWQ0R0fk4TiGIleohOIySs5FujYGrK3yVjbCFYxZux+397+uzq5oRwDxY9iYCkpG6kUoMmnqWaskgLGhoCltqn/LW+rfg+08xiOZFXpBN1Xi5j0HTAu/IknhG6M1qJPDKCyY6qqKc7C04g7Zz9SxIkcdkw0sGSmmrhfJVJ8yHXPd1sdSzG0koR2BhX9wp0O4tRg4bMYImRGWddhALhpG3O+CJz+34kJrxP2qekmgpfaEmydWAIL2TNqLLjiiEptgKcHe3BE6XTs2HFHbVfnI+UHxCJcW/N8ET2ko80BqdeBPgTVSp7x68z0KUo2RAZoI1sd0D7IbJ389kto8h07ZtaHgktqGaCmKc8bS3Zm9Gc9c5V6hV4DbOsbc1DB89CkPJlwyXetBeSHyyygoEdkwWExh6ar6dQoHGEZbOJjJmutRyS0s/ZXPlnTMtynuB89hW+iokcu4hp4WBaAeg0nKz7TUlfSMapXtVu2qVH0LVbE0B9LHAwhox6mskhYDnMQJohpHma8ewbL2mC6a+FKaTCYl0ERLUeBoO/0jMSZ+bdHCwpHZA2BoSu/OwAUq8ePBTwUmDUTPs6cwKBozQtYdsWkXCn0cgL6e2KLbqmABmEESxLNs1t+j8ARTH6qV0E4tU2plRcUH6VK+rtcDpgY/TLEM2JEgSGFokppTPhfLo8W3Ze5FBJcrbn+P2IxonQjiC+guH/b3eg3aLHBRBm2p4lS5BkMcSEeHz1moQtODLm/VEcZINWOEIDMmK4pcJ6BWGGEVYEdZe4fcB24ZTpjOlIpTNnVubqa7bAPLYj5UgMYEXiO1Zc2cufhSetk7Ex4vKKgL+EWc86h+fjfn0YFP1WDvz3aEqUEubFepQd1YQP4Rze9Wd4LEyOxEaJ7TAfO0v4yvwlAmdFmHLk1fMintAmeCiWgsas1BD2jSss/u2h3x5eyu/RUoh1OHv2I6O6beIYxK9jm7ayneGmdR8FRiHE9MXXPwKIkalkO7dSh3ZUege/W2fVzaizkmsiBdsC+RuGbr1BKts2EuTw4dfUuMMbNEk2vU5rbV1VXaczIorKCrjtkcu2q1qf3v2sYwwzsyTL+q68BXHSolacZ5I0HMgDSrTtV9yRwaiRZZ1yUHE7kBi9MoZXWG8NB19OKr3GTNe7FgOtoss/Cqis2bx5VVouuFY3oJGvKzvarx0NFEYeXB9ikPOuIfJOGnvwcZJgi2NaOSpK30hqB1boqlfXlS2+LNOiSI065GDsZj5XcxIKpMO3V+BR5oIGoULmeh19Mqxiq4SSzCukjU+PxzEoPUpnk/MiQNueynTO/ZReqI2PitFgn2lQpWMOhQJU6QMtEbGHOAtNa2qeBK2icV4nXoQ0d88pxIhBTKZKqqKdOZGuE/ZlHQtQDm91FNFwlIa6ipcNZkwY13JXd9dfcyB2m4C4y6oMsOhCzoU4thtYPY5WxcGDqAwmyrJPj7AFJiIWGxvQiMucIHbwJzW1ex1jJES6vS+qCAddqFggUZxpxN4ngA03sm7ghNdGluz2PGZHKWzXeuZ0OQiO/5kf/HzgWHSE9mwoWtSleyRS9JUphSlcKiPjDlgKtIhVe1Y3Ud8FLfs1ABtzmFzGc8uNT3gBCvJy11hQUIKCEY3fQgKt0cWanv+T4QXeRjPboy+MIja/jHYkYloSowHLyDYYDSGA6dEGi5Iyb0D16kTqHPVMadP4QwqoKyy+kuy0aXzR0+jggBp4nrhyZzW19Rki6OaMSv1IIDaElcQGahzej5NVe1G2cIOoGFEgWe1rbNQ6yu2kif4t9mldJ6DaX3Uy5CJY4QGhgNB39qSGOjoB+wMfci6Ux1tXjDnXNxos4ZKPJswsgAzqR6SkekfKW6Ogz4IXyQS9NKlz1fvGDOM5FIMqqoJwyVk2YL72C+CIpMVXJRRTtTxTzTjDCdZ2IqBZMV8AcwOC5pMF0t63KpOMW0v6mHubLNBgiKPFRxZYTKkcyOEGe3ElZKl1IhK15gLsSJgVtVsT+AISzUiZwbEK32kTo1Eoxrtm6M4bAamfUypYDThXRjgoa0io7AHUFE5Pbw2FBOAlVpKDlYjeyLjbu6MVJW2VyIokgqc8MGXKmgiwHnq0O863gWdfJkz9v6hXplWHxMUdzW0gdM16FiECnGAnwRO0hE9exRWCSz0Y8dscg2fFhtbH9UMZW727tf43FISPXZLYtKGlKEkJaHjrMJXiZjuCM6hX5QqlZIH4JhMfMlFcuSSrUG8I/hz6ESb3CHQg1fKqhNi4o6dIMV2DhA6hQTaSBwlqnIKoh/LUJlH+24703JkRhAes13PsJiGeruJs17IQYrYBJOWN5XAV86mCwuBawlK6gvr5YNGE62HJSxDM9X8X2vjJXSfKrGkmgobEEdpxnBfr52b8JeEmeTM0+PWkAGa4UmSFUSlDoLFRpl+jYip5n9TNVe44k2LlzUYKCGh6pKLt9UmdDR4qWr98bun1T9bANzXNEJlkWg86YIGXEdoZggXIijyo0JewoLDffEmGrBNqM6nio5g+IQmaRYzVuOUjB8pGM2FpctjZUsU640e+FI2pmS1Bul8i1sJ8fKj7gIDdwLXFIxnMoDlQEyGVq9/MmwmbpGeRmrulpRUslaHYFJWZtMvfwSRUklYBg0S2car4w5NRfMrJGAuQx5f9+hg1XQSDl6FtHYEkClMBFHfuYNYnM7sYpSQdgL1/6xGaukGR019nhUU4zIjGxsPKqwf0CF7bk6QpxkS5xHMtEhIX/AziY1iKw0hIXrBIGrNHSpojUsNtkRutaRdtHA5v2QLlCviiLCHksFpVApPYvr+HSIV03drBPHOqurgHSpW8DYQpdXvi8JzVUY3oNlPDibdzcPMzskDtBF2k6FReNDPDkToVCViVLdA1eAuQIsIO4YMxZ+AqW5VQGg9KmgxzBWNywzkr63znyqPoqdzRdJrXojv2MUmrrAL45zIWvo8jI0k75d8C2fVw4etX9L7xqEKrm4IDb/qvCMtBRbJlfq/gYsAm2rL4HDygQhGIYj1NaXynP9nsNBC1WZWv3oLgH0YwnzZFUwsCW50wta6xmF6LFDp7QyXmevnwiM9UfLTYavJ1ccfjd1Iamor6k0wXNcFT97xH7NOczTZzgqdsQTAwwGX1R6P2XnTMWharaYudsCXOmzkXBvBblBudNUrF0e91c1oWToBWh7NGXfuExf4WVKxMDU0B5ayjK7fCL9QWFEyQtOqnJaZrPj5k5uCEShI6XKYGy82ZCZWwbVwiTG29vmxQcQ8cMh0Ioqjpaq1v2945/mTKadVehBsJQyCijWM0VLbuaGRijtQ52NTqGo/tqEvzD9i1JnC/LTK2TIB7ASWk+BmkMybQ4Z0gCvt0MriwDFnlojxYHgsrXAc7muO0Aty4v05WwnhrcXYxCyrBbgmznH+hRjLmAxVI79EPyElcrF5gyXnni6rVRnXuqCtP9N4OKmVXVmYniwLtwHtZwJlJQVKicsFnqlRpwkvsOoVFeAouWHhN5B7h0H+qJGvOrAglKyfijXUrXWUvdpUepAJhNgQP2zqf7ZSu/oSmZBK/GCXuCCrlQqF6v5pALm3m7o5dE8vGp7WSkrIfH4Uzw48sNmlMikPa66NhtWSVsoQ6E8YMq4obid3GmjC/XiTVg5oV3GqBCH0tGZ6/lU9HeYuQQoiQGPr/0z9gfQpiH9EU4A3l98sM8OYyaKgKojmGev54MDDuxhnQL1eadQVDYIHMybuVwndR1iLopDGuYhM1SVkDMXG2Hb2Gqg4cdoBlUQRUdkHICMkZESTL0UEygBd7xCdTGurEjq2soulq09UCc3ml1izKajRqFPtdfgVg1zhh1kT0FQwuOrF2P3sEJF/A02Ux2VUWAH7p1yu8241iAspwRtCHsJoRaFJ1SF4vSFkw3Ph3grphcD+JW6I1lXziW9qb5fAaN8VHfaYf/3uYLU+kIquEch9pJKL4kS6ggwnlJTTFMZfAJWQmnFNllRyj++guWmLeqDVGavaiN8LxrgvcHCLoUB97XNYP7OGGzZ9enU8WiO/lJN73CfBsA5ld1SmVPOJGjzcNOv76P07kdKKPKi0I90dW0qph2h75jSaYAYVQl2DSiXhzlW5vKKFWNwLZK0ior5K6mo+lV9OTQW6NR3XLGXpDIrXnmBIPbQBR9Qm0cyzq7GaRM9beDcWnYOVC29yOYhLL9E4wquqL7JNefaHZzHPOoSilHCnpgSGTKfrGR5QdHYgW2muIJGaUcwkDSpSsObw94qkAfob4Y5zcPlqlSsechOs+Ecup2J04gv76LcgXy+/MOB6ltcZ7jL0AvgpmkoMtg3J68Jd1b96RqyK+mLRcAepxfbZoIz21S5CQPKQ9nlAifeKawuYHUsRxW7pNaQC5bMc/4SKQAJXb6wLLMAZc8mA5FaiK7JZs0HKW0c07gAyU8jAHkLjqkq5KJuiwwj2a+5YnXsivhxL4R2PbAXjL4xYqjWtLHT3BGfFC12cV//kNcDGQEGWcQycB/5n+b2Wcbx5uCqSb74DUK2KayZZUXxsOwF9Hxk3Cm3S37Gpx5RMa8fme81fqEmHDvKtSr5A1OVoc2CHF5SEVOo8DXIm+gk8EJ1u3pIhQ1qg7pQPXenZKgXJDDFhBffJFhaxLfhELIjK01KCJBN1KbN2NBmkCWSuwdz+jf7BK5UCOxYVDfs0CT1qWESMBZi+/dxxdRLQ2HzMOanS9IwR0VF0kBxIDGwqIhhpFTNipIhFrCVBWUEHHM5e5vJUN3++Cnu6ggPqBzLpYkz+x2cJCbyePWNUPIBFSwVemYkIDSJUTHNIf4Ur6xxOhCeDLkVn8xGrIkvEkFGWYKgAsU3v8MyDVC5xtl25jZM7C6WrNQVYMCUUTQPaTDIDxudMb6kB3yjWkRmvXRUDq5QQIXE4NuFIlnbNGloHKXKHqJ7Eku6xMuihNjQI0PPG+n8fhTCwYUO8onMw1t+EHrbaCqoo4B8mlSae6Q+f4Qz8lFLSireW88X4tSNgSTuYYEncqEUyoKsn+60fXkBLj7t+bTiVgAZ5J4rLwnWc8CoZGiLGNB8Whl8cy9jz5NuKiqeKQkZSZuy8dZI9SWafh7/K/Xkl07h119JWXfw7VunoDWmXzqYXd0p/CM/PF5zKwRrQeHlhYoN4ER/D75/1QxurWSgO6lUy0iGnqsCZs1QC0SPjBFvwUUxyXore9134SIKpLsAYjtRbaQuCzhSlnKQ5gc7L6TOuF8gL/Dd9T0CEaIdobyoyAo7QuuQpKX+TZlUkB0WtUwPhlPV4D2XhL93sFmWoe76BVTpQd7gGxFvG06R5uWzDaQu4RCnUWQEY6Wr8xTdavVd+Xga1612rklIePYMJWY7voL3qJfNePdxozKHuSr90QRh6MD92zpJSn5K5bRPBHFKYFhjeKSCPP4Xdwf/eAT3P1ob1SOUN/UQ/3hU1UUhsuIRXeS+g+4w9hI+5lybGoYB70WhVog5TMnlAsxlKDBQjNjClvO7bxiwfj4pwp3iHySBBpD9Ac41rbkZd4raTgcE4vbfebd1xVxinSgzi1ZqQSIRLBJy44wNCGP6bOATmMpjXOGUuBxJ2euTR2hQhteP6k5nvJOMuzSI65aChw1LzoBSSkOuL5lUlwz7TIC9Y6u8DheqC+0VUXeYg6rOrKHQXnF9ORWHmqe0U4AgOYhaBcqGPQ1LjQpGR3B3QOouHTAglAqYq2DD4XRJC/+B/NQxqfEx1iZNG0/ftal/2sCJnLNk4EsGPtsFshHTqqh6TDZx2pqPpFaJWdasKTdhZiagFT/A3Z1LGDYf54VJK6oFw3qc3pYUAUAlBiSbMYS42iAZJ/nlEPdKUdo01s7a9SVZU1HFc8wXbUV5fA5f4JWDKjI7dYF8fL+QVqNq15e5VGbqFy1QbfJuGcsgAeRoxQSprytSlZT3FxIc08UBVPhlHAKokGeCWafEpdNMEYVHgKxULpcfU+v1xrb9K86AP/oIeP8JoCD/o44BoP8/9yDI4x65e918krfbIap7ZpPmE5A7yBFaGESZ5ZhA8LlRiDnM6n3XQy5FFSBU7g7+KCqFZfyzxRUZLCifioTxQRLpRQHmj75LnJ1wO88udgePf5jkZvYQgKpPTTVM0dD4gq2FuPiBUxQBW3yIxvbxHCv4j4yCSwajzCspUegZV8/CwI24RdJ1HICNfZc7Qhl/spBVUp8ewXug4bcatZnTEVHwVpPbwOkInXBQiiMoFrevqqYN3RJu452857srNkm+8YRKqi1hJMDij64Fa3MXowiw7EuAgsaE9SBoRLw1K932TjdNbVFELAqC8H/wVhQLs/MHckxNq1AsZCAuKJNsBph3bfvlov7URVUZhOAGyA3pDWWyoz5IYpoac76HcYBgmnjjuk6H9piz1AWXuiCuiEtfIHIl73y8pC8X+Aq1iFQt5Jj+XPrC3cglqod3Xuidfx18O9WtNqbhte+5C/fvJLmhlPRHyW4oHPzZ0psn8KbzPO9rFV5kyOmJjqnuT+XtJ+p22n2OPep4/vTCILtVqu0d60HAoVJ+a/ElrlC+BfiSGTx1E3OcsgYO3hVTtEUlaENFaVjcgMsRMjvTQTvgUDoYk7sYtXPpU2NAN12ICNNVGh80ngcJ9evv48XkroZxh76u8HtGx1StE+lHQjmBTGVrLKQQTE3xcv2x1I4jGd/+BOchFBdP196DMwb9e2W4jmBqYM4UrDQP9TRlXqPM15i+ufAzfIvtAaARm+Y3T7+ca50+e+uCh29+Pds43dubE81pk/62xUKIJZDv6SOvbWqDL0A9SHczaFWP0tObfzI74UyL+f7fAvE9PGdJN38y3SBnynftX4sLcOj/Ds4M/f2TjBmH/if4Mnz/PrbsJC0X4eAnMGVEyZIn/4/aW0uevKSb38uTVR3HBbY1nbifqYKpVSWlfCO/BMeUg/dNYICRCm2EWraqhBVEKsAyP+rbTLRqVIxLGWpGlgr6VyYFXSCBwX0Oa3bg+bY3ESSgOskNvHykHzCGNRlRDdfmPjUO7eEwHWHGAY7KRaRzYnAwmoqRUB8XVUZCXNgU7qyC2wIwM83oXqZ+7G1du8NsD7OKHXD/YZbXG3GgzXQwl64/qyaJEZjK1aYzwwyqPVM+MotcO43c+GZ4PK2UmkeJtKhDAx2TDLrpitqARZ2cVsQrvbSJZjVVoQ7uRuvRkLupxFwcfMEydsT8OvoUC6/o/Ah1hmZWc94zijPIJ8dUxSqTdy2jniqQZ8gxrviBAgG3Rpi+ZGrtvzG3FHY1RqGaEZyGcAtQiHSQi1QF1SxWSQqp5TlziZrkmzYSsCXMGNKvfbNrZyNa4/sU3rJs6EYLMyQVcPOGmGCkK13hKsZbM65el2voW2zemjW0aDMX7sDshMGUoswCC2yn0CBlZFXJlvNNrvAFZHUxa9TzXnKaVPWrjhhy22azZlNocoov8j0J8H6hsVlNwwEjGhBrztsWvuiIXhSGXt7Yh/iiIyD3Am3CWOMkpyGU6QRrMJauUe0XtMqzecO722Y9JU9ok17akI/IBCO/Rhk4nRA18FnGGaDmWygW1LwKGJqQgl8/0G6Dd1uKlkTyL0Ek34pv8Wqzy1UtjLnE91mGiHZZTQApL8SsG/NHuKVK/ACocmqOyqlY4OXVWie2IBqeefZmBZ6Uqv7Om91gO12oR19t9ZNjHtG4DVrpW3Do2/OwHaShDv9fNGz/q4TOaKL6sy3bwsutVHTlmYJd1VZDFbTGlliPA+wIpn6STgbnUF5gjK8DUlV1fqFmqbJsqPvbyh3x4EVGqMW0f9NBUgoEYo1nSjRl+wZwkOShyICBBjrhYZk86Bou6qpLlU+tx8CvQdJX88DR/iNfaMEabIHeV2/tQ9P0jT24MO5Dd6HCPn7Mlac/vaxfHs3wkgV5NCqiQ7GnuQlm2U5668ecU0dVCQQ0NwREkVdubJWGFuPdTSFjsI4lxrhcv2p+WedlbBRwIsDNH8WHEO9/ejB37mIv/ff/A/33M13orxfHdcJX744KUxaZBZFn32KjwfQKHfqpAdHUzq77hYMvy7i0/3EhTMu4tH/DRV3GpS3PtWVc2jIubRmXtoxLW8alLX3ZyxiIJd0s49KWcWlLnvwvvreWPHlJN8u4tGVc2jIubRmXtoxLW4YcLePSlkSyjEv7VlzGSixjJZY+pf9JPqW/LlZijtksq2Atq2Atq2D9vCpYy9K4y9K4y9K4SxHh36U07jJXZpkrs8yVWebKLHNlfn6uzLLg+LLg+LLg+L9fwfG0OJYriFHicInGlZQ4pu6deQRJ75dOoe95ncIj0i0oinIVL3EdBF6Uc8vjCTwm0mcW0KXhQNhYdxt7HTI3W68m9Ed6zPHEAOJvyui3pZETkpr6F/tPuS6Mo0I/97htIZnVa1W4d86KPwi8Ptxa11D/6qcwH3LBxUj/xswBSAzQv0Mv9PGOadPe80aR39XXG1/gL/0qzh8w8QQpSEdsSnRYgX6a7NxunwcyJPX4wTH8NvBQP7SGlFTVv/qppK5DWpXLC/3bZmNuMTV6Df9OAEgTusJg1jsFCFM8GdBSKBYAJXBIqTQTQAA8TM8bzBlJWoueHx5b2TlBLwpuUG6oi+6rBFQYHP7YhKuAgRjftQuX5PDPkcPyDrOlnv/P3WFG87DEJXHRSq9v1oZzBTKX1N3TGH/EtRERr18HwQlWRIWewInfEUZASoKNbus51zsvM6KWJJsyTcXiDblSsuslCymOr4kttzLAQsylBOA/zt9rLqhQ18EUC3hAKoNE8a+XR7UWOtDiQ+o6vtTZoVlBSr4E9GclS7hY9IOS6d641DSH3eDFhXNw6WtA44sUzQWIb9JJfFUp3mXqQ+iG3aU52/FWvatonWfIHLjMWSsnKoYLJOCB14v6fep4Zd/zMzl08Dnmn37XPqAoXWGZvfgQRw8gFQtcykiBpz5gMuyqBOEI3C4yhOCfFMpVHC5cW5uTij6nzsZ33AIqtte3Yq4p1NXavu/oK+LXnvRt8iq8b4FZxFxvfR1MVWAfqHZqyyukzPNuxU/mukMOQQImfZAE576yWS8azH9Vg8cm6l8SbJU+ZZI8h0hGqFSCIYyOKce4GjyahhTD/CElQGAETRnXBC+71PMEVb1HJSPUpj5cFg2XmEfYGj7tc2Gj1q/D8/IY9YJpQ4kAc+2nwpvJocxCoEmBQaSo9m5aaAyB+fTAbhgJe+G43cyg80iMfyWo7EfB3JGtb2sXFO5/Np7R+GbzBOBrpD+l79drZGNza3uH2B6TCC174TIXRXl2jnpN7UVt7VAoqtfKHdFnCEZXeGE3WdCjIDhWL668sGIed8Rz5IW0y14sxiBp4ygIbuDJkX6Q4s65/RaKhWwP72LPPxfERGzPCTjVh328fAk96W/y754PaRjJLip6OTc822zWX6O6VJ8RVI1Wtte3i2R7fQv+t1Ek5XJ5NUMN8P5dbvNFDHzABAhCyCC0nXuOnardlWKLMTNSfKWZ8JXv8kjs60QNqtjk9pJNLtnkkk0u2eSSTb7BJjfWl2xyySaXbHLJJpdscjGbNB6YJatcssolq1yyyiWrXMAqATA6kEgZAY6Oa/9S8oJpKaAhc7jLw1IvskYMJjgKaOjJkh/1HG6VhnwwRMoAXLUQIxKrbjpUDGBrQ3KgMbdrd1Lhv71guqYys8HUquLEDgrc9b0gJL92BCGEHGtgKj4vqidVT/T5IDK1Br6p/OgPqd4+/B3CgMDHHQKlJK3JL0SwSbaHldW/m7bU53UBvN5iumVq9JVMT6s4hMNCwu0Doijt72RtDXhYYiMGrpDKeVfFCSCAhwbUZcBgLc+FqgUwg0cw3j9C/D+5iVgwTbXC6JPQUyF+qcPLhI2soaH5/0AHv9CeZbPH1TKkFSjHPcQHmmT8VQW05XkjztKAn7bbDVLFx5Ko7PkIy8/AdmjVztFFRnqBN5EMYSgaNilZMAYYua2DJyOZOCWhQaprcsqobSbUm+JrtWbx9HR3QxYwfaoxISNV+IaGpNpqHuNxJpmUipMrmCEoDI5VZoXMLpMV4+dcXYgIs+y/6o1exPOPfCO/EDqhPEMP5QELL4w1f0URIrc1RSoQOmL17xjXp2n+xEvROmR3jFmazH1qjYCVuRRqd4ATCcl+pSM6Ycf4VjsF9bPvxn96Uv3l+UxQn2vsdQoDHg6jXtny3LVkJ5QGHrTGyUItHRxtZRU2VyfkNjn4BdKV7K7mYp0CWVvTREF+I/86xAzgKiwrkNXfC8D+9yVlWEZARJqlHfxCMqRQvmKTGQYHH1GfVxV0eR9UGnX1dobLwZcASZEERTgU4eO4p3LMHRv18kl6fxiX/yG1RuDUFPbK6mq5bq9we7Ws0LeiJrtaPlKFoRSUvI+j/McvRHBHUWkn7Lth+dgPuAj7K54st0KbBUGRdLQsreIJqOPAEj8ugunx8YD857jTEZ0CzmT1O30fR46jltvI6qnv1dff4H9ra3EDTfmZUQ9I/De0nh/Og3IunUIz28fCWaSBYNJf7YhvaZ7TmIZDdNgavgOn98Ij1gumXfWyI3Dc5EHZ9WzmyDLuxS7sRaI/Ss1n9puAwXZRzSo+B4nOV4c0tvRx4qaB+gUU/TcILePC7NChJ9EjbKget4hm4ajBDMPQlwdra75Dp4q6yn7ggZgjy14wpT6XwAah4xZjWQmg7E9V3ZokCNNxiIx8gInZM+JCzLRkGQ+LjCSRmnh2v6lDAacBvOq94Bo+DXAfQbQ3oSZ2RqkYWGtHiydaKQHJz6wgtkkBVTH7dGZPY5Ebn+tmBwrav5FqwKDIwsJBqJSqKXzLEzEpNWJaWkpGWDWnJfmFfEjOmg/kb8Cy/8WOmeQ4B2izx0wC8b/3CQM4CIOppgxFHScsTK1R8gaWOeZ/v2RoA0SmbsI/Vrhd1OP/onl/0g3ygpWONgHo7rx+Wv4u/SPb3wGywXQfqpM0RPotQ0ZEYn4EO4AdzI+eNMicKW8BQf5TIhzkPwlbxeDvl5K0RyXbs9Cek1J8wMbEB8qogOpe6sBcxbDegLpKa1IloFNRKynte9469Zfunf/1t5et2t/NBiqk1VUsolKMZ6MW/bsz+jfbWxmMYNV5IJKAhVEg2goRF+kooYE3SyhZySp8SYlM/45Uo3C0JJsfIxtfCX7zPCbNgd9FL/9PEcv3WcySUBJCWYn/Krv2Ktr82EvIhFTlNb/8WoC0koNFRr+4mFae8Q9WwXwdH4Cp8lvLg3DJ0ZYH4fIgXB6Ey4PwLyeUuYMQmuocByQWpA+oUlVYk8zplwBEbjG1FmuwFnC4KcAVDUHSwEFs6/lVW3i60okG33LtPWt4OgYcnKImHzD+RHkpdehCIbEczS3iAyAQohKuWDjxghGkV6JTGnpJykWg5x4qBKsF/JL+ouoJ6Tns64oB3lIPANiyHK4Z4Nf07WJrAxaWZEjBXoZ1gwF55t6BFkRRqPn0qORWHFkB+FdPYqKE8WDL9hgN1H0DSUv1aK6pSl/FjDBcA3X93tAL+Ctumqr28GYe3maWZji1A1q2meuZCapO1+D/mBXk+WoCXr/vcKEynfBpXE9Y2Qd0rAJsmYD1AyaHJPRGTEiyQh1OVTHyR91Ll2IO1iOwnuyjH+8fuvCZgDiCQlM1ArudyrolOu0W+FMbmmPeD/zxTjyE6qOUp1oh/RsW0K8gzKrj+ViZVLUTJmzfA3svcAjBVB3wDOGBXXHEpgnhTSYThAV2B8iPQIlgkZFrPgsk2KdKCmUlhBFZ4PdJJpjeecFI+tRiFZ+fs7yKJ2/DTSamg5LDxsz586eBBYv6ngljohZK0aqU8UFBm6//W61jwVwhVgDIWurdfKmNv5G6CAPPjixloq95VgRBPerwQRu54xAl4iP7pbbLhS7MP2bIdCqNuiyTSvYFPFSZpsLBGhxqsszWJmoKJya3SUMjgyiSUsRaJg01IvYCHN71ZGgqXXBhziOJlT7+9jc4qCSU/OCS2HoGRE20p+9KUT3FYSmaBaZWUJWljwdMRU1J7D6+VKDvQZkN2I/gbokgK+8AwPiNXOjf2qD4G6l5E7xMBQ/S3/MfdJFekJ/0328AbSnzH5l98OP//YQu8rsFaGs0CDOI+eJHvbLNxsmO0w/WtE9driVOidVc3H5pHlVql0dJDzPec2mP1nqO11tzqQxZoL3pUv+7ZtMgXFNdgACRxm356qidHUpEAxaWvWCQ5RDx4wTq62BaVi6btdWfCa0XCjYHL0J75PAXHqSHGrKXsu8mQ6nf78XsT4CWIUi50J54s0MlXS8cLg6E+EMoYeDN04GGFq4xyg7l0jETWUqQjAbWsBy/WaNByPvUCtfkEA6RtcSBu/rPQwsVqRbQberSJUO3vvsks6hFujWPDU2spSKvVn8mbrE6HoKUhnkW2pU7OFT6LLSGq78X7JL+/A8BXnWemQKBOTROGzOkqCDjcoZbZB5nduIM1v9poP2hn0POiHEVWZCBdurzGUD1E6MypIh3bX73/fPQIki5nKIZ9abZoYKoNx0wV2YhTj9dgz8y++2nQgtDLdh7TdCfM0NZYHyVZe6ltDLzSP+1ENKfBK3MP+GwXpHFIMb0IDY3VHxqDRnZLK/rizISNQP2HsXXiGP9rVy7qFePrlpHpc3yenkYuo6q2hG48rrfUso2KN+hJ1MRskbkBM2ZBVLn2AMyUL71PRm6VKTgynqtZ5XnVEpAoZ0R/ZXVAEt14de6rEI6GqOIUqGODCjqgGGbhZQ7Mr8EC0qsh9qcguorYS9gvFClWUXIS2jq0OEHKlRfW1VsI7ZqnfCDzLGxlDvi2AtI5axyb9rJxD6jbCq6DkzKgrJgBIJZCroTvMqoT7mDc6ir6pVKY2JGIi9hkBAgRZlFSmgeor4vi7HRiFsQG890xZkII+0hyMV1wbLk+Uq9KtmeCooENMZaGOQfeAFecaUu+LI8F0TxNB6GytYUellVDoX0x8fHJ9kRvmSR7akLy034oAi8KGQBBCysfFA2ng9FXco2voFwJWDPGHSF0ZMqchSnbKJFdRBMxp0RsOeyAmpFB5N8WIVOnsvPYAb88gEp6yuGXQRMllUVnpUPBgZ4DTFeqwi/Km7IZbxGUOQQloXY6sYwycYsoA4JGJWekEqxeVSZC9x+RK2sx4gnILhCYUUb1brUCRi1p0n8/uMBfg23tavLuvA9AasqEksZP3b6Xb2waFntquIatv5YxY0hnaNZwyxofAuXtl1grLUnGJLXpYdUmaRjaKgx9QNuLkPt+xxdUFBTKFBb/A39W7mrspY83IBrMLsSInsVgfuC/WUuq8uoYb9/kPRFlKupJAVgKGt4wRuWSwlUnSW0PX4ppDvDmnCqgKmyfX0tFiDGDNr9+itk7dwGzrdv8BhpC62S8S01yiL6BgNcaWrb0+p8PJa5qvMnWro74p0hWYswpXyNaLI3XkkMvzEm1cLBl6/foPo/bL4fxEXaMg5z/4Nt4x3xZxjH38Bi1XgLEkzG3lwwzvhp3+9c7lzGdn5y1C58+/b/A5QQvNw= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns a login flow's context with, for example, error details and other information. + +Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure +that cookies are included in the request or requests will fail. + +If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward +the incoming HTTP Cookie header to this endpoint: + +```js +pseudo-code example +router.get('/login', async function (req, res) { +const flow = await client.getLoginFlow(req.header('cookie'), req.query['flow']) + +res.render('login', flow) +}) +``` + +This request may fail due to several reasons. The `error.id` can be one of: + +`session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should +request a new one. + +More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and +[User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration). + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-o-auth-2-client.ParamsDetails.json b/docs/reference/openapi/get-o-auth-2-client.ParamsDetails.json new file mode 100644 index 0000000000..d1972bb4af --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-client.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The id of the OAuth 2.0 Client.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-o-auth-2-client.RequestSchema.json b/docs/reference/openapi/get-o-auth-2-client.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-client.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-o-auth-2-client.StatusCodes.json b/docs/reference/openapi/get-o-auth-2-client.StatusCodes.json new file mode 100644 index 0000000000..059bf862f4 --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-client.StatusCodes.json @@ -0,0 +1,379 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + } + } + }, + "description": "oAuth2Client" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "Default Error Response" + } + } +} diff --git a/docs/reference/openapi/get-o-auth-2-client.api.mdx b/docs/reference/openapi/get-o-auth-2-client.api.mdx new file mode 100644 index 0000000000..74afa7f8dc --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-client.api.mdx @@ -0,0 +1,40 @@ +--- +id: get-o-auth-2-client +title: "Get an OAuth 2.0 Client" +description: "Get an OAuth 2.0 client by its ID. This endpoint never returns the client secret." +sidebar_label: "Get an OAuth 2.0 Client" +hide_title: true +hide_table_of_contents: true +api: eJztfWtzIjmy6F/RYc7G2HENxryMvTEnlqcN2IB5GNtNXyyqBMhUqYqSiod7/N9vpKSCKoy73buzM+dGbH/oboOUSqVS+U75W8wk3PCoK6jDYpexKyIQZqhV8MUMpRJJZFiUMIHGG0QFR7VyAvVmlCPCTNehTCBGlsRDHhG+xzgSMxLM4MTwiEgM2ZDtQ+MIewT5nJhIOMgl3sTx7NCamJmo5RJWK6OSwxgxBJpYzoonUJ/72LI2J+8QlCCHbEoY8bAgJpo4HsKua1EDw9Y4Ws2oMUMrzAQsajiM+zZBG8f3QsAcb39hA7t4TC0qKOGJ2EnMcWEB6rCaGbuMTYmQk1MliUXsJOZiD9tEEI/HLr9826Nub0YQNZEzkYTaLatmA3gKw1wsZrGTGMM2iV3GqBk7iXlk4VOPmLFL4fnkJMaNGbFx7PJbTGxcGMWFR9k09vb2FQZz12GccPg+lUzCP4bDBGB4+S0WIsvpCwfEvoXgRTHex/H/56NzPTg8+ElSwTAI5yPhzAkbcQFLTzffI0BBTkA9mIC6egKwt/pCfh58jKi6CwHcLcWCXSK1PJLL88SQ3WMLOMNVOwYiP7+sxLMk6LPj4oVPnhP6M8oRRmNsImoSfII4IWgmhMsvT09Xq1XC8TYJw7FPTcfgpw4G9ow71DROX1YirtaNy3WHrEuEoGwaxXVGPIKcJfE8ahK1j6nljLGFuB5OGXrWw4G2YVI+A6X3ePIkhi3LWRFzZDgeHzkenVLGf8xsqKCmoVKr00UtNU0KFEbgvG3HI6jfueHoSPIvuTw9nTlcfLl0HU98PdaMA8TUCMAR2HhOFES4VIQLPmTCkdtU1DqVG9mKuASqwX0FonselkdLbFdsThTViLck3q9cQVRbAxad0KmvBAU6eobvRoWbm9agUh61OrWrWrP7fDxkK2pZaKzvE2VcEGweWI4ToRYLdqEpqHbmuoSZamufQygxZEWC8ApmixkWiLAl9RxmA8mX2KN4bBGkkK40C8WbSvkZ3fa7PUCVE3kJn0EMPcurKnEVDlo53lyKMEFsfkAybdlC7ktyhW9SwgzyGU7QQ+V9Y4oQcYtygUwyoSzg4QAiV1hpVQS03J2/PnV99WALCQQg9VRkUZtKnpiRQAxJKbIBuR3RjRGJIJwTSQ6yxrZrkRNkEE9gylChXdvyEgf1SdASWz5R1xj2MGTORPJxQnGzpHWz1YNjkyBWMyoId7GhBJleInYZC669vTEdG1Mm7z126anPicdP0Iffuw4X/CcPS8wcj75KFhoZjklGUw8zMYoIUotOAFGpU5hvWcBKgc5ysRDEg+P9v1+S8Yuv/+eI8d99/rvNf+e/27/Pjv/7neg4iQkq5E6bvmWVNQN/Fx1q/q9BxSMTj/DZn43PGBtzY4YZI9bIcqaOL0accA7I7cyIdzcuqjuL2JjHSwoIupFAUFcBQR0NBO5i0XEsgpnmaO4Sg042cBtXMyJmxJO3stNGemGuBA5GnJroSGOFauVjVLIwtUHAUGZYvinloZysFh+y4JaB0mOCTjYB6ADKioqZsqvasLqafYAWvkfh6oHMTQxZbYIcmwpBTCViTTLBviV2V3SCLU5CSm2sdvwBoX2P/lO07XdqQM5OGySAIpJUDgb2OQl2KhxkOVMwxIk1QTBN7pODjMMBJEWn8UaT4qA6VnJxZHhE0hJb/C+9yxodeogt9xVBrQx0AiFaK8PxUNv2BWAm9SZz9Meu5yypCYeKUb9fK2dQoGu3dub3KKNM7x8i08Q2CdCZ+TZmcY9gU6pPgBAY+loNCQfWdz0CB7ZV2ENGmBkHeY1MH9BAEXnyPSyVi/UJPLtyYICpmrYlyP6FMzwCBmqgJjGoUYI9QdbiRJqjYgamo3L88BS0CgqBpRzNiSsA2gzzmbLnbbj0zIQvmSOQRwywLyWhHKlzHS5+vNMRWbsgREb485tGFTUHFbb7n1BiSVQM3/MIE9ZGIsV9F8xGYipMBQ+paWuFNxwlAUW1G/DLmMhldjhTJsiUeCGkD8uCfTT1zVc/9Ts1ZRaAFFBUkFYHWpExcvGUaMZWRrhCBWQfHsPV3/GaEmya1cKGKupet/o3ZWRS7lp4o8wkKXKU9bjlRcqGDAM0Yy6PaYL57EN2BDPFEJ+x6EtqaGDGSQvXmeitcuQRjbNUIUBz5fDBHOQSx7WAMaV3S8cWGbKtAar2fYLExqUGOJqI2JhaCJumRzh/ZzgRy/2H/jHheNOfMoXUDTE/x4YlGAxnVMZCCouSml0QkaiJoDbhAttuVGj8ytV91KTfMp+JBYnDnEPnYZIlNcgoapf8lQL+Owj9+ebad5D5iwy2iecw8a9abFUA8u8z2Sjn6Ihy7hPvWArIdxbcwifeBu3iX2hMhmyrXH7WcDtEkz/OcvsA+j9H5H/FdvPAd/eU8sUM0QlQL2S9gWcaIb2k8pBtySzP4oA9vXca6LbwGFH22yUAM8KkjN+huoRoFFgB0kDZmgJMnqMJAG3KiI6vaIHlOkIZk9YG2b4lKAhrjRJHKkYwBlU/nUIIwxd/R3SCCJU8R/mOV07Q2BGzIOJwUOOo6woff0bpXMFo1IPR+4pnN1aCRBJk2GiLxg58ThKohBlsxGEEHPfLnfYGWR8Y1GrRS/T83tZ+HrJCWPigkmOS7fj33uTzkO2xYc2GsAQNdnZkgto0QKv81/Eleqb66+ch6yiJpr2CYI2InHsOB+jVuMoa7saUXKJn32OXlIjJpWQlfikjZJeSWHEg1iUEFccEe8SLACpLKRvd2g9hadEsN/1TGjnY8V+q5faQ+PM128tqfuA61LutJhqQMWqQDeoS8S4SPiebA9NuILjmTFB4Og9MaCVj9cUfSgjDWEjawK0J3bIICkf1QeN4yCQInkDFTSC5lRh3PJN4Aej6oKHW4lJLaA9FwTUduM5guQPhN7Dgdq7rkQnxZDgP244KDtonCFti5vjTWSS9IKNvsFCXCI4MzJAxcxyQ3A7CnNMpQxjZBKsgoxNCUhmfhHpD5vqe63DCT0CmmYSDso0EQ/eSD9b0PcV7kpbYmg5j6AhbU8ejYmYfh8mqNCjVImo7BoHzIYPAE8cbMlA7W6U6J5sE2kUdlfpEfOb4lhlI3zFY1VPKRaCKpNivFZoFNNzxT5dOGRY+xJyZiSrM8DYSdVQI8AAmUIBAR4E9O7ao9AHHG/SlPih8hbD9mCCsOUgqSx3lBLen5FgWBYURB9HFKRdYu9lR873TTWVzB10RbwmE3Y1sxz8YaUbH9UbNfC2euybp2zw+fzhbDkSud1VbZ9bF0VU7fTvOdPlTt5BZxh1vWX997dC72Y3V6eTPGB48rid3hUeRpbxcy41KqZuLsTlwMtVq++XqrrpsOp2H+IgX65tibeRZ8V5xyp8enb5VeEnXL1ID+zFF2bgQb6829QnHtVrZII/FUpw8xNe05OcWt4v5E03fru4K1Zvc+NZsV26Tr5l60VhVe+l7kw4KtU7fL5QGdyvv4XaRO0+tzye3Pq7ha3r+UL6aijMqZql06WaCOxW7Pvcv2neGMRuLkV95jM8WXvUxx0RPdDMuHgzuXvK59c3NRaYb701yy9x6fnNxlm9Pbrqt3iL3UHpdL63q6rVYXxRcVpiNV4ubF7c9m/avkplKueMtvG7RyD6eFW/IkuVqbnZ2VpgRzotuenUzv5u+jjyHGHMR34yXr43eS6V76+Mpcxc3y1bv/PFiSWr+NHW7atefaqn7F+O1Y5wtX295KvvgVe/yZbe/iY+bppu/6NnLwsPKEP1bWjen15ZTX6XSpWUyPa31C/My473Fkz13x7VJ3PDcabNRte/ao0q54ZC8O2o/PD1NJ+OOR9NNp3J/1T6/nec2FT9/81KflazZEy42X/zBKhVvWMVJq5Cenl/Ys0mRzWuMkGyjdWFfdbLJRXt+dh+/dbz+Y7NXvX2q2cl5tZIjj/eDanFVv75pPM6u++lM2aGNs/t2nC+f3FLKL9xWm4VRv15Z3V6U7lLj/IJk4llygTer2+XK8AteZ14oZu1ibdLCrTp20vbEnzcKlYPc7EbZ+SrD2w9zI/eILzZ5pz64GNVuXjJr33X9pPVKR9fn9715N79+yXbNh7ThVJIOtR9X6xpNEbtX8Emy38JZ051WrzbFesbIi7vUfTWTTD10/Gmj3Gvn8fxxVnWyolA4P78jo6Yt/McnI11K2+laKnOVulp2srxbXvc3hWbqdZG/mbCLSt/mOe8x3RrnHwltzHu0+JI8uJ1FdDv8wipcX0ym0yJ3qp18CxupzqiSmq5S+ZTXS82vWoXZsmZZlV7ljEy8Qm7m9/vL20nRuHVZ3lqQQW75+soeH7Pd7l313L01SyM8raXZVb42ds+K/XGy3qce7jQX/cnNzLgbj8yLq2qmPDsn55nBuMOdccdh/kvvsXm2LuF2rtfKnb0sB95D/OYsL9YPq8xF5m5kTOeHtkOiuyncFYqHhs33zhCvplO/urnyBg28PC88ZO4b/enBiYdCp0qdzKkJ6mRONtItiKjoICltYwFpUu0LUmOrM6RVrsap5BbkKDEzyImMyyg1qRQslplBZwJzt8oaB3p1yHRsE/DwHMuC8J9WS1x4viHVys6ekEgHjtyQ+UyjRswEQgNwnCKDQlUJ+yufIJNOpC0ghiyMW2BedIkIgmKgN03KBWWG2FsggdBRCwx+fTxIZeWM2Q682rlNpzOBAsePgze3vx9EJzK7uEEzvCQhAMPYXGyC04JDPg62N/aF3CLUPlDlMEpvasjASV9iS6YALDAlsaBLmKH8u5Chg3yu06R24liRXmOmjTEVeTQwJ3FOGKcASEfmotr3LJdMmxOSxJP8JJO9OKhe5+JAMYVec3+THxo40sJwph52Z9TYmTtDNsE2tTa7Ew8snRPEfWBljoaxTrcwjIG9MYxVSsNYYruypqkygYbsOzYQ2jeBwH5VfuS/z9DZHs0O2U+fTKdbOHQYLCpYlr2Ft+5v7trWKJXEi0l2/nC9Kj95xIo3nGXNzfNzsqo7ZqrycG3lxcDqFNOjDrHTmcaqOFlYjbsr94wt8CyePbvO1F89f0GSRrWdzc/alZrIDRbektn10sOaNf1aMZumDyO/3394uC5fFwlul7odp1l/bW74i1NPJ3u1Pm8UKfVmRXw+SaWz7Ydxg16bvnFDlve5ttFY17PGY/61lcrnFvWb4qDbtuOtGlmuFrzGu7XrTOZO2BecOlU6n83HNytnsRq0OleFxySzcg/L+5Y1K5TNm5did9EtkN5Zte2XyiX2sHotlTv55kWtWhzVXsyuqM5Lce9epBrZ4uOkbSaN9KbqjpbXnbMs6ZjJ13r+4e585RRL+XvGsZGriDO30c1euA+5VDZXbg/8fL9sVlqO1Si0p4Y5mqaabuE8ZxRwdfRi9PLJl4uGV3ld5XvLJKsXrwj3Sy/t5ssVHzVezfmg138QqfQ1u7irc9M4u33y8SBJFw9F4l4/Th6dRZNYr/eCnJ2di0xxde8m5/3b3Ioka4vNQ8nCT9NWLd+ND8rFVWrUWpp2nmSb9uyxMLYq985majzkHzM55zo3blBcups0StXyrdGZlmY2OS84lbPN09Mjb4/x1Shde2l7pcxN8fb6bpX3bi/MwUs9X7NfqLF8OnMLdtJcxxvXpXZ6k23fN7x1sTw5e+22eLEzb3Vfivleu1Vm9dvXXPzFzM564mntPrVXbadmljDrPaWfyjm/U3R7dnkl3M6VnUv37/iZna0O2qtxspeqVQ8aB3umTq45nj+syoP+jMZJJ5stTceT1Hl1flcuD2rYbuGyl/RezhbJydmkWnk9G2QLo+TF4/IqeVGly7NCKxUv5ztWfto9u5+/pmjytdRdsM0mX0imsg8to7OkrdvGOautK5nW9ahd4XMnb4qaN0737Epq1n9Ylub26+qiwnvVs5u7YuuqlKM+v+k9ELdWOltf+PNSo/p0tzSnotIa32Xnr+ZFc7aIG+bC7pLb+xtn3b4xz8bWkt73Lu7tfHxzliqJR5fUr1u4Vhb37RurOKvTotNuDKbp5bprZx7WNYs2W2SyINOaxe1eDadv3W5uMLBKjfTmeoZF8i7uddbltbmh9+bVaPVaX7rJ2mqUWtn83CXx9rTZflz2B9cXdXc2aGcb6fzjolKk9erD3SHC7xllycJZ1XZbg87F2ahTGLgLjwy6eNnET+ML9kAatOgky3dXxdd0qjxeNBZ3+W4GF+v2uDOrG4Z4Kd28YMridOmLzPm5KPRv7df66r5eLi9St0/VVeniLp65f3yyq/3MdZ2KzZ3ffb1+JLlM56UZr4yad8lUbzC7St9dDXKes8gZ2XPj4sLz+rzSW9XrdNXN32bds+wt9V+z6TJuvSzj/mJRLVQnm1UzO5ivr8ceLhov1+KW3vmbu/HdYl6qzuIOZtfz1WOTbARvznp+yr6zV51suZPynKcUa9PqSynHuDmPF84r6W56dfv6+Fhdnb8sx4OB8zhwLpbFTHJ0+5h6TFYf77oLo/xqFGvGYpQUjGE+Sd8PMlVznbPzyc5ra5yqcmax82XjoXCY8HTPMtzcjtxc3XvYdOnrmXCq08Z4cB+vm7X0y11m4/oX3vh2sE57d/XixBbJqvP4Ou3Xnir31YrRWqyI3Wnmz16dcgHjeHGebAyaV+WX+vVT2Szb1dkgXWieW7W466/nI/v66ap+duatN518K5t9uOmSdLdtdyaN1VMtt+mnMk/r5V2j+lgTpmX2G1evrVwN5157jVnhvtM/tB2fH0iu9zlBR8OY648tZYGCdh/Gjvdtgm2oA2wsR1lSaDcrobWnnBw1d4ntWs5G5yKYCWYRCZIekOwMLR0Yx7KgSwc62BSZWGBQ7Evi6ZyJNPKCuMiQOUyOSaD7nVlqOLbtMGuDhjFOZWxnO+FYmSeEGfAx2UZUjqNandODVv86yhSTfLpVT5dT6+pZcZpf+uMLcUPOpte3r/fnOZLv+fzCb18vO/eVg4eyzhofGWzrrMTvIZFNXsiyNnASgHjGDFMWtt9CFo78Dkx6FSfX1ZrtRu0hDIKjL51qKZvKJ79qw+cdfOkBbBPDkJ4H8NIk2wYYw5N0XktllBMIVbAxGzKdTI9EEHUdLSe5TJwwiDqb6KhLDGktZwAuIJfJZfJfUTyuYo1quO9ZwYxjVK500Jdar594yF0kE2cXF5mv7/apsEqo6Om7LzXZAoYCDlS7CKouZUaMelAqGJr3c9WWmyi7rEfVymvHv7DTueub5kj4JJe9uGm6D4OcW9p0BZ0/vjRqg1oWH1DCb+GK9C/yQiuTX/miJzLA+XU7zRm/EEOEItdQdj4g4wbZvMf07TPTII6tI96frLPYD4NDsg7C2ZCz04FcPfRX/n7wl/qg8RWZjuFDlayu0Q0mSAnAt+XEQZC4KysuThDdWf5KWsFw7Qwf8ePQWBA6PJJ/24oKDhlRO7SoEnSBBwvpPWxxZ1syKiO42/3sRIv0Uo/48UmoOFqKOu0wakRkUlDOQdtugmBfwfrSD5epOr2hIYPA8N5acgUbmwThJaYy+QFFWSC9j4C6fR7xALf+Tqdy1691KmXVDmBZCpi+v9vwvjlkAQnCUp1gYwYTfuVhfYGnJIEKQQ6AO3YohK7TfDuvXbqnzrY6G7CAvQ5Z6Eii2z1BpgPHyh3AH+p3O5VS6/a20ixXyicgtqjMJ1pQNMyJ4Xtkd4jrrPE+Wwsry+J0Xc6GlAjeCkPdHxFEXYKiN300KmyjqiC9kFTRBcZc6AIwDUzuBr4ZMhUQEjMI7wRVYVGx807avKzESKUB/9IcHOTyPykQIHsf5O4L4YKrgLkCcbytxAHgBzdvE4FB70s5rDEDEdLBq1vCge92ZwY6B+RYIvSlqhlwvDlHK2JZKqQBAE5Q9+5GVd11V3g6JV5ofS0e305izooR7xNbbsE42UAB/1H6L1CMujgj2LQE+b1OpfdumWNRY/NJ4rfl4ID86qdDxW+SMqp0Xubj9sssXY8usbFBavGtgAY5i6E3AJAYE45m+mqbBGxA2engeFPMghS84VgWMQQ/kSL4BAwOKbAV7U3KDQvSe9DxxB2GLWXmHSYDF0FJiUdM6hFD1pYcSLEG7S1th4t4R48NVZWoaoXAxpGtAVCkaNGduFblGkqUU6UGtv0NQAEYU2FmvM9lTwj8gwpT2dEHPKmWlMJRH/yQfbSBkHjCE/k3UqOgzhONCWFBP9he6vOHlskPyPSOebakCmgUfAA/7+eeg+qNYBHkexbfanxjy8/RpopQz4RuCoKiQij4/smdhQvK/krBeAiTP79C4RAWf1HRnQ7fqjKb8Jn8sAisvGHYpsaOG3eAIi1BijN3X4b6BGWZwXjXSOm7YO2doCkkLBwPmcQiqvpKyd7U1uiqCdURxnQBmaoOlQkYxcuQ/oefv4PlQbkVocd3K5g/Tw1tYoc/i9Q5w/5A2P80GQ5vQMq9kVKLI22Tjg6WWuztoaNFZktOlYUOQMLCLuEAZmYXvIDuV7AZQ6UXKtovhW3grW0NxsDQj8LXx6etaVnkZ1n7Y4ZM2/uUB6QNwHvkRQptWWsiK9fplO0SIbJiTWP3XUJ9IG0Pk+adOgpBCcxK1dvjSYsyHkqm7HQVEAUsf62ZYO/K4eBSdRnYmOmaQ92vzAMTZEItwkN2vwbKicRMamnVWSA8SpYSiB0sA3XSSCbctt6OTBHqLSSGrNVWlT/aqVU7ObBD5Sm92+A2BaXnj0JTR+GLNWRgSkDyM1Sb+bPKUrljn65+7OgJhwsgo+ZdAFwm5rZV+VtLQtdEGpipIiP9caRkMdQ3uyuURLpOskmIrlLab9aOljRegtBQxfG18rbBcqfD+50a1Dma2wrGYHQh1Fa9PzwYG0LiO3WYP1+EyA3H/UzXUBfGATXkfyJWeCgQBOl4bEDCDxgFbDRLV+TJdQKOPMJ8yAI7V/J1EMBKJ9LRClcIZuXOMxdfj/dPdMiA+WXZmCpKltwrsYi0qUejkoDGmcImnlL/JtLq38vMIcHDiSEcb7QN6HqfUjBdOQvVtrMCr0FpjsBhka2uSPWBhx136H7GluFbSk22OfFNh21sx+chmDxcc93TamkrbTjCQwYSSN10KLdmU4vsBSEjxrIuGzhIhjl1R5DJ1+8xRHffnVO3pL5EMFJnwoNPDA8M7b22F/0oh2psgqOEePOQ6XbtbeAIm7bqRz5cFC/x0ob/d9FTHsp7JLU78Kfg6istr775EQepwVIABhWsz2EIfLRt/npG5fcSOhTXHrLgGspI0bZnLAwuuJvbnaveK5kVoKauMdfV7ujZxdRbUU70Ww8qC3H4GQVlIgcCVrawjGwiZo4u/5FltLHLva65MebUiJ18KJZ0zXfwogt8DtdCV43cSvjKjJNiAd5jCJryIyMVJlvXKgpW3arQ+xZSHzwfwPT5Egra5VaOUZcATbYNoppGkVnPEFl7Dj9qso6vVqs4eKJx37N0nP4ZBSF+HdG67vXaewpgRrBJvMQ7vMAlfr78Q5EJIzF2zA0sKoMZgozmZDOChz4uwV/fxaJ76sECCIPsCE+iXX/PzGFETVQnoZNawVMrR6o+COqC+AmynTEINfgheCwDbiQYUrI0Se3psBQ7xIvft7k/YriD5vaPmC0wrXeG+Ad8dxj3z2YNesSzpQ0KZio0NBwKGMqFdHX4uwiVCCBwBWHIgiDVXhAC7YWssJQ6HjaEjy3kEUtFe2fUBWkpVkR3Sm1bNnVvbgRcdIBhEFdwqeSHLLDaomHOg/RSftknGx5vMLgLcsa251H9+MOeRwumqsU+3+0IW4Ne2JFyg0ZbA/lnPL++BiKZkZg7o/mdD3jI+4vkKgLOBJA1ABnA4runXUAnBBWNJ9pz0AsGbdn1QW/IvtQHva/AORRb9FW2s8vWO4mjsn3qg66SrdsuChpqjKO7UNc7fJRFDceh0zqY2nzIZHq136vG81uJKUWQ8qtDFtf+O1JI+2yyl+cAH73tgjH7TPM+qP32tq+wnPBDW/Jbre7+6cetKp7neO/aYYj89MPB74t74YuRScb+AXaTs1AZvkS1XcO2esQImlaCnBgoBJMske2YhxMswTIh6B8ttvvsQzgzesi4UwCuKZMN2tfE0oad6ggPt29KKKrDMeoV9GYk7HfdBC3/Ogx72CAWWPhctn29x0lqyK4cIR208GqZ5NknGvK/k1CW21ChpUMsV9YtpYouwb2REGX+jkKR65dvMcfbhIJ7scsvX+EZNoGn8AicZlxIh6/jjreJgzcnHxmKj31jDg84xGYb08NxafPGZ3QKr7+t40CPrtypekvOwmwKFN64pCuRjJ3ELDwmVuwy9g/H25wawV3iju8ZkgY2mKfo25AhhHQMreDSE/VzKfwq1JC9Kev71xCsX/8OjAAGvdh71Oo3xMgqCuHo+O/BWOzSmi4V1yO3ax9F4BzLBSx4N8K81Pr07+j09Acv5W0tRBk1ZPINKGIe75D9hhRTnaianTf0Gzx4RSOYJfZe7ztSVKHmkB3/PfZ2sqX4lROitDKgwkR2sTGHLB4kCwADTfSjIRuKoZJNawFV1vDjxN7+1+Hqf45LGHapVtvD2JSKmT+WTzXtTiI+dWC03OLEZ4Zc7egYjnYoqIkuf0PDGDVH+m4MY+j0NLBPfkc/ICcAHYroAV/+hiKIJZpktXfcMAm7VOv9QxMK7ZqmbfTUYSZovBPknYAsgclbSAnNK+1a4mrvhDQxE/CEztRzfGYeHZ8gah4nKmti+IIopKCv2PPQf/2GGLUUiYZiYotE1fUoE5Mjhye6wiSedwLV4fJ2q2g6tiyg2POHKDw/X6K/LYdDNoxJzI9/ALzqW5ay8gMNH5qvZr/BX6enOxNAXsPn/YUvUfhHmPN+UccXsGgnCunjzYRxIdw9HrK3MOO3N2ImtUjA/CC+PpQyjrcZBfEkufDugwSoNYsnHOknpEZBc7WaGN3X/lQP7DM9suDSyhqMWCmw5EhXEiAYoH4Cfv4FlcMvw8G7gKCLlAeKLZXXVUJE+lTBU2nwLIpirYTrOTIWDy8qYpdyuJIAuEvI3ot67kaVqWxjdFCwsgsORG/W7omEhBRXEaka2nj0tinhJLcBV/2z6AYy4xdVXKfobvsheU62MdyQeyVfFYj4xjusARjEzw3D8Uwp4rfxb3jrTj80EyhInZpPwKyKEk7KJpU1OrBGEDhQmQNVwoLGxHJWJ9tGmqDtBpwagMSxoFzWhMpnQCUYGAs9Egm139J2f0VZlxLdzyWKKu2fPolwyhBG84R+RvHLMFasFDqVzqjXalSaw9jX7RFUmMqbazGmo4ls21YVCGggY3CT5JgQLoVATO6JVFkW6VI97FIh+Yt6foZ8vAjmXO/HpSO609mhFXeqewf/ONCV6Df0607t/Ip+AaXzOY0DAIS30agqdN+9PxxIhWAIoLAVlL9FsAZ9PopKmCNqHu/mStlwNNQ2qoYRhMhhg/H/eQ/iUsrHMBQFJoyI/pZI0YS2EgqOhFy+X383IKJ0vo8G+huXmKC/IXIce5PWJFSgwyuvYDWHzEJweYIitfePFB8dB88UK7My/MzwfvL8Z58vjj5TrN4iBgezp+C29ly4qbOP6zuFL9Yh3f6/BnFXKcb3hN7nv0+h/O/F9yj8Q8I2j6X/QtYCOskcphCbkw3UBB/2T05iMqB9yE8BYyGYu+XG7fj/cOV/uPInuBImBOkMQFtiKWaxy9ipZDntCvHTb9R8AwNUlQ7IPfieFXoP95u2hUbc8qdvBy2jU8mm6rHj4IWO7ZRoOmVnY72jyaN8hNzboCYRUMCJ2goKAigJ9Oj4MqI+ofJJwSDq/yU8A/JojkW+HgXIG+oD+Y43n50GyJ/q5wpPp0TEuYAXGc3jhCZbYG11Zf5T7kelfYLwl8yf6USQPmNYTz5jKs2j6Ej10buh6jVxGCpfdZcBt7BVVdIhnMiH/cjRSBGSMIntBBtUQE/h75jOokvIzmRiUSYb5nXOO+Cvd2lqXUMWvOl8hC2KlZX5rKHoEq9nYP3oRz8PX/0aAAZN97HO9m2sdxUNunBhmyz5JB1UEVo4aqWIDuTfizO9a9dxtMEc/g0NG8dHjMhnLaOMBwbgnGx2jPfu8XgDHud0BT8Nyl4jz8fLLqUfs4y3GUBlMxQzFFwKLR8/i7cqjZbVEBZZEuvP3wa87sQmThBrxoZUZ/KFSRCWytH7hzrH3W9uAMy66rvYu9jiL6jGhOeYvqGc2bLOCin3I2h60Ok76Y6BCNSVREsihU6hXeMJVIh+AR9uE+uyB11uFjoJdPWC7C5B7aCUOVyzmEBttaKEIls3HC6CVnvK0NhzVly5rkP2yy+oW25wyKhTvi2+DuWwtJ/Bo3FuqT52J6jSF9sFd0Mxl+C3GYwJPByxgvsI8QkfTwmXWeTf0Y3+WRvav6Oys2KWg00AgP6ZPwAifCB/0J/fAdt45A/a/+Dn//wBIA6DBWzL2BMRwnxx/XHCJMvdjdMfnOpIKD/deY/HB2n7pVMplG8rOwh7MU9uzk/HljM+tTGU2G0Vv/r31MSeOFUgwHQI0zbRrPSiSzF/SgS88RqVENuPd1i3vE1CGSSnx38kto5g5B2+EtuKRdfUCy81I+uEa++WUj9/lrJ/ALZEonQQ2ytnf6kd6A+X24av/y2cMHXe84HGto6XOLqUjZeERTmBE+wZs8T2m1MMbU7YEKd8BkrkdBfxPP7XsX3BS/wB3wK2ylHa8q1rv/AoaSXfBh8HPHEaytcc/5G0lXVKEqUwzvvYHg1AqUyIMGbH/yzacT3934K8Ah7ZAoI9tK/be6yoMKN8T1pEPo7cxD2q/8tIuzP3ADtLiqtQfATbjUv3ENWfBC5DiHlP39++fx1bidJBSdHxx5voUp4/3kyJzaMYhz89hf9E7tsfii0s9cHd60A4PLKUATEQnqBOyCsLPtL/+xDTPwhbfljDQTKGGoSpJxQCQ9OVhfOpBLRqRz1huHtYfi1prOfy05taqdLsVuKpRDIxE7YlvRQoVWpNdKkTuN3C4aFseWBygudMPK7sWAuIIYLON1t37ii8Pojm7nvRoQKO//wCuh/9FjPtl0D+AJI/VPqX8sy/6WjJl5h0FWLBLyKA87qkJhQgQPoIBnz7Bu8Y9D3r7Q0+lo9FQ9nCLiSifnsd5fB/M3Yp39L+zrEdBS+MH/8o8v/RFoJqerYJxRvhPQEZXaRm7O3r20lMVWiGQpYFWdMWmvKuACgSVbqq9GLqN/aESvq3Pl8QCfny7TA6376pEdJVenvbYqdd9q9vb2//D/XuUAM= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Get an OAuth 2.0 client by its ID. This endpoint never returns the client secret. + +OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for +applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-o-auth-2-consent-request.ParamsDetails.json b/docs/reference/openapi/get-o-auth-2-consent-request.ParamsDetails.json new file mode 100644 index 0000000000..e602438966 --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-consent-request.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "OAuth 2.0 Consent Request Challenge", + "in": "query", + "name": "consent_challenge", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-o-auth-2-consent-request.RequestSchema.json b/docs/reference/openapi/get-o-auth-2-consent-request.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-consent-request.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-o-auth-2-consent-request.StatusCodes.json b/docs/reference/openapi/get-o-auth-2-consent-request.StatusCodes.json new file mode 100644 index 0000000000..b144dc9ee8 --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-consent-request.StatusCodes.json @@ -0,0 +1,485 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "acr": { + "description": "ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it\nto express that, for example, a user authenticated using two factor authentication.", + "type": "string" + }, + "amr": { + "description": "AMR is the Authentication Methods References value for this\nauthentication session. You can use it to specify the method a user used to\nauthenticate. For example, if the acr indicates a user used two factor\nauthentication, the amr can express they used a software-secured key.", + "items": { "type": "string" }, + "type": "array" + }, + "challenge": { + "description": "Challenge is used to retrieve/accept/deny the consent request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "consent_request_id": { + "description": "ConsentRequestID is the ID of the consent request.", + "type": "string" + }, + "context": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "login_challenge": { + "description": "LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate\na login and consent request in the login & consent app.", + "type": "string" + }, + "login_session_id": { + "description": "LoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you must not ask the user to grant the requested scopes. You must however either allow or deny the\nconsent request using the usual API call.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client.", + "type": "string" + } + }, + "required": ["challenge"], + "title": "Contains information on an ongoing consent request.", + "type": "object" + } + } + }, + "description": "oAuth2ConsentRequest" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "Contains a redirect URL used to complete a login, consent, or logout request.", + "properties": { + "redirect_to": { + "description": "RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.", + "type": "string" + } + }, + "required": ["redirect_to"], + "title": "OAuth 2.0 Redirect Browser To", + "type": "object" + } + } + }, + "description": "oAuth2RedirectTo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/get-o-auth-2-consent-request.api.mdx b/docs/reference/openapi/get-o-auth-2-consent-request.api.mdx new file mode 100644 index 0000000000..ebb8ed8f87 --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-consent-request.api.mdx @@ -0,0 +1,46 @@ +--- +id: get-o-auth-2-consent-request +title: "Get OAuth 2.0 Consent Request" +description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider" +sidebar_label: "Get OAuth 2.0 Consent Request" +hide_title: true +hide_table_of_contents: true +api: eJztfWlXIsm26F+Jy3n3ta4HqKiInnXeuowKDiCgqEU9DDIDCMmMSDMyQeyu//7WjiEHwCqrTw/3w60P3QIx7L0jYsee49eMTYTlUy+gnGXOMoMZYQgzhMNgxn36juF7ZHGbZNFsNfapnUXcR9T1HGrRALXLYTBDhfw+ajh8iahAlNGA4oDYWdT2VwiLuUDBjCCHTylDns8X1Cb+kAVcTkJYQC0cENlGhOMXYgUIMxs+MxQQx5HDML5EeMzDANEgj5qTdPPEOHYWzciemBHkhiKQ/cYEoCA2opMhg34x0FWHEhag5YxasxhyOfgE8BEzHjq2HMFx+BJ+4ghbFhEKKZ8IHvoWEYizJEi/CDQmM+xM8kM2ZP0ZQRZnAqayZthxCJsSoBX2PMJsNWqQaGSo9ItAd90r+FVBmJ4hFMTP4Sl02Bn7fCmIvwuj+sSmPrEkIjyPErMPmRkZOgMKOAlRwNGEBJISE+67au01YpJmBeST15CItRUScono2qJYFvECYg8Z95FPXjRAkmhyjIg0Npng0Ak2sJcUWmDq4LFD0IJiBYi/QteY4SmxUdmyeMgCVH/ziE8Js0ge9TmyQhFwl76TrUTNIs8hWJAhmxFsI74gvqF/vDFsboUuYYGkQT6TzXCP+PJD086cZaYkUASpqsG7CqVMNuNhH7skIL7InH35de10JTaeBkp3RFWzCJlshkLT15D4q0w2w7BLMmcZjcTISrQDOlKf2JmzwA9JNiOsGXFx5uzXTLDyoJMIfMqmmW/fvkJj4cEYAn4v7O/D/yzOAsIC+BN7cKAlgnsvAoD9NTGe5wP6AVW9seXD/9Kolatd5BPPJwCmOhzl+FjCRionWUoVpn4LUNXBQqAumRAflg8tsBMSNOE+Cmaw/OkhBBEC1gM98hBZmMEuRjSQzIS8weRqT2flCOQNu55DsgjLo5JmEygUlE1RsORogq2A+2tzwZqvkTGbwe42zK+7sFO3YHxNghm3E+iJNfyG7HMIwv4UHrHoZCXnceXABq9QyJOeGozkUSNJAn04seUjymzZQqT7R4RYByqrerq+BCgmM1mpnhgJPgmW2Cc5QazQJzaakxXQjwbEFVv2Y0RZ7Pt4BZ/jbb1B3mqSYWpUkU8Cn5IF2VNcZs8mbJU67IbHbFtFSzL9zZnWrwWBsE+iKT3iA1NM8AjggW2PsGYNjjMDpgeXhsijOxFix1llE42teMghmxIG3ITYcickzp7QjH6JmVx0QCd0CVrx0E8Mxv31iS3s4TF1KJxRQHr9xMKNNQr4nLCRCGDq6ep7BCirK64PHVBPdwB+rX6Q35uvzeY340YUM1hGFyb0Evkhu8cOtRH3FMZA5OeXZfAsCfrMPfwakue8/g6YABpjG1Gb4CwShKBZEHjibG9vuVzmub/KW9zds7kl9jhs3EKOU9vae1kGOTVvTs47ZD0SBPLIJ2GdEZ/IK8CnNlF4TB0+xg4Sujll6Fk3B9omSfm8nUkoSWFkcV+MuE+nlIkfbzZU1gJGtd3tobbqBhRvMwLr7XKfgDAg0I7ky+Rsb2/GRfDlzON+8HVXbxwgZkJUcfGcqBH1gRCSVwKailp7EhFEmO1xyoxoBUSHownUJ64XrBQPEMRfSKFEjqhQgy06odNQXY5o5xl+G5WvrtqDem3U7jbPmze9590hW1LHAUFK7g7KRECwvWU6QQLNcDQWmoIKszV56ccA5YesQhAG7qSkHcIW1OcM7na0wD6VsoUCun5TrlzVa8/o+q7XB1AFkYfwGa7X5/hSAnGM+/Of43A4tKWA8pmdoJvK88YUIXIOFQFISpSZPWxGFAoqxWDkeYnX34hr6ugBCnkEQ+quyKEulXtiRgwbklxkhfgE1IAPOELA125Yi/gBpgyVO81oLwkleqobTx5jwGHI+ETu47zazZLWN+0+LJscYjmjAREethQj01NkzjLm2Lsrm7uYMnnusUf34BITWfTh7x4XgfjJxUqIKiPQfkZTH7NglGKkDp0AoFJWYqEjxVQji3k4CIgPy/v/vuznTr/+nx0mfgvFb674Tfzm/jbb/V8brCObCWggMb0JHaemN/B3waH2fxtQfDLxiZj91fCMsTW3Zpgx4owcPuVhMNIy1CgWjzdOXPrurGBrnquqQdCVHAT11CBSPodB4CxWOHcIZnpHa3kMTuNyRoIZaBEzgrodpCfW6hVGgtpoR0OFmrVdEHqpCwyGMssJbckPZWc1+ZCZUwaXHguM1NftGPkQLWmgtMF2B2ZXvbfQIvSpEZvyQ9acIO7SQCrJQULxio7oBDuCJC61scL4A0KHPv1dtL3rNoGc3Y5SboFI8nKwMEi7GtOAg8UA0UAQZ4Kgm8RTCnfYjKToNF5pUnxH2htZPpG0xI74W8+yBodu25brF0GzZlTkZk2aVlw3DAAyeW8yrr/Wiq0Nis7dXbN2hMxdG8mZ36OM0jB/CMwNdokBZxa6mOV8gm15fcIIcGFIAVy1DjjMr9XB6MIeMsLsnFQ67BDASNuZvgelIJZPPiG0o55saCBV3SKCrB84yycgoEZWDbhGCfZBNc1GNo4hYwSMBHgKtwpKDEsFmhMvgNFmWMyUPO9iZR6hAjEOmogF8qUkFJd3Lv+uXqIxHZE3D5jICH8eabCDSMZTjvCfUOJIUKzQ9wkLnJUESoQeiI2gvQGkgUhc084SrwTaBxAVNpmzDGVB8SiGmbKATImfAHo7L1gHU5989emu21RiAXABRQUpdaAlGSMPT4ne2EoIjw1SygwY7zXF2PRWSwqqqHfRvruqIZsKz8ErJSZpexq0ivYiZUOGYTRrLpdpgsXsw+0IYooVfEair6qmRoyTEi6faFRFbC2RVwjQXCl80Ad5hHuOtC+C1YaOHTJkkQCq8M6iYOVRCxRNRFxMHYRtG3TzDcGJON5/6Y957k9/TjOXJ8T+3DasQmNYoxoOJLOoqt5lOAZB6DOlYQXUJSLArpdmGr8IdR416aPNZ+OA5KDPtvWwyYJaZJSWS/5OBv8dgP56ce07wPxNAtvE5yz4dyW2Bgzy54lsVAi0Q4UIwaAODHJDgpPWWRTbetGYDFl0ufys4LaNJn+c5PbB6L+PyP+O7OaD7u6ryxczRCdAvYT0BpppivSSykMWkVmuxRZ5em010HX5MXXZR1MAZIRJHh+DugBrlPZADVnKwcGRDQO6lBFtX9EMy+OBEiadFXJDJ6DArDVIAikbwVj6vMBNwcPgn2CBJVTuObD7GtiyaMyDmbE4bL1x1HGFrz9z6ZxDa9SH1usXT9xWDonkkEmhLW07CAXJoypmgAhnBBT3s/j2Bl5vBGo16Rl63pS1n4csZfdHVW6TqP2mNvk8ZGvbsGlcjQqzHRuuTWnC/4/dM/RsPJHPQ9ZVHE1rBWaOFJ+D4SMqqHb1NzgbU3KGnkOfnVESTM7kVhJn0kJ2JomVA2KdgVFxTLBP/NRANcll06j9cCzNmiXSP3UjG4z/1ltuDYi//mZ7Wc63HIdWr32DBmSMLskK9UiwYQmfk9WWbldgXOMTlOwujAiteKw++EM5wjCT4DZwahKnLAXCTmtwuTtkcgiRR5WV4dyKjXMf3Jx66NbgUs0l5C2hNRQ1rs3hOIPkDoRfwYRRX8+PvGfY5co46GYRdoIZD6ezlHtBWt9goh4JhPTnWDPOhXT9YiHolCGMXIKVkZEngFTCJ6H+kHmh73FBhPQq2UTAZZsyhq45H5zpJsX7kpbYmQ4zaAc7U+7TYObuJsmqblCqWVTUBoHyIY3AE/BVwbUTXargd0Kx1VH7i7QTX3PfMUjVUyoCcxVJtt8s35TRMN4/PTplOAjB5sxsVGeWv/KUF9PAAZtADQR3FMizY4dKHXC8Ql9ag/JXMNtD5IDeQcrZrqycoPZUueNQuDBywLoEFQHWanZafO/2CsfFraqIvwDCxi07uQ9a2ul2/dFNqZkrXpDD6xI+eThYDIJi/7z5dvRWGZ13Dq/HRz3x1CsfLXLcX7Te37v0dnbldLulA4YHj2+T2/JjcExFrVkcVQtXp2N7wI8ajc7L+W1jccO7D7mRqLRWlebId3L9ylQ8PfI7p/xy2DotDNzHAmXjcq6zXLUmAjebNYs8Vqo58pB7o9Ww+Hr9On+ih9fL23Ljqji+tjv16/33o1bFWjb6h/c2HZSb3buwXB3cLv2H69fiSeHtZHId4ia+oCcPtfNpcECDWeGwejXB3brbmoennVvLmo2DUVh/zM1e/cZjkQX9oHfk4cHg9qVUfLu6Oj3q5fqT4qL4Nr86PSh1Jle9dv+1+FB9f1s4jeV7pfVa9lh5Nl6+Xr14ndn07nz/qF7r+q9+r2IdPx5UrsiCFZve8eygPCNCVLzD5dX8dvo+8jmx5kFuNV68X/Zf6r3rEE+Z93q1aPdPHk8XpBlOC9fLTuupWbh/sd671sHi/VoUjh/8xm2p5t2tcuMb2yud9t1F+WFpBXfXtGVPLxzeWhYOq4v9w2nzrjyvMdF/fXLn3rg5yVm+N725bLi3nVG9dslJyRt1Hp6eppNx16eHN7x+f945uZ4XV/WwdPXSmlWd2ROu3LyEg2Uhd+lUJu3y4fTk1J1NKmzeZIQcX7ZP3fPu8f5rZ35wn7vm/t3jTb9x/dR09+eNepE83g8alWXr4urycXZxd3hU4/Ty4L6TE4snr1oIy9eNm/LorlVfXp9Wbwvj0is5yh2TU7xaXi+WVlj2u/Ny5ditNCdt3G5hfuhOwvllub51N3vp7Xx+JDoPc6v4iE9XJd4anI6aVy9Hb6HnhfvOOx1dnNz3573S28txz344tHh9n1P3cfnWpAXi9ssh2b9r42PbmzbOV5XWkVUKbgv3jaP9wkM3nF7W+p0Snj/OGvw4KJdPTm7J6MYNwscn67B66B42C0fnhfNF91j0am93q/JN4f21dDVhp/U7VxT9x8P2uPRI6OW8Tysv+1vReU2jI06d8sXpZDqtCN7oltrYKnRH9cJ0WSgV/H5hft4uzxZNx6n36wdk4peLs/DubnE9qVjXHis5r2RQXLy/s8fH417vtnHiXdvVEZ42D9l5qTn2Dip34/3WHfVx9+b1bnI1s27HI/v0vHFUm52Qk6PBuCv4uMtZ+NJ/vDl4q+JOsd8uHrwsBv5D7uqgFLw9LI9Oj25H1nS+DR2SxqZ8W65sazZfW0O8nE7DxurcH1zixUn54ej+8m66teM206m6TubUhutkTlZSLUhd0cYp7WIIcMJaF6RWdGdIqVy1U84t8FFiZpGstMuoa1JdsFh6BvkE+kaXNTb36pBp2ybA4XPHAfOfvpZE4IeWvFZieUICbRS5IQuZBo3YeYRkPF6qUSIqYX3mLLLpRMoCwZAlYTPiRY8ExigG96ZNRUCZFaxNkEdopw0Cv14epLxy1iweXmHu0uksQEbxE6DNreNjYu5WaIYXJDHAMDMPVma1YJF3DXrjMJAoQuwDVQqj1KaGDJT0BXakC8ABURIHdAE9lH6XEHRMdM+MuPldRXoNmRbGlOXRwgKCVpigMJC2zKVv34Pi/qE9Ift4UpocHZ9uvV7nwZZgCj3nOpIfCjhSwuBTH3szasXizpBNsEudVbziRtLJIhHCVhZomOn2ysMMyBvDTL06zOSjmTVNlQg0ZN+RgdC6CATyq9Ij/zxBJ1qaGNhPr0y3V962GCzNWBb9V//tbnXbcUaFffw6OZ4/XCxrTz5xcpd80fRK4oQsW9wu1B8unFIwcLqVw1GXuIdHl8vK5NW5vD33DtgrnuWODy6OWu9++Er2rUbnuDTr1JtBcfDqL5jbqj68sZuwWTk+pA+j8O7u4eGidlEhuFPtdflN6/1mJV5463C/37wTlxVK/VkFn0wKh8edh/ElvbBD64os7osd6/KtdWw9lt7bhVLxtXVVGfQ6bq7dJIvlq2iKXvPi6Og2cE8F5Q06n83HV0v+uhy0u+flx33mFB8W921nVq7ZVy+V3muvTPoHjU5YrVXZw/K9WuuWbk6bjcqo+WL3gsa8mvPvg8LlceVx0rH3rcNVwxstLroHx6Rr77+3Sg+3J0teqZbumcBWsR4ceJe941PvoVg4LtY6g7B0V7Prbe5cljtTyx5NCzde+aRolXFj9GL1S/svp5d+/X1Z6i/2WatyTkRYfencvJyL0eW7PR/07x6CwuEFO71tCds6uH4K8WCfvj5UiHfxOHnkrzfEeb8PyMHBSXBUWd57+/O76+KS7DdfVw9VBz9N281SLzeoVZaFUXthuyVyfOPOHstjp37PV1ProfR4VOQXxfElxdXbyWW1Ubu2utPqzCUnZV4/WD09PYrOGJ+PDpsvHb96dFW5vrhdlvzrU3vw0io13RdqLZ4OvLK7b7/lLi+qncPVcef+0n+r1CYH7722qHTn7d5LpdTvtGusdf1ezL3Yx7N+8PTmPXWWHd60q5j1nw6fasWwW/H6bm0ZeN1zt3h4dysO3OPGoLMc7/cLzcZW4WBN1CnejOcPy9rgbkZzpHt8XJ2OJ4WTxvy2Vhs0sdvGNX/ffzl43Z8cTBr194PBcXm0f/q4ON8/bdDFQbldyNVKXac07R3cz98LdP+92ntlq1WpvF84fmhb3QVtX1+esOZb/ah9MerUxZyX7KDpjw/7br0wu3tYVOfu+/K0LvqNg6vbSvu8WqShuOo/EK9ZPXg7DefVy8bT7cKeBvX2+PZ4/m6f3sxec5b96vbI9f0Vf+tc2QdjZ0Hv+6f3bim3OihUg0ePtC7auFkL7jtXTmXWohXeuRxMDxdvPffo4a3p0Js2mbySadMRbr+JD6+9XnEwcKqXh6uLGQ72b3N+9632Zq/ovX0+Wr63Ft5+czkqLF1x4pFcZ3rTeVzcDS5OW95s0Dm+PCw9vtYrtNV4uN1G+DWhbL980HC99qB7ejDqlgfeq08GPby4wU/jU/ZALmmF79duzyvvh4Xa+PXy9bbUO8KVljvuzlqWFbxUr14wZTm6CIOjk5OgfHftvreW961a7bVw/dRYVk9vc0f3j09u4+7ookWD1W3Ye794JMWj7stNrj66ud0v9Aez88Pb80HR569F6/jEOj31/TtR7y9bLbrsla6PvYPjaxq+Hx/WcPtlkQtfXxvlxmS1vDkezN8uxj6uWC8XwTW9DVe349vXebUxy3HMLubLxxuyCsTNrB8W3Ft32T2udQs+fyqwDm28VItM2PNc+aR+2DtcXr8/PjaWJy+L8WDAHwf8dFE52h9dPxYe9xuPt71Xq/ZuVZrW62g/YAyLyeH94KhhvxXd0n73vT0uNARz2Mni8qG8nfB0TTJcXY+8Yst/WPXo+0HAG9PL8eA+17Kbhy+3RysvPPXH14O3Q/+2VZm4wX6DP75P75pP9ftG3Wq/LonbvSkdvPNaGeNcZb5/Obg5r720Lp5qds1tzAaH5ZsTp5nzwrf5yL14Om8dHPhvq26pfXz8cNUjh72O251cLp+axdVd4ejpbXF72XhsBrZj312ev7eLTVx871/Oyvfdu23ohGKLc/1OELQzzHjh2FESKNzuw8zuukwQmTpAxuI6eyHulde3p+ycFneJ6zl8pX0ROuDXOD3A2ZmY2gjHMqBLGzrYFNk4wHCxL4ivfSZSyDN2kSHjTLbJo/tYLLW463LmrNAwI6i07UQddpV4QpgFX5PIorKbvtUF3Sr1v6U3xaR02G4d1gpvjYPKtLQIx6fBFTmYXly/358USakfitOwc7Ho3te3LsrbsfWRwPZ2LOF7yB/vn8qwNlASgHjWDFOWlN8SEo78DUR6ZSfX0Zqdy+ZDcgiBvnQb1eNCaf+rFnw2xpcaQOQYBvc8DC9FssjAmOyk/VrKo5xHqI6t2ZBpZ3rKgqjjaAUpHuUIA6uzjXZ6xJLS8hGMC8AdFY9KX1Eup2yNqnnoO6bHLqrVu+hLs3+Xfyie7ucPTk+Pvm7gqaDKK+vpxo+abGZDwQ5UWJioS+kRoz6ECib6/Vy05Sq9Xd5Gjfp7Nzx1D4sXVzejICTF49OrG+9hUPSqq15A548vl81B8xhvuYS/JTMtvsgDrUR+pYtmpYHza9SNy/SXhOUa0ikGZHxJVpuQfvtMN7Bja4v3J+Ms1s3g4KwDczb47LQhVzf9RWw2/tIaXH6NMmCibCs9NhxoEYUTGyNxT0ZcZCFXwZwLxa2guVaGd8Ruoq3OQEr43yJWIcAj6iYmVYzOaLDg3sOO4FHIqLTgRvjErEVqqTtiN5sIjpasTiuMGhDpFJR9UJQlY/Ay80s9XLrqNEJDBobhtbnkDC62SZy3pLNP0A5Q906kNMBI3+nWb++a3XpNpQM4jhpMn9/IvG8PmSFBkqsTbM2gwy8ieV/gKcmjsvEBCO4mTOjazRdr7VI95VF0NkABuA5ZYknS6GaRzWFZBQf4IX63W6+2r6/rN7V6LQtsi0p/ogNBwyotJF7Et2Nr01sLM8vgdB3OhhQLjpihzo8wVhcT9KaXRpltVBSkn+AqOsBYBDoATA8msYFfhkwZhIIZmHdMVFia7Wxwm5dlMFJuwL/VBwe+/E8yBPDeG999ORlwZTaXYcdRJA4MvhV5lwQY7n3JhzVkwEK6eHlNBOy7ZB4YRsDH8okfVcwA9+cCLSG7U5o0YIAs6t1eqai73hJPp8RPzK/Z47dshi8Z2ZKFtYFyG9rJBAr4Q91/5mLUwRkGaTmkscitD7SVCB53qLX6JPE7srEhv/q0LfhNUkaFzkt/3HqYpefTBbZWSE0eMWjgsxhyAwCIMRFopo+2TUAGlJkO3J9iFmfzOg6xApGVLDgLAodk2Ir2NhWWA+49yHgSnGFHiXnbySACE1Jisk6BKFtcrCa9pcNFkOvqtomoEhWtYGQcmRoAQYoOjdm1CtfQubrqGojyG4AC0KbO7NydUJmzENpXlumx0t4VJcVGtsEh+wiBBHvCE/lfpFpBnCcaE8JMPtia6/OHkskPyLSxeSJSGRqZL+Dzuu/ZRG+YSVDoOyK68a1oP6eTKhI5EzopCIIKIeD7JzFLBpT9nYxxGyR/fYTCNij+pqA7bb5VYTbJNflhEFhtxbBLrXg3xgOlUoLUzox/TOQJyjCDcZxIGXog7WXRFBwW3Ec2cYjO/9dJ5kboagYqI4zpADIVHSodMGovg/sfPn8Hyq18K0WP70Ywf54aWsROfpeKcwb8gNn/NBm2IyD53khdiyMtk462hlqs4WAyztsqTb+n5fNy7HAAMbMHWkDvK8iMidALZe2XzNZoa5HAaAT99Ph6+Ux+PQT5Oc56myHT8j4VhrRmeFM4QMaayMh1OmWxI0RGrGnovkuoD7jtdtJsXEeJUYxYqXJ7fClR5hLOlPiuAqKA5K9vJsBdKRxCXl0WtmY65lDn4QsjgkyoQ0RC7teDCiIhk7e0yixQSdDSzWWmgThplZwdaTvSRRgXXWh3VOSPVmoVJlswVJrSBoKRC0r3HyW6jpIHa8hAlADnZyI282cvS6WOfTr6sas7bA+ATIt3ZnDpmIui8iNJQsdEWpipICP9dbowSpw3GwdKIh0neUOIjlJaT9ZOhzSeAdNQwfHNWpRgGd/hd90mxDnaUQSjaV1OpFWvNzdtE0B8Jw7z54MQhcW9z2QN9aAdUEP+kZLCE4YgcMdjCxx+sFFARnN0RJ6cx+zIHSyGzMi5cl8bA9Zh/jAd4QrGrOLJ0enX3fUVHTJTV0EHJcvdK6FIpamnrZIAxoGCJldQ/88fqv+fHW1jPIJALYVRZND1P3XB9GQv1Ix6Ga1B3RxGYZGprkjlgScVd8h+xo4VOuqa7AgS2pytXB6KxJgiGXPd19eSH9eowEMGHEiddAi3ZlOHrBkhU8KyDhvYSoY59Ua6KMMm9r059UwlFGgpUjUchOWDoL2W9pKXsRo6sQmWEuzNQ6bTtSPDEbZdlY+8PShewqUF/++CpzSUTSC1OvCXwKoq6ozULz/aQbr8DjBAE8H6nBxBjKLkr2dU2+TQCbv2kJljqAr7mJyx5HDmbEaYq9wr6RWgto4x19Hu6NnD1F9SQXStB+WF2F5GQYnIhsHKFJaRqnuiaCDDaKEyTiprbowFtTLZD9mSjvnWo24v2KLEOMkWoB6DScpPtdQVWIxqlR5WnapEfQt5HzxvgfT5DALaJSq7qEeAJlGCqKZRqtczWNaek8V63nLL5TIHmmgu9B1tp39GxsSvLVoX/X5n7QKA4kfEz2/ABSrx89kfCkwSiDG3VzCpNGYEZDQnqxEU+jgDfT22RfdVwYJtRcKirL9nxhlRHdVKaKeWKbWyo+KDIC5IZJHLx8DU4IMplgEnEgQpGZqkcNrOxbbtxe/L3B9tuK3i9o82mxGtY0H8g323HfbPeg36xHelDApiKiQ0bDMYyol0dPiGhSowIwg1wpAZI9WaEQKtmayw5Do+toIQO8gnjrL2zqgH3DJYEp0pFaVs6tzc1HDpBrIwkJCXvKpoBFs/bebcSi+ll30y4fEKg7oge0Q5j+rjD3MeHeiqJvt8tiOgBrmwI6UGjSIB+Wc0vzs9iNyMxI6F5g0dcJv2l/JVmJ0JQzZhSDOWiEu7wJ1gIhqzWnPQE5q07NagP2RfWoP+V9g5FDv0Xaazy9Q7CaOSfVqDnuKtURYFTSTG0djUtQGPLhoV+ky7dTB1ofyWNMH2G7lSxDElC1J6dULiWq+PhrTOJnN5tuyjb7ExZn3TbDNqm/JuRpfaFuOaLjWnUv8DVRvApNF+pviVKrz2d1nvZRXI0XfKfV1Bg1TNryAqHpmoVChlrI2SimPicKnEcWk8WjM8YSG4ReUpxXpEAHeNaua2Ug3+d/Qz9rytBFUYmRTWbQsnUdLZqfGyqfHjNMbIz5oo6+gT6STFa413oBaixfmcErSHfOISdwwpOg6e7oI3gEpNUh4uHzLDWeTp2zaJTe34FpQV3qjWh7bWpkM7JD/Nx7Oa5FMzsznTGDGyRD5mNnd1RICShiOvp6oeJ3QctJBxw4kgFmZ2t7rkZKEChtrNWlWnpu7J4iJDpnNbtUgOK/+LmQV2gCqCAZma2/aCWl8rlJKCInPk2x6v4GLSpY2AYls3AJQbGyWO1UaxxJESkbfWTNSxM9vrB36qYqIfCQ80UalT1WxKCXyxBUjZVXGC2LKwlDI0rV0a0u2rav4RU53OIQviSH9DGl61MwqNsi5DqoImZJ3PtVHVfNJJjIFrg99CnA3Z/0WxLPS7y0eKPOqtmROSHjZzGem8Mkv74YX2o5l1iAmnwwQoOH6Uz9SAqLJklezpc7AeqFmoWIdeo5WNzGcmKVDWNMMmXmdLUp+68D5PDIEDKiYJt1l6kYYsclypRYI7MT6HQA5VnkjuTOnJj27vpMWloOCK21ORIAyW2uM9d0IWYH9lKh7pGhy/0xqo63hsnqOaLvCRtC4lQtHjBTee0a3rq4cXW4iWuid0yZCA+BNsEVmpJAoXMe7HfFTZVh6rOHHjDNLZIdm4/xEYG0VLvgvMXVPlSYhAekmUxWYSOk7S/SmLqSwoWUbs34yeihmU5vWkpEYjxmTqDZh+LrchwMvjXuj9ubjIKZLILCmz+VLtvg9+TJRtVmXssAdM2acqyuhdnVh9q+Ym3JK3gk0xVC2QQqfqDwThYwHBK1q5CMBgridRpSIkK/W458GmCz1ZSzIPcSyhNftzKaMSyBUYwJF9uRExklPHGzQ/ZEv8Jy/SMDMhKlvWm0EIZEbZ1PWQUaHnrdNH0Vzg8HS9wFRdsLTRNlHY1Mi5iQUH0OKYntRCm9m33dmRN3gG+rwltQF5W9s2BeCw00ne4t/WDUrNmhRKLigLlCqBsG+sE/KjhjSSXjyfLCgPhQNcSoQxd95KE3XPeFgIEwIKcMaVj4YsEeegKzuBD9EDnTJd5nij8MiGV3FdOIepPhBiAV8JikhUYVJCU2zoTjHCZI6YrgrC0A748ghcl9hf7UpeSYVCMSmyj2Wee7cDSh4NVExoXE8+miHKTEcklyyDhHa4j7iquBEBt6vi9mTpciiyKzk3EFqdI3VrxBTXbN04smA1Uuul7RwpyTba0CAED5k8EYiFSljWBV9UlbD4YjV6q2w80o3lzlKMTsV/r92ewHmUkRE7200ZdORwCzvbZM+75pX6ybD4aEdRW0sfgK6D2TRUjAX4ohwgVrPTV2EWrUcuD9lHfp1KtXN0ouKhi0fFr9E8KMD67hZZJQ2pjZCUhxrp5EyT7T9kw8zEz1XLaAKB7DJrLaHJJsokAPgN+HOmxBt5QikDHx62cVbtDt1gBw4ObHUsk+Ag6J2oqEiIXc9CVS4ddDNeoTqbQmrcDzrJQjfE93nEeyF+0icCblg6UcGaOhBU85FIshoyvaKS4aRLuRmvjhK1O7rc/c/IWAmrRdV4AcwO+6AG25pgv2l6iNlL7Ch2NvejFpDB0qg3pCrni50PFRrltjIip8F+reK2iSIx4RdSg4H6O+qtB/FdlUk6SXmy8nbkuoVK3/rYG5ijamywLEw6XrOQzTpkiglasK6yVCCz5XMJKx5Glb5tgrU1Jb6DIpNEXGjqe0EOYLRMxlt9XHI4UrJMqeHY6aOUgIRjOaoVjMX3qB1fKz/j3jdwf+BOjuBU3uMUkPHU6sc/GDbw9G33CKpi+hCkpZ5BIZtBA7MUraIwa4llIrhdfil5aCweqGJfanjYH/oVE3nxxTwXqqurGk5J5qAnUK8HyI4zvpSlK3Xerwr7lsFGql6+jD1JWb9ik2cIRexlRWfY1d91TW4hlHZD6pMngY4NlZGVXkXRJAWWPLrhy6yp1W2rnnCYRIx0AgGFclS26zt84IeJHbFR8usWNrj2JIr05U65jmP4wOpqWN+3DfmRb3s85Fs2c3Twcw9zbFiITUZSIhwkDjmzOIQzQEF+JbRlDewyAE17tBNopC1Zkcs/4NtOqolKvdrgtnIfa5UqgsvsCngpR71dAxDKAqlbNBBtXZGFTDUS22rarq1oEuKv2wzyUXBtRYPQ559fPdO5z1WlRe2Q/t2rVweJYIPqUk74uPFm+Q34YWSTcbjFISR7oRr8iJrxhlbPDEBZqei1HQoiy0Lp+d+bJjH6R5PF3304znaVQw0AOgcAeEEcL8FMUgUWlTAlaxCm43b6M5I+CtrMoQOlt4esBDgIhSzMtgmT9GH3ZAspHSRnO9o/+ETJ3O+kfEk0VPDntm2X/lmGGIU+hdoTX37NcH+ViLnNnH35Cq/+BHgK7xDpHQuH4C3H/VUOhHFZ+z83Dq051FXOzFa2j3MyFCU3o9NZBtoCEXoSPfWcEYjpQNaVR3oSskw24+AxcTJnmf/i/mrPMi4u9S4WIO6CeIp+HTKEkA5tLXs0qz5Xk481DNk3dTn+khjrl3/C6gOjCtbemviX9DCkRtjZ/adpiz3a1EqCbhnNvZMaZ1dO4JAomCfyPp1pY+I/0d7eJ55uikI5pF2YaePfbgz+r0jtraxKrv2G/gUvU9AUrPkPnpbaUfRaB3HIdv+Z+ZaNVuacJ1ZExT8kF8PD1hy0LHAKAVx6cXaGbBgMjW8QiqTAx4kb/cmF+ot7hGGPajFnmJnSYBaO5UsL8YrlphxaS8QnIbPkbDu7sAWGwToC6OxfaJhZ/3akD9Uwg/b2jEn3N/SJRYBJ5SyJjXL2L5QCPH9DlmvbBjphj2q3/rYO5U5T/bq2e6AnOLSzyM8CI4LO0Uh5vec6zfz5B+uqiZ4HZ9bU5yGzd3Z389U1guysU2g3X38DtxVRsEN1Ud9H//EvxKijKD0MJm6Qb3g+ZcFkh4t8L7CJ72ehRozklyqmHjsOEPf5h5A+P5+h/1wMQc2WiO7+YJIGWKElvzT+/kR/1fsb/GdvLw4IkKf/+SMAztC2r2GMTSB4GAAQ3fTIP0YyCSMR3u6QfUuer84qmMmbzJwx4KYfMj3ur0Ym6lQCEH+Rh6vVEXkuo4kKo7UIAKRH2I7w+lh+okfZo/U3iH2RDFW29CRlTAP1Cc7JP1At+aAMPCeUtCmpdDDF0qT0bV5YAbOq2qp5z+cyhB8eYsIeFcAKYOAeIWsP8XgrY3XXJiAwb8TGi/SJTSi8knmmuH4C8fQpVixSogFM5bPgGl71D5WTr1iAVJ/MzFtlUlmMOGUuiKGGwSC8wLK4b8srKLK/gkKl69ObC1xn9OWhV10xPmVjk6m9MEf04ptPosxXGe2wzEb1t0y1LlCdYCTjCBTq9TA5DLSF0kp5hW81wq8i01nT+JyhtFDx0yuRtEZAa5HXry99GWYq9XK33h3125f1m2Hma7QEdabS7TRb1CYRFhn8jAop9VJ9tGSbBCxlw37XWLW0SXpUNztTQP5DVa0nH0+ChdD4eHREY5kiMWMsWsTj76Zu7DjmBf0L/bLxpbnwfkH/gOvu83cdTBH4K42MQuicBB93jxsCqBHn/VcKO5BCRh+wpp0N4HfjMSVv2RlqwVuPbSLzgUC5//udoc8k500Op8ZLQqp/JZLHoYjVwdqSs01A4gap6+6T8KD/FBIk9J+I7Ga+SfkZSuHAc3OgHCQEYdDsTLb8xy+E7uyaN0KVQJ1+3jP5Cuh6bt/veUk0/UKoegYU/P19NfbWJ0yh4jhfx+ZD4SV4Swgifw9qMvro07h56gLfXK0Pt/t30Uo9yBrj9det1862L/OuvStVRPIWQA09zhTsc7KCaijbVcBsRrpRtqmCIACZvtH2j9r/zzH4n2Pw3/kYwAAmcwRQlIgEs8xZZk/ucf1u6J5MfTfBf3smKwjsLDJrU6ItfVeRZPmrlidHwgmn37ZKl3vynKh3Jk1x9KhLOpMlllM36PYo33/1V+iGBBB9C949aV+HUeLXgidUvuZk3Mxfkj2ANNwhX3cM8Jb6Qj6hKmZ7Bvg9HU+wNyVBTgTwGJa9m9dkNBJrT6aeSXxUxo2xa0r/gM7B0fsA5pMvyEkRM91SfbXRVC0INJUP6kpLajriTdnmUl/epZZG8rC8TVxuEEysckYnMMqR+WTiUAbTl3W6odl/GxmCOn3fPKe5gx2KlaT+rEfRHrhnOC3pr35+fPXqOIOQYuMJk29yriWT6hCTKE/lk3RQ+f9Jc6QiOpB/zZa4USmNa6UDCs2ZzBYw8oOfBkBMbTwQoudkFW+8jXd7LTD7e4HYMxVHUi/3ygJxP94y/moAYekQb1D2KFTb+lm4VVy7DFhQEa5/ORoQmcQm3DgRsPKsyce9gKEqZfm/1DrGb8MDZD31W2bDaPwP1GSBz+3QUgaBWvJh+6jelM6ckiotsESdxL0gkumUO02RR+X0D/BllNMoY10kshCioKPCZGEv1DFVZJLlIvKoo2aUo8iqWVwEpsoxZcYnJJSi+g/Uq10KHScUpRTF6UNaVxNpB4Z0A8YrqANpzYRxUyzk8FFUi4rogPMYRb/IBL7f0JWJUlH/fkM1vmQOxzYMgH7PPxgiuSB/0L/fANpc6h9a/+Ln//0BQ2wfFqCtYT9IEeaLF47zNlnEJ05/saet2GIv1sB3t9L2S7derl3X4xHW7NXCnu+NHT7eczFUN9D2a6H/v2djP9hTQ4AokaRt/qbeT0/FwikJ4Hm9NIeIvo6hbvurvLJP7O3+kdDygJENeCW0dYe+UT851Yy85T03nkp9/ixl/wBoiQRpK7TnfH2qeOgPp4tcD3/KTpjyzX2goW3hBU5P5eIFYemdIAj2rVk++mUPQ4U5bAV7YgaXyF5sRt7996F9wQv8wb4FaJWmFu1bz30RadLKfWu+NntiL+GT2/0jaStTxCVISZjXod0ZwKUyIYE12/29YOd09z8FeDV4CgUEOHQuOmtbUUFGxRq3SH2dOolrVP+3gfZm3pbtLCmu/BspaFceXQNUf2NUhsTm3ds8ff8+tBKkrZyiG45X6an8cLyaElekIU5+uwd/pM7bHwotTPXB2euCSyE1lQVGGJGnPKGVma/0Xx9C+gdBK7bfcODhohZhqnq1ETQ9WbOokIcquWlNGM4elj9LGuu+Yu+qWa3f9Oq5Qn4/PwtcR2opkCXenugsc1DDAy4SYRBG5ATNmfhCybEOECMwRQddXTRNwfVde/e6Lp2Iz8nI0qGQNpBy40DQQxbNVmOf2jIyyjx2l5ikAYF0kB+j40jtrBQ1o+h0FRSvXTW+rGu6UchAB89F70yjADJqYRjGlzrElsb1d6PmyXC5LJqRPTEjJk5wKSVxMQcpWtcL30ha1xUUDeRK5nVSaTOJZyBNMKgy6EsHp4AIuARIEMNFZtiZRJkem6m5VGW6MTt6DDxqZKj0S/Q6s4IwPUMiY3VHawc6zTAq7Ahpv4nZh8yMrGsNy3dJ4hxirq6T9dC+RAW21GOgZoWEXCK6tiiy3AAoP9yPipYlozMj0pgYkXXsJYUinQQyfI3+co0ZhmdEy5bFQyZf+SY+1bmBHFmhCLgLWU3biJpFnkOwIEMGBT9kelJUjS3aGHZSB0kERYEHDtynVFoXdNy2sp19yUhFMRMZa7IZbVkxFrRMlNYOcUfglYVev/4KVcXvfOfbN/haPt0qLWs2FYC5sWR+59TumBd+dz/jJPsIG2XP3ma/NGZw6e8xtjsZUZXNqKopCWN6WS58otdGyF/K/Hhe7xtKxVHIkTHAmMi+RD9htkqM/euvqoXUob99yxgstC3n67dv3/4/b84xpg== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the +subject and then tell Ory now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which +initiated the flow should be allowed to access the resources on the subject's behalf. + +The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The +consent provider uses that challenge to fetch information on the OAuth2 request and then tells Ory if the subject accepted or +rejected the request. + +The default consent provider is available via the Ory Managed Account Experience. To customize the consent provider, please head +over to the OAuth 2.0 documentation. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-o-auth-2-login-request.ParamsDetails.json b/docs/reference/openapi/get-o-auth-2-login-request.ParamsDetails.json new file mode 100644 index 0000000000..cf090637da --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-login-request.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "OAuth 2.0 Login Request Challenge", + "in": "query", + "name": "login_challenge", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-o-auth-2-login-request.RequestSchema.json b/docs/reference/openapi/get-o-auth-2-login-request.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-login-request.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-o-auth-2-login-request.StatusCodes.json b/docs/reference/openapi/get-o-auth-2-login-request.StatusCodes.json new file mode 100644 index 0000000000..2077404075 --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-login-request.StatusCodes.json @@ -0,0 +1,470 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + } + } + }, + "description": "oAuth2LoginRequest" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "Contains a redirect URL used to complete a login, consent, or logout request.", + "properties": { + "redirect_to": { + "description": "RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.", + "type": "string" + } + }, + "required": ["redirect_to"], + "title": "OAuth 2.0 Redirect Browser To", + "type": "object" + } + } + }, + "description": "oAuth2RedirectTo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/get-o-auth-2-login-request.api.mdx b/docs/reference/openapi/get-o-auth-2-login-request.api.mdx new file mode 100644 index 0000000000..ba0156233c --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-login-request.api.mdx @@ -0,0 +1,46 @@ +--- +id: get-o-auth-2-login-request +title: "Get OAuth 2.0 Login Request" +description: "When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider" +sidebar_label: "Get OAuth 2.0 Login Request" +hide_title: true +hide_table_of_contents: true +api: eJztfWl3IrmS6F/RcN+cts8AxmBj7Ht6zrDa4AXMYmwX9bDIFCCTqUynMlncXf/9ndCSC+AqV9++3e/D1IduA1pCISn2CP2WMgk3POr61GGpi9RwThjCDOHAnzsefcfwPTIck6TRfDPxqJlGjoeo7VrUoD5qlwN/jvLZHGpYzgpRjiijPsU+MdOo7W0Q5guO/DlBljOjDLmes6Qm8UbMd8QkhPnUwD4RbXgweSWGjzAz4TNDPrEs8QsMJebKox7xltQgCE+cwEfUz47YiHWIh0wyxYHlp/dMB4DBENTnxJpm0ZMTIBtvUMAJwsik0ynxCPO3e63m1JgjRojJke+gCTRekUkGu+6IbZwArTzqEwHu3OF+WvxFfWQH3BetJxZB2ws9GKX43FklF6xm5oZHCBulDkcMhz8eUKbXDn1cz3GJhxi2CZo6XtiMcjRKeYQ7gWcQ5KwY8UapQ4Gd/pzEYRBbOseWRdiMQD/suoSZxARY9yBv0L2BXyQ2YmD/wgGBXgbPAHcHE89ZceIdwogeMalHDF+MmUV9PeiIhaMGnMDJwH4MFt9BU+Ibc0TZ1PFsCarD5BGQKPDIW0B47IxgwyCuD6fSIwIR0Fi1Iub2ul3PMQjn2VQ6BWgUXzbN1EVqRnw5ww3A2ZX9U+mUiz1sE594PHXx5bet6xIdf9ELqW6oqleUSqcoNHwLiLdJpVOwa6mLlMDF2Ii1AoCpR8zUhe8FJJ3ixpzYOHXxW8rfuNCF+x5ls9S3b1+hMXcdxgmH3/O5HPzPcJhPmA9/Yhdup1ja0SsHQH+LjSfPj09l7wiGi+3FNWuwk4BNagIGp5R4yJnGTojCMiBzC8p0yrCoAucjlFVFC46wR+AwiNPnEg82PkZXYJ/bLmHNGqo6jMEGTy1nxbNowANsWZt0rLERDTliM8Jgg4kprkkMKVwd5RVmPkxqOIwHNkEbJ/Bigzne9sQGdvGEWhSQB4tOohIOIudj31kQNuY+TD3bfA8BZdEB9aED6qkOcF/lD+J7/bXeCj1uiDG9SiSnR2J6nh2xB2xREzmuXDEg+eV15b8IhL44Ln4LyEtWfQc0AE2wCTuN04gTgua+7/KLo6PVapV1vE3WcOwj0zH4kQM3Kp9xqGkcva78jJw3I+YdsR7xfcpmSVjnxCPIWRLPoyaR65hZzgRbiKvmlKEX1RxwG0fly97jhS3LWRFzbDgeHzsenVHGf3zYUFl2Q9V2t4fashtgvM0I7LfteATIHUcH4sKQi6MjoOxfLlzH878eqoMDyFQAwBbYeEHkiOpCcMHeYJkSW0diIYgw03Uo87OoCbcIkO55WGwtsV1/IzkXJ96SeL9wOaJcGhzRKZ0Fkl6hgxf4bVy+uWkP67Vxu9u8bN71Xg5HbEUtCziPOB2UcZ9gc890nCg2qVehMChXtsUNfgxQdsQqBOEV9BYUnbAl9RxmA8qX2KOCEUqg63flyk299oJuB70+gMqJuIQvQPdexFUVsALDcbwFbD71ic33kMLwWIh1iVMRmJQwYw8x2z0Jqqm4b0wiImNR7oMcQZk+w3pELqGSBEbcl2j/NUuSVw+WkEUwpOqKLGpTcSbmRJMhQUU2QE0xQx9QBN9JC3SQNbZdi6SRQTwfU4bKnWZ4lrhkrktsBZKVI1jDiDlTcY6z8jQLXN+1+7BtYojVnPqEu9iQhExNkbpI6Wtvb0zHxpSJe49degScnqfRh7+7Dvf5T25WTMYcg4w5nnmY+eMEIbXoFAAVTIwFlgVHSTNJF/s+8WB7/++XXOb8638dMP57wH+3+e/8d/v3+eH/2SEd6ZRPfbHSu8CyauoAfxccav5/A4pHph7h878angk2FsYcM0asseXMnMAfc8I5ABfJLTs3Lsk7K9hYZKpyEJCWQHjvyUGE2ASDwF2sOI5FMFMnmrvEoNMN3MbVnPhz4olb2e0gNbESITHi1EQHCirUrB2iqoWpDQSGMsMKTEEPRWc5+YjpW6bFm40eWo+yor6Ud9sdmF323oOLwKNw9YDmZkesOUWOTX2hAUEHpZZEV3SKLU5iTG0iV/wBogOP/iHcDrpNQGe3I8V3QJJgDgYGpUet1HdAklNqEYJuYp0caBzWI0k8TTYKFd+R9saGRwQuscX/1ruswKH7juU2I2jWtIokBV5q24EPkAm+yRz1tdJbzDTCaDBo1k6Q5rWhnPk9zEjB/4fA3GGbaHDmgY1ZxiPYFOxTKHxK/FZsSOqkrkdgw0KGPWKEmRmg18gMAIykNv89KDkxPPIJoR31REMNqewWImT7whkeAQE11NyAjRLs+WStVGbQ0EaMkSXxEJ4BV0GxYSlHC9DwKENzzOdSnrexVAEpR8zxkUcMkC8FohzBc53v6iVqpWOydoGIjPHnF43qsg8qh+ufUmIJUIzAAzuCtRFA8cAFsRGUUGEX4DE2ba3whqMcgChXk7pIUeYXTyKYKfPJjHgxoPfTgm0w1c2XnwbdphQLgApILAipA+wYyMUzog62FMIjpVtaV6KzJgmbOmpxQRX1rtqDmxoyKXctvJFikrIYQKvwLILyj2E0YyG2aYr5/MPjCGKK4X9Goq/KplqMExKuM1VLBUOEglmwEMC5VPigD3KJ41pwMIU6TScWGbFQAJXrTiN/41IDFE1EbEwthE3TI5zvCE7Ecv9Hfcw63uynRCF5Q8zPHcMqNIY9qmFfEIuq7F2Ga+AHHpMalk9twn1su0mi8QuX91GhPjx8JvZJBvrs2w+TgMltnJRL/k4C/x2A/npx7TvA/E0C29RzmP+vSmwNGOTfJ7JRztEB5TwAkyEQyB0JThjNUGSAQxMyYiFz+VnBbR9O/jzJ7YPR/xiS/xXZzQPd3ZPMFzNEp4C9mPQGmmkC9QLLIxaiWezFHnl6azfQbfkpwezDKQAywqTtOwR1CdYoZecfsYQR10EmDGhTRpR9RREs1/GlMGltkB1YPgVirUDiiGqbvOXMZmDCCPx/IjpFhIozR3l0VtJo4vhzbXHYy3HkdYWvP8N0LqE16kPrbcYTtRVDIjFkXGhL2g4CTrKoihksxGEEFPeLiHsDrdcCtZz0Ar3sytovI1ZOOGyqjknC9rva5MuIbR3DpnboyJUdmMA2wV1h/sfhBXrR/p6XEetKiqa0Aj1Hgs7B8CEWZLv6Gu7GjFygl8BjF5T40wtxlPiFsJBdCGRlAFkXYFScEOwRLzFQTVDZ5NJ+OJYizWLRP8WR9Yr/Vi63BcRfz9leV4s916HVa9+hIZmga7JBPeLvWMIXZLOn2w0Y15wpinfnWoSWNFZd/JEYYZSKURu4NbFblgDhoDW8PhwxMQTPosom6Qp0PDNyXLSG13IuLriE0lDkuKYD1xkkd0D8BiYM+7oeET5CcDzajjQO2mmELX/uBLN5wr0grG8wUY/4HBkYvG2Ow6UrkHM6Ywgjm2BpZHRiQErhk1BvxNzAcx1OeBpomkk4MNuEMXTL+WDNdjHeF7jE1myUQgfYmjke9ef2YRyt2rPDlTlYtUGgfAgj8NTxRgzYTshUF2STRZHVUbJPxOdOYJma+k5Aqp5R7mtWJMh+s3xXRqPo/PTojGE/8KQLtc4MbyNAR2UNBxwCORDwKJBnJxYVOuBkg760huWvYLYXjll5gqRDUVo5Qe2pOpZFgWFkgHRxyn2s1Oyk+N7t5U+Le1URbwmIjVp2Mh+0NJPt+uO7UjNTvCKF2xI+ezxeDv1i/7K5PllXxpedwu3kpMefe+WTZcbxlq339y69n99Y3W7pmOHh03p6X37yTymvNYvjav7mfGIOnZNGo/N6ed9Y3jndx8yYV1qbSnPsWZl+Zcafn5yBVX4ttM7zQ/spT9mknOmsNq0px81mzSBPlWqGPGbWtBoU327fFs+0cLu6LzduipNbs1O/zb2ftCrGqtEvPJh0WG52B0G5OrxfeY+3b8Wz/PpsehvgJr6iZ4+1y5l/TP15vlC9meJu3W4tgvPOvWHMJ/44qD9l5m9e46nI/L7fO3HxcHj/Wiqub27OT3qZ/rS4LK4XN+fHpc70ptfuvxUfq+/rpdVYvVdab2WXleeT1dvNq9uZzwaXuZN6reu9eb2Kcfp0XLkhS1Zsuqfz4/KccF5xC6ubxf3sfew5xFj4mc1k+X7df633bgM8Y+7bzbLdP3s6X5JmMMvfrjqt52b+4dV47xrHy/dbnj999Br3pZo72GQmd6ZbOu/by/LjyvAHt7Rlzq4sp7XKF6rLXGHWHJQXNcb7b8/2wp00pxnDc2d31w37vjOu164dUnLHncfn59l00vVo4c6pP1x2zm4XxU09KN28tuZVa/6MK3evwXCVz1xblWm7XJidndvzaYUtmoyQ0+v2uX3ZPc29dRbHD5lbxxs83fUbt89NO7do1Ivk6WHYqKxaVzfXT/OrQeGk5tDr44dOhi+f3Wo+KN827srjQau+uj2v3ucnpTdykjkl53izul2ujKDsdRflyqldaU7buN3CTsGeBovrcn3vaXaTx/nyhHceF0bxCZ9vSk5reD5u3ryerAPXDXLWOx1fnT30F73S+vW0Zz4WDKeec6j9tFo3aZ7Y/XJAcoM2PjXdWeNyU2mdGCX/Pv/QOMnlH7vB7LrW75Tw4mnecE79cvns7J6M72w/eHo2CtWCXWjmTy7zl8vuKe/V1oNN+S7//la6mbLz+sDmRe+p0J6Ungi9XvRp5TW3dzlvyeXwc6t8dT6dzSrcaXRLbWzku+N6frbKl/JeP7+4bJfny6Zl1fv1YzL1ysV5MBgsb6cV49ZlJeuNDIvL93f29HTa6903ztxbszrGs2aBXZaaE/e4MpjkWgPq4e7d22B6MzfuJ2Pz/LJxUpufkbOT4aTLnUnXYcFr/+nueF3FnWK/XTx+XQ69x8zNcclfP65Ozk/ux8ZssW85JLma8n25sq/ZYmsP8Wo2CxqbS294jZdn5ceTh+vBbG/HfaZTyU4W1AR2siAboRYkWLR2StsYgjiw0gWpEfIMIZXLdtK5BT5KzAySFnYZySYlg8XCM+hMoW/IrLHmqyOmbJsAh+dYFpj/FFvivhcYgq1E8oQAWityIxYwBRoxswiJqKdEo1hUwvbM6SheaMTisGnxokd8bRQDvmlS7lNm+FsTZBE6aIPAr7YHSa+cMY+FI4nRbTqb+0grfhy0ue31IDoV3sUNmuMliQ0wSi38jd4t2ORDvbxJ4IslQuwDlQqj0KZGDJT0JbaEC8ACURL7dAk9pH4XE3RQwJWb1M4eStQryJQwJi2PBuYkwwnjFAZSlrkk9z0u5grmlOTwtDQ9OT3fy14X/p5gCjXn9iI/FHCEhOHMPOzOqRGJOyM2xTa1NtGOa0knjXgARxmCq7q98igF8sYoVa+OUtlwZoVTKQKN2HdkILQtAoH8KvXIf5+gE25NBOynd6bbK+/bDJYkLMv+m7cebO471jifw2/T08Xj1ar27BErc+0sm26Jn5FVyzHz9ccrq+QPrW6lMO4Su3ByvapM36zr+0v3mL3heeb0+Oqk9e4FbyRnNDqnpXmn3vSLwzdvyexW9XHN7oJm5bRAH8fBYPD4eFW7qhDcqfa6zl3r/W7DX51WIddvDvh1hVJvXsFn03zhtPM4uaZXZmDckOVDsWNcr1unxlPpvZ0vFd9aN5Vhr2Nn2k2yXL3xJu81r05O7n37nFOnQRfzxeRm5bythu3uZfkpx6zi4/Khbc3LNfPmtdJ765VJ/7jRCaq1KntcvVdr3dLdebNRGTdfzZ7fWFQz3oOfvz6tPE07Zs4obBrueHnVPT4lXTP33io93p+tnEq19MA4Nop1/9i97p2eu4/F/Gmx1hkGpUHNrLcd67rcmRnmeJa/c8tnRaOMG+NXo1/KvZ5fe/X3Vam/zLFW5ZLwoPrauXu95OPrd3Mx7A8e/Xzhip3ft7hpHN8+B3iYo2+PFeJePU2fnLc7Yr0/+OT4+Mw/qawe3NxicFtckVzzbfNYtfDzrN0s9TLDWmWVH7eXpl0ip3f2/Kk8seoPzmZmPJaeTorOVXFyTXH1fnpdbdRuje6sOrfJWdmpH2+en594Z4Ivx4Xma8erntxUbq/uVyXv9twcvrZKTfuVGsvnY7ds58x15vqq2ilsTjsP1966Upsev/favNJdtHuvlVK/066x1u17MfNqns77/vPafe6sOk7TrGLWfy4814pBt+L27drKd7uXdrEwuOfH9mlj2FlNcv18s7FXONgSdYp3k8XjqjYczGmGdE9Pq7PJNH/WWNzXasMmttu45uW81+O33PR42qi/Hw9Py+Pc+dPyMnfeoMvjcjufqZW6VmnWO35YvOdp7r3ae2ObTamcy58+to3ukrZvr89Yc10/aV+NO3W+cEqm3/Qmhb5dz88Hj8vqwn5fndd5v3F8c19pX1aLNOA3/UfiNqvH6/NgUb1uPN8vzZlfb0/uTxfv5vnd/C1jmG92j9w+3Djrzo15PLGW9KF//mCXMpvjfNV/cknrqo2bNf+hc2NV5i1acTrXw1lhue7ZJ4/rpkXv2mT6RmZNi9v9Ji7cur3icGhVrwubqzn2c/cZr7uurc0NfTAvx6v31tLNNVfj/MrmZy7JdGZ3naflYHh13nLnw87pdaH09Fav0Fbj8X4f4reEslz5uGG77WH3/HjcLQ/dN48Me3h5h58n5+yRXNOKk6vdX1beC/na5O367b7UO8GVlj3pzluG4b9Wb14xZRm6DPyTszO/PLi131urh1at9pa/fW6squf3mZOHp2e7MTi5alF/cx/03q+eSPGk+3qXqY/v7nP5/nB+Wbi/HBY9561onJ4Z5+eeN+D1/qrVoqte6fbUPT69pcH7aaGG26/LTPD21ig3ppvV3elwsb6aeLhivF75t/Q+2NxP7t8W1cY842B2tVg93ZGNz+/m/SBv39ur7mmtm/ec5zzr0MZrtci4uciUz+qFXmF1+/701FidvS4nw6HzNHTOl5WT3Pj2Kf+Uazzd996M2rtRaRpv45zPGObTwsPwpGGui3Yp131vT/INzix2trx+LO9HPN2SDDe3Y7fY8h43Pfp+7DuN2fVk+JBpmc3C6/3Jxg3OvcntcF3w7luVqe3nGs7T+2zQfK4/NOpG+21F7O5d6fjdqZUxzlQWuevh3WXttXX1XDNrdmM+LJTvzqxmxg3Wi7F99XzZOj721ptuqX16+njTI4Vex+5Or1fPzeJmkD95Xi/vrxtPTd+0zMH15Xu72MTF9/71vPzQHexbTsD3ONcHXARbu8HEkhIocPdR6nBbJghNHSBjOVKSQlGvrOKeonNS3CW2azkb5YtgpozvVk4PcHbGptbCsQjoUoYONkMm9jEw9iXxlM9ECHnaLjJiDhNtsughEksNx7YdZm3QKMWpsO2EHQ6leEKYAV+T0KJymOTqnO6V+tfJQzEtFdqtQi2/bhxXZqVlMDn3b8jx7Or2/eGsSEr9gJ8Hnatl96G+d1PWp8ZHAtv6VMD3mD3NnYuwNlASAHnGHFMWl99iEo74DUR6aSdX0Zqd6+ZjfAiOvnQb1dN8KfdVCT474wsNIHQMg3sehhciWWhgjHdSfi3pUc4iVMfGfMSUMz1hQVRxtJwUTzKEgdXZRAc9Yghp+QTGBeBOiielryiTkbZG2TzwLN3jENXqXfSl2R9kH4vnuezx+fnJ1511Sqiy0nq686NCmz5QcALlKnTUpfCIUQ9CBWP9fi7acpM8Lutxo/7eDc7tQvHq5m7sB6R4en5z5z4Oi2510/Pp4un1ujlsnuI9TPhbPAT+i7jQUuSXumhaGDi/ht0ckYAQs1xDnPuQTK7JZhfSb5/pBnZsZfH+ZJzFthkcnHVgzgafnTLkqqa/8N3GX1rD66/IdIwAomRVjK7uICgAD8OJtZG4JyIu0pBiou+FpFbQXCnDB/ww1lZlWcT8byGp4OARtWOTSkKnNVhw72GLO2HIqLDghuuJSIvQUg/4YToWHC1InVIYFSDCKSj6oDB9Qa9Lzy/0cOGqUwsaMTAMb80lZrCxSRBeYiqcHxCUBdT7ALA74AkNMNR3uvX7QbNbr8l0AMuSg6n7G5r3zRHTKIhTdYKNOXT4hcf5BZ6RLCprHwB37JgJXbn5Iq1dqKdOGJ0NUMBaRyy2JcnlppHpwLZyB+CH+N1uvdq+va3f1eq1NJAtKvyJFgQNc2IEHok2cX1q7HprYWYRnK7C2ZAkwSExVPkR2uqig97U1kizjYyC9GJURQUYc18FgKnBxGrglxGTBiF/DuYdHRWWJDs71OZ15Y+lG/Bv9cGBL/+TBAG899p3X44HXOnDpclxGIkDg+9dvE18DHxf0GEFGZCQLl7dEg7nLtoz4DlAx7KxH2XMgOMtOFpBDp0wacAAadS7v5FRd70Vns2IF5tfkcdv6ZRIH/vEktsizQwSKOAPyf80Y1TBGXrRYkhtkdseaC8SXMeixuaTyO+Ixhr98tO+4DeBGRk6L/xx22GWrkeX2NggOXlIoIHOYsgNACAmhCOdwmcSkAFFpoPjzTCLciYtixg+TwsSnAaBQxBsiXuTcsMC9x5kPHGHYUuKefvRwH0dUqLz6gApe1ysOr2l43A/01VtY1ElMlpByzgiNQCCFC0akWsZriFJOZVsIMxvAAxAmzozMwMuckLgf6gsEgCFvStM+wttgyP20QJi5AlPxX+RbAVxnmhCCNP5YFuuzx9KJj9A087hCVGlcaS/gM/bvmcdvaEnQYFn8ZDjG+F5TiZVxHImVFIQBBVCwPdPriweUPZ3EsZ9kPz1EQr7oPibgu6U+VaG2cT35IdBYLUNwzY1otMYDZRICZInM/oxlicowgwmUSJl4IK0l0YzcFg4kBxtEZVlrRJptdDV9GVGGFMBZDI6VDhg5FkG9z98/g6Ue+lWAh/fjWD+PDaUiB3/LhHnDOsDYv/TaNi/AEH3xpItjpVMOt4barG1Bp0I3Ja52T0ln5cjhwOImT3QAnpfQWaMhV5Ia78gtlpbCwVGLegnx1fbp6RpEeRnWdttRkzJ+5Rr1OrhZeI0yHZ0KiPX6YxFjhARsaag+y6iPqC2+1Gzw45io2ixUub2eEKizMScKRGvAqSILH4/XLtUOLhgXQY25irmUCVIcy2CTKlFeEzuV4NyIiATXFpmFvgeJUsxiK2ngThpJBxuobYjXIQ6IXrE2h0Z+aOUWrmSPSuUmtLOAkMXlOo/jnUdxy/WiIEoAc7PWGzmzzJLqY59OvqxqzrsD4BMind6cOGYC6PyQ0lCxUQamMkgI/V1svxElDcbBUoiFSd5R4iKUtpO1k6GNF4A0ZDB8c1amGAZ8fBBtwlxjmYYwahbl2Np1dvNddsYEN+Jw/z5IERuOO5nsoZ60A6wIf5ISOExQxC447EBDj84KCCjWSoiT8yjT+QB5iOm5VxxrrUBq5AtJCNcwZhVPDs5/3q4vaMjBodfhI3JoGRxegUUiTT1pFUSwDiW0GTy8v/Zgvz/xck+wsOJ4TveOKpP8CkG0xO9UDOqaqC0Bsk5tMIiUl2RzAOPK+6Q/YwtI7Akm+xwEpgO29hOwGNj8njMdV+xpZDacIRHDCiQvOkQbs1mFtkyQiaEZRU2sBcNC+qOwZO/t+JCb0HdqvwRQUvlCdffiJIjaCvtJStiNVRiE2wl2JtHTKVrh4YjbNoyH3l/ULyASwn+3wVPaii7QCp14C+BVdY0GctffnSCVM0VIIA6gvUlPgIfh8lfL6i2S6Fjdu0R09dQllbROWPx4fTdDFcuc6+EV4CaKsZcRbujFxdTb0U5UbUepBdifxkFKSJrAitSWMY28eeOCv8RYbSpi62suQnm1EilPyRLKuZbjSpoYqwEy60YX4pxukpLmJSfaCkhCVWr5LDyVsXqWwh+8LIH0pcLCGgXSzlEPQI4CRNEFY4SvV7AsvYSr6KyzqxWqwxoopnAs5Sd/gVpE7+yaF31+50tBjAn2CRedgcuUIlfLv5UYOJATBxzA5MKY4ZPxguyGUOhjwvQ1yNbdF8WLNhXiinM+nthDiOyo9wJ5dTSpVYOZHwQxAXxNLKdCRA1+KCLZcCNBEFKhCbJNe2nYvvO4vdl7o8O3F5x+0eHTYvWkSD+wbnbD/tnvQZ94tlCBtV1rPYZDMVEKjp8x0Ll6xG4HGHEtJFqywiBtkxWWFAdDxt+gC3kEUtae+fUBWrpr4jKlApTNlVubmK4ZANRe4kLJj9iWmpLmjn34kvqZZ9MeLzBoC6IHmHOo/z4w5xHC7rKyT6f7QhLg1zYsVSDxqGA/DOa30ANIg4jMSOheUcH3Kf9JXwV+mTCkE0YUo/Fo9IuwBN0RGNaaQ5qQp2W3Rr2R+xLa9j/CieHYou+i3R2kXonYJSyT2vYk7Q1zKKgscQ4Gpm6duCREjVsh3LrYGrzERPu1UG/kSmFFFOQIKlXxySu7cJVSOlsIpdnzzn6Fhljtg/NXqM2NY2xGHLt78mgMLyxZLN77KrVrvK/KxvDFu1IEP2qnAGWzznqhnkjUU0yyra0pCTTiLRIaZvBMblBFKeRyurWwROuo7Urc5MV7bXIkljCZpmE94BkZ1mUb5RVsTbpeBW14rZGlfMJRxOGnQfbJ78Ysf9GET39I8jQQbC9LZUkbqXXB1rlphjKl8eVLV7vQ4Q45WqkYDyWfhcNosy0k/xLVoCTs1C+Db1aVjpUwXVikaiLhLXPf09ikLw0n0cGxz7l05jpPblJIxYav+Umwb2SwQoaHbLEiTiZwhsYUoC41paXcEXtKY+XxxMS6INjBczH3kZXTVF5/H/QoqBqAezeo5oqEhDXUGPhrNGGa+/K3v1Vw/M9SBO3QKsLquyAT7wpNoiodhC6nLULQwVQ6GsVBX9fQEosJCz2PwJjp/DBd4EZNGWsNfeFpVVqfdPAsuIuFFGQYUnJKowH0KMn4o6EiS5O7WlImHTOsu5nOyYEibiOG7j/3rWIKeKLWVFmOit5+j74UWeNTYgqhYVdIMoelZEK7/LGquqYmaljCAXcpBgynwXjkv0BIc6EgwNcCSg+GN3UJDLdXJBS13FdOHSBK+rRZcEXHhjzfy9mZBKqBAMosicOIkZi6uiAZkdshf/NmzRKTYnMuHPnEEaVknY5NWRYLHTv9GFECDhNbNfXmduq5Ga8OKIWv2IbDqBFcQGJjdaz75PFQo/SHHQCQ0gUglubJgXgsNWJc/Fv20ppsyak9yvKfCmOIOxpDUd8VJCGRkHXI0vqBNwCKsWDiDrvxYnkMy7mXIeRAZxR9ZQRi/lKVXUY8EO4IJfGlS5zt3jBjmcikmRk/VCYak+aLfwG6xWg8FglF1m0M1bMM04I43kmqrIAQwfgDyDALrG3ORS0knK5xLi/aSJyZbsdEBSpL+PKosq/4QxhdisimXgpFXTgeMiRWfshcIcy9keUeIVCnYJyA6LlPZJcI8K4IuvaGK4Kv0b7pXQlZStSsXD6QENaxYiJG4FYYE8E25BOAllpKGKsWvYVjceqsThZktDJGNIt7gmURxoqsLVfHaJjyzGwtU/2HDRv5E+axIcnippK+oDlWpjNAklYgC6KASJRPckK02g7+nHEPrINV6qdkzMZU1k8KX4N50E+Vrybp6U0JA9CXB5qJBO8dMbwiI1SUy9TLaMpBMOKzJdYLEss1RrAb8CfcyneiBtKGfgBsInT8nSoBgdwceCoY5FIA4GzREZWQfxrGir7KMf9ZIPqbAbpNT/oJIplEM9zQtoLMVge4cBh6VQGfKlgMkVHQslqxNSOCoKTLAelLcNS1O6oisg/I2PFNJ+qtiTqE/ZBHactwX63dm9EXiJnk7V7HpWADNYKdSBlSVBsfajQSNO3Fjn16req9mpPtHbhCg0GanjIeuL8uyqTcLQ48eq9ofsHqgWra69hDis6wbYw4bxJQ0bciEkiaMC+inJjzNzARota36pasEmwiqeKeFAYIhMVq/meoxQMH/GYjY/LloZKli5XGhmOpRIQc06F9UYx/x62I7byMy5CDfcHLqkQTumBSgAZTS1//JNh03WN9mWsqmpFUSVrVWY9LGsTytmxQuYeEUGzeKvxwZKCAc1ZUIKOkEdsImj/1MKzQ9BIqfAsCmOLB5XCWBj5uW8Sk5qRVRQzRNZU+ce2rJJ6dqGxh7PqYkR6Zm3jwYiRFfIwMx1bRYjHOZ7OQlA6JOQPmMmkBpaUhkThOobazVpVlSo6EsUmR0zVOlIuGri8v+hZQDSQRRHhjsWCUjDnjkFVfDrEqwrLcaKWuHCb4bDULWDsQ5fXfl+SMFeJ8B75TAHZdTfPEzckDNAVZzsWFi2+FJwzEgplmSg5PFAFWCvAAuKONmOJLlCaWxYASpSjl3Noq5soMzJ1vBX2zERX2Sl0Nt8oyRy2XcnvIgqNCxjCOBd0JFxe+szE+MB3fV578Bi9KRBC1axpHheaf2V4RlyKzaI7Z5XWRaBN2TN8QEEiRIThMHn1ufRcf4Y5KKEqPMiwUuEuAfSLEubRrojAFu0Pkw4ztSJfeOxW0cMBetMSp1DECsU2Tt6vKab7xLet1IV4VX9xSiM8h1Xxkyz26x5mvvUAgvBqzkQw+Eel9zX7/rajAzm77xp8S6dOjn/u3YDkmNUoLyd+TsOrbjjg1Iey9BLgtNZLBWqVXze2iKQtNnR8+84+XqNjM2925AWx+8ooEMKlj/AvHKk3KgBCUSZ0jw6t7IOinKdaxL7Krlu7Hof46z6zdBhiWlEg9J3P753u3HdkvUHllv3Du1cHmXYH60LS/bjxbhEK+GFskkmwxy0ieqEa/Iia0WGWxfahuJLO3QD+YpKltFR9b5rY6B9NFn334Tj7lWY5AGjNAOAVsdwY5UuUGZTqgKjEl4xe6W+RbG2oU+HC+7mYj/2Ai/JkuzAJT25PtBDybXy2k9zxJwrHfifxSSxDhkDuO3bJn0WgTeBRqMDw5beU421ikaepiy9f4VESH8/giRR1YuESrDOOt8mAOikq4GcmgbGA6sKp+cb0cEYEZGTmdDZPQVtAQk8sT760AoomoHXjkp6ALJVOWXhCrNRF6n8cb3MU0lL55A0s3AYFC/02YgghFeBZdmlafq7GnywYsW+S0f8SG+uXf8LuA6Hyt15c+FXIVYkRDg7/qdtilzaVmqtahnMfJMY5FBNYRL00FD4Tc6GM4f9ER0c/fFMmDGYQjJ8p0/VhBPpvSJ6rtEwv/YZ+hbcZaALO7N73bg4kppLAjdjhP1Pf0uGOXDqxnZDe//gmuNhYgH0ARGCASW3KwYiN/FFKud+gRAh8nNrhnw6XfzkuYdilSlQbpWbUnwcT8c5AtFOZmQOtxaKnATPEbAeHsPUjPwk+uvgVjVLJ78bqIo1S6OhIOyJ+Rz9EPUw38pNH4+JXlAA5e0dWWwcFOmGXKnf2vg7lTlP+unVeoCc4ctPISwPpgc7hSFl1yjrN7OXe3VTIzoLIPvOcgJkHh4fZmwQqDpKYOczW1yCYEwk11NP0PPQfvyJGLYndkT+1/WzD9SjzpwcOz/Z8k3heGqqiCNooo8ixZQFSX34A48vLBfrP5QhMQmKBhz+YogEeE0EZtX871l/2/gb/OTqKHODinr/sn/4C7X4J/XcBcAIfAOgmR/3R8uLQEe4ejti3+F3qbPy54Fb6PgHF/JCwOd5mrOMrxfTRF1lgnxbPOiJuJj+WFmItvqr++5a6PY4Xa192aX0thGQgmKKlK3CiG8hPcCv+gWrxZ1Pg0Zy41VMmPUmyJVQB/Y4IGP7l0cy6niMC1eG5IexSDlceBu4RsvXcjLvRfiFlpAQDXGReS97PmElGEMgEVY8tPHlnJSEUywDy8VlwNU36h8w8lxdePAenZ94rc4qSuwmDVgQ1DEaFtuJ4pmAxoYcAHoJRVdg1g1Z5a1noVZdETlqBRQIrzKGj6mRYvczvRBNigd6mq0zpmlSgx8FI2lXN5RtZYhhoCwWEsnK91XB9FZG0mVzPBUoKDT+9E3F7GbTmWfXG0JdRqlIvd+vdcb99Xb8bpb6GW1BnMqlMkUFltGOhSVrrs4BGfa1EmxgsZU1stwizsJq7VDW7kED+Q9ZmJx9PgjlX63HpmEYyQ2zGSHSIxj+M8eXo2Tj0K/pl6yvN2H5B/wC29lmeBoP73kYtQy7lkvgfdY6aAYghnf01sSqQMMZ7ydHBFtCH0XiCnhyMlDCtxtUx54CUzH9/OOyFoLPxweRocRjVr0RQNRQSN9hNcrELRtQgwdQ+BQ36Ty4AQv+JyGHqm5CHocALPKIGwn5MsAVNTeeAf/QU4cGhfoxQisfxlwTjzw1uZ6v9/IOFyacI5XuDEHvSlyPveSUR6mc726v4QCTx1zER469fkrCafnJNrmTOu7vzwbH+znISbz1G6/lr9udg96usbR4KxY6sfaj/5jAJ84JsoJLHfsUtnRLGt30KHIg0um94yMP2/3vY//ew//2HHTrr3AZYmFiAP09dpI7ESVYvWx6J5GztjjgSKwJZXGYVisUKv2goE/6mJMExt4LZt71y4ZG4C/IdRF28O+ySzLSIJMwdfD2J90m9DbojPtR2AM+xMGrDKPJRY3BHTKl8hVj5cr7Ee0CKjWORrwcaeEN+IZ745PMjDfyRilU5mhE/w314rMk8zCokalmzJ1KjxHpkRoi2OAo3g8oRUfsP84kXzoRwmGwpv9ppKrcDmooHX4WNMxlNKa1miS8Hia0RdCprEtvRC4ztcUol2ImRnenUogymL6t0OH3ydjLYVHq5fu7xAFsUSxn7RY2ivLsvcEeSX/38+PKhYgbeTe1lFW9GbiU7KoddmEfxSTzI/PS4oVAiHdC/ZeXbqeTlKHUBCqHpzAswv4O7B0BMHDwQfxdkEx28nXdlDTDIuz4/0hUxEi/LigJmPz4y3mYIRU8glqXsUqgG9bNwy6opIhhGRk//5cuAqDc2dbR5H0sHnXh8CgipVHP/R+5j9KQ0QNaTv6V2zLn/QE3me44ZGFKVr6mEEal86XpIKrNHKKNAEFWS8VI+v17uNHkWlZM/wJdhzp1wQIvFQviLijgUhadQR1c5iZczyKKOnFGMIqo6OdzXVXgp094aLlXMf6Be7ZorN2iY8hKltygtiyddC756PV7toArS1hNGTTEXw4cRUzJaSDjcdGSVSDD7Hd3oCCj573dUc1bMcrAJA6A/8g+GiG/In/Tvd4A2k/iHtr/4+X9/whD7hwVoa9jzE4j54gaTrEmW0Y1TXxwpOzM/inTnw724/dKtl2u39WiELYsyNxdHE8uZHNkYsu+VhZmr/x+Z2POP5BAgSMRxm72r95NTsWBGfHj+LUkhwq8jqNveJistC0eHfya0js/IDrwC2rpF19SLTzUn66xrR1PJz5/F7J8ALREg7YX20tmeKhr6w+lC58C/5STMnN1zoKBt4SVOTmXjJWHJk8AJ9ox5NvzlCEMFNGz4R3wOTOQoMv4e/uvQvuIl/uDcArRSGwvPrWu/8iRqxbnVX+szcRTzlh3+mbgVKcwCpDjM29AeDIGpTIlvzA//KNgZ1f3fArwcPLEEBGvoXHW2jqKEjPItapH4OnETt7D+LwPtzt09x1lgXHolEtBuXLoFqPpGqwyxw3u0e/v+dWgFSHspRTeYbJJTecFkMyM2T0Ic//YI/kjctz8VWpjqg7vXBWdAYioDDC08S52YVqa/Un99COmfBC3fz+HAL0UNwmR1ZS1ouqKmTj4LVVyTmjDcPSx+FjhWffnRTbNav+vVM/lsLjv3bUtoKZDF3J6qLGhQwn2HxwIUtMgJmjPxuJRjLUCGr4vi2aqol4TrO/bqbU06FjeTEoUtISEl4X6BYIQ0mm8mHjVFxJJ+ii02RQOqe0LmlYpQNtNC0AzzHmSglnKxeKLq5k6avQ5LC1MdfKjWqGVWVaJKZ4rLWG7qC3G4I5NBo2fOktMBYDCEfB5SGgdsvJG1kmIvhGz1kkFUYcCeiChdkUkGu+6IiShoj/ryuS7wjaXVy8bSxQWtRYL61kIPRimuE/rCBevoWlHSQ5jtcfjjAYScyrWLXAsRpSQfwBb50FF04giqFwkvqawvOUodhklMWz62yG1CZS4nM8Mns7fRoN4vltiIgf0Lj8fwHij9RCXRhqUPfUdqGWLQEQtHlbV4xbsdISy+I9nZdsBfrEJZ4rHMKHARTqUs3LUVYro/ni0WfwTOMPBkUmEuUEH+0hT2JSU0v1RofUmnlKlEG8RSKvsIAnzgCECf336DItYDz/r2Db4WL4UKQ5lJOZwIbYr8zjU80A/KHv7YY/XRSqQBetcEqa3WwgmjzXAibCmdkgU6YrbvskBurNdOXF3CjnhZ72scRcHqoV6vrV1fwp8w28TG/u032UKow9++pfQalFnm67dv3/4fPvqh6g== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the +subject and then tell the Ory OAuth2 Service about it. + +Per default, the login provider is Ory itself. You may use a different login provider which needs to be a web-app you write and +host, and it must be able to authenticate ("show the subject a login screen") a subject (in OAuth2 the proper name for subject is +"resource owner"). + +The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. +The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested +authentication process. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-o-auth-2-logout-request.ParamsDetails.json b/docs/reference/openapi/get-o-auth-2-logout-request.ParamsDetails.json new file mode 100644 index 0000000000..4994db7f89 --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-logout-request.ParamsDetails.json @@ -0,0 +1,10 @@ +{ + "parameters": [ + { + "in": "query", + "name": "logout_challenge", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-o-auth-2-logout-request.RequestSchema.json b/docs/reference/openapi/get-o-auth-2-logout-request.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-logout-request.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-o-auth-2-logout-request.StatusCodes.json b/docs/reference/openapi/get-o-auth-2-logout-request.StatusCodes.json new file mode 100644 index 0000000000..7d79d63440 --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-logout-request.StatusCodes.json @@ -0,0 +1,434 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "challenge": { + "description": "Challenge is the identifier of the logout authentication request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "expires_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the original Logout URL requested.", + "type": "string" + }, + "requested_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "rp_initiated": { + "description": "RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client.", + "type": "boolean" + }, + "sid": { + "description": "SessionID is the login session ID that was requested to log out.", + "type": "string" + }, + "subject": { + "description": "Subject is the user for whom the logout was request.", + "type": "string" + } + }, + "title": "Contains information about an ongoing logout request.", + "type": "object" + } + } + }, + "description": "oAuth2LogoutRequest" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "Contains a redirect URL used to complete a login, consent, or logout request.", + "properties": { + "redirect_to": { + "description": "RedirectURL is the URL which you should redirect the user's browser to once the authentication process is completed.", + "type": "string" + } + }, + "required": ["redirect_to"], + "title": "OAuth 2.0 Redirect Browser To", + "type": "object" + } + } + }, + "description": "oAuth2RedirectTo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/get-o-auth-2-logout-request.api.mdx b/docs/reference/openapi/get-o-auth-2-logout-request.api.mdx new file mode 100644 index 0000000000..f68221ebdb --- /dev/null +++ b/docs/reference/openapi/get-o-auth-2-logout-request.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-o-auth-2-logout-request +title: "Get OAuth 2.0 Session Logout Request" +description: "Use this endpoint to fetch an Ory OAuth 2.0 logout request." +sidebar_label: "Get OAuth 2.0 Session Logout Request" +hide_title: true +hide_table_of_contents: true +api: eJztfWt34ri24F/R5cxZnawJhHdIzupZl2cCJEB4hCRFDRG2wAq2bCybR7rrv8/akmxsQqpSp/t0z4dbHypgS1tbW9J+b/FbQidcc6njUZslrhIjTpBnUI4I0x2bMg95NpoTTzMQZqjr7lC37HsGyqbSyLQXtu8hl6x8wr1U4ixhO8TFAKmpJ64SC+KJxtlb0bAv2yXOEg52sUU84vLE1ZffEhQGXvnE3SXOEgxbJHGVkLCnmoFNk7AFSZwlYBzqEj1x5bk+OUtwzSAWTlz9lvB2DvThnkvZIvHt21dozB2bccLhfTadhj+azTzCPPiIHcekmkD1/JXDzH+LwHNcmIhHZe89Dle/HVCrGrxClCPPIIjqhHl0TomL7Ll4ooiEfc+AV3LMKM0OkD9LaCZVWMYH2xO+KlpwhF2CfE50WCOHuHPbtSLLg5mOug5hzRqq2owRzUNz097wFBpxH5vm7izSWNuDnLAFYbCOREdz20URWnG0MahmoA2WG0OzGfctgna270aA2e7hwBp28IyaFGgKk45TGGsa4Xzq2UvCptyDoRe77xGgLDqgIXRAA9VhwiZMvhDPg8fB0gRwQ4oFs0RyeCSG56kJe8Am1ZHtyBkDkV9eN96LIOiL7eCVT15S6hnlCKMZ1mHl8RnihCDD8xx+dX6+2WxStrtLabZ1rtsaP7dhE2STNtW189eNl5TjJsW4EzYgnkfZIo6rQVyC7DVxXaoTOY+Fac+wibhqThl6Uc2BtlFSvhzdXtg07Q3Rp5rt8qnt0gVl/MebDZVlN1Tt9geoK7sBxbuMwHpbtkvQqH/L0Yk4R+Tq/NywufflyrFd7+up2jhATIUALIGFl0RCVAeCT5hni2lKap2LiYTMKIWac8mesOtisbTEcrzdmaQacdfE/YVLiHJqsEXndOFLtoROXuDdtHx72x3Xa9Nuv3nd7AxeTidsQ00TzdR5oox7BOtHhuPEk4MFs1AUlDNzHMJ0ObXPIZSasApBeAO9PQN7iLA1dW1mAcnX2KV4ZhIkka53ypXbeu0F3Y0GQ0CVE3EIX4AdvoijKnD1bLSx3SUsPvWIxY9wyHBbiHmJXeHrlDDtCI97vxNUU3HemCRE0qTcQzqZUxbs4QAil1hJBiPOy3791aqrowdTSCEAqboik1pU7AmDBGxIcJEdcFeQR8c5gmefCXKQLbYck5whjbgepgyVe81wL/EUGhoErbHpE3mMYQ4TZs/FPk7J3Sxo3ekOYdkEiI1BPcIdrElGpoZIXCWCY2/tdNvClIlzjx167nPi8jP04XvH5h7/ycXyDNulb2ILTTVbJ9OFi5k3jTFSk84BUSHbmG+asJUC2elgzyMuLO///ZJOXn793yeM/+7z3y3+O//d+t04/V/vWMdZwqOemGnHN82a2sDfRYfq/9+g4pK5S7jxV+Mzw9pSMzBjxJwqlYYTzgG5vTrz7sTFZWcFa8tkVQJBUpVCAwkE9RUQOIsV2zYJZmpHc4dodL6D07gxiGcQV5zKfg+pgblkOBhxqqMThRVq1k5R1cTUAgZDmWb6uuCHorMcfMKCUxaoO7sAdABlQz1DPOv2YHTZ+wgtfJfC0QOem5qw5hzZFvU8oksWq5M59k1vf0Tn2OQkItRmcsYfENp36b9F21G/CeTs94ADSCIJ4aBhXyjHYqaeDZodoh4n5hxBNzFPDjwOB5AknWY7RYrvaHtTzSWCltjkf+tZVujQY9vyUBA0a0AnYKLNGiwPtSzfA8yE3GS2euy49prqsKgYjUbNWh4FsjbUM79HGWkQ/BCZDrZIgI7hW5glXYJ1IT4BQqCOKzHk2TC+4xJYsFBgTxhhehL4NdJ9QAPF+Mn3sOREc8knlHY0EA0DTGW3kCCHB05zCSiogZjEIEYJdj2y9c6EOgpGxYQxsiYuwguQKigClnK0JI4H0AzMDanPW3DomQ4vmQ3Wmwb6pSCULWSu/V27RM10SrYOMJEp/vykUV32QeVw/nNKTIGK5rsuYZ65E0hx3wG1kegSU49HxLS5wTuO0oCinE3iKkGZV8zvcabMIwviRpA+zgsO0VQnX34b9ZtSLQAuIKkgtA60ITPk4AVRG1sq4RIV4H14Bkd/v9ckY1NbLaqoosFNd3RbQzrljol3Uk0SLEdqj+FepGzCMEDTlmKZ5pgbH25HUFM07zMafVU2DdQ4oeHaczVVjlyicBYiBGguDT7ogxxiOyZsTGFl05lJJixUQOW8z5C3c6gGhiYiFqYmwrruEs7fKU7EdP5bfU3Z7uKnVCF5QvTPbcMqNIY1qmFPMIuq7F2GY+D5LpMWlkctwj1sOXGm8QuX51GRPtx8OvZIEvocWw+drKlGpnG95O9k8N9B6K9X176DzN+ksM1dm3l/VGNrAJD/nMpGOUcnlHOfuKeCQb7T4IQzDe3dbGhGJiwULj+ruB2jyZ+nuX0A/d8j8h/R3Vyw3V0pfDFDdA7Ui2hvYJnGSC+oPGEhmcVaHNGnD1YD3ZWfYsI+HAIwI0zw+D2qa/BGgRYgFJRQFWBiHXUAaFFGlH9FMSzH9qQyae6Q5ZseBWatUOJI+ghmwje5ABeG7/0L0TkiVOw5yvd75QzNbM8IPA5HJY48rvD4M0LnGlqjIbQ+FDz7tgIkEiCjSlvcd+BzkkJVzGAiNiNguF/tpTfw+kChloNeoZf3uvbLhJWjzAdVbZ2E7d9bky8TdrANmxa4JWgwsxMdxKYGUuW/Tq/QC1WvXyasLzmasgqCMWJ8DsCHVJDt6ls4GwtyhV58l11R4s2vxFbiV8JDdiWIlQRiXYFTcUawS9wYoJrgsvGp/RCWYs1i0j8lkYMZ/61S7gCJv16yvW6WR45Da9DtoDGZoTbZoQHx3nnCl2R3pNstONfsOYp254EKLXmsOvgTAWGSiHAbODWRUxZD4aQ1bp9OmADBU6iyCzi3ZOO2q+8DGa1xW47FhZRQFoqEq9twnEFzB8LvYMCwr+OSOXGFOw9btnQOWmcIm55h+wsjFl4Q3jcYaEA8jjTMkGbYNnBuG2HO6YIhjCyCpZPRjiAplU9C3QlzfNexOeFnwNN0wkHYxpyhB8EHc/Ge4kNBS2wuJgl0gs2F7VLPsE6jZA0iPVy5g1UbBMaHcALPbXfCQOyEQnVJdim09zpK8Ym4YfumHnDfGWjVC8q9QBQJtt8sd8post8/A7pg2PPB58x0VGeauxOoo3KAB2wCCQhkFOizM5MKG3C2Q19a4/JXcNvPCMJqBwlhqbycYPZUbdOkIDCSwLo45R5WZnZcfe8PsoXiUVPEXQNh9y17yQ9a6vF2w2mn1EwWb0juroQvHjPrsVccXje3+W1let3L3c3yA/48KOfXSdtdt97e+vTeuDX7/VKG4fHTdn5ffvIKlNeaxWk1e3s508d2vtHovV7fN9Ydu/+YnPJKa1dpTl0zOaws+POTPTLLr7nWZXZsPWUpm5WTvc2uNee42axp5KlSTZLH5JZW/eLqbrV8prm7zX25cVuc3em9+l36Ld+qaJvGMPeg03G52R/55er4fuM+3q2KF9ntxfzOx018Qy8ea9cLL0M9I5ur3s5xv261lv5l717TjJk39etPSWPlNp6KzBt6g7yDx+P711Jxe3t7mR8kh/Piurhd3l5mSr357aA7XBUfq2/btdnYvFVaq7LDysZss7p9dXrGYnSdztdrfXflDipa4SlTuSVrVmw6BSNTNgjnFSe3uV3eL96mrk20pZfczdZv7eFrfXDn4wVzVrfr7vDi6XJNmv4ie7fptZ6b2YdX7a2vZdZvdzxbeHQb96WaM9olZx3dKV0OrXX5caN5ozva0hc3pt3aZHPVdTq3aI7Kyxrjw9WztXRmzXlSc51Fp92w7nvTeq1tk5Iz7T0+Py/ms75Lcx27/nDdu7hbFnd1v3T72jKqpvGMK51Xf7zJJttmZd4t5xYXl5Yxr7BlkxFSaHcvret+Ib3qLTMPyTvbHT11ho2756aVXjbqRfL0MG5UNq2b2/aTcTPK5Ws2bWceekm+fnaqWb981+iUp6NWfXN3Wb3Pzkorkk8WyCXebe7WG80vu/1luVKwKs15F3db2M5Zc3/ZLteP7mYnvp2v87z3uNSKT/hyV7Jb48tp8/Y1v/Udx0+bb3R6c/EwXA5K29fCQH/MaXY9bVPrabNt0iyxhmWfpEddXNCdReN6V2nltZJ3n31o5NPZx76/aNeGvRJePhkNu+CVyxcX92TasTz/6VnLVXNWrpnNX2ev1/0CH9S2o125k31blW7n7LI+snjRfcp1Z6UnQtvLIa28po9OZxWfDr80yzeX88Wiwu1Gv9TFWrY/rWcXm2wp6w6zy+tu2Vg3TbM+rGfI3C0XDX80Wt/NK9qdw0rmioyL67c39vRUGAzuGxfOnV6d4kUzx65LzZmTqYxm6daIurjfWY3mt4Z2P5vql9eNfM24IBf58azP7VnfZv7r8KmT2VZxrzjsFjOv67H7mLzNlLzt4yZ/mb+faovlsemQ+GzK9+XKsWbLgzXEm8XCb+yu3XEbry/Kj/mH9mhxtOMx16kUJ0uqgzhZkp0wC2IiOghKW1ikWihbkGqhzBBauWwng1sQo8RMI2fCLyPFpBSwWEQG7Tn0DYU1DuTqhCnfJuDh2qYJ7j8llrjn+poQK3t9QiAdGHIT5jOFGtFTCI3BcIo1imQlHI58hnQ6F7qAN2FR3AL1YkC8wCkGclOn3KNM8w4GSCF00gWFXy0PklE5zdiDlzO36MLwUGD4cbDmDueD6FxEF3fIwGsSATBJLL1dsFqwyKfB9GaQzeESkftApcEorKkJAyN9jU0RAjBBlcQeXUMPad9FFB3kcxUmtVKnkvQKM6WMSc+jhjlJcsI4BUDKMxeXvpliOqfPSRrPS/N84fKoeF16R5Ip1JiHk/xQwREahr1wsWNQba/uTNgcW9Tc7Vc80HTOEPdhK3M0SfQH5UkC9I1Jol6dJFLhyIqmUgWasO/oQOhQBQL9VdqR/zlFJ1yaPbKfXpn+oHxsMVicsayHK3c72t33zGk2jVfzwvLxZlN7domZbNvrplPiF2TTsvVs/fHGLHljs1/JTfvEyuXbm8p8Zbbvr50MW2EjWcjc5Ftvrr8iaa3RK5SMXr3pFccrd82sVvVxyzp+s1LI0cepPxo9Pt7UbioE96qDvt1pvXV2/NVu5dLD5oi3K5S6RgVfzLO5Qu9x1qY3uq/dkvVDsae1t62C9lR662ZLxVXrtjIe9Kxkt0nWmxVv8kHzJp+/96xLTu0GXRrL2e3GXm3G3f51+SnNzOLj+qFrGuWafvtaGawGZTLMNHp+tVZlj5u3aq1f6lw2G5Vp81UfeI1lNek+eNl2ofI07+lpLbdrONP1TT9TIH09/dYqPd5fbOxKtfTAONaKdS/jtAeFS+exmC0Ua72xXxrV9HrXNtvl3kLTp4tsxylfFLUybkxftWEp/XrZdutvm9JwnWatyjXhfvW113m95tP2m74cD0ePXjZ3wy7vW1zXMnfPPh6n6eqxQpybp/mTveoQ8+3BI5nMhZevbB6c9HJ0V9yQdHO1e6ya+HnRbZYGyXGtsslOu2vdKpFCxzKeyjOz/mDvFtpj6SlftG+KszbF1ft5u9qo3Wn9RdWwyEXZrmd2z89PvDfD19Nc87XnVvO3lbub+03JvbvUx6+tUtN6pdr6OeOUrbS+TbZvqr3crtB7aLvbSm2eeRt0eaW/7A5eK6Vhr1tjrbu3YvJVLxhD73nrPPc2PbupVzEbPueea0W/X3GGVm3jOf1rq5gb3fOMVWiMe5tZephtNo4qBweqTrEzWz5uauORQZOkXyhUF7N59qKxvK/Vxk1sdXHNTbuvmVV6npk36m+ZcaE8TV8+ra/Tlw26zpS72WSt1DdLi0HmYfmWpem36mDFdrtSOZ0tPHa1/pp279oXrLmt57s3016dL+2S7jXdWW5o1bPG6HFdXVpvm8s6HzYyt/eV7nW1SH1+O3wkTrOa2V76y2q78Xy/1hdevTu7Lyzf9MuOsUpq+soakLuHW3vbu9UzM3NNH4aXD1Ypuctkq96TQ1o3XdyseQ+9W7NitGjF7rXHi9x6O7Dyj9umSTtdMl+RRdPk1rCJc3fOoDgem9V2bndjYC99n3T729pW39EH/Xq6eWutnXRzM81uLH7hkGRv0ek9rUfjm8uWY4x7hXau9LSqV2ir8Xh/jPAHSlm6nGlYTnfcv8xM++Wxs3LJeIDXHfw8u2SPpE0rdrp2f115y2Vrs1V7dV8a5HGlZc36RkvTvNfq7SumLEnXvpe/uPDKozvrrbV5aNVqq+zdc2NTvbxP5h+enq3GKH/Tot7u3h+83TyRYr7/2knWp537dHY4Nq5z99fjomuvilrhQru8dN0Rrw83rRbdDEp3BSdTuKP+WyFXw93XddJfrRrlxny36RTGy+3NzMUV7fXGu6P3/u5+dr9aVhtG0sbsZrl56pCdxzvG0M9a99amX6j1s679nGU92nitFhnXl8nyRT03yG3u3p6eGpuL1/VsPLafxvblupJPT++esk/pxtP9YKXV3rRKU1tN0x5jmM9zD+N8Q98WrVK6/9adZRucmexi3X4sHyc8PdAMd3dTp9hyH3cD+pbx7MaiPRs/JFt6M/d6n985/qU7uxtvc+59qzK3vHTDfnpbjJrP9YdGXeuuNsTqd0qZN7tWxjhZWabb48517bV181zTa1bDGOfKnQuzmXT87XJq3TxftzIZd7vrl7qFwuPtgOQGPas/b2+em8XdKJt/3q7v242npqeb+qh9/dYtNnHxbdg2yg/90bHp+PxIcB2SgE8mCcefmVIDBek+SZwe6gShqwN0LFtqUmjfK6Wkp+gcV3eJ5Zj2TsUimA5qEQmCHhDsjAwdKMcioUs5OtgC6djDINjXxFUxE6HkBX6RCbOZaJNCD3u1VLMty2bmDk0SnArfTtjhVKonhGnwmIQeldO4VOf0qNa/jW+KeSnXbeVq2W0jU1mU1v7s0rslmcXN3dvDRZGUhj6/9Hs36/5D/eiibAvaRwrbtiDwe0wV0pcirQ2MBCCeZmDKovpbRMMR70Cll35yla3ZazcfoyA4+tJvVAvZUvqrUnzewRcWQBgYhvA8gBcqWehgjHZScS0ZUU4hVMeaMWEqmB7zIKo8Wk6K+SRh4HXW0cmAaEJbzgNcQC5fzJe+omRS+hplc981gx6nqFbvoy/N4Sj1WLxMpzKXl/mv7+YpsUpJ7+m7l4pswYaCHShnEWRdiogYdSFVMNLv57Itd/Htsp026m99/9LKFW9uO1PPJ8XC5W3HeRwXnepu4NHl02u7OW4W8BEh/C2aGf9FHGip8ktb9Ew4OL+G3ezZK9G8iOca0t/HZNYmu/eYfvtMN/BjK4/3J/MsDt3gEKwDdzbE7JQjVzX9hb9v/KU1bn9Fuq35kCWrcnSDDoID8DCdOHASD0TGxRmie81fcitorozhE34aaQtMh8fibyGr4BARtSKDSkYXWLAQ3sMmt8OUUeHBDeezZy3CSj3hp2eR5GjB6pTBqBARQUHRB4VVDcG8gvGFHS5CdWpCEwaO4YOxxAgW1gnCa0xF8AOSsoB7nwB1RzxmAYb2Tr9+P2r26zVZDmCaEpg6v6F7X5+wgARRrk6wZkCHX3hUXuAFSaFyEAPgthVxoasw395qF+apHWZnAxYw1wmLLEl8umdIt2FZuQ34Q/5uv17t3t3VO7V67QzYFhXxRBOShjnRfJfsF3Fb0N5Ha2FkkZyu0tmQZMEhM1T1EYHXJUh6U0sj3TYyC9KNcBWVYMw9lQCmgInZwJsJkw4hzwD3TpAVFmc777jN68abyjDg3xqDg1j+JxkCRO+D2H05mnAVbK6AHYeZOAD86OQt4mGQ+4IPK8yAhfTx5o5w2Hf7NQOZA3wsFXkpcwZsd8nRhpimdGkAgDM0uL+VWXeDDV4siBsZX7HHb2cJe8OI+4kpd6GdKKCAD1L+BYJRJWcEkxYgA4/cIaCjRHBsk2q7TxK/JxoH5JffjiW/CcrI1HkRjztMs3RcusbaDsnBQwYNfBZDbQAgMSMcGepo6wR0QFHpYLsLzIIQvGabJtE8fiZY8BkoHIJhS9rrlGsmhPeg4onbDJtSzTtOBu4FKSUu0alLNJFbciTEGpS39GzuJfuqbSSrRGYrBDqOKA2AJEWT7tm1TNeQrJxKMRDWNwAFoE2d6ckRFzUh8AeVFzB94e+SQwrmqBZ+wj6aQIQ94bn4P6gzMzAk+xAW1IMdhD5/qJn8gEzvNk9IqoBGwQP4fhh7DrI3gkGQ75o8lPhauJ/jRRWRmglVFARJhZDw/ZMziyaU/Z2M8Rgmf32GwjEs/qakO+W+lWk20TX5YRJYbcewRbX9btwDipUEyZ25fxmpExRpBrN9IaXvgLZ3hhYQsLBdpBOTyOwryXuzodLV9GRFGFMJZDI7VARg5F6G8D98/w6WR/lWjB7fzWD+PDWUih19FstzhvkBs/9pMhyfgOB7UykWp0onnR5NtTiYg6oSRl3RVSQ6AAnL+4ADqJkDsAIGX0FnjKReSG+/YLaBtRYqjIGiH4evlk9p0yLJzzQP20yY0vcpD0gbgHfJq2DaItdEZK7TBdsHQkTGmsLuu4T6gNseJ807cRSBEqiVsrbHFRplMhJM2csqIApo/koywdylwcGF6NKwZqicQ1U3zQMVZE5NwiN6vwLKicBMSGlZWeC5lKwFECsYBvKkkQi4hdaOCBEGBdET1u3JzB9l1MqZHJmhtJTeTTAMQan+00jXafRgTRioEhD8jORm/qywlObYp7Mf+6rD8QTIuHoXABeBuTArP9QkVE6khplMMlKPYymLkbrZfaIkUnmSHUJUltJhsXY8pfEKmIZMjm/WwgLLvQwf9ZuQ56iHGYxB63KkrPqwedA2gsR38jB/PgmRa7bzmaqhAbQDaogPMS084giCcDzWIOAHGwV0NFNl5Ilxgh15gvmEBXqu2NeBAyuXysUzXMGZVbzIX349PVzRCYPNL9LGZFKy2L0Ci1iZetwrCWhkJDbJrPybysm/V/ljjIcTzbPd6f6+gk8JmIHohZr7Ww6U1SAlR2CwiFJXJOvAo4Y7VD9jU/NNKSZ7nPi6zXaW7fMITB7NuR4qsRRyG47whAEHkicd0q3ZwiQHTsiYsqzSBo6SYUmdKUTyj964MFhSpypfImipIuHBE80FRfug7CUlcjVUYRMsJfibJ0yVa4eOI6xbsh75eFK8wCu4A+N76EkL5T2Syhz4S3D1pZSXb360g2RjwQCDDNaXKAQ+DYu/XlDtPYeO+LUnLDiGwlMU1oxFwQVnM5y5rL0SUQGqqxxzle2OXhxM3Q3lRN31IKMQx69RkCpywGBFCcvUIp5hq/QfkUabuDqompthTrXE2YdsSeV8B3evlOO3htwJ+FKNE2wB7mMIivJjLSUmoWkVBytPVeR+CyEPXo5g+nIFCe1iKqdoQIAmYYGoolGs1wt41l6il6tsk5vNJgmWaNJ3TeWnf0GBi195tG6Gw96BADAI1ombeocXmMQvV38qMlEkZra+g0GFM8Mj0yXZTeGijyuw1/e+6KG8sADcIHvCk3jV3wuzGZEd5UqooFZw1cqJzA+CvCB+hix7BkwNvgSXZcCJBEVKpCbJOR3nYsf24vd17o823FF1+0ebLVCt94r4B/vuOO6fjRoMiWsJHRTUVChoOOYwFAOp7PB3HiovgMAlhAkLnFQHTgh04LLCguu4WPN8bCKXmNLba1AHuKW3IapSKizZVLW5MXDxBppGHI8LIT9hgdYWd3MepZe0yz5Z8HiLwVwQPcKaR/n1hzWPJnSVg32+2hGmBrWwU2kGTUMF+Wcsv5ECIjYj0fdK8zsb8Jj1F4tVBDsTQDYBZACL7692AZkQZDSeKctBDRiUZbfGwwn70hoPv8LOodikb6KcXZTeCRyl7tMaDyRvDasoaKQwju5dXe/wkRo1LIcK62Bq8QkT4dXRsJEshRxTsCBpV0c0rsP7rJCy2UQtz5F99G3vjDncNMec2vFi7+N7IeLbGYKRB5UgxBKcjq/MVPh87jOhFGO4x+UHRrH5ftOoXQJHXnkt5L06OFIDeBuozR/cLBC+/asm5Ewpox6Fc3dkRr1m8FLdMCT8ES7E3uahKQsnYwNxq7DtbIcw6hNTxAl62PV26KTfOz2TwcclszdMxOfZ92IGUT3uWOayqlqVNzkoxZIytC9vVAETzPc0Dwosbf84C1P62ZHBlHKohhKMEo7MxlCaqNJqI6N9f29XA13xfYG+0HYXIkj4/h67gwPw7duhxmYfudfu21kin/m5i+YObpPbZ2xEzOW9S06zYQfChWVyFc4C9V446N7PIl7nFJpEnn3sVAVe+9uoM1DqITvbD4qUQryC9fmFo5lrb7iMU4sLJAI3RERDcFxb2K5geahJHDuZB6kMUYy/HmNYYfCholAY2p9fvKDz0JaV6Eph/7dXr+66tvuO6kQ8/bDx+/IEeDHVycw/IjBFL1SDl6i539HyGjYouwui+qDS6mSNLFs/HiIOholA/2iw/bMP4Rj0mHkqAdxQJq6YuCGmEznWsQJ0AUXWaMf9GkODxI+CurREBZKOcxcPez4XhavvcRI6/kC0EC6m6Gj5dOYTV4p8JyVGTEM6x49tu/hr4YLxXQq5+V9+S9juLhKTSFx9+Qq3WHp4AVdkqh0Lh2CbtN1dEpxQ4m605MzXlnDvTMLY6S5OClM9adCFkYC2QISBmJ68adPEbAFk3TlkIDBLnCVMPCNm4irx37a7O9cCFYDbvquJiVtgVaPfJgwhpFz/ZYeeye/V6GV2E/ZNOg1+icD65V+w+sCovIO7+H5FjGziEE5O/xW0xQ5tqgoX1TIc+yQG51QMYBJPccDwTs4rZRP8C52fh2asCG0wcVEd0U/3qP2G5L45k4mF39CvcCsfjeGROn6h6YkkxcHoE3b6r8S3s5Dm13aE1tLyi5LZwdoS0g8gyglYKbKfTNjEm0iWtPWgPAS+zq3wo83lJ9shDDtU2RuTxIJ6hj8Td8zt1yK5sKG1mDZoLWK0k1NY3Il3gD+6+hVNEgcPp+qwTBJAU2Vy/Y4A3sSLr+7VryiGU6pDNgdrDZ2wQ5WtcqxDudeUbw+WHHqCln6G3DPgHtA5hJRSG6XXTF0fXzBFzhTc/rVwbZ/pJ6enqdv4XE8O5n6aqm+J5ntEIg73Jbgu+q9fEaOmpODEm1tequG4lHnzE5unBp5OXPcMql4Eh5NRQmyaQLaXH6H58nKF/rmeTNgkISZ5+oMxGr5pSidGYMBE+sve3+C/8/O9hSOO68sH41+hI08BwnsUbN8DFPpxuD+cYRRBwp3TCfsWPTO9nWcIuROcG+B9H7Io291NAx+6GH//IAWC0OQpW/hGsvuUCqlXKwBHZ3sIyY10KDu0vgU7XjA/0dIRZAkayG9wPP6BatHLMeFqVBBm0gmHTZnaIlmUcCsFt0XCzVByi6Yc1xbhSLhUFjuUw+EGwANCDi4VdXYyUy8MU0DO3t4/Gj+o+1tiUoIZxjh0ZOLxwyt5npgG8InPohtwn3/I/GJ58i0/IhuO6o/iYpWYe3CPNQCDEKKm2a4uxEUYAoTrPtVdW4GwVdlJKehVl8xMmuUiTRHGCHynMngqs/jQjJj25iysJQwqD8H2AUgce5SLtHhxE7IAA22hTCwl51sN51cRqXnx+VyhuALw0ysRzZqA1jylbpL9MklU6uV+vT8ddtv1ziTxNVyCOpOpQ4odqoAKCytLA1cQkDE4WKJNBJdywHUPOLSwPB2qml1JJP8hb+AiHw+COVfzceiU7uV/ZMS9GrCHfxoVwftLw9Gv6JfDZ4EI+wX9AwSYkl7Q23N3Ck+J6zXxIpZzcH2TcjKE/CFoD8iEbPXXGP6gN0yPs56TQ/RO9xAF7ziZKCVYQQ6iiECA5P/5GPCVYKtRaBJcFE31lggWhkJOBktHrt7jsW8Qk2OfQwf9kwuM0D8ROU18E5osFO3AxdigpkdUUrCxgrzeD2+RPzkN7pGXmm3s2vhq5Nb4wxykuE4eZbmhWvjurnl5oTx454YS2rFr7eEqJPsQ+Y8UEG8bUSf+lJnEkBbXbX0Wa0dK2fdk/2jPfg/h2I39e4y/j+5naXxy5FnK0k+FOUW2HtTj2kxitSQ7qKw4bi6dJURY8JjZBOpH0DfcoGH7/9mo/7NR/9hGhe5BnBhwFyh6RuIqcS52ofqVgHOR6BqUsZxLnEHplSlaYj7CPx6qXr8phWvKTX/x7aj6dS42srxUPrgJKewSD1vvFbl3FHkSP/bg7lCHeJAoj3oSCgIoKfRk+yJyOafi6tYguvol2gPyFWyTfD0JkNfkA/F7Cdw4D5A/V9fCni+Il+Qe3Hyrn6YUFQOVbiDyTMR8ZHg9cNIJ/7YKuKsVhvHEddFCB4u3lI/eNZXrIcIE8OsZwi0YVd2qytEUeziKLY1gMimdWHYwwcgiJ1S2koBsz+cmZeJiEpVbFGy+d+lAKlc3uDv/BJsUS1X2RUFRqbQvcAzij34evvxxFwYhgiAEIyILB5ljKkEsDEp/kg4y2TfqW5NEB/IfOMbelUXaSiuP/mYNeKwZEdcHxzceaJlLsttvvHc/0qGBD9vx+HlQXhD7mQ5RDfrjLePuxlBBAkljZYdCad3P4i1LUETWmUnWxPzrpwG36LG5HXjEsQzYiJt8gVVKa/K/5Truf7cHMBvId4l3HtB/oCbzXFv3NWkx11T0Xdo4QXGZSpMQNh9wRJWxuSaC6ZR7TZ5C5fgLeBgmMIm7PsRkoWJLZYmJKj7UC0pGornhKdSTIwoookTO5l5wpQllQYCDS0vuH2hQa3PIXKI8LHKJ5AooY4bHvfEin22/gjJMHA64b4q5AB9GiudwQc9GRKkwW/h4QbjI1vkd3arvSkv/HdXsDTNtrAMA9O/8AxDRBfmT/v0O2CZj/9Dhg5//9yeAOA4WsK1h14sR5ovjz1I6We9PnHpwrhy3/Hxvop4epe2Xfr1cu6vvIRy4aLm+PJ+Z9uzcwpDKrFy2XP0917HrnUsQoElEaZvq1IfxoZi/IB7cpR3nEOHjPdZdd5eSBvz56Z+Jre0x8g5fgW3dpFvqRocyyDblWPuh5PfPUvZPwJYIlI5ie20fDrUH/eFwobf9P7ITFvb7faCwbeE1jg9l4TVh8Z3ACXY1IxW+OcdQToo175wbIETO917W0z+O7Ste4w/2LWArTalw3zrWK4+TVuzb4HGwJ84jAabTP5O2Ih9UoBTF+RDbkzEIFfGreKf/LtpJ1f0/grwEHpsCgjn0bnoHW1FiRvkBt4g9jp3EA6r/YaQdwzmynQXFpfs/hu3OoQeIqieByRDZvOfvT98fx1agdJRT9P3ZLj6U6892C2LxOMbRp+fwIXbe/lRsYagPzl4ffO6xoTTwkvAUtSNWWfBIffoQ0z8JW35cwkEAiGqEyatqAkXTEQVK2RRciRG3hOHsYfFa0Fj15ee3zWq9M6gns6l0yvAsU1gpkBLanauUUrDCPZtHYvqBygmWM3G51GNNIIYXVBhbqkJS4vUZr/GhSR3JOfmDP8CpNHhw50MshgpLTOXRSTfDl4RQqhOhYSt/NCsRZsXBVJW74etZAiI80Om33+C2lZFrfvsGj+WvdYITQqccFNfAl/OdmZ0Ev3xwij7CVDrejjhoAned8BwHLgyRJXGWkJniEadfWeTWRnq9S+OJOWGu68OACPvSotAmCjwFX8JXmO0isH/7TbYQpsS3b4lgEsqk/frt27f/Bw0L8Xo= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to fetch an Ory OAuth 2.0 logout request. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-oidc-dynamic-client.ParamsDetails.json b/docs/reference/openapi/get-oidc-dynamic-client.ParamsDetails.json new file mode 100644 index 0000000000..d1972bb4af --- /dev/null +++ b/docs/reference/openapi/get-oidc-dynamic-client.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The id of the OAuth 2.0 Client.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-oidc-dynamic-client.RequestSchema.json b/docs/reference/openapi/get-oidc-dynamic-client.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-oidc-dynamic-client.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-oidc-dynamic-client.StatusCodes.json b/docs/reference/openapi/get-oidc-dynamic-client.StatusCodes.json new file mode 100644 index 0000000000..059bf862f4 --- /dev/null +++ b/docs/reference/openapi/get-oidc-dynamic-client.StatusCodes.json @@ -0,0 +1,379 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + } + } + }, + "description": "oAuth2Client" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "Default Error Response" + } + } +} diff --git a/docs/reference/openapi/get-oidc-dynamic-client.api.mdx b/docs/reference/openapi/get-oidc-dynamic-client.api.mdx new file mode 100644 index 0000000000..152cb42b87 --- /dev/null +++ b/docs/reference/openapi/get-oidc-dynamic-client.api.mdx @@ -0,0 +1,46 @@ +--- +id: get-oidc-dynamic-client +title: "Get OAuth2 Client using OpenID Dynamic Client Registration" +description: "This endpoint behaves like the administrative counterpart (`getOAuth2Client`) but is capable of facing the" +sidebar_label: "Get OAuth2 Client using OpenID Dynamic Client Registration" +hide_title: true +hide_table_of_contents: true +api: eJztfWt34riy6F/RYe5ek6wTCOEVkr3mrsMzARIgPEKSpi8RtgAFWzaWzCM9+e93lSSDTUh3evbsmfNh94dOMHKpVCrVu5RvMZNww6OuoA6LXcZ6M8oRYabrUCbQmMzwknBk0TlBYkYQNm3KKBceFnRJkOH4TBDPxZ5AR89TIloFX8xSJYsSJp6P0dgXiHJkYBePLYKcCZpgg7IpwBoy1x9b1EAUQDAikEk9YghrgzAzkYEZGhPkc2IiyhAn1iTOibekBkmgmkDUdi1iEya4RKzlElYro5LDGDHEkJU3DNvUQAoV1CFTjbXDUNtzhGM4VmLIhqznwBxIhNd9gjaOj1bUshAjxETCQa5HOACCuQwJ81eOsC9mhAlqKLiGR0z4iC2eQLWJwksSRKMxZD4nCt+eMycMVQJCF6KQbomYOSZ6VjONODE8Ikauw8Wzwu1jtJAaDDSDh/3ODVr4xNskhqw2QVQgicIe5DHm1Hg+iYDTlKuV5XaEnnQjEwDmjkdfFeIzgk3iJWInMcclitw1M3YZA9agpqF3RQGKncRc7GGbCOLx2OWXb+9YkSBqAtNsCYlSiaRGA+agMMzFYhY7iTFsk9hljJqxk5hHFj71iBm7FJ5PTmLcmBEbxy6/xcTGhVFceJRNY29vX2Ewdx3GCYfvU8kk/DAcJgDDy28x7LqW3pbTFw6IfQvBi2K8jyNH2NMsDHtFvInj2aGVAGGjjIsmlrPiCdTnPraszUlosLEDOWRTwoC8xEQTx0MhHDlazagxQysM2+ggw2HctwkwjRcC5nj7E8szSi0qKOFAW9eDHYRPkgqGQTgfCeDakTxIZLr5HgEK8gXN5l39Apw39YV8HjwGEQFbHMDdUixYJVLTIzk9TwzZPbaAM1y1YiDy88tKPEuCPjsuXvjkOaGfUY4wGmMTUZPgE8QJQTMhXH55erparRKOt0kYjn1qOgY/deBEp+IONY3Tl5WIq3njct4h6xIhtPDa4TojHkHOkngeNfXZnlrOGFuI6+GUoWc9HGgbJuUzUHqPJ09i2LKcFTFHhuPxkePRKWX8x8yGCuo1VGp1uqilXgOKtxiB/bYdT4oDjo4k/5LL09OZw8WXS9fxxNdjzThATI0AbIGN50RBhENFuOBDJhy5TEWtU7mQrejUgg+I7nlYbi2xXbE5UVQj3pJ4v3IFUS0NWHRCp74WzkfP8N2ocHPTGlTKo1andlVrdp+Ph0zK451K4IJg88B0nAg1WbAKTUG1MtclzFRL+xxCiSErEoRX8LaYYYEIW1LPYaB60BJ7VGo2hXSlWSjeVMrP6Lbf7QGqnMhD+Axi6FkeVYmrcNDK8eZShAli8wOSacsWcl2SK3yTEmaQz3CCHirPG1OEiFuUC2SSCWUBDwcQucJK6w+g5W7/9a7rowdLSCAAqV9FFrWp5IkZCcSQlCIbkNuYoQ8kgnBOJDnIGoMeP0EG8QSmDBXatS0v8QQCHbDElk/UMYY1DJkzkXycUNwsad1s9WDbJIjVjArCXWwoQaaniF3GgmNvb0zHxpTJc49deupz4vET9OH3oHj5T25WSCuODMcko6mHmRhFBKlFJ4Co1CnMtyxgpUBnuViAWRS7jP2/L8n4xdf/PmL8d5//bvPf+e/277Pj//NOdJzEBBVypU3fssqagb+LDjX/16DikYlH+OyvxmeMjbkxw4wRa2Q5U8cHo4hzQG5nRrw7cVHdWcTGPF5SQNCNBIK6CgjqaCBwFouOYxHMNEdzlxh0soHTuJoRMSOePJWdNtITcyVwMOLUREcaK1QrH6OShakNAoYyw/JNZSLDy2pysGrVKQOlxwSdbALQAZQVFTNlV7VhdvX2AVr4HoWjBzJXWZCOTYUgphKxJplg3xK7IzrBFichpTZWK/6A0L5H/xBt+50akLPTluatJJJUDgZWprxcqXCQ5UwRFeA6IHhNrlPatziApOg03mhSHFTH2lQOWfd/61nW6NBDbLmvCGpl6eLMCJjxlCNq274AzKTeZI5+7HrOkpqwqRj1+7VyBgW6dmtnfo8yyvT+ITJNbJMAnZlvYxb3CDal+gQIgaGv1ZBwYH7tkGwV9pARZsZBXiPTBzRQRJ58D0vl6nwCT+XfBJhqdyogyP6BMzwCBmqgJjGoUYI9QdbiJHCc2JAxsiQewlPQKigElnI0J650pmaYz5Q9b8OhZyZ8yRyBPGKAfak8aKlzHS5+vNIRWbsgREb484tGFfUOKmzXP6HEkqgYvucRBu45IMV9F8xGYipMBQ+paWuFNxwlAUW1GvDLmMhldjiDzz8lXgjpw7JgH0198tWnfqemzAKQAooK0upAKzJGLp4SzdjKCFeogOzDYzj6O15Tgk2zWthQRd3rVv+mjEzKXQtvlJkkRY6yHre8SNmQYYBmzOU2TTCffciOYKYY4jMWfUkNDcw4aeE6E71UjjyicZYqBGiuHD54B7nEcS1gTOnd0rFFhmxrgKp1nyCxcakBjiYiNqYWwqbpEc7fGU7Ecv9Hf0w43vSnTCF1QszPsWEJBsMelbGQwqKk3i7AMRC+x5SHJahNuMC2GxUav3J1HjXpt8xnYkHi8M6h/TAJxJRGUbvk7xTw30HorzfXvoPM32SwTTyHiX/VYqsCkH+fyUY5R0eUc594x1JAvrPgZEwO7eJfaEyGbKtcftZwO0STP89y+wD6HyPyv2K7eeC7e0r5YoboBKgXst7AM42QXlJ5yLZklntxwJ7e2w10W3iMKPvtFIAZYVLG71BdQjQKrABpoGxNASb30QSANmVEx1e0wHIdoYxJa4Ns3xIUhLVGiSMVIxiDqp9OIYThi38iOkGESp6jfMcrJ2jsiFkQcTiocdRxhcefUTpXMBr1YPS+4tmNlSCRBBk22qKxA5+TBCqpOL7DCDjulzvtDbI+MKjVpJfbsHTI1n4esmiIueSYZDv+vTf5PGR7bFizISxBg5UdmaA2DdAq/3V8iZ6p/vp5yDpKommvIJgjIucA/JYKOoi/hrMxJZfo2ffYJSVicilZiV/KCNmlJFYciHUJQcUxwR7xIoDKUspGl/ZDWFo0y0X/lEYOVvy3ark9JP56zfaymh84DvVuq4kGZIwaZIO6RLyLhM/J5sBrNxBccyYo/DoPTGglY/XBH0oIw1hI2sCpCZ2yCApH9UHjeMgkCJ5AxU0guZUYdzyTeAHo+qCh5uJSS2gPRcE1HTjOYLkD4SHFtnvX9ciEeDKch21HBQftE4QtMXP86SySXpDRN5ioSwSXSTpj5jgguR2EOadThjCyCVZBRieEpDI+CfUg8ee5Dif8BGSaSTgo20gwdC/5YE3fU7wnaYmt6TCGjrA1dTwqZvZxmKxKg1ItorZjZMJRBoEnjidTcjulOiebBNpFHZX6RHzm+JYZSN8xWNWQTgxUkRT7tUKzgIY7/unSKcPCh5gzM1GFGd5Goo4KAR7ABAoQ6CiwZ8cWlT7geIO+1AeFrxC2HxOENQdJZamjnOD2lBzLoqAw4iC6OOUCazc7ar53uqls7qAr4i2BsLuR7fgHI83ouN6oma/Fc9ckfZvH5w9ny4HI9a5q68y6OLpqp2/HmS5/6hYyy7jjLeuvrx16N7uxOp38GcODx/XkrvAospSXa7lRKXVzMTYHTqZabb9c3VWXTafzEB/xYn1TrI08K94rTvnTo9O3Ci/p+kVqYD+mKBsX4u3Vpj7huFYrG+SxWIqTh/ialvzc4nYxf6Lp29VdoXqTG9+a7cpt8jVTLxqrai99b9JBodbp+4XS4G7lPdwucuep9fnk1sc1fE3PH8pXU3FGxSyVLt1McKdi1+f+RfvOMGZjMfIrj/HZwqs+5pjoiW7GxYPB3Us+t765uch0471Jbplbz28uzvLtyU231VvkHkqv66VVXb0W64uCywqz8Wpx8+K2Z9P+VTJTKXe8hdctGtnHs+INWbJczc3OzgozwnnRTa9u5nfT15HnEGMu4pvx8rXRe6l0b308Ze7iZtnqnT9eLEnNn6ZuV+36Uy11/2K8doyz5estT2UfvOpdvuz2N/Fx03TzFz17WXhYGaJ/S+vm9Npy6qtUurRMpqe1fmFeZry3eLLn7rg2iRueO202qvZde1QpNxySd0fth6en6WTc8Wi66VTur9rnt/PcpuLnb17qs5I1e8LF5os/WKXiDas4aRXS0/MLezYpsnmNEZJttC7sq042uWjPz+7jt47Xf2z2qrdPNTs5r1Zy5PF+UC2u6tc3jcfZdT+dKTu0cXbfjvPlk1tK+YXbarMw6tcrq9uL0l1qnF+QTDxLLvBmdbtcGX7B68wLxaxdrE1auFXHTtqe+PNGoXKQm90oO19lePthbuQe8cUm79QHF6PazUtm7buun7Re6ej6/L437+bXL9mu+ZA2nErSofbjal2jKWL3Cj5J9ls4a7rT6tWmWM8YeXGXuq9mkqmHjj9tlHvtPJ4/zqpOVhQK5+d3ZNS0hf/4ZKRLaTtdS2WuUlfLTpZ3y+v+ptBMvS7yNxN2UenbPOc9plvj/COhjXmPFl+SB5eziC6HX1iF64vJdFrkTrWTb2Ej1RlVUtNVKp/yeqn5VaswW9Ysq9KrnJGJV8jN/H5/eTspGrcuy1sLMsgtX1/Z42O2272rnru3ZmmEp7U0u8rXxu5ZsT9O1vvUw53moj+5mRl345F5cVXNlGfn5DwzGHe4M+44zH/pPTbP1iXczvVaubOX5cB7iN+c5cX6YZW5yNyNjOn80HJIdDWFu0Lx0LD53h7i1XTqVzdX3qCBl+eFh8x9oz89+OKh0KlSJ3NqgjqZk410CyIqOkhK21hAmlT7gtTY6gxplatxKrkFOUrMDHIi4zJKTSoFi2Vm0JnAu1tljQO9OmQ6tgl4eI5lQfhPqyUuPN+QamVnT0ikA0duyHymUSNmAqEBOE6RQaGqhP2ZT5BJJ9IWEEMWxi0wL7pEBEEx0Jsm5YIyQ+xNkEDoqAUGv94epLJyxmwHXq3cptOZQIHjx8Gb218PohOZXdwgKEUKARjG5mIT7BZs8nGwPKg6giVC7QNVDqP0poYMnPQltmQKwAJTUpYx8cC/Cxk6yOc6TWonjhXpNWbaGFORRwNzEueEcSrroRSTRbXvWS6ZNickiSf5SSZ7cVC9zsWBYgo95/4iPzRwpIXhTD3szqixM3eGbIJtam12Ox5YOieI+8DKHA1jnW5hGAN7YxirlIaxxHZmTVNlAg3Zd2wgtG8Cgf2q/Mh/n6Gz3Zodsp/emU63cGgzWFSwLHsLb93f3LWtUSqJF5Ps/OF6VX7yiBVvOMuam+fnZFV3zFTl4drKi4HVKaZHHWKnM41VcbKwGndX7hlb4Fk8e3adqb96/oIkjWo7m5+1KzWRGyy8JbPrpYc1a/q1YjZNH0Z+v//wcF2+LhLcLnU7TrP+2tzwF6eeTvZqfd4oUurNivh8kkpn2w/jBr02feOGLO9zbaOxrmeNx/xrK5XPLeo3xUG3bcdbNbJcLXiNd2vXmcydsC84dap0PpuPb1bOYjVoda4Kj0lm5R6W9y1rViibNy/F7qJbIL2zatsvlUvsYfVaKnfyzYtatTiqvZhdUZ2X4t69SDWyxcdJ20wa6U3VHS2vO2dZ0jGTr/X8w935yimW8veMYyNXEWduo5u9cB9yqWyu3B74+X7ZrLQcq1FoTw1zNE013cJ5zijg6ujF6OWTLxcNr/K6yveWSVYvXhHul17azZcrPmq8mvNBr/8gUulrdnFX56Zxdvvk40GSLh6KxL1+nDw6iyaxXu8FOTs7F5ni6t5Nzvu3uRVJ1habh5KFn6atWr4bH5SLq9SotTTtPMk27dljYWxV7p3N1HjIP2ZyznVu3KC4dDdplKrlW6MzLc1scl5wKmebp6dH3h7jq1G69tL2Spmb4u313Srv3V6Yg5d6vma/UGP5dOYW7KS5jjeuS+30Jtu+b3jrYnly9tpt8WJn3uq+FPO9dqvM6revufiLmZ31xNPafWqv2k7NLGHWe0o/lXN+p+j27PJKuJ0rO5fu3/EzO1sdtFfjZC9Vqx40DvZMnVxzPH9YlQf9GY2TTjZbmo4nqfPq/K5cHtSw3cJlL+m9nC2Sk7NJtfJ6NsgWRsmLx+VV8qJKl2eFVipeznes/LR7dj9/TdHka6m7YJtNvpBMZR9aRmdJW7eNc1ZbVzKt61G7wudO3hQ1b5zu2ZXUrP+wLM3t19VFhfeqZzd3xdZVKUd9ftN7IG6tdLa+8OelRvXpbmlORaU1vsvOX82L5mwRN8yF3SW39zfOun1jno2tJb3vXdzb+fjmLFUSjy6pX7dwrSzu2zdWcVanRafdGEzTy3XXzjysaxZttshkQaY1i9u9Gk7fut3cYGCVGunN9QyL5F3c66zLa3ND782r0eq1vnSTtdUotbL5uUvi7Wmz/bjsD64v6u5s0M420vnHRaVI69WHu0OE3zPKkoWzqu22Bp2Ls1GnMHAXHhl08bKJn8YX7IE0aNFJlu+uiq/pVHm8aCzu8t0MLtbtcWdWNwzxUrp5wZTF6dIXmfNzUejf2q/11X29XF6kbp+qq9LFXTxz//hkV/uZ6zoVmzu/+3r9SHKZzkszXhk175Kp3mB2lb67GuQ8Z5EzsufGxYXn9Xmlt6rX6aqbv826Z9lb6r9m02XcelnG/cWiWqhONqtmdjBfX489XDRersUtvfM3d+O7xbxUncUdzK7nq8cm2QjenPX8lH1nrzrZciflOU8p1qbVl1KOcXMeL5xX0t306vb18bG6On9ZjgcD53HgXCyLmeTo9jH1mKw+3nUXRvnVKNaMxSgpGMN8kr4fZKrmOmfnk53X1jhV5cxi58vGQ+Ew4emeZbi5Hbm5uvew6dLXM+FUp43x4D5eN2vpl7vMxvUvvPHtYJ327urFiS2SVefxddqvPVXuqxWjtVgRu9PMn7065QLG8eI82Rg0r8ov9eunslm2q7NButA8t2px11/PR/b101X97Mxbbzr5Vjb7cNMl6W7b7kwaq6dabtNPZZ7Wy7tG9bEmTMvsN65eW7kazr32GrPCfad/aDk+P5Bc73OCjoYxXUENxoHPyTB2vG8TbEMdYGM5ypJCu7cSWnvKl6PmLrFdy9noXAQzwSwiQdIDkp2hqQPjWBZ06UAHmyITCwyKfUk8nTORRl4QFxkyh8kxCXS/M0sNx7YdZm3QMMapjO1sXzhW5glhBjwm24jKcVSrc3rQ6l9HmWKST7fq6XJqXT0rTvNLf3whbsjZ9Pr29f48R/I9n1/47etl575ycFPWWeMjg22dlfg9JLLJC1nWBk4CEM+YYcrC9lvIwpHfgUmv4uS6WrPdqD2EQXD0pVMtZVP55Fdt+LyDLz2AbWIY0vMAXppk2wBj+CWd11IZ5QRCFWzMhkwn0yMRRF1Hy0kuEycMos4mOuoSQ1rLGYALyGVymfxXFI+rWKMa7ntW8MYxKlc66Eut10885C6SibOLi8zXd+tUWCVU9PTdl5psAUMBB6pVBFWXMiNGPSgVDL33c9WWmyi7rEfVymvHv7DTueub5kj4JJe9uGm6D4OcW9p0BZ0/vjRqg1oWH1DCb+GK9C/yQCuTX/miJzLA+XX7mjN+IYYIRa6h7HxAxg2yeY/p22degzi2jnh/ss5iPwwOyToIZ0POTgdy9dBf+fvBX+qDxldkOoYPVbLbXggNGw4035YTB0Hirqy4OIEOheBcKGkFw7UzfMSPQ2NVJ0M4/7YVFRwyonZoUiXoAg8W0nvY4s62ZFRGcLfr2YkW6aUe8eOTUHG0FHXaYdSIyKSgfAdtuwmCdQXzSz9cpur0goYMAsN7c8kZbGwShJeYyuQHFGWB9D4C6vZ5xAPc+judyl2/1qmUVTuAZSlg+vxuw/vmkAUkCEt1go0ZvPArD+sLPCUJVAhyANyxQyF0nebbee3SPXW21dmABax1yEJbEl3uCTId2FbuAP5Qv9uplFq3t5VmuVI+AbFFZT7RgqJhTgzfI7tNXGeN99lamFkWp+tyNqRE8FYY6v6IIOoSFL3prVFhG1UF6YWkii4w5kIXgAUtMrAa+GbIVEBIzCC8E1SFRcXOO2nzshIjlQb8W3NwkMv/pECA7H2Quy+EC64C5grE8bYSB4AfXLxNBAa9L+WwxgxESAevbgkHvtvtGegckGOJ0JeqZsDx5hytiGWpkAYAOEHduxtVdddd4elUNSJFxePbScxZMeJ9YsktGCcbKOAXpf8CxaiLM4JFS5Df61R675Y5FjU2nyR+Ww4OyK8+HSp+k5RRpfMyH7dfZul6dImNDVKTbwU0yFkMvQGAxJhwNNNH2yRgA8pOB8ebYhak4A3Hsogh+IkUwSdgcEiBrWhvUm5YkN6DjifuMGwpM+8wGbgISko8ohoAgSgHUqxBe0vb4SLe0WNDVSWqWiGwcWRrABQpWnQnrlW5hhLlVKmBbX8DUADGVJgZ73PZEwI/UGFKZCMkCtCTwnHXw/jBAkLiCU/k/0iNgjpPNCaEBf1ge6nPH1omPyDTO+bZkiqgUfAAPu/nnoPqjWAS5HsW32p8Y8vP0aaKUM+EbgqCokIo+P7JlYULyv5OwXgIk7++QuEQFn9T0Z0X6p+N7MkPi8C+14gbbglSnLn7MtQnGOkFhroiF6y9EzSFhIXjIZNYRFVfRdttVZ8wVyX/soBMVYfKBIyx7ciFz9/B8qDcitDjuxXMn6eGNrHDzyJ1zkE770+T4fACpNwbKbU40jbp6GCpxd4aOlpktuSrstABSFjYJRzAzOyCF9D9CjZjqPRCRfulsA28ta3BGBj6Ufh6+7Q1LYv8LGt/zJBpe5/ygLQBeI+8SKEta01k5Tqdsl0iRFasaey+S6gPpO1h0rxTRyEogVmpens8aVHGQ8mUna4CooDlrzUTrF05HFyqLgMbM11zqPuVeWCCTKhFeMju10A5kZhJLa06C4RHyVICsYNpoE4ayYTb1tuRKUK9hMSQtdqq8kc7tWolB1aoPKV3C9ymoPT7o9Cro/DBGjIwJSD5GarN/FllqdyxT1c/dvQLhwsgo+ZdAFwm5rZV+VtLQtdEGpipIiP9OFKyGOqb3RVKIl0n2SREVyntN2tHSxovQWio4vhaedtgudPh/U4N6hzNbQVjMLoQaqveHx6MDSHxnTrMny9C5IbjfqZrqAvjgBryl4gVHgoEQToeG5DwA0YBG83SFXlynoAjjzAfssDOlXwdBLDSiXS0whWCWbnzzMXX4/0dHTJgflk2poqSJfdKLCJt6tGoJKBxprCJp9TPRFr9vMwcEjycGMLxRtuArvcpBdOVb6Ha9q3Aa1CaI3BYZKsrUn3gYccdup+xZfiWUpNtTnzTYRvb8XkIJg/XXPe0WtpKG47wkIEEUicdyq3Z1CJ7QciIsazLBg6SYU7dEWTy9X0M0dV359QtqS8RjNSZ8OCJ4YGhvdf2kpC1GrqxCbYS4s1Dptu1t4EjedUJ9CMfLoqXeGnD/7voKQ/lPZLaHfhLcPWVllff/IiD1GApAIMK1ucwBD7aNn89o/J7CR2Kaw9ZcAxlpGjbMxYGF5zN7cpV75XMClBT15jranf07GLqrSgn+q4HlYU4fI2CMpEDAStbWEa2vFhF0UCW0cYuYweuQomdfCiWPnNxizLjpFiA+xiCpvzISIXJ1rWKglWnKnS/hdQHBy9tuYSCdrmUY9QlbHdpDDU1jSJvPUNk7Tl8qck6vlqt4uCJxn3P0nH6ZxSE+HVE67rXax++6+UdXvKamss/FZkwEmPHhMtsnmUwQ5DRnGxGcNHHJfjru1h0T11YAGGQHeFJtOvvmTmMqBfVTuikVnDVypGqD4K6IH6CbGcMQg0+BJdlwIkEQ0qWJqk1HZZih3jx+zb3Rwx30Nz+EbMFpvXOEP+A7w7j/tmsQY94trRBu+qipoMBQzmRrg5/F6ESAQR91dOQBUGqvSAE2gtZYSl1PGwIH1vII5aK9s6oC9JSrIjulNq2bAaXGoXBRQcYBnEFl0p+yAKrLRrmPEgv5Zd9suHxBoO7IN/Y9jyqjz/sebTgVTXZ57sdYWnQCztSbtBoayD/jOfX10AkMxJzZzS/8wEPeX+RXEXAmQCyBiADWHx3tQvohKCi8UR7DnrCoC27PugN2Zf6oPcVOIdii77KdnbZeidxVLZPfdBVsnXbRUFDjXF0F+p6h4+yqGE7dFoHU5sPmUyv9nvVeH4rMaUIUn51yOLav0cKaZ9N9vIc4KO3XTBmn2neB7Xf3vYVlhO6iE31cWp194cvt6p4nuO9a4ch8umHg98X98IXI5OM/QPsJt9CZfgS1XYN2+oSI2haCXJioBBMskS2Yx5OsATThKB/NNnu2YdwZvSQcacAXFMmG7SviaUNO9URHm7flFBUh2PUK+jNSNjvugla/nUY9rBBLLDwuWz7eo+T1JBdOUI6aOHZMsmzTzTkfyehLJehQkuHWK6sW0oVXYJzIyHK/B2FItcv32Iq8RW7/PIVrl8TeAqXv8Xgzi1Igq/jjreJgw8nrxaKj31jDtc2xGYb08NxaenGZ3QKd76t40CFrlyfukHOwmwKdN24pCtRi53ELDwmVuwy9j+Otzk1ghPEHd8z5MptMErRtyFDCCG4pa7g0hP1qRS+CWrI3pTF/WsI0q//hM0HI17sXWT1G2JkFYVwdPzPYCx2aU2Xh+uReuajCJRjCd6CmyLMS61B/4lOT39wN97WJpRxQiZvfSLm8Q7Vb0ix0Ymq0nlDv8EVVzSCV+LQpX1HijDUHLLjf8beTrYkv3JCpFZ2U5jKLjbmkLyDHAGgoal+NGRDMVQiaS2guBo+Tuztrw5XvzkuYdilWlsPY1MqZv5Y3tC024z41IHRcp0TnxlytqNj2NuhoCa6/A0NY9Qc6SMxjKHT08As+R39gKYAdCiie3z5G4oglmiS1d6Ow0vYpVrdH3qh0K5p2ka3Ht4ERXeCvBMQIfDyFlJCsku7lrg6tEmangm4PGfqOT4zj45PEDWPE5U1MXxBFF7QUex56L9+Q4xaikpDMbFFoup6lInJkcMTXWESzzuBunB5rlUcHVsWEO35e1g8P1+ifyyHQzaMSfyPfwC/6luWMvED9R56X739Bv+dnu70vzyPzwdnv0Thy0jhxfczO76AmTtRcN9dVBgnwt3jIXsLH4P2RsykKgmOAkizD4WO421GQVBJzr17kADdZvGEI52F1CjosFYvRpe2/6oHRpoeWXBpZQ2WrJRgcqQraRAMUJ+Au39B5fD1cHA5ICgk5YZiSyV3lVyRjlVwXxrcjaK4LOF6jgzIw7WK2KUcDigA7hKyd62eu1G1KttAHVSt7CIE0XO2uychISVYRMyGFh49e0pUyWXAwf8suoEE+UVV2Cm6235IwJNtIDfkY8mrBSIO8g5rAAZBdMNwPFPK/G0QHC6807fNBFpS5+cT8FZFiSplmMpCHZgjiB6o9IGqY0FjYjmrk203TdB7A54NQOJYUC4LQ+VdoBIMjIVGiYRab2m7vqLU0dH1XCKluX96B8L5QhjNE/oOxS/DWLFS6FQ6o16rUWkOY1+3pK8wlTTXkkyHEtm2pyoQ00C+4ATJMSFcCoGw3BOssibSpXrYpULyF3X3DPl4Esy5Xo9LR3SnvEMzBjp8B/040JfoN/TrTvX8in4BxfM5rQMAhLfRiCpkr4iIZvm0q6E9tu/kGXdQAMutJP0tsizQ/SMwyUamgqSXc0TN4x0AKTmOhtqM1YAgiq7IEP+/H0C5lAI0DEhBCiOkvyVSdqGtCIO9I5fvUdgNiCioH2KC/sElMugfiBzH3qQBCqXqcB0smNchSxJ8o6Ca7YMrjY+Og0uNlTkavpR4P9X+s5cdRy81VjcXgzvaU3Bbew7f1NlH+LClINYho+B/DfauUqPvSX6QKT+F978X6aPwh4RtHku/h6wFdKA5TCE2JxuoJT7s4ZzEZCD8kKcD9kXw7pY5t+P/w6T/YdI/zqTwQpAVAdwllmIWu4zp27BPg9T96TdqvoERq2oQ5Cp8zwpdrPtN21MjbvnTt4PW1ankW3VrcnDVx/aVaF5mZ6e9o8qjvM3c26AmEVAJClf6y3gbQEmgR8eXofkJlXcTBumDL+E3ICHnWOTrUYC8oR7IC8H57DRA/lTfe3g6JSLOBVztaB4nNOECi60rE6lyPSp/FMTRZCJOZ5T0LsN88j5UHQYJj1SP3g1VGwFD5fXwMnIXtsxKOhYUediPbI2UKQmT2E6wQL278H9Mp+MlZGcysSiTnfc6eR5w2Lt8ty5GCy6HPsIWxcpSfdZQdK3YMzB/9NHPw1d/VIBB936ss71k611phK6A2GZdPkkHVc0WDn8pogP5vU2oGu1A38+BPyGx+ysNmEUZD4zJOdnsGO/dLfQG3PLpCn4a1M9G7qGX7U4/ZhlvM4ASaaiKKLgUekd+Fm9VYy3LKiyyJNZfvwy4JopNnCBojQ2p3+RVlSAulbP4P2ofd38CAjDrqu9i74KUv6AaE55j+oayhcs6vaRcmaB7QucBpUsX/YsnQIJCu8YTqBD9Ah5uM/SymV0uFloSdBmEbFNB7aAmOlz8mEBtNaOEIntAHC6Cnn3K0NhzVly5v0P2yy+oW25wSM1Tvq3iDiXDtM/CowFzqUB2O6jyINsJd0Mxl+C3qZAJ3ECxgvMIMQ4fTwmX6ejf0Y3+rG3x31HZWTHLwSYAQH/kH4AIb8if9O93wDYe+Yf2H/z8vz8BxGGwgG0Z/qZOmDBfXH+cMMlyd+L0g1MdW+WnO0/0+CBtv3QqhfJtZQdhL4rKzfnp2HLGpzaWCl/nwfXPUxN74lSBAOMhTNtEs9KLTsX8KRFwWWxUQmwf77BueZuEMklOj/9MbB3ByDt8JbYVi66pF55qRtYJ195NpT5/lrJ/ArZEonQQ2ytnf6od6A+n2wbE/y2cMHXe84HGto6XODqVjZeERTmBE+wZs8T2m1MM/VLYEKd8BkrkdBc1Pf7XsX3BS/wB3wK2ynPa8q1rv/AoaSXfBo8DnjgNJYGO/0zayoIniVIY531sjwagVCZEGLPjP4p2XL/+b0FeAY8sAcEa2tftPVZUmFG+Jy0ijyMncY/q/zLS7sw9wM6S4iqcH8F249I9RPWTwGUIMe/p+9P3r2MrUTooKTr+eBOdyvPHmymxeRTj8NNT+CVy3v5UbGGqD85eB0LqkakMCIrwBHVCXlnwSP/2IaZ/Erb8sIaDhA41CFN3MQSGpisr8FMJ6PmOesJw9rD8WtJYv8tPb2qlSrNbiacSycRM2Jb0UqDmqTXRNVPgeAuHh9LugckJnjPxuLJjLSCGCFrobN0CpPD647HhfUc7VCzyn78M+J+/DPjn/GVA7eJBWgdycVS66vL4fNOhpy+B8x00WknX8JKaUCAC+TwY8u0b3C7R96y3N3gslwJFJbv4kvqbgpTD72bsUt5w/h0GPwrufT/+UVLmo0UEPQ5sE4rmwi0PMnZLzdjb17eTmKJEKCBckJWGoVfelWVFgnRXlV5M/R2lUKPF1oHeVtd8O4zOt29qhGSzt7ctdjr+8fXt7e3/A0jsZd8= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint behaves like the administrative counterpart (`getOAuth2Client`) but is capable of facing the public internet +directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. + +To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token +Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses +`client_secret_basic`, present the Client ID and the Client Secret in the Authorization header. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-oidc-user-info.RequestSchema.json b/docs/reference/openapi/get-oidc-user-info.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-oidc-user-info.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-oidc-user-info.StatusCodes.json b/docs/reference/openapi/get-oidc-user-info.StatusCodes.json new file mode 100644 index 0000000000..7a2ad75630 --- /dev/null +++ b/docs/reference/openapi/get-oidc-user-info.StatusCodes.json @@ -0,0 +1,129 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "OpenID Connect Userinfo", + "properties": { + "birthdate": { + "description": "End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.", + "type": "string" + }, + "email": { + "description": "End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.", + "type": "string" + }, + "email_verified": { + "description": "True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.", + "type": "boolean" + }, + "family_name": { + "description": "Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.", + "type": "string" + }, + "gender": { + "description": "End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.", + "type": "string" + }, + "given_name": { + "description": "Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.", + "type": "string" + }, + "locale": { + "description": "End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.", + "type": "string" + }, + "middle_name": { + "description": "Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.", + "type": "string" + }, + "name": { + "description": "End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.", + "type": "string" + }, + "nickname": { + "description": "Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.", + "type": "string" + }, + "phone_number": { + "description": "End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.", + "type": "string" + }, + "phone_number_verified": { + "description": "True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.", + "type": "boolean" + }, + "picture": { + "description": "URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.", + "type": "string" + }, + "preferred_username": { + "description": "Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace.", + "type": "string" + }, + "profile": { + "description": "URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.", + "type": "string" + }, + "sub": { + "description": "Subject - Identifier for the End-User at the IssuerURL.", + "type": "string" + }, + "updated_at": { + "description": "Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.", + "format": "int64", + "type": "integer" + }, + "website": { + "description": "URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.", + "type": "string" + }, + "zoneinfo": { + "description": "String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.", + "type": "string" + } + }, + "type": "object", + "title": "oidcUserInfo" + } + } + }, + "description": "oidcUserInfo" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error", + "properties": { + "error": { "description": "Error", "type": "string" }, + "error_debug": { + "description": "Error Debug Information\n\nOnly available in dev mode.", + "type": "string" + }, + "error_description": { + "description": "Error Description", + "type": "string" + }, + "error_hint": { + "description": "Error Hint\n\nHelps the user identify the error cause.", + "example": "The redirect URL is not allowed.", + "type": "string" + }, + "status_code": { + "description": "HTTP Status Code", + "example": 401, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "errorOAuth2" + } + } + }, + "description": "errorOAuth2" + } + } +} diff --git a/docs/reference/openapi/get-oidc-user-info.api.mdx b/docs/reference/openapi/get-oidc-user-info.api.mdx new file mode 100644 index 0000000000..fee3189d4b --- /dev/null +++ b/docs/reference/openapi/get-oidc-user-info.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-oidc-user-info +title: "OpenID Connect Userinfo" +description: "This endpoint returns the payload of the ID Token, including `session.id_token` values, of" +sidebar_label: "OpenID Connect Userinfo" +hide_title: true +hide_table_of_contents: true +api: eJztO+1y27ayr7KXmU6tORJlO4nTOpM79bGd1G0Se2znZnItjwORKxExCbAAaJsn9cx5hfOK50nu7AKUSH2kSZve6Y+jycQUCOwu9nsX0McoRZsYWTqpVbQbnWfSAqq01FI5MOgqoyy4DKEUda5FCnrCX48O4Fxfo+qDVElepVJN4b1Fa6VWsUyvHL18Dzcir9D2QU9GiqEYfSNTTOF4r3IZbMebsJckaK2H9q2FRCuLjPuXCq2LR2qkjhTjTIRFwi8ql6FyMhFENaAx2vRBwNu3bwd783cIGYoUDRRymjkYI1h0ID0sg7YkTCN1K10GhTYIUk20KTxQMdaV45kMPoYzRLig77bE5HIjc660u8NhKpxwRiTXaGKJbhJrMx2mOhlmrsiHZpLsPHm8+cBiQlAHD3sjwuHRpeiEzG1AFWj1FMRRP9IlGqblKI12oym6Y5kmbyyaIzXRUT9qdmCj3Y/R9uYm/Um0cqgcPYqyzAOHhh8sCfdjZJMMC0FPXakfl6iODmBfK4WJA0IiPZLSEBlOeixjaVyWCofLIA5VOqB131oIs+o+GCwNkjQxBWFBKDg6O4bvdja3drc3Nx/BxdHZMX379z//Rd8v4d27d+8Gr14NDg4aRsB5hlCjMPBq7x3JcHNzc5OULuXNqSm4TDiQDqQFXUjnMI3hXM9xg1Z5zZIkMH3GEaDTGpHn+pbWvNYOPbAUS1Ss0dorS6VSNHlNI2UuHC3+1gIxAgzmgrY3qRSLuB9UnOZ+qKzztCdCkcZVOevfjTAMq9DKZSBUCswtqxmZLMocC2KasaAQU3AanLgm4qSFiUicNiCV0yCSRFfK0YREG4OJy2vCzwZFsIhES8rk6hKj3cg6I9U0uu9HWAiZf1KMpcEJGoMp4IAmg0hTg9bGcOSsN2x49ebsnCyWOMJkZginz/fh8cPtbbg4fb5PD5e8ckB2A7ZWTtx5qZ6e+PWvj8+JjTVUJfNbNtDHSFyqlPylwj4pUCptUlmLKXHxzNsUPI6frN/h1Q0aOZGYLm/13FQI0nuz1ra7m4VMWBgjKmgAPQXtMjS30iJMRG4xhrcZBrr3cyEL+B+mXlpwhgjnNwUKdqTCO5XjE3BaX4OYTCS7nBsE67C0xEVUtjLYTJZLNN0KdpPO6DzHFMZ1Zw8QUDhZID94yoOzpLUlGhIYG0qGgbRxDbeZTEgfF/GRQMLu6ZmdzJ1jgRLgvldhNhqytyBGpO1bBxMjCrzV5hq08WSLxFUiBzE1yIpugXywVIEAH23Y6YAwCMERqmlLzGOtcxSK5DwRhczrKyWKFW7prDL0YsP2CHsurIPZ967o2w5AKrC6QEiq3FWG4leJusyR7TgTNwhFlTtJIx47A7WEQun20FNyL7xqTLGP/VGfd8u4/Sqv5hZLYdiVjGuwpUgQkkwQr9CsNuEp8dt80ob9lNhrpIUUJ1I1GiMtNBIMIc8gTLAQObJA6SGGY1L2EMYbF1yRBd6S0iuU/D7wsoEfphPAEIbGOa7eg7xBtUZ2L+gdtMQ3keary286Q2L/VGHlOhH5p+Omn7IcNeHv+yePnnh3uvNo5xJyoaaVmCI4MSUTlmyiri5lIvK8buLszsPvB1uwl5eZGGxzrN15+P2///mvrRaERKeU9wDFQMP5FYk+AHi4tbOzAIGGPAiOPKaeQajK0kPod7kjIBU2i+G5NoB3goJbH1AN3pyxSM1gfy+GPdpmootSODmWuXQ1KO0IFIlxFhFZT62XICuhUD4224QSKuGDXkCvDRjB2ukyoQIdfYr8bTqu3pw9hVP0wf0keB3S8yTT2iL4KItl8MReRiGMEcJbzPOVAi9kmua4RrVf8cuvrMrFHOjX02XYy61mYayjp42WTV5px9JZyZbV/GhZwaTKcwZGqFJpy1zU5D44ZWsVG6KZRqGC2KKtleO8bk1x0uVEk0rBVpOJvONKxKRISQ3lTsZP04s5QJAyLfRZEKpkTR6lZHK9ek/7wlKUYxoXBOxZWYiaTID+EMvGPlpbmh80ee4dvf1IZZ1QCSVD0CAOuZKewCt5jfNax9dutNFcq6mVKYJoAWwvSzKBq5W4zLTCK1UV498INPNk0WGOvAz8shgO462dR3DBfy7JU50e7h+/enX4+uDwoNlpyMeZT00etWCrf9uCjUfbj3vw+PHjwdb21jYx72+Pd2Bjuwc73z2B7UebmzEceVa3SeCsQ0jFFQjeOVSWM3VfNLSpmeVns1melXOHXFlfc/g89+H3OzvsmOnhsrXKO4gVO9jZfNTs4OGjp3jnnj3eefLdbzL/y/PYDgP+Ellsh6I/OYftIvvLJLCByYGhQUuDiAPbuSQas/fzhhNMw8fleq5jdja1rZ9SzRVz3ktYzppLmZD/XlanN6cvF90V27eeyBwhLAtZB81lItj6OVYqkAUlFjx7o6P+Ak5ev+jDTyeHL8gNw4uj563JvX4nXBMseItjKH2awgbMfj9gaAdJ1xBz9uPxm5cH87yWsqGZAyetaLaRaaeXvLKtpGtCTRN6CCWnup5L48b6m0VdqumfGUtnhKkDEqrc1aJ+r7b3xodeVRbN6qDyWquBL4jBZtoQ0tSHmJnud7Z0K22GbI6sJ42P1o2BnZ70wVZkMRY+CIWpRhLNhzjVjZBDpe9Tf9LAG5HLFH46O34NnvhWyGXOi7yVQczA/9CHIcv9NpMOOdFYwwaW0RdrJusE+YLQBLOzaDJTo6AetI9Ze++TIrHVeFVNOf5AbbIBHJG7ILfCfbuVHuzI2grNm9OXK+FXJXVo0ivhVvj1xve1NtvuUJIX5II2AGn3Zaiv5SUUfMvMRTT6G8b1BCwmWqUWJkYXsPX9k83B5tZgc+t8c3dzd/N/SXIFCnLl7FzenO9DpZzMZ/2lITlp2p0nLdqNpHI7j+bblcrhFA3t9xbHVq5qH66W7Uxw2sA4102xsyjP4B063CmrcU66vxxatCEz1WYqlPyHnzwLaLNJxMDJROaSE2Py7ivl9w+tkDuly0riLYOZ2syCi+bp0kc2+ko8FGOqvJZk1OLEbPpCIXVYUYN2eCKM5PbDXoFGJmL4UturPTXFfGXaej8b0azKNINyZRpoN5nvaWZ3X9339HYiqtz9gebzIfXXl1rN3HVfP3m520cvrlIcV9M1q+CAXsLRXEnoaOGYmsPiRsicPT/VHHgDhU5XO6cGTQv6OmTzsbVwMqlWGL4H8KNUjgj8EfPS58gVK6Z3OfX8aAISUVmmNmgFH+OQOqXScDv/9CXpM9UYTbN7pa9zwlX2iur5ZZp+PD8/gTOeAfs0o4Xt0ebWZxj/J3SOt8EHQturVK77uh9ZTCojXR3tXnyMtODx3YvL+8t+5MTURrsXrKXRZT+6G2hTD6i6zWUh3WBcJddIVGZ1asSAnUQyKDCVVRHRdNr9Ge/LMnhqlBA/6xLPmKSoH+VijHm0G/2gTT1Mckk634+srkzCOy5KbRx8HCkAADq02Stl33/b12oip5UJ6nfv/cO3LUjfPiWh0yGY48b6bDY8A4W3XQgbvafNXFHKo1AdhpkB80YHSq8F/iN4kffZBcE9PANxK2QHVrxw7rTRexrd92d8eaFb/FBcALRZUYrkmvx0ISQbW2DNxkiN3CgKafgo8l8nxexRW/+kS1SilJ4zMIqm0mXVOE50MZxzbDDVNLtHCOgUhrFt9EgABKPLxN1n0AEav8bbBZbSIlHKfY901YK9kyP/doG3tJJO5fpg+mSbtHgGKWZ5nBzFLxY4GtgQ/10k11OjK5Vu9Hrx4R0mlUNPjpwwuP96BkrmvDE3cpPCxc9LI5WbbGgbn7kUjenDKPgPTlopA+aT2TXI37/fhW9uRiM1ipji3m+Afk7NGfYFzelja71ffU//DYezCV7F3y8i3oX2V1qzjFRXjpCediGt20qbErRlb6Tu26p6UruMfXGjruQZ1lqvNvWVfzlSjHY+EFNwyG1MPoYz9SuO7WFhd1eLSw1a18zcK+XhHXUW2RXwzJK330zw30iLH8ABddabvCDT1h938loqRLl85UDMuX5zOE0FjFepuDSavK6NtalFKS0ZEQGmY+2OFsdlzcmsgFxa7shQp81WJdGE6YJTotZhgdwpZLfS8VetjXdtzDtD3sYzGEWfS25j5Q98mu8NtKhantInzAv3A7hyrlymTZPvzakmYFKFZiA7z1mPdO/kCCyaGyoMQ8SBUucyqWNadejDn/UtHkE1Dt1oKNBlOuWyf3bXYYy5vu1T/A69JV7JWSdBssJJO6FmQa0r48HQXGqmx8Fdt+Qj+L6Ev2BBTLYxqhtptLoYRXv7+4dnZ1fnxz8fvh5Fl55Zh3SUzP11djR+h1RGN/EiJN604UbneU5LfnuNG1tweXxAUcowbdcL9gHsG6TD8bVIhLV+Kq2V87jVwtiErzl0lj0tcqYOmDy2NdcX5lMIxswfPesgpQB31TVl8rnNSjbBjVFIqAIEPWmC6+C/l5fvshNqw/BA2kSEt8j2DzM3QNzE3WXs8wkdr/4pIuAby3TAN4C96J5zIZteD1KdcH7dymgoN5dTJXw/aPGmyUaPcnMyGMqILuneCTWWz30ud7xQDkz1IrilcOfuWtHtS2CX3oMvk7skv8+FutH+Ehdpj/PLeYeNU8BrrKPddZlkP+KCe01GSeGnWT5j/mzJf4SwVgikr96TeuAMy2XRbjSs5peTvHf2UqoMxfQmknwM8ePK5tX0fmU0GbIgjKSyjy2ivcQXQKGyjeZxKVqsTd6Rxz42NbxGxy3iEw8FCEoM73TFh3ATqVI+bvB95Yv2in2trM5xfqUs8QNEbGyzYUP8MKmMQeWGU3QD6wRF414cmNVEqDMqssNlLWFlMiu8uf3LI7M6jPCRSMcojD/emc/0Q0tTm2rrYzTJ9S2j6UTW/VA8dgbfdETDdhKnWOhmgx7okP4noSa69BvQk0kuFaHfAx7lO4HSNJcPwg1B8oQGJwZtBhwULWyIXAofmd8HKFc+bL4ntewOfTl8fzlPSVLOUz+JQt1CGGpuSBLfeN1n8sH5Ra162TOd2G9qf1vSA15uGeqQZLQvcda68tfIhOoqHoXia6znind7e8u0kHWQqyJNpMBjhyUaS5nmwLNswDT2YhbXb6mMqd9qc8393r1S/kzu8AvphtsGwCDHG8z//7dx34+aNh83GxN22OEOXRSS4x+8HKPmkDsiys78u2ipq/EAjuj0K60SXwAc6KSa3XHwGXie+zZm4lPYtJBKWmf8ORuxYO/kiE7ouy9okJ0O33ukXjdvFtOQ1YnQwD8JzOhcwI3hxGNkKJTFFtrSrcIq3LobG31rfbo/Ug8ewNnBz3akuC2bhh00RyVom4zPdjtsfHQ4l6Dv2s8QzqcKy+BnvfWJpvYV2WNzf8XuEhm/wsvmPov//AoH+lbxdeWzg5/h93wIRFsgX+nzK1E76HxgceDLP18BxGqwRO2BMK7DmIuyGscp3swtLgwMQ7/HDud5fG8lby9OD/cOXh3OISx0dmx6PRznejwshHVoQqfHhr/DVBg39CAoYWjzNn59eN5FpaopOrqW3fUQs+E51cemjn2VM+x9TWq1U7hEL1N7mMs7adqoMryLy2KOyn//XM5+BWqRSVpJ7Qu9iGoOei26WZPuT9GEqV7Wg0DtT+JGdFEV4gZVVxMsCpNk8ezNkI7t6Yr10GYURIbzLlHvj1P7QdyINXpL1PpSYKa3ZfHBdlnLetsMNzoxbHWPe1+TtxQBfcRq07xI7cZbCioTdEnW+71kD8LyP4V4D7yzBaA9nPx4sqCKnjJpF7xFZ7hjiQtc/8NEl1m5Qp2Z47592aG2LuUCoWGkKRlayjtctr4/Ti2TtNJTnFbjuovKVON6ioXtUtweHdJDx96+KrWEao3tnVILsYMqMfzDCalbVVkzFJ7WUvqVqLWrIxw1sGWCynKd1SSapUgypF9TRf2FSphsT/Br5nFYa4cvj/YPX58dDrbjzZh+qsRVCprCHk/O0NxIboYPnbatc7om5aTKGY31eSz9/MVyfltq6wqhWnSt/13Rwgnq7Oj4Pz9A++v8AC1UQNQzpta85EqWtetj6MZcRLNuzGU/on4+jX38SNcZ3pj8/p6Gf6nQ1L4H1PRb+Li2H3mMrSbbHt+0bjXVlu4RdBpDLw7Poz73GoikbrU871VczF4JVbdghy4AdLsBECr7fiCJGwPcyFsJ5DOr+QaamFfv1A34/WBDsyRArVz2SXCddow/4W/WTo1Q7opX3V/e39//H3n48so= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns the payload of the ID Token, including `session.id_token` values, of the provided OAuth 2.0 Access Token's +consent request. + +In the case of authentication error, a WWW-Authenticate header might be set in the response with more information about the error. +See [the spec](https://datatracker.ietf.org/doc/html/rfc6750#section-3) for more details about header format. + + + + + + diff --git a/docs/reference/openapi/get-organization-onboarding-portal-links.ParamsDetails.json b/docs/reference/openapi/get-organization-onboarding-portal-links.ParamsDetails.json new file mode 100644 index 0000000000..4069711adf --- /dev/null +++ b/docs/reference/openapi/get-organization-onboarding-portal-links.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Organization ID\n\nThe Organization's ID.", + "in": "path", + "name": "organization_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-organization-onboarding-portal-links.RequestSchema.json b/docs/reference/openapi/get-organization-onboarding-portal-links.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-organization-onboarding-portal-links.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-organization-onboarding-portal-links.StatusCodes.json b/docs/reference/openapi/get-organization-onboarding-portal-links.StatusCodes.json new file mode 100644 index 0000000000..4963eee69f --- /dev/null +++ b/docs/reference/openapi/get-organization-onboarding-portal-links.StatusCodes.json @@ -0,0 +1,302 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "links": { + "items": { + "properties": { + "apple_mapper_url": { + "description": "AppleMapper specifies the JSONNet code snippet which uses Apple's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "auth0_mapper_url": { + "description": "Auth0Mapper specifies the JSONNet code snippet which uses Auth0's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "created_at": { + "description": "The onboarding portal link's creation date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "custom_hostname_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "enable_scim": { + "description": "Feature flag to enable SCIM configuration", + "type": "boolean" + }, + "enable_sso": { + "description": "Feature flag to enable SSO configuration", + "type": "boolean" + }, + "expires_at": { + "description": "The onboarding portal link's expiry date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "facebook_mapper_url": { + "description": "FacebookMapper specifies the JSONNet code snippet which uses Facebook's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "generic_oidc_mapper_url": { + "description": "GenericOIDCMapper specifies the JSONNet code snippet which uses the OIDC Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "github_mapper_url": { + "description": "GithubMapper specifies the JSONNet code snippet which uses GitHub's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "gitlab_mapper_url": { + "description": "GitLabMapper specifies the JSONNet code snippet which uses GitLab's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "google_mapper_url": { + "description": "GoogleMapper specifies the JSONNet code snippet which uses Google's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "id": { + "description": "The onboarding portal link's ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "microsoft_mapper_url": { + "description": "MicrosoftMapper specifies the JSONNet code snippet which uses Microsoft's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "netid_mapper_url": { + "description": "NetIDMapper specifies the JSONNet code snippet which uses NetID's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "organization_id": { + "description": "The onboarding portal link's organization ID", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "project_id": { + "description": "The onboarding portal link's project ID", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "proxy_acs_url": { + "description": "Proxy ACS URL if overriding with a customer-controlled URL", + "type": "string" + }, + "proxy_oidc_redirect_url": { + "description": "Proxy OIDC Redirect URL if overriding with a customer-controlled URL", + "type": "string" + }, + "proxy_saml_audience_override": { + "description": "SAML Audience Override if overriding with a customer-controlled one", + "type": "string" + }, + "proxy_scim_server_url": { + "description": "Proxy SCIM Server URL if overriding with a customer-controlled URL", + "type": "string" + }, + "saml_mapper_url": { + "description": "SAMLMapper specifies the JSONNet code snippet which uses the SAML Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "scim_mapper_url": { + "description": "SCIMMapper specifies the JSONNet code snippet which uses the SCIM Provider's\nprofile information to hydrate the identity's data.", + "type": "string" + }, + "value": { + "description": "The onboarding portal link's value", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "id", + "value", + "project_id", + "organization_id", + "expires_at" + ], + "type": "object", + "title": "onboardingPortalLink" + }, + "type": "array" + } + }, + "required": ["links"], + "type": "object", + "title": "organizationOnboardingPortalLinksResponse" + } + } + }, + "description": "organizationOnboardingPortalLinksResponse" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-organization-onboarding-portal-links.api.mdx b/docs/reference/openapi/get-organization-onboarding-portal-links.api.mdx new file mode 100644 index 0000000000..0eaa12e09b --- /dev/null +++ b/docs/reference/openapi/get-organization-onboarding-portal-links.api.mdx @@ -0,0 +1,41 @@ +--- +id: get-organization-onboarding-portal-links +title: "Get the organization onboarding portal links" +description: "Retrieves the organization onboarding portal links." +sidebar_label: "Get the organization onboarding portal links" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2ziy/is4TE1FqpLIbCa7D5rKqdXYnoxmEtvHdmofIpcCkU0JYxLgAKBlrkf//VQD4E0XW1KUebIfEgkEuj80Go2+gHr0IlChZJlmgnsD7wq0ZHAPiug5ECFnlLP/UnxIBJ8KKiPGZyQTUtOEJIzfKd/reSIDaTqNIm/gzUBfNAZeVOMuzbCPOMrreRmVNAUNUnmDL48rOC6l+ANCTUanYz7mN3MgmW15rcjoFHky7JZRPfd6Hqcp4DfbZcIir+dJ+DNnEiJvoGUOPU+Fc0ipN3j0dJFhb6Ul4zNvueytMm+ibyBoNj8Foym1fbHcYmeVCa5A4fO3b97gf6HgGrjGjzTLEhYa4sEfCvE+NuhlEtdCMzvaLBB+YBpStf4cacEkpVkGcpLLBNvaohhij0+mA1EZhCxmTjd+u744PwdNQhEBUZxlGWiymLNwTnIFipiRr9WYZ1LELAHCeCxkaoWqBZkXkaQaDC0WAddMF68ViaimKNcVwfQ8muv5m6exYo/DsOLII2INJVAN0YTqdZSoSZu30mtFzEBkGlENXs+zKLyBh9/7mqVgtIlGFzwpSm1aZ58rLdLJXCiNKok6OHisaeU5i96huuZJQqcJbKbT8zTT+NA7z5Pk8+fRKZIGjiMmKmTp+tR+AapzCSRO6AzFZjuT65PRJxIKHrNZbs1ELbOpEAlQ3iStxO6Ury92IfyQMQlq/9UwA4tvW4uYhjAV4u5Jzf3FdTpIecvBR9TfGXCQLJwIFoVPAv9gO16MTk8Owo59cDC5lOKeRSCPOQmm5/n0afimy0HIPzD9az49LtyEPgv3Iz0Y7kd6VLhCzJ45Oz6YLofBNUOPCNeawD32vj3dWzZzl+2eslAKJWL9pGQ+lb0OEk41+ojy4aBZ9CTmc9Cj04PwmpFHxLrqX+23sKLt3B2yyA0/cz/eWeXVHsj2oZjQUG1eoEt8TIYn1+Tz1UfCYiLuQUpmYCyYnhNKrGMAso/+pBRJAhF23iRky8wcABIiJnG+T7A1RvzKdTwiAEXTZELziAEPYeIIwjqK6+Gnj2To+pEL1293EILDEyBClk4UyPtte8PKwPg516bbUSRg5v7UlsRJH3zsGol9h2PXCOtJ1CejT4ejRhl/B9T3NMk3qNWTu9mOeXbjLpvx3xfP7PVyaCtiXY8bG57rbUVXTHFIwz8XGwJsnJPrT6WkxRoMGxo+RfW5EP7KxaneEmm35bbH4J73bs8Yd32JlKY8ojIiF7IwakSGlyMCUgpJrFr4VtiN2Nc8XSd3ZgaVMfjaqAim+Wx91Ck2YyiiKeOKmF5NlfTJzZwpwhTJVU6TpCBcaELvKTMRGKE8InOqUHOn4KKbyDcaQNPMrAfOE9V3ShUQGtFMgyQLqkhuYyEtSMx4ZDQeEkhRlBsUfcu0z2kKCM+MNiLAyHEdAaoQKA0RikjkMgQSijyJzHymQGKR82gr30mL6boQq2+1KONc6jnI1v7GLT4Hwm1MKOIadRvwhdFpa3lHp+Qfb398908SCVAGLTwwtVFEm4710SlKh5Kcsz/zUkSjU3/MYxuaTrjQk3pBz6R0Meu50MOyecz/zIWmE3gIASKIsNv/YcuZa0D4PE9xg26k6/W8NoXGDq7i9of+TPSRTB/n4A02kzoYInq5oBSdbbCXn+yDevlqfXJjNp8ZmupcTdDwr9M8weNAQiZBAddNknaYPS86796865F3b37Ef/7RI77vd1vagM9rn4tx/a93NRTGNcxAGiu5zSC6oNgYiBNnq1atqt1dt/WgyhhZu3JV25U2mw021NByAbY1kz++mMkXM/liJl/M5IuZ3G4mI4hpnugXU/liKl9M5YupfDGV20wlSgnCXDJdmAK8kMV/hLxTGQ1hmLHfAZtvsSJtU1+byvS2LF5ginch5B1xSS2SJZSDQWnzN8ZMQYQmJaUc17MQuWwNdakQZSzXogRirheYNJI31zpTgyCgGfNDwZVIwBey8NXcQ5CazhBhmVJBkT30hSz6mAdKWMp0f5qHd4BrNaXhnYhjFkKfRinj/RQilqdG03Htr80K2wknlM9wpkUG12bmXs9L6BQQ0r+FLIIwYdYyWuuFa59ioog8jjkhhLirDMOM9WzDSbNiOeZLEkuRktcNYq9/wjsHOEndrm+S94TDok2h0/2p7EszNuJ4dIXgetbMOy1CXcMhAV3KfRQNiN0+P5EgqK9fENK4fDEe28oI6bhTFhc05xHEjEPUtQSbuZ821ZV7FZZ0s/FZ+uVEH91O7ZkDjCzJe0IXlLUk4O9yD6Vjl6QSglui9hzGvPuTh9dEnC58EA0d4FSze2guf0bDO1TxlDKOkJ06dMZ8rMfWKXnQY89+jdPqo1D2k8iA04xZVSBjV8j0Q5EGtYr0ZwJ7G5nEOQ8Nt04XlW6sq+mQwXsy9qqvE2e7xh4JArcw5C+yZbXtWhhELXFYou22LZSfXfGKBx/rtqYP3pOWIPxzWKzoPQ6iGTuxgto0YHg5sk9XtB9HokfWI7KHph8HV5T8ctNcjvwPu+iQW1L/ZxrezST6K51ur6FTK+rU9c8eIMw12Bmw2CD4n/eEs8Su31jHqfZ/ySTjOu4I5V/rCKTskbHzJhdz4CSkSYJi/ron3q9fB+SH+/GYjz0z+e4zLH/Jk4T8enNzWTmxjfF29BL/CYKqgzVpX3dCMyDP9ikPOeSyDlPkGmFetXnvK5TmnEBl3TFfNvf8ZaHn5n5Jue/xaNlq+oUsJvbhmBs4dYOfiggS5bey/XUKf2JrDBOTn59U8nR095DUKlsJSpdkhhlD5yuzB5DpmRmRlh3sN9yWr8gpWl/UM3ST8E4RnubCjKWJOa2dsTbBRnlKZwkt7F7wy5MdT2uaMYWWDAlfA7RPNz8rMLgilCRMaXTDaZIQlWeICaKVo7C+P+ibY6F1SjYm3jYa1r6baaAV2xVuaWpfGQvmTHOaN85nW2vCW2pYbbKhppEONglZGsEaNRJjnNAwFDIyR7YJK5AKOk7W6SKli0YykbCw8HHUmbW1yggLaDg3PEgKei4iQqWx4Fghi8gUErHoofNlvVw7kug51UhJUc2UKcAZf8yQwb4hVeDb+Z5U8/sZqATZns+ArLuNe68GDUNQaqLFHZjeygd+z6TgX8bez2fDq7Oryc3F72fnY++2WoYzjtEqJc72uvIqJ6z0f1wQh6Isd6Lp08AyLC3+yulAqMLTwHUbWJCvyIm51bedCVXKzSdjE1b7YQ2ODXesZtBt+SATFpH35HX9rTxaX5NXeLA+f16vOjCO4krTOtk9DmtkoWXhRGPF8wH0zpeG63EohsrKvW+JDh24yS5mslMLq7c6827Nyti0zthlHRxLETd85P7/7spyYI6KJnFLvTkd9xSMpSWVwUXtgsE6rLpD63Q/CB35QRmA5AcCXRMePfRVdNePRGiSTo1oBhNhbGYzHzte3u50y+vbNkRqX78erWdrVgPRZ8KLtRvTeA5vuFy9A6edQ451nuYqts4lv7Ecdj577fW4VcHu5knqh4Z3+H2k/PfL+LtIOLMO2br67mYynhSuvX1Rz/r7iPZZLn+/YDs79/TTqGtySPCggSsmuBXkHaaNtmVeqns2WzMwKKqSRGWwGtdzXgzXi+F6MVwvhuubDReysgGTFb6Rqp57Ay8oA8DgsZbqMmgKQAWPK/JYBvV69e169RP3olsZwl1jvdEW/aZUsbCqQVqDiC2VVDEuRWWZmpir3dM2rXUVGJi9NW/6JGJh3+9qhmonrhbSavzcSq2bW5N+BKlwmfXAEg3wX5xJKDI7ARHHCePIfkhMKylX0nqvrqqHDqyEWIKaExPeKdKhCaM2dP3qqExsAPgVVbvdtD99+zYix4qbd2U7YcR2kQEfnWIwy53632B3c00SP+woB20HNWo6VujmVnoxNJgt4fWqsnBROFMEeJQJTLcUIiccIEKIX5rVEIwo76C47ZSQFouFwYJZYDwUg1BwjBdUkIFUmIrpW5H1DUZTqXpeZTaUfPbEXZdq+gncQ/L3TwPrqzwWZcGfhsY1gJQyXFKXPfq3qxRVL2kismv7zFsrlL0iI6xjRXloM2SnIsyx/G0NmklRJQnJ8mnCQpvjQR+GKS1NMcDUtYaXI+WTYfsBNpKQYlycFFjdtpOFyCUnKF4qZhG5dMIgVqWssvrk0nI0VDDNkwqlk8KW1hgnUykWyubDxvzVK3J9+rvCV1eZIpGbAbETnbrr1JZSVcBltgzeWEHfmO6KYeN+gTLkjTBwTCySRCxwP2LCNKczUAOE8Rf56L67cPcvcioWPBE0QgLkkD8k0VyQI/39hWj7rT+y2rD/3xFIbCaLaE+p1C3BfMnyqR/Bfb3jXEPgqlIqqNNR3Y2y/XJ1Njz9dFZTWKk/qegumCZiGqRUaZCuHqXc/0FEpQ4sCTxqm7L1z89u2qx4PgONqfC2haiaa9QXsvBtsi7oHhOt0BzW8Bq0Zwl7YLLJag4PfpbWrOz3XSV7BLRgIG1E+0GssqpJb2VXlRK/iybMxLoeOLS/0XvaZpXSe+BtTVBAZTj3qycBlZrFNNSBmuMhEtQlmO63o/2D3tMteotobdBZ6W2W/qHaojV6WzaXOhE0ivrdY8oWT0B7YjUxr6Lt/AcPlRh0OO8eCrvvhn8X8JZ4awoE53D56+WKKlpkTK1Yi1ZzayeuSP2bQWfzbIM6G4nb2mALbZGxFaCupYwuGsobrO++b0drIG20FFf5tGizkvm0mEGq2oibrQF+aO23o6JFVlv23hXW2FqsQkwrKZ+JmlvV5D5tRXoktGrzCYfVYRYCxvmDKnAeZjScA3nrv1m7yYR7j5rHRsZurAo+jk7Ozq/P+m/9N/5cp4mJUkCm6iLG1wuZqTQHWqjGXbLS5cRkGUhl/dgEhWH820wonVLewLVPuWY1wG9crT3wF2OcB4+lO6y9MhOJudcFbRxe3eRC7oOtL8qZp+vJiW3R+G3Pw9ovkn98xIuvn2WyXGLznzlIc+MNs42S2R/GwAtvTJm7s94gpomCJyTRuXIhapc8//M1GwVQvrHHi0aq1Ou5jGhDBuY3aw4Bts9P2xwAcXUhlrfLnjcHGmEOo8oOY1CTNbPBa7ezW9mZD2c3nv39l8Yv5lSxYJkh+fK4Gdvjo+1hQqjlsoLqQvnb5XL5/1ibgp0= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Retrieves the organization onboarding portal links. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-organization.ParamsDetails.json b/docs/reference/openapi/get-organization.ParamsDetails.json new file mode 100644 index 0000000000..4069711adf --- /dev/null +++ b/docs/reference/openapi/get-organization.ParamsDetails.json @@ -0,0 +1,18 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "Organization ID\n\nThe Organization's ID.", + "in": "path", + "name": "organization_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-organization.RequestSchema.json b/docs/reference/openapi/get-organization.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-organization.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-organization.StatusCodes.json b/docs/reference/openapi/get-organization.StatusCodes.json new file mode 100644 index 0000000000..eadb431c54 --- /dev/null +++ b/docs/reference/openapi/get-organization.StatusCodes.json @@ -0,0 +1,268 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "organization": { + "description": "B2B SSO Organization", + "properties": { + "created_at": { "format": "date-time", "type": "string" }, + "default_region": { + "description": "DefaultRegion sets the default region for identities provisioned into\nthis organization, when the identity does not specify a region explictly.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "domains": { + "description": "The list of organization's domains.", + "items": { "type": "string" }, + "type": "array" + }, + "id": { + "description": "The organization's ID.", + "format": "uuid", + "type": "string" + }, + "label": { + "description": "The organization's human-readable label.", + "type": "string" + } + }, + "required": ["id", "label", "domains", "created_at"], + "type": "object", + "title": "organization" + } + }, + "required": ["organization"], + "title": "getOrganizationResponse represents a B2B SSO Organization.", + "type": "object" + } + } + }, + "description": "getOrganizationResponse" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-organization.api.mdx b/docs/reference/openapi/get-organization.api.mdx new file mode 100644 index 0000000000..e6227febd3 --- /dev/null +++ b/docs/reference/openapi/get-organization.api.mdx @@ -0,0 +1,43 @@ +--- +id: get-organization +title: "Get Enterprise SSO Organization by ID" +description: "Deprecated: use getProject instead" +sidebar_label: "Get Enterprise SSO Organization by ID" +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/itnmelEmpHIbJrdB3WyU8dWU/die21n+hB6FIg8klCTAAuAlrmu/vvOAXiXFCet052dkR8SEQTOHR+Ac8AHL0YdKZ4ZLoU38U4wUxgxg/EEco2wRHOh5K8YGeBCG2RxKEJxiUZxvEMNTMBUGFSZ4hrh6uocztWSCf4fRgRhIRUwyEoK8wK40XB64o08maGyfU5jb+It0bTHeSMvY4qlaFBpb/L+oSdlJdLpCUlzvcKKxXOi7nsjj1O3jJmVN/IES5GeXJcZj72Rp/C3nCuMvYlROY48Ha0wZd7kwTNFRr21UVwsvc1m1GfeUbCRoN38MTFkq9/nynJDnXUmhUZN71++eEH/RVIYFIZ+sixLeGSJB79qkvehRS9TZHbD3ei2JPTcVfPNyzdb/iS/dEhECilWZswyX0iV0i8vZgbHhqfojfo6jLwYFyxPzEzhcifjE/f+0r4GjUaDWSGUw8ANs5HFYxSGkyzk/zuuuRQYAxdGhsKsuIa2iiNYr1BYWuXAAmKJGoQ0oDOM+KIAVtHHezKkSQo/FJiPIxRGsQSm747dr1AwzdlYSGVWyLSBI83ZGT1NmTahyPXYNr+7qp/XaJ9/QXrGHKbvHBE7lHrAu6tQLBM5Zwm8tf95Iw9FnnqT914jhDfyury9kVeyc7+IEY3My5621Rt5jrR303fKyLsfL+WYOI3JF97E+x+qTCEiU8aF3o4NmmgJ1wbkouPb5xrKMXbWGUz1jvlT682UYgU983g3D7lrMtfhned23m5RT9gck08iuMpTJsYKWczmCYId6G+T3LTB4b1nuTomjY1G7UnYuFbOCeyIJDdJH3e2KHde3jSDerh8WYIPKFomNAqjgcEupGgpU0qy2di53zbMHupkylefiWzbFteGiZipGM5VAT9cnZ/B0cUpoFJSgfOkvwVn9u02uakdVCHv1qgY5/lyF47N8yWQBuQnsL2AC8ebTATXBFFcQ65zliSFBSJ2x3hig4KJGFZMg5EwR0BBjTHJjPcszax7SM+YGTZnGoHFLDOoYM005LY3DV1wEVvMwwRTMuWOuN2j9hlLkcSzo60JaAnbloACCbXBmEwkcxUhRDJPYqvPHGEhc7Fzvliisw7TbSPWT40pFzkhkGobE6RDdsFMrpDgoZa6K/C5jUZYc7OC0xP4+8uvX/2jWQbwnuudJtoFFKcnZB0GueC/5ZWJTk/8UCzQijET0swah06V+s69OJPmqGoOxW+5NGyG9xFijDF1+ze1TMuG1hqwk6438roUPgngn1bEzchLUWu2xG0z/exeNO5r4qkcswP5Rp42zOR6Fsl4B81jGXdAqCHphgENg8GrF69G8OrF1/TP30fg+/6wEw30voF1Lsw/XzWicGFwicpi5T5QXaJAxSMLEMclVvWx1c2uFqjWYORw5bLBlUcR09J665g6mPz6AJMHmDzA5AEmDzD5MZh8dYDJA0weYPIAkweY3A+TZYrtAJUHqDxA5QEqD1C5DyrJShjlipvCVqekKn6R6lZnLMKjjP+I1HxD5RqN6m53DcvVjAo4Q7OW6tZ6SckEsoQJtFKuVzxaOZjCmCAlZYL8WchcdYaWlS1tkWtdCWJT4blKvIm3MibTkyBgGfcjKbRM0Jeq8PXKIyENW5KEVYWMTHY/lqoYK2Yw4Sk343ke3SL5as6iW7lY8AjHLE65GKcY8zy1kU6+v7IedgonTCxJ0yLDK6t5nb6eeN9KVQRRwh0yOvQi36eZVAYeQgEAUNb5jjI+cg3HUiz4MneVw1BsYKFkCs9bxJ5/QwU5UtKQSZve8BoErrsUBsNvqr4s46eClq4Iy54N80GH0NBySNBUdj+NJ+CmzzcQBE1tEqBVmQxDV0eAQVXIMhJyEeOCC4yHjmA7Dd+l2is6OtLtxkfpV4o+lDN1ZBcw2MBrYGvGOxbwe5n5gbN+rW/pja64oRh+41G5tHT7W9lyt2CG32Hb0xmLbimaqYpB0pWeH4QiNKHbf9yb0HOPi7T+KbX7JTMULOPO6xB6S25W+dyPZBo00TBeSupt1V/kIrLcBkOKr9DU6sDkNYRe/TgrYSr0IAhKH8DvsMexzuxWoo45HNFu2x7Kjzq35iFC0w3qyWvoGMI/w3UvxGkQy/ixM9SuAUcXp+5tL9BpJG2+RqBGhPI0uKbkV/Pj4tR/2wuX0nv+GxbdLhXtQgbDUSt8epEz9Kf3GOUGnbB8YZn97TUInjhXhWaRGv+7THFhFgOp/SsTo1IjCMs9oi3tRixJyKIf9ov24cMEvroLQxF6VqXhI9S/y5MEvr++vqh3oa3xbvSG/gmCuoPDpA99xhN4u7vcRcO3+cvcEP/LLtGPKNaWC3U2DMWmPRsvCrOyBfxqRhK+78VfqYqZexkKy7lp8FMZY6IJImaduwy1/iWNver2CSoqEpeDjjJOe5vM4bvtmVm7VB3cE02FZ3BC4EYOp13IShIVDdKOZYldDEsstHv5ahHMEla4oPSrhZMWQ5ZxTehBhK8Qu4uHnxXlXZaq+sySBHSekUwY91aa5u6Kb1G3swi1FO9OVIepVg1Cjk8Vt4K3ZxY1SjhM89byh9Y+LDcruvXgTnLWOtQkVQU8jdREjAtgUSRVbFdEu2snKrQvcXsaqHZAkMmER3RP4hlMHb5payxk0crygBTNSsbAFLqLGrSVnWMi1yN7ychuIt1IMCtmiJJmhusFXe2w2x1LhvpGTKPv9D2u9XuDTKHq6jOB7V3ZZ3uDRRFqPTPyFm1v7aO440qK96H3Znp0Ob2cXZ//OD0LvZvaDfY+FDAoQdDZjgl7f8oaszwjkSmrOWb7tGQ5qlC2h8jANCFw2W3ihHwGx/YGwH4mTOtSn4zPeLPNaXFs7XYaBsPOuj/jMbyG581TtZw9h2e0mD2+RvY3DSXFXtM22c9YIImFUUVpGmeet2g+ekttXth7XNUA0r8Gs9cdm22h3qCxxqiv2rAhaUFrEJan9pK0XLT2mON/9UlPLJq3iTgqbfHKt2ghE2rkpDDByTb7pkNnvfyoFPCVtoLAV4BDe1y4H+v4dhzLyCZhWrt7SgzxpcsEbF/vGAyra33udNC9lne6najon8Ee2Vlv3aSj1W/HpbtP4PTJu+1tnvaKnsmVuHYc9qyCdNBeyr7FtvZR5r61N/oy5vvrjfcEpsvcbmY74LqT86Mmm/UucX0Zgz3K5Uuba7Cn3U/joc1k4L1BQVcnnZFuKXmx7/w/8u5YkuNH8gBkhopEDRP1sANcHODiABf/x3BBZNxu3hnQWsysvIkXVKeT4KGx2CZoK6eDh56uG6/JpF5RTckVduZM86iuMzm4oZbaMnQ4IsfO7ca/29M1bXWVdDp4aa+pJ3Jt2XTOC8dlvrvT+K6TPl0VsWJ+jKkss6eBIxrQv6RJJLPyav1ikXBB7I/AtkLlDbfzKis3tPlSuFCoV2DPGBoGLOHMnZ8+lFRm7hTygcKz2/T59N2XF4KqKt6l60THhvMMxekJnahEGcLX1N1emaYfn2gH4wa18vbO6GR+VRxZmR3h7cqhLI+CXAOKOJN05i9kDgIxJhHftzPedKy5xeJmUIm0Xq+tLJT+oyUniKSgva4OMlSa8gFjZ7KxldFWIx4PmR1p/c+Uu0nHjxO8w+SvV4NqaGIhq6Iui+zCiynj5NIyhfFtWQ2ov1Ihya7cO2+rGPIMTqlWEeeRS9OcyCinEmfrm58kgSyfJzxyiQbaIXBtlM0C29rF0cWp9uGo+4IaIWJUVEwKqmA6ZTEuT8gM7ljCY7gojQEupFyw+nDhOFoqlGtIpTZJ4conXMBcybV2SZlQPHsGVyc/avp2h9PHA04DcIrOUVenZ90qDHNX6mx50LfwWzNs1ZC1JW+NQWMWMknkmuYj5eNytkQ9ITF+h5/K5/Ko9jucyLVIJIuJAPyRPyLRdsgT/f1O0o47f9Bv+Py/JyCxmyxJe8KU6RjmfZbP/RjvmhlXNgRlOUIHTU5kuNO27y+nRyc/TxsKvcKDjm+DeSLnQcq0QVUWInT5fxAzZQJHgpbUtm39s+l1l5XIl2h8qZZdhKibG6nPVeG7jFEwfEpppRG4Ja+Vdprwe67arFZ472dpw8o9f6pln0BatCLtlPat7LNqSO9lV9eQvkgkLOV2HJTS/sDuWJdVyu5QdCNBI1PRyq/fBEwZvmCRCfSKFpGgyfAP/7y0v7I7tiduSVp3pKvjNkt/1V3T2ritmquYCFqF2+FT2pZWQLditWXuSzv4hRaVBZpoNfyjYo/L4V9EeEe8owKQDhffX/RC0UnGdQ8tOs2dmdiz+p8WOltlO8LZWtyVnjrSFhnvCVq2VKeIVvAG27Pvz0trRdqJFJf5vOiyUvm8WGKquxK3WwP60ZlvTyotsdoz9y6p0NNhFVHSRvtcNtzqpvLXXkmfSFq9e4Wj4iOPkM7kk/rwe5SxaIXw0n+xdVuF5h6zr62Ny7E6+On0eHp2NR2/9F/4K5PaL0YNqlSfL65Q3XFbyAyM1K37QtWWk1JRqLTbxyZkDLu/zaQ2KRMtuT6pZtA/nbfuTf51X9KXu32qNVGxkNtTm7XkQ3k2r2/2kPqTTj6jczynt/1kxM3Io5IkEXl4oOuO71Sy2VDzbzkqe8+JsnuK2xtx9poT1/bGpDdZsETjR0w0uCwPrUN4/Iv+nWpW3/OKopWa9EZlBrKlqf2M/48I9jlf+/8BEfvm3txsRt4KWUxZjTobS8ecrJ193bqT28nLvJ1e05fflJRoPoKuT4dVzuT9w27ZHh5cD3uo2mxqUcvD/c1ms/kvtBjiig== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Deprecated: use getProject instead + +Retrieves an Enterprise SSO Organization for a project by its ID + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-project-members.ParamsDetails.json b/docs/reference/openapi/get-project-members.ParamsDetails.json new file mode 100644 index 0000000000..dc95b3a242 --- /dev/null +++ b/docs/reference/openapi/get-project-members.ParamsDetails.json @@ -0,0 +1,10 @@ +{ + "parameters": [ + { + "in": "path", + "name": "project", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-project-members.RequestSchema.json b/docs/reference/openapi/get-project-members.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-project-members.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-project-members.StatusCodes.json b/docs/reference/openapi/get-project-members.StatusCodes.json new file mode 100644 index 0000000000..08f8ee923e --- /dev/null +++ b/docs/reference/openapi/get-project-members.StatusCodes.json @@ -0,0 +1,309 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "properties": { + "break_glass": { + "description": "BreakGlass is true when the identity's recovery address has break-glass\nrecovery enabled for the identity's current organization.", + "type": "boolean" + }, + "email": { "type": "string" }, + "email_verified": { "type": "boolean" }, + "id": { "format": "uuid", "type": "string" }, + "name": { "type": "string" }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "role": { "type": "string" }, + "source": { + "description": "Whether the member has access through the project directly or through\nworkspace membership.", + "enum": ["project", "workspace"], + "type": "string" + } + }, + "required": ["id", "email", "name", "email_verified", "role"], + "type": "object", + "title": "projectMember" + }, + "type": "array", + "title": "projectMembers" + } + } + }, + "description": "projectMembers" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.", + "properties": { + "code": { + "description": "The status code", + "example": 404, + "format": "int64", + "type": "integer" + }, + "debug": { + "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.", + "example": "SQL field \"foo\" is not a bool.", + "type": "string" + }, + "details": { "description": "Further error details" }, + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + }, + "id": { + "description": "The error ID\n\nUseful when trying to identify various errors in application logic.", + "type": "string" + }, + "message": { + "description": "Error message\n\nThe error's message.", + "example": "The resource could not be found", + "type": "string" + }, + "reason": { + "description": "A human-readable reason for the error", + "example": "User with ID 1234 does not exist.", + "type": "string" + }, + "request": { + "description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.", + "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", + "type": "string" + }, + "status": { + "description": "The status description", + "example": "Not Found", + "type": "string" + } + }, + "required": ["message"], + "title": "Error response", + "type": "object" + } + } + }, + "description": "genericError" + }, + "406": { + "content": { + "application/json": { + "schema": { + "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.", + "properties": { + "code": { + "description": "The status code", + "example": 404, + "format": "int64", + "type": "integer" + }, + "debug": { + "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.", + "example": "SQL field \"foo\" is not a bool.", + "type": "string" + }, + "details": { "description": "Further error details" }, + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + }, + "id": { + "description": "The error ID\n\nUseful when trying to identify various errors in application logic.", + "type": "string" + }, + "message": { + "description": "Error message\n\nThe error's message.", + "example": "The resource could not be found", + "type": "string" + }, + "reason": { + "description": "A human-readable reason for the error", + "example": "User with ID 1234 does not exist.", + "type": "string" + }, + "request": { + "description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.", + "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", + "type": "string" + }, + "status": { + "description": "The status description", + "example": "Not Found", + "type": "string" + } + }, + "required": ["message"], + "title": "Error response", + "type": "object" + } + } + }, + "description": "genericError" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.", + "properties": { + "code": { + "description": "The status code", + "example": 404, + "format": "int64", + "type": "integer" + }, + "debug": { + "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.", + "example": "SQL field \"foo\" is not a bool.", + "type": "string" + }, + "details": { "description": "Further error details" }, + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + }, + "id": { + "description": "The error ID\n\nUseful when trying to identify various errors in application logic.", + "type": "string" + }, + "message": { + "description": "Error message\n\nThe error's message.", + "example": "The resource could not be found", + "type": "string" + }, + "reason": { + "description": "A human-readable reason for the error", + "example": "User with ID 1234 does not exist.", + "type": "string" + }, + "request": { + "description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.", + "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", + "type": "string" + }, + "status": { + "description": "The status description", + "example": "Not Found", + "type": "string" + } + }, + "required": ["message"], + "title": "Error response", + "type": "object" + } + } + }, + "description": "genericError" + } + } +} diff --git a/docs/reference/openapi/get-project-members.api.mdx b/docs/reference/openapi/get-project-members.api.mdx new file mode 100644 index 0000000000..bf54f4c288 --- /dev/null +++ b/docs/reference/openapi/get-project-members.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-project-members +title: "Get all members associated with this project" +description: "This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`." +sidebar_label: "Get all members associated with this project" +hide_title: true +hide_table_of_contents: true +api: eJztW1tz2zYW/itnmelEmpGoJHWyO+pmZ91YSb1NHdd2tg+Wx4bIQxE1CbAAaFt19d93DgDeJDppLt0n6cGWQODgw8G5A7wPYtSR4oXhUgTT4CzlGlDEheTCgMLfSq5Qg0kRSo0KjIQFAoMc8wUqkIl9VCj5K0YGbrlJbYOSGcLVu1+OZidXIBVcHcz+O3v77nh2chUGo0AWqBjNeBgH02CJ5tgR+MlS1cEoKJhiORr6MT2/DzhhK5hJg1EgWI70yw0JRoFHGQdTo0ocBTpKMWfB9D4wq4K6aqO4WAbr9QV11oUUGjU9f/bkCf2LpDAoDH1lRZHxyGKb/KqJJfctetxgbgcWipZguCOzUMiuL5cZ0/Znl6Pf08M39Ay4BkIItykKyyYeozDcrB5rUBjJG1QrYHGsUGtImQZLeGwJz0XdAwVbZBhDItUmlahUCoUBqZZM8N/tOojhnhELKTNkIliPAswZz3p45J9c3qDiCSem3veM5rY9kSpnJpgGZcnjZpaGlNuqnjna+C57iO3RPpdZRguttrVLZBQYbuhhcFRm2fv3hwdEl+Sud0ItSxXh9u78kqJJ0fHRyzQxnkUR7YFJlSyXaUfGY64wMtkKLPft87m4lepaFyyqiOiUF8R3FGUeTM9bwlr3DC62GLZuy/J5YHnq9smzcmtz/IobUnLh56m4U7Q1izjhOzKl2OqhfjpYE5guqzZ7jIK9J08/SX269GZKSQW1PgJTCJqE16oHE4C2wwDDZQilYKVJpeK/YzyCBYutbUJtRhCG4RBkZEU/JqZ3lTOScc++n6UI2jBTarAdRgHesbwgVuw92Rs10siFebHXyDYXBpeOkTEuyuU25QNqBi4cBS7FXMyFNasJxywmIyATgwKENIB3hdQYk1ktlDQkX2zJuNAGMmTXXCznQqPQ3PAbbBMN24iD05/feurzIJFyHtAsRJ8BKW3Yp5sxGsazHoP1ulRWJRz7q25kGKjhY/u4xf8PsolEh5YL8SbXQrA84xpKXbIsW7n13DBujQIwEVtNdQ7Jm8QuV2iPY2bYgmkEFrPCoIJbpkmYiISRkHARW+3GDHOS4R5GPbDsI5ajteg02rKAVHQbgZdTJIl1VggiWWaxXc8CIZGl6DWeluhlZ9JtJta/GlYmfv9azATp/I1gplRYeW07QRfwu0Xjxw8P4Omzb/eeQyxRe2nlupdFzoJ3sR0eEHcYlIL/VlYsOjwI5yJBC+NSSHPZbOhMqdfuwZE0+1XzXPxWSsMu8S5CjDGmbj9Ty8w3tIxsL91gFHQpbNvdUXA3XsoxkRnTGoJpP6nPhrgeBTlqzZY9hugn96DZvkae/Jhe7XW267LfuL2SMcldoZDsaZtky+TBgAwd7D35lv48dXY0/HRDuH7Y9yxRoOKRNRCvvJN4QFrO0kZEyGC+15iUmY+U1IqLJamri3SSFdwwxWWp3RANXEDL80AmlzzqZduD2zBrc9xZbA/osW5vxKZuf5JGK2S6T433IS1zJsYKWWwFzXWsAzxngdqTv6dYvK2lG0rau3hvifqZ7x969ndbGp9V+SvafSWsWeYCpIpdamAUi3Au/K6wSEmtQaO64RECU1HKycWVCnVj3h1hBhTCdTkc/x2T53uLp2OMnj4f773AF+NFFC3Gz5/tLf7xLHry7XN88bBufNDntx+0pzySBl73b99GcFZJ0kUj7luOsKsXPSFVW0FcQPViF1DtAqpdQLULqHYB1S6g2gVUu4BqF1B9SUAVY8LKzOyCql1QtQuqdkHVLqjaBVW7oGoXVO2Cqs8Pqgg6RqXiZmWP5qVa/VKdae4X/Eek5gs6aieWVgf422t8p1ZwhIbOQ61ZUTKDImMCYf/4EG5THqXOr7rAI2eCDNBKlqoz1J9Kautq68NVTXtUqiyYBqkxhZ5OJqzgYSSFlhmGUq1CnQYE0rClbp/QXpCdlWo1VsxgxnNuxosyukYyLgsWXcsk4RGOWZxzMc7krbXLZKlO7e641WZMLGmZqwJP7bKDUZCxBRKef0u1mkQZd368OpcOeF5IZeB+LgAA/H2I/YKPXMMrKRK+LJWP1daQKJnD4xaxx9+RStAKDfGz6Q0vQeBtl8Jg+F3VlxX8UGjDRIS+ZzP5oENoaGfI0FRMn4ITu+9gMoGBj7Vps0oRY8IFxsMG072X6pGNdmANL4HdMt4BEG5dBRm45fsJ52L4XbAe1Qx+I1uMFYzCzzZPCxZdk9DkjNv41vN4MBdzM3cJwZ2ZB+5nktdfpXbfZIGCFdzxF+bBkpu0XISRzCcN38dLSb3tSpNSRHa2wZB2cm6qSwPTlzCvROzSK/I8ILY5DsIfQOPnprtz05fQwRAe4e3GPtIgVvBXDmPfgP3jQ/d0YzdpJJmBEagRGW8aXFMKKyE4PgzfbG2KZ134PYuul4os0WA4qjZpGM7uMCoNOnA8scT/9hIEzxxX5ibJTfi6UFyYZCB1eGpiVGoEc2+drEONWJYRa64+BOXqagrf3MznYh7YRQw/Qv91mWXww9nZcW0BW+Pd6DX9mUzqDk7VrrannsL5RaeJBm7PLEtDM590yX1wUW1MqIvhXKzbYn+8Mql1CZXok7160KRItbp0D+fCzt00hLmMMdNhJZn+BowfuLG2zbGK3K7vul9wiiMLZ51sz8IyoergfpGMP4IDsg02VkoRUklUNEg7lmXWjntTYvOmyn4XGVs5WavgarLjrOCaNJIInyJ2TV9YrGx4wiDj2lBGwbIMdFkQJow37GRz5yy0RqtjQlsL72qgM1B2GaTkfxZuZTIeATlDb2LysmW80fKHCgoUTvqgkbhT1Rg2URMxijGjSKrY2vP6Ph65VOeOoXLeUMiMR6uQRs2cRdKWWcii1M4BOZpUxrbkUSh5wyltWGAmb0fkll3Q50aCSZkhSpoZrhOO2nlqS4b6Rkxj6Nb7ql7f98gUqu56prAdUHzybrjrW5dGXqPtrUMUN1xJcT4Pvp/tn8xOLs/e/Tg7mgcX9TbMKFgEBt62Od4xAbxyjj4fJVZW6mT7tLDsV+Zzw9QCXSkruO82dSAfwSuFzODDk9hrf3Y9Bb/kjZNuzdjy1c0Ew47ThJfweMP1PIZH5Hi816G+Rq08LAftDRqrK/46GzCtZcQZKY0XKq4br1yNIwi12XzZgU2u/bJrZ/Sg8hgNBWsmBvMqb3GUZNKKScb/6qE0tdayTccRagPyT9HaKajNFe0NTrcRNB063uhjQOAbbbHAN4BDG2HejXV8PY5lZIP9VkxIVUe+dNWOvmuwg2F1EdZFlVsXXzcLBN0gu21E64Bs67qsuxNrSiXOHLV9uhj4zw6Sf1G+spSbgHviAnPX8v5fhP7jQDecL2EsnGPcZuyW5P15cJ+B7C3X5rwD7mLQ+Rnm8dBmUnhnqG4qhYNxTcnTQ/nHKLhhWYkP5SEUH1Tja4Grx+wEbyd4jeDRQOfcHUqLyaTBNJhUwcrk3n9bT/L6Vn4VO5zSYYm/+840j+oDFCed1FKvhAIiYtHCOvtuT9e01VVSRPDMXgrP5K2dphMjvPL1xE7j+062n65ixcIYc+mT/YkjOqG/tJJIFm4BMkkyLqwAgm2t3nqIneH3BSay/QoThToFG1doGLCMMxczXXkqly7yuKJd7jZ9On33noSgOmRw4qtcTMC7AsXhAUVRgpz74QGcUXd7tZu+/Ek+GDeoVRd1TLeX81f7FrMjvF2hkj78a78qspIlCMSYIJ63CzQUylzj6mJQQbq9vbVYKI0mIzWJpCBXqycFKk05wNixbGwx2mrvx0Wmpwr1ibib6tE4wxvM/v/LoKqzSGR1Wskia6r9mxqBT1v+7YtX9YswhOzUPQu2aneP4JBKa3EZudTsQEYlHSG5QNrmRlkGRbnIeOSSC3IoXBtlqym21LZ/fKhD2O8+oEaIGB3aZCv7TpBdLMY+KmZwwzIew7FnBjiRcsIawrGb0VKh/CKXmt6pKF3ZFhZK3mqXiM3Fo0dwevCj9ueTsV+Br44u/NtJjlJ9CMLdUVJrB0ObaNUTts7otCVf17ETmWXylvSR0u2SLVFPCcYf8Nb/9pHiH3Agb0UmWUwE4HM+RKK9IV/p8wehHXc+sNnw6Z+vQKKfLKE9YMp0GHNelIswxptG43zDxJf19KTJg4a9vD0/me0f/DRrKGwU8HR8PVlkcjHJmTaofEFP+/+TmCkzcSTIb7Z5Gx7NzrpTiXKJJpRq2bUQdXOD+p1ahS5LnAy/JlppBG7htWhnGb/jqj1VindhkTdTud9/lrNfAS1aSL1o38jNqRrSD05X12L/EklYym058Gj/w25Yd6qc3aDoSoJGOlYK6ycTpgxPWGQmOiUnMmkKeMMvR/sru2EPyC2hdUlALbdF/qvustbKbdVcycSkddQw/Jq8JQ/oPFYb8ybawS/kVBI0UTr8XNhjP/wvAe+Id5YAtIbjH443RNEho+PPjox0mjuauMH1LwZdpEWPOFuOu8pyB+2q4BtAfUuVKrSEd7KtfV+O1kLqtRQn5WLVnUqVi9USc91F3G6d0JeOvn1VtDTVA7p3QsXdzlQR5fg65LKZrW7y3x5E+pXQ6n4PR2cLPEI6IJ7WSep+waIU4Vn4ZOtwlXSP2ceWx36snrw9fDU7Op2Nn4VPwtTkmc1SUOX6XXLqDtwp5zRSt+5jVCEnFS9QaRfHZsQMG98WUpuciRauT6lVbibVrXuB/6d3333ETzVmOiTgNnOz3Lz3SXh9GE0smDbAqzz8YhTQcQN1vL+na2PvVbZeU/NvJSp7/E51H8Xd29N0+s61vXkWTBOWafwADwYnPjkdwkNYqxeIxapVkgpGvvhUwV1frEdBiiymnL8ubVESULRLWVtXMTuliTezs2Bk0/z2a+hV7lRVFM7v+zHd37seNuVYr2uIPvW9WK/X/wMJ5Gun +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-project.ParamsDetails.json b/docs/reference/openapi/get-project.ParamsDetails.json new file mode 100644 index 0000000000..6d2900b86b --- /dev/null +++ b/docs/reference/openapi/get-project.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "Project ID\n\nThe project's ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-project.RequestSchema.json b/docs/reference/openapi/get-project.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-project.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-project.StatusCodes.json b/docs/reference/openapi/get-project.StatusCodes.json new file mode 100644 index 0000000000..b1abef2620 --- /dev/null +++ b/docs/reference/openapi/get-project.StatusCodes.json @@ -0,0 +1,395 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "cors_admin": { + "properties": { + "enabled": { + "description": "Whether CORS is enabled for this endpoint.", + "type": "boolean" + }, + "origins": { + "description": "The allowed origins. Use `*` to allow all origins. A wildcard can also be used in the subdomain, i.e. `https://*.example.com` will allow all origins on all subdomains of `example.com`.", + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object", + "title": "projectCors" + }, + "cors_public": { + "properties": { + "enabled": { + "description": "Whether CORS is enabled for this endpoint.", + "type": "boolean" + }, + "origins": { + "description": "The allowed origins. Use `*` to allow all origins. A wildcard can also be used in the subdomain, i.e. `https://*.example.com` will allow all origins on all subdomains of `example.com`.", + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object", + "title": "projectCors" + }, + "environment": { + "description": "The environment of the project.\nprod Production\nstage Staging\ndev Development", + "enum": ["prod", "stage", "dev"], + "type": "string", + "x-go-enum-desc": "prod Production\nstage Staging\ndev Development" + }, + "home_region": { + "description": "The project home region.\n\nThis is used to set where the project data is stored and where the project's endpoints are located.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "id": { + "description": "The project's ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the project.", + "type": "string" + }, + "organizations": { + "description": "The organizations of the project.\n\nOrganizations are used to group users and enforce certain restrictions like usage of SSO.", + "items": { + "properties": { + "default_region": { + "description": "DefaultRegion sets the default region for identities provisioned into\nthis organization, when the identity does not specify a region explictly.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "domains": { + "description": "The list of organization's domains.", + "items": { "type": "string" }, + "type": "array" + }, + "id": { + "description": "The organization's ID.", + "format": "uuid", + "type": "string" + }, + "label": { + "description": "The organization's human-readable label.", + "type": "string" + } + }, + "required": ["id", "label", "domains"], + "type": "object", + "title": "basicOrganization" + }, + "type": "array" + }, + "revision_id": { + "description": "The configuration revision ID.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "services": { + "properties": { + "account_experience": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServiceAccountExperience" + }, + "identity": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServiceIdentity" + }, + "oauth2": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServiceOAuth2" + }, + "permission": { + "properties": { "config": { "type": "object" } }, + "required": ["config"], + "type": "object", + "title": "projectServicePermission" + } + }, + "type": "object", + "title": "projectServices" + }, + "slug": { + "description": "The project's slug", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the project.\nrunning Running\nhalted Halted\ndeleted Deleted", + "enum": ["running", "halted", "deleted"], + "readOnly": true, + "type": "string", + "x-go-enum-desc": "running Running\nhalted Halted\ndeleted Deleted" + }, + "workspace_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + } + }, + "required": [ + "id", + "revision_id", + "slug", + "services", + "state", + "name", + "environment", + "home_region", + "organizations" + ], + "type": "object", + "title": "project" + } + } + }, + "description": "project" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-project.api.mdx b/docs/reference/openapi/get-project.api.mdx new file mode 100644 index 0000000000..97858fd3a4 --- /dev/null +++ b/docs/reference/openapi/get-project.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-project +title: "Get a Project" +description: "Get a project you have access to by its ID." +sidebar_label: "Get a Project" +hide_title: true +hide_table_of_contents: true +api: eJztXN1z4zaS/1f6OJUaa0uiJpO5e1BqrtaxlYk2u7bPHlceTJcMkS0RMQkwAGhZ6+h/v2oA/NLHjJ1M5u5BfpBEEOhuNBo/dDcAPwUJ6ljxwnApglHwAQ0wKJT8FWMDK1lCyh4QWByj1mAkzFbAjYbJaRj0A1mgYtRykgSjYIHmwjUM+kHBFMvRoNLB6OZpg4uvBpPTSETiY4oVx9cVZU7VCmbSoB8IliM9uSpTngT9QOFvJVeYBCOjSuwHOk4xZ8HoKTCrgmpro7hYBOv1LVXWhRQaNb1/++YNfcVSGBSGfrKiyHhs+zH8VZOATy16haJeGu5ax1LpKUtyLrbfoWCzjETa7O4vKZoUFZycX14B1+ArwlwqMKktSArJhaGee/lnUmbIRLDuB1LxBRd6my4pjmWZXGICvlII1xrh7m93NFb2HX02b49hybMkZiqBmAlgmZYwQyg1JsAFmBRBl7NE5oyLPvAQQ7hLjSn0aDj8W4iPLC8yDGOZ3xGhbJsFSGEfayoa5Bzu2i3t+BrM9Y7hqvvPlGKrYN0UyJm3LMNN1rKHE6k0tbMjU5SzjMeHofn/NTQoHriSIvfzbVtTrQokkmkAIYxEoWQCF0omZUxNIqENWyBcGbbgYhGJBB/gFB8wk4XlQPzKPBjdkBiEFbZ+0A8SfAhu+xvd6gePg4UcUJMBCeakfxHDdT9IZY5ThQvu0GO7hxWiUkVwFUOHfVyT3dlRNhI0GlimqLCtBEiYYVRLG6kwASaS7UqvG1vVwBRCJmNmMAkjgeUgRmEUy2B8feJ+RYJpzgZCKpMi0waONWdn9DRm2kSi1ANbfH1VPy/RPv+C9IwljK8dEduUasD1VSQWmZyxDD7Yr9ZgNEIE/aDLO+gHnp37RYyoZelr2tKgHzjSzxrD/8Mur/sB34E0u1a5uVQ5M8EoKEu/qrHkXGSralXbmoFuKdxFmt5szp1gBwWpFkzwf9vVbg9udapsz8dInHcqkK1V5rtQsizoSWlrpSjmUsUIMSrDuACFJEnsGmb8nlrS3JJzuLo676BPF8ATnLMyM3vn2Kl7f2lf0yzSVmrfzM84i+o8QWE40aU+PXDNpbAIa2QkLOS3+9+niebA1zdcQSJRg5AGdIExn6+AVfTxkTwJk60Ok+7rTzq/pu226Yxru7S0x/a1Bt/mJcve/tm9QXv3FN+inrEZZs8imJY5EwPCCPJRwDbcMcfXbe/4JrBcHZNGR7f71+4Z0zxuz/BdKlDoJs50ny5iKeZ8UbroAKrqfxT2NKoHHuMOXGBxLEthpvhYoOIoYtzls5MsraH1fd7UlK/3Cd14ELxy4hw73uOGtTUOhxJfT4xJxZHQnZUmffv1eJ8fW37rflCgyrnWHpy/DveLhuczvNGryojIoLJy8bkl2tZ5jnEaZvYsyvbV9gqqSiG4WMCl+45EyjKDCfxkv8jBzJCeT913C899y6AfuCbWq3WVbj8n6g7Afqkg636wlOpeFyxGP/U7c/kdRetllhE+7ROiGpWzMsuuryenuwGrDTB+uFowUCndO0TdCKPrjW96PJ83rmBNEnUHs37VD969+fZF+YOdViESCvPO1Qr+cXV+BscXE0ClpAKnTgLJjQCW3m6TG9tGVX5jq1WCs112fkrFBNHGBoG2FnDheFNkAk1YUrIsW1lvhz0wbkfWenYpc+kgrEJmktmHkr6fFLXMmEZgCSsMKlgyDaWtTU3nXCR2YmCGfuC25taebp+Rs8udi+f0RnawLQGZFWqyYIValtYTlWWW2P7MEOayFDsXZUt02mG6rcT6qVHlvFQ2ndBSJkXdxjroplQ1GFgGXYHPrT3CkpsUJqfw7dvv3v1n42viI9c7VbRrBZ6cknYYlIL/VlYqmpyGkZijFWMqpJk2AzpW6kf34kya46o4Er+V0rApPsaICSZU7X+oZOwLWsC0k27QD7oUnuVFflkR1/0gR01Bxraa/uVeNMPX2JNvszOEIuwp9TSWyQ6aJzIhuysUahSmTdI1A2oGR+/evOvDuzff0ce3fQjDsNexBnrfYCsX5r/eNaJwYXCB6pOL3gIFKh5bgDjxWLWJtG523TaNajByuHLZ4Mrmwr2FkJbWB8fUweR3B5g8wOQBJg8weYDJT8HkuwNMHmDyAJMHmDzA5H6Y9Hn8A1QeoPIAlQeoPEDlPqi0myVxqewOxM1TINXqlypje1zwn5GKb+lQFCVTd5/OoglMCHmGhrK9dpSUzKDImEAr5TLlcdo+tpAzQeO5kqXqNPV5U7cZXKeO7X5bqbJgFFQHWFjBw1gKLTMMpVqFOg1ISMMW2p/ksP2/JbOVajVQzGDGc24GszK+R2M3ruJ7OZ/zGAf2gNYgx4SXubV0GvsrO8KuwxkTC+rpqsAr2/N6j2wU/F2q1TDOuENGh1409nkhlYGnSAAA+BNsxwXvu4KT9oZXJNYwVzKH1y1ir7+nvXPqpNnYHnsPApddCke976u6rOATOoIiYvQ1G+ZHHUI9yyFDU+l9kozATZ/vYThsTt0BtLY6oshtVsJRtVtuJJQiwTkXmPQaoZ/8TOq78yhreA9syXhHwrA5BHjkFFOLEone98G6Xyv/g2wpXTDDH7Ct74LF92RTtGFJMnj9H0UiMpHzAh5NFLjHeV7/lNr9kgUKVnCne4iCBTdpOaNTTsNmTAYLSbVtJ+eliC23ox6NcmRqyWH0HqKgfpx6sIgCGA69fuF32KNep1xiEJnusI/eQ0fI8AyXG0ZAjVjBT1wndjU4vpi4txumQC3JPemD6hMOUuOaUlhZ0MUk/NAMmFdq+AOL7+kkh0iOev1mAHvh+BHj0qCTi88t3f94D4JnTmORmecm/LFQXJj5kdThlUlQqT5E3mGyhylilmWksrudUtzdjeCbhygSUWAF732G8I9llsFPHz9e1N5Yq71rvaaP4bCu4ObmXYvnqBo9qrnNSpaGWF122+8Wv80dddGLxLpt9Rcrk9ptqcryCc32oo1Uq6l7GQnLtCkIc5lgpsPqjJhvUfdjszodvakqHRec1unCYZWtWdgOVxXcExntKzglIKDxohU1lURFg7RtWWaB3eOG9UsrQC8ytnI2VEmoCdhZwTXNQSJ8hRvnBMJiZY/osPq4hjuuWJBMmGygZnPCOLQI1QHUVse7U8qBku0GTerniluBxCs7tT2o5GULyt1hPNp/p+14F5VY7VCRVH4DsiU1EeOCjlZLlVh0tx4oUaE11q3PUK3mUMiMx3Sw6BWMHf5oqyxkcWp5QI4mlYk9j2VPNpFbNsNMLvu0TjuHyLUEkzJDlDQzXM/pLJRdui0ZqhszjaHr70ndvx+QKVTd/oxg28N48Wi40+VTI+/R1tah38+9iYIfxseX48vpx/Ofx2dRcFsPw1hQYMPAY5bTHRPAq6XS+/ukymoG2TotWY4rPNzATmCasNJXGzkhX8GJQtrO38uEae37U/Apb5bsFsfWyt0w6HUWyilP4D28bp6q5eY1vKLF5jkrDZEzauUld9K7k/01PFQvSIwaF993RKe1fOppHzXy9JrGFiWOIh/yeSJy3nJQBv/dIjKyuNhu7wi0ZfBv0cIT1ChFQ4Kjbc5Nhc7Ssk8A+EZbGeAbwJ71MB8HOrkfJDK2cXvLIaRcAl+44LFzueGoV11vcL5k93rCZDus3fTYP+OHbd1ucFcYTKnER0e3umWx7gcLuSloez03j601+6+R+g/IXLglcFvBtbF9Utbpxjm6v0jSI/8d5knPxlX4aFBod2z25im4p1BqXzTSDx5YVuInohJyCSoStQXWzQ6WeLDEfZZI1dxS72S1Epo0GAXDynUZPjUSroMmJXBFyVGXobTHPOuEaX3ws+kPeUako5ld9bs1XdFW1eb04TyTS3c+s+0snPjETafwupMHSFeJYmGCufRpgKEjOqRP6kksC9cBOZ9nXBD7Y7ClUGnTLQU+BUmrgcK5Qp2CdTA0HLGMM+c83XkqU+eC3NFwd4teTt/dixOUHgwuXSXyGc4LFJNTcqeEN4mPVN2erqUfz9SDcY1aCShWHcGUanVsZXaEt1Pg0vuBrWtN9oqfQHupBG7aqRvyae5xdXtUibRcLq0sFEETWg1jKWjx1cMClaZgYOBUNrAy2rTa501mR37qhXI3eaVBRrdyvn43KBks5rLanWCxxWzMGach9fHL331aq77PSJJduXfBVlbvFUwo6VZfQTqVcUm5eudR2yApy8Bdd3NRBi0uXBtlEyk2CXd8MaFrZd0XVGjvl0mRrSgV7zpLpz2dCw0PLOMJXHhlgDMpZ6whXDiOlgoFGrnUJlvVl9RmSi61i8gi8eoVXJ3+rP0lp8T3AFxHZ6gr11m3djj8RbfWCIYWOWuGrc0Qbcn7q3q0p0AX3mg+UqhdsgXqEYnxO/zTP3vf8Xc4lUuRSZYQAfgjf0SiPSBf6O93knbQ+YPNgpf/fQESu8mStKdMmY5ibopyFib40Mw4XzD0GT09bAKi3k7d3lyOj0//NW4obOTudHI/nGVyNsyZNqh8Lk/772HClBk6ErRktnUbno0/dlmJcoEmlGrRRYi6uJH6XK1CFy4Oe19SWmkEbslrpR1n/JGrNqsUH8Mib1i55+dq9gtIi1akndJ+kJusGtJ72dVp2L/EEhZy2w68tP9gD6zLKmcPKLqWoJGpOA3rN0OmDJ+z2Ax1SovIsEne9f68tL+yB7bHbklaFw3Udlvkv+quaq3dVsWVTQxbOxC9L6lbWgHditWWeVPao19oUZmjidPeHxV74Jv/JcI74p0uAPXh4qeLDVN0knG9gRad4s5M3ND6nxa6SIsd5mw17rLKHWlXBd8Q1JdUUULLeIfbs+/PS2tF2okUl+Vs1WWlytlqgbnuStwuHdKPznz7otISqz1z75KyvB1WMcX7OuSy4VYX+V97Jf1C0urdKxztK/AYaet4VEerxwWLU4S34ZutbVeae8y+tjr2bfXwn5OT8dnVePA2fBOmJrf3Kw2qXJ/P/TUqCjeN1K2N78rlpCwGKncTLMhIGS7WltrkTLTk6mQkN2Pn1kGfF/5TEu+aU1aY0vrchli2208+UK73k0nWUSuYv6W7Q9pQjacnOkFzrbL1mop/K1HZrXNK0SjuLjjRzjnX/j9LzFmm8ROdOLr04WOvlb/d9+9PdvahuoQpVq38UtD3aaRWN9a39C8JkCUUt9epKnLki3Zqauv4VCez8GH8kW4CU9jdXNyr458qK3DztFuspydXw4YN63UtpQ9fb9fr9f8C8BhTaA== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Get a project you have access to by its ID. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-recovery-flow.ParamsDetails.json b/docs/reference/openapi/get-recovery-flow.ParamsDetails.json new file mode 100644 index 0000000000..3a1797475c --- /dev/null +++ b/docs/reference/openapi/get-recovery-flow.ParamsDetails.json @@ -0,0 +1,17 @@ +{ + "parameters": [ + { + "description": "The Flow ID\n\nThe value for this parameter comes from `request` URL Query parameter sent to your\napplication (e.g. `/recovery?flow=abcde`).", + "in": "query", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies\n\nWhen using the SDK in a browser app, on the server side you must include the HTTP Cookie Header\nsent by the client to your server here. This ensures that CSRF and session cookies are respected.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-recovery-flow.RequestSchema.json b/docs/reference/openapi/get-recovery-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-recovery-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-recovery-flow.StatusCodes.json b/docs/reference/openapi/get-recovery-flow.StatusCodes.json new file mode 100644 index 0000000000..b83a5d6750 --- /dev/null +++ b/docs/reference/openapi/get-recovery-flow.StatusCodes.json @@ -0,0 +1,1401 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This request is used when an identity wants to recover their account.\n\nWe recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)", + "properties": { + "active": { + "description": "Active, if set, contains the recovery method that is being used. It is initially\nnot set.", + "type": "string" + }, + "continue_with": { + "description": "Contains possible actions that could follow this flow", + "items": { + "discriminator": { + "mapping": { + "redirect_browser_to": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + }, + "set_ory_session_token": { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + "show_recovery_ui": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + "show_settings_ui": { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + "show_verification_ui": { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + } + }, + "propertyName": "action" + }, + "oneOf": [ + { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + }, + { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + } + ], + "type": "object", + "title": "continueWith" + }, + "type": "array" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting,\na new request has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the request's unique ID. When performing the recovery flow, this\nrepresents the id in the recovery ui's query parameter: http://?request=", + "format": "uuid", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the request occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. recover account via email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the recovery challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the recovery flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "title": "A Recovery Flow", + "type": "object" + } + } + }, + "description": "recoveryFlow" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-recovery-flow.api.mdx b/docs/reference/openapi/get-recovery-flow.api.mdx new file mode 100644 index 0000000000..35373c0b8a --- /dev/null +++ b/docs/reference/openapi/get-recovery-flow.api.mdx @@ -0,0 +1,54 @@ +--- +id: get-recovery-flow +title: "Get Recovery Flow" +description: "This endpoint returns a recovery flow's context with, for example, error details and other information." +sidebar_label: "Get Recovery Flow" +hide_title: true +hide_table_of_contents: true +api: eJztXf9327iR/1dQ7uvZek+i0u3e/aBttufaya66+eLazuXuRXkWREIS1iTAAKBlNfX/fm9mAIqUKMfZONs0ZX6IbRAYDAYzA2DwAfA+SoVNjCyc1CoaRRdLaZlQaaGlcswIVxplGWdGJPpamDWbZ3p1YFmilRM3jq2kW/bZXBsmbnheZKLPhDHasFQ4LjPLuEqZdkthmFRzbXIOFcUTNVF/MXplhUGKlombQiSOuaVgXDk5OD4/e8oSra+kYE6zmWBSJVmZipRJhdmMeFcK6w4s++ni4pQdU96fBE+FiSfqqTbs6K9H/xvyWbbWJctL65hQtjSCuSV3vgrLuNlbA9NmQ2Qls4zNucywDeM5Ui2twAIzatIAmoRCscJcCzOwMhWMF4XtYzZIlYmwTAmRQutMqZhWjLNE57lWzOlikIlrkQ1SnXOpJgrECDWFEnNtVtykSE6qROdSLRpyWKIcIKurd+kIuJ5Op7/YiSqsKFM9SHQqQu9NlNGlEyZeCHd4MAy9ftBn3K5VwualSqAD2aER7/rMCNtj7ycq0co67Ej2mPEVl44lmRTKAZ0zT+RppldQLCbWDg+I04Me0HkXvyuFWb85QP162wM2jbCxEQrz1jiBHL2Juu1hQyDjc42dV6kXS7gCjZnrUqWMO/bmpVmznw132rKjJNGlciywxU50UuZCOSz69jCOh1Zk84HvpCGq55BTqUHgoxdH/UgXwmCpcRqNoq2mRv2o4Ibnwgljo9Gb9zuWJhjkY+MTaAP8ec2zUqDeYJ9VxUEthGVzo3M29Zo4Za/OnrG/gdBqGa1QDvp8rUszUbwoMpmQSA5FvIjZtOrSP0O7HvNZkoopNkYCU9gJUT9SPBfRKJJp1I+gQmlEGo2cKUU/sslS5DwavY/cuoBc1hmpFtHtbX+7jTWFtNDI10uhWGlBV0Fxz09+BlPjwW7ARPpgCMFIoEVgOpXlegvFDLtWP1HY/tkav5MGBmkEekthRMy8mwM3YMkPoL8BK7PCWtShmmMwwoJ3EmklKNLhjaSIj+gu6bwFUdpCKyssfP/20SP4gZ5UOfi11l/DXyxI8H2NXoujDg5KWnBBKVuBfLliMhXKSbdmK66cRQ9D3Q6CkYZ5bUYX9lrgxzwXKmVG8DT0zptfZykFt3alTTowwgo32DEcsAsDluMkyYEnTl6L3RYeYXqfyTmzwvVxyOFSWe+aPU+5cEudUh9Ky2YC2AdhxGyMKVJJJ3mWrSdKaQekoBO3OqeP3SBVKS5hRNtl5jhUXmhr5SwTjKMjtGEUKbOUzXUGBo3GOycXIJ3IsZWpBHK5VNxpAwk5Lwqoe/Q+MiKVRiTu0tvBpdO7HIxVCrohcAzhNFK+GpPTpepngoVWpGAEdqlXII3a6F3KVvGTqu2KXysa73i24msQLrifHV6n4Kp3Utmx5+W1dEsiduZz+ZH/Qp+T+PuRUGUejd60SuLtdm/1o5vBQg+gzAB4jkZt5T6i/tv+/boAfDR4XbQnyl8f9pnTu5p1W3egb4K02yvctFTPfhGJA2rSZZCQ1Bqz0wxogBXuUpv1pXdfl05fiZZerbSIlIhX7m7FLZPWliLtoxvEiVht/LBL1DGa6UjwKVdC4VjFS7cEdwNk02qi9Kl61tqeKXj4lvSWvj4X7qVZn1OuC8i0o2ztIruPun0yE7f96B6dhSXAh0FnUB167gdHLHh/dburnXcq224TUNuWenUZvMplKb9Yd7XNKGjQVlJbvy31Kox6r8a7irPd+nvpzK+s9rYf4Vgyer8lCZm2e6jxSdCSxqIt6kc0QY5GUVnizG5nECxNtt/rtRH1ayD0CDR7lZZG64aDLK0wB7bmJ6nEq7NnfipWlXXrQiYwWrMSTB0djOIwEfDzOcuG7OiUFMm2jORbBiDT+3tVL3iJs/e9loSy/GialdFY4ZxUC/vgRhMIP5TR1BgNRlNL2qO95z7HPqOpt/7eRvMrqv0Eo6nk+JBG0yD6FRlNJfgHNJoNzcporoWRcz8TeXDDqRN/KOPZYjgY0FbyHm3+n1qufYa0LZF7G9MnsPAJRtWQ8UMa1g7hL8+4+hExyWeZuORpaoS17e3yH0mF/YR7FtoYwpKbteUHjbi15ntaYUMDHtC6m3SRplem9QsKpXiyMEVW4uW8JXTWWXtn7Z21/yta+06EuItHdPGIT49HdOuobh31JTj/L3cd1YXnuvDcv7SFfPbw3BdqId1+25e433bPktBSn48bw9fwt7gppBH2krvdBj+hb0eummTJXLDDVxfHPdrbr6OSPKGYjeeVFTPrQH9W0i4F7vuXRcqdqI+d/YniTIlVRWfJbYWwgq1yD3OovBEQGAAjbS6pzcuNT5gRBWz/I/igAdUqlXxXghOMGYJBCmGgooA5aHivProhUPYGMVnDZ1VmdmDZuyYWZsSWzhWj4fBPAFLwGIWY/FIoGJfysjTZD3/2DD7+k0x/uI8nppVJax+O8dP9ulAnSWnMx8jbl7xsHQrO6COYjK/cgx/IisCLwbLK0xApIYo22CiETHjsFEAoJqqGNGvgqwgNsUHKvTp7dgCAJbcEsBz1RA0U2LpOJnBhq+Gf4acLvY35CHxXRXGMaiNuHXctmJJzSN7WTsxL4+cGU4NAuWSptRWXhDEZMW6vNpbmNKPPjAcQCmGsAtTGI1/YteRM5FxmPcInXeIfI6SEv6IFzoRQFXwrVDJRgKYR6WWy5Fkm1EKMGvoDvWnLJBHWzsusWidXdlEVw5xEK0anZLiyMF5fFnydad42VwlZTilHBTJyGimxlDtOGrRjuZBnqfUVwT+pkU7kRQbjabTtOysn2eb/idy6EKiYQiKUFAZGXsgpKNvUO/RpXHPCF1DA20BFoVVR2nYTPNhHmLqmcPbTxfNn7Kk2OcyKRGUEBjlbaXOFaFg2025J4DTIixL46/nLF786ErEJDaH4uW8V0qYcYN3TP9VSHk+i9+9Z7Anc3k4ir6KPJ1GhrZtEP0xbpZELa/nCT2ADdKnJrUf+tveWL78BCMfslRWgm+j7ktI6ncu/g7sPVcVt+kDDSuUSpXL/9d0mn1ROLBB9F/p7fIJa9CG+GLH02kjnIJKhGM+FkahZapFJu2yVyn7trOiCek0U+Eg2VnM9UYSCfgL/T5S3UXZOP2sTMCgBf0I+QA/6DPeZg923stZQIYrKV3LHZKaUF5BxexqzncGS7oCG7crpOTlHWdPbhr88fXl+0WsTu9LpliY2Cb+A7x6f6c2U7AMNVWQiR8PVAfXoFyqvxgykcc0z+ByDlVbgdZwbAR7aj4JcsemfZL74YcocX/SBFiWponShih+mbFY6xjOr2dTqXLAi4zAwihuHZrZl7s4ZOSud+CAukO9a39KIebsqZlJdHVgGGdhhKqwDklKrHo6RMJqROY1YaeR9p3JHYcJGiNK5JKtr66nLdiuBTkJv3Bh0pUUxH+CKUtiA1eQsl6jKes6mkCGGz1PwoRMFiGgjc24kLD/9SMQzWo/lBXdyJjMEvYIXflkIBQvRP8aPYsbGPpZunSkTx6RjTiRL5deyfrklLZtEfBLFEzrbAJoNNg1dPYb/J0rmCzbO+UKAohzB/AAMDpvLzvHHRKXymp3Ia+kDosHS+b2M+sEqvq1stHPgnQPfJoFuJOTqE8WNEb/dlCdVO6pc1vbceePMwGY5oM+hAFp3q2Kk8nq3J4LWMis8qhq8Oto4rCJAXQzBxNlKpgvh/HaRbxLjONsMi5GTl8/ZkF1Lsdp1vknG2/bjjhh+ADD/9n4cnUDBpY6fmZ+8fN6qZTAhRredphLo8uy0UfdugaYQYD5NTpAXIM0rsR5Q5K3g0oQdMiP8RD4sFFIvvNgfI1mznK+r6SLIbwqcDeI4ntb66w6z/WeMAZ97CLj/CECcf65hAPT/tx0I2rxHq62HIm3WznilZ8FI2xUoX7RMWoRcLFsc+0+YHiLXElpVD4TsGTS6qYpXVJkvPpeWQjf+1tMVa5L2MRoV48Ayq0uTiPtOZ1cybTvI8xqSP1rltmwIWPWjJlXTDzq+x7RQFh8xiiJj+wdRlHUbCrIo3cfUgl0GtewuUkqnQVUz0RZGQ/hKLceGtD+9KIh2PFEU/GlydlQr+gS+gw7flelCZBNVmruyvDLZRGE0VblBOIN2R/5jynrqc06UEqv7lHshVpsyWlGkls7Q7i/0UokLmYtjnYqJgsAeTjRWYgZYFXVXq3ze1z5rzURRsDgRhP8hHtyPttsP6lhrVoSQug3HUG6bmXuZfdepD9qpOC22gNtqGdfORdj3AIIHloWsbC5FRrNAUwoITcx5ZusOY6Z1JjjSz/hMZN1asFsLYo/k/Aa2BdrGx+f85hl+wlWEj3E39C/nNzIvc0YU4vvN2OiYdOvo7sn6YBqDnK0d9zXN3HCW9Lnmbjg5+K1nb1olmUyudvvmpTqGDw11+oVfc09vtZTJsrbcFjciKSGOC9uMUNBDUOodg+6WlravxewIfCjOCE+g9xH2OWKv8JaBULk3GRt21qDvxTXPDnueAdQLK5LSQOcaaa/Q2QUCF0YuFniHiXWCp6366SXgs+4VRCBVlwev2sGc//xhuYRbI1xFsMCNfM7+yq859dPmwo7C6GuZElDlpVn3fQW+sK2Os9syWUIMHcbDn8WaGbGQ1tE1FzDGZHohQdrarAPPZ/UsIdE307ZlapR+BgT3FsOvmB8YuhLr9uz1jzu562PvWEl3Z+ntzHVqdza0JU+9bEDj3YdGW96age8RPaFqG4KjpHrzdlO2G9zIsUv/Lhbv43M6vfmN9QY9U/sW/0v1DDb2f4VnBnqf6Jix6k/wy1D+fm452+TcJ4MHcMooks4n/1vZVueTO735tT4ZHdC+o2Gw4BAp4a5tM6a2QRGWsDGVrcGdIsCIroqaqFTMpQJkhGJT6OZpwFrS0qhfQbW9I6MdLkJnYEiBW8YBq5aJxA1To4tUrxQzHLFXbgm7fGxuhBggmANXERTuo3r4DKuZqFBPgMQSkBcr4zWMBBXuM+tx58QEID9nPLlC8GFYe2WCFl6vxn47LNUMbnXKYPsPboDCy5324EXO6mAuGIUyAMVCIyGeUrt9rQqNrpaA72sRbloX7ubqNhitaJnHmU14xg0VRvzaIRlgn6kynwnTB41iPkTTg+vJJM/k36HXhZlxJ/MNuI4q39ONeGRiqx8LDnEw3wpOY2ijN3d3RrEF7epIjSP8KMCLZ4LZcpZD3CUN6igtI5XGCYFMrgSMhrTivrNtNel6iTKhHIyGVsMaGvSgVajE1bZUWU2o8U64hBp5Z4wEYglbgfSXRbDabTB3wZ0Tpu2oXC2y4TPtAcEG5nYDMeaK5Eq9WJlmKNIe6Nsf3toOtPgwF1pgs8EQSqGwwJ7YKWSoBVlR8i1ZXuAHgNGK5Gqmb1qyHPtPE7WUaSq2w6aQ5Sf80L6TAN/3BpupGRkE0UBZW76e44eJmpXO6ba6/4IfJgow2RgTznTC2+o54Q6jwc/gO+Xfk6st5g3fXp2Na/MJH9KrB/JRmBDk9yKDTScUDRRrbAZQe6N+RO2KEJpQ498n+G2De0eKOiX5IpQEjpjv99XByjFLjHqTZTC+0fWd2w4R47JeAWq7ENvbmB/jLXEvF7na3W/AW2TbGferTrpn1vOz694So63VRsK0+S4ymI9RRlboTCbrB8Y8YnAbVqV38XFgWZUPYP7Lf8XA9pcCnfFK9VtHtpVWSWvXqISmi8fnp7DuP2KYky6r5XT3Kh7BsjjxlTks9wVdRntMl76y8xDZOEUVjSfq/3QZJrVLfi0qAptjmIA1lnTvdKiiSRvYQZWH62sDN0BEupgBfdgiQ7SyP8Di68DSMNOndmBtv2uftMyFMcJ4u7rLDkPWO2xwL+7DkyDYx8dt5fmiz8fPn2z5kj3nBAnRQe5pp4FNt1M3/cpzelSVQkZbISCkXq3YKs8t4t19DAhP3GyCca37qmGH9MPnjv/9sFEgm8/lh1DuvzmYu7Wzu/37f8P9+y0SvvR+XCeUujcqjCIye5Bnu5d1bSq8876uDpf2lUOYOlzaV9ipHS6tG9c6XFqHS+twaR0urcOldXvZHQai05sOl9bh0jqf/IXbVueTO73pcGkdLq3DpXW4tA6X1kGOOlxapyQdLg3u+O6wEh1WottT+vfZU/rnYSV2nE13C1Z3C1Z3C9bD3YLVXY3bXY3bXY3bTRG+lqtxu7My3VmZ7qxMd1amOyvz8GdlugvHuwvHuwvHv74Lx+vTsdaJGGeZtBhcqU3H6N2ZKcz0Hk+iudaTaIp6CwtF28MXshZGl8WuZv0IycwWIgG9DB4IM3uy1a5D7R1qbXob/WMzkWl4w9bpGPdteZk5dkI/kX5t6yJsVPh0LdME1Wx8cqyVEklVwOi5zAQ7pZ8+FdrDnkl15f/GkwNwMMD/7bQr2MXLi9OQX+ursri0IjHCsWf4l/9UnR8IeIIap1dizTyswKduLPdyLo11bFwlPIW/Az+8cMmSs2P66VMtzzN2fvT8mf87FfB0H9V+gr9vGKgrOkmwuTsFAiOfDGKJ+hGIBAYpOmYCAoDEershnLE51uLbh8NWs01AhfiGxQ3PcftqwypUDr98e5lofPftXlbYqcOnqUP3hlm3zv+0N8x4m5SkZTlG6aVKsjKFCSCeXMLX/TTij+rvY+LECXqEoCcw4k9UmCBtwEavxnZ3wtidiOpUthaaqqY37AXNXZ8Lx7F+r2ytNwPslVxtAvz59nvDAxX0HEw/wgGSAhL9f/581K9CF376UHuOrzZ2eFdQm1+C+JszS3hY9IDmdHc8atribvDhwv1PVfuHFMMDiHfqSfVU6R59o7bW3pyuv13cfE4Y30INL+fWJ9YsvJPOntJD9Vstvd1ZWYbHYOmp9n703aPvKh+m0FfwoshgZiy1Gv5i6fVTAtvtCVI4rlJAXMJrxQizg4UWGSCZwq4nJevefWQbCxlhC5iX7ZRKxaxc7JY6geTNe8SYq+7zN6cOSlviEg/CUvyaS0S54ECxeWlbKMSzxNg3+PSkbycsnGccHhVOeeEA2s/h0WwkAY8xS//ErwfLtbnNPc2GA/vhEU6SWzjR2OSg/sqy32uk5+6hPTOI4pWq9U1sJHrZqHRXiNVfG1HOS7MzgGoKrCjuSiPCPiVW0GT4Jaogrb7HJ+wP3/7xu/9kqRYWuRU30raKaM+r5RgN8LEHEtH4JJ6ouUA2LpV2l5sOfWLMU/rwQrujkDxR70rt+KW4SYSAIxRPjPkbpDzxCTVf2Uo36kdNCvdylg/L4mYS3QL/9ENv42VuEpYvs/c97tJe4rKr5b3ldOdRbiJJxRguVA6/e/Rdn3336I/w3x/6LI7jXkMb4Pu9NrH3udOFUDAtQQfho847bpWsq+YeK2dEfuVs41c+6CaR1o9UKbrJPzzq3GTnJjs32bnJzk3ud5Mh0Ne5ys5Vdq6yc5Wdq9zjKoExvrCoGQZrx76/GWizHhjuRCZz6QazMrkS0MArw522g6KcZTIZLOViiZoBsjpHiVi83C3jagGmDWdQQlTHRy2j/9ZmPaQDgBBLIDjCKJJ5oY1j7yeKMcaeemaOCtmnlGOt5nJRhiOtt3QM76BG7eB72G2GrRQHmrLJzR4zJVZNCoe970NeXsixAl+fCJ+zVvthg1IPq8iEYzIdMdK079lwCD4MIhngD2qHKun0K+wQc8NzAa410TkciwXep97rTQFjyv5WQvhkkxF3OJ0mGElt5Apbk8MQQfkzBJke81mSimkvBvQq7Q8BDCWc+ewR04nWV1LUGf/p4uKUHWOyZXRIs8RbDsAczk9+xkgsmxm9sgLZ6Ac3aYW5BjZl6jE6pd3EviFDjTT7SfA0tGm2xs/UZ1ULPbmlMMKPakLZku5X4I4dn589xeHMCmvJkxPPgD2AYVUkTqQxOwzh9N5eQYRuf+8NvY/jH7tljxlfcdnQh3gh3FktUnVIuihTr5TExUT1vkcEiVf7H3VN3QFHfC3qml7w5Aq8Wc7hlDiEK1HzDydq4iYhij+J6M95Xv2qLf2mC6F4Ib0AJ9FCumU5ixOdDzfGMFhoyI3thVsbsLbDHtjXxMmUjR4DMD699I5sErHh0OsF+wf7cvQZ2CUpE8v0+x62v15thm4EQdS92ugxa6hC/EKstnwcFOKFPCbu2gocnY7p65ajg5LASZ+ZPoyLULiiFFcO8nQc/7hlImF/6S88uYIIukoPe714nB7KtBeTBA+pvb34Cd1CQozKOVb0u8dMyYwUdeLmuYufFkYqNz/UNj53qTCmzyZ+Rk2bVzzLoJend7A1nY7Y768nEzWJsD29D5B/WmYZdXqYtNfKU+lb+G84rDJ4K9iueMTqf0KZ3Uo1XCIwic6alO5qTp0bYYveRN3WXdDp2i1xpyC4IRjP9w662qwv6eNEYdWbhDjXqchsHKzzEqyT+XLNhm2XNAJsiHIeFRJmegUN3pizQAmEDPQXqPk3gGyQKpjtUlsEYQVTQLvxrh1XNkvnCjsaDouMr0nf4sJomP7YWJs1L6QF3wiEz4VozgziYk3XJmwwQFnGbFkATyLdmkZUzszGOIg0Zhi1hjeNkEYKbAY4sPuyG5w38P0EwIaMh61bWnrgVQ9+2uIXKzAjDP2IeWpMHQXj3TJ0vGOhkD7biLj9hh0bAWd891bCraWsUFZupk+1GuuzqE0NvTCEssfsYDMAHbBvwI9/YWPPZowHbptjz4bjr3vYARk4s/aaQdrxo3DNLb/NR+jpyiM+bqgHzKYuG47kUKZ9z8VjPyZsKKFHOJz4AIGnqOf12fnghx2SI/SKdTJEp86X/yrQI7HKMYEpiNEuA5sMjeHmA3yw31tkhf2eiR7iEG8GNr0apDrBmE9tcQRxKLmgwAMuCZsjag9BZobntLiiC0lru7e1RfpuEOufakr/8c3NH0++D/YU1Ve1eKS/X7WGev+DLfrKTK0hEbwDGfTECFcadUGCONvaKF/obXXZmYC5m9rM6mvUHZJUpzwfrTwFTQt3/c2WW76X1vxLqcyH3U2nLg11Oaz/EedpD4OF4sYJZen6tzfvI4A9j/ZFC6vLXtqihtAXoXQ1Ktauh+lGx87BdaNjNzp2o+OX4W46dfng6AgFPDAXtQa1BK5WiYZWZPMBMCoTUXXKEDoFBj1qASkTwGxHVZDovQ8NXdqsXNy2BoqGOGoaCbus4RxLVYS2PT0WItqEnHZ68/9AkgBzeCHcSpsrOBaEu9xAZXPMGaEAcLMl9eSbeoljrazOxNvDwHxCCcBsbJfDwPzQv4ozXAg3sI5DoA3vuwT5hfuyzwGWQe2ZcSuTCqqBFxhgSqWdUB+Y70xwQ/dkb3JS0k5WOnaFJxmwD+jZqKU28u9oQMd+y7iR+KrRNct1anicilyHBhLRIfyPaHZdUAP0fJ5JRThpTK3uwaR4gjdxsB0j5kbYJXP6SijLDnkmOV2iO/VULjmeHZiCD2omfTx9IFEIBcCE6IwyQcCPTosxf1wM3NUFZEe8OvxyTzk4KlTb+iah3+LFz0fIMxHeBd/UTukLlRYaAsXgKpSg+2sbigcBySux3ijearVCXsA6YF4JmggRHDsshLEQ2BqQyAbII/rCD6uMWb/W5soWPBFHhfxZtJ3Uv5tvtgoEBpm4Ftlv3wy8aGOuAy6KJzi7pis4R5GPe/839WMUnr6JgLNz+rZ7RPwbNlbO6LRMKLZ/opMSUEI0EGFwPcsYTf3RD/M0l8pfKH0t0OkcnY5tzI6aHyCRTkipDM+OU2NF6mPbHAZQmbJTLwxGKkXKGrNTqhGpgKvPtXXhhLZUYWCyeEL9m29gxLJwVF1alvoWMGrozN/xT5QqnIt3gbUepOuUqwprMCyL5KvLsOcajoeDPcJuTQmnSUbAxj/YM/+3D0D+g53oFT4CgCPqr/kHJOod8kD//gHcDhr/2HbCx/97ABLtZIHbE25cQzBvinIWp+J6Y3E+Yeh36O1ws5vRa5Xtm7MnRyfPn2wobO3F2/RqOMv0bJhz64Txe/PW/xym3LghkYA5RF228YsnF82qVLkQLtZm0fQQVfKG65dmHdNez7D3kNxqp8QOv8jtk0zeSFOvailu4iLfVEV/31eyD8CtQJZauf1Rb1e1Ib23ugpW8Vk0YaF39cBzC89vNKvK+bVQTU2wgptkGVdfhtw4OeeJG9olDCLDzf5v79O5hZtU9uht7bGQoLdF/ottihb1NiQHnRjWoFy9h5Qt3uqELNV53ub28DUMKnPhkmXv17I98MU/C/NEvNEEBm04/el0SxWJM2m3vEUjuWGJW1L/ZKaLZdGizihxAiY0uF0XcotRnxKWDDXlHe5a36dziyy1eoqzcrZuVmXK2XohctvkuJ46hF8a9vag3EJVe2zvDBbSjaoSCMraWOraqiwk+d/2cvpA3Nr2EQ7v2UgEgFZHVdzhqODJUrBv40f+gvfNMgNsj+NnlLEva4fPxsdPXpw/GXwbP4qXLs/otLnJ7cv5Oa23Yf3ttK1BbsOUE1bOwliax2YgDJzfFtq6nKsaXzvb3dvr59oxg+iiMfunCAJgvMOyPxwKroM5+jg39MCCvschp8Jxmdn2CwRw3voXH13BRSwTNxDLoIsFlZMDjHx49AKdAPBBljRMXv3K8MC2hFziiXqqDTv669H/hnx2E66hEIu/xaAWUNlTA8PDD54IPsQx5zLDNozp7jVaN4kwLx8gzAiEQsGRAUaLeFHYfhVDkglA7oW/L6FEAD9gZPIcAk26oEXWINUEtAQxVmsxONagDT7QQs/TJDqHCXldDksKPTndXNDhVH06nf5iJ6qwokw1PbcbIInK6NIJA2CHw4Mq2HPQ93cxVk9oHRrxDsFbCMokTCq2OuBQPYxme7/DiHcxsXZ4QJwe9IDOu/gdhAffHKB+vUXshhGA3FKYt8YJ5ADEWA8bAhmfa+y8zWEIWHiFgxfwPA0uVX/GfRxYaOlS1UyiscR4exjHzYAXqueQU6lB4KNXw+yDIQzxWR0wQLT89z549iaq08IwHZWH64gxePO2HwG6CrK+fw/nWF6Z7PYWklEg9Np49UgxxvbuMN/DMx886dWRSOF1tIeN2U7U/cFI+4RFm2gYfA7bbQg2CTHBaPTm7S1cuwwa85GyqMd4QQKfOco7Ub9FmPcOKR6HuPdGktU2JUQXivqm5s5pskb898cnF9Ht7f8DkDSxXg== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns a recovery flow's context with, for example, error details and other information. + +Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure +that cookies are included in the request or requests will fail. + +If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward +the incoming HTTP Cookie header to this endpoint: + +```js +pseudo-code example +router.get('/recovery', async function (req, res) { +const flow = await client.getRecoveryFlow(req.header('Cookie'), req.query['flow']) + +res.render('recovery', flow) +}) +``` + +More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery). + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-registration-flow.ParamsDetails.json b/docs/reference/openapi/get-registration-flow.ParamsDetails.json new file mode 100644 index 0000000000..429a33923d --- /dev/null +++ b/docs/reference/openapi/get-registration-flow.ParamsDetails.json @@ -0,0 +1,17 @@ +{ + "parameters": [ + { + "description": "The Registration Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/registration?flow=abcde`).", + "in": "query", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies\n\nWhen using the SDK in a browser app, on the server side you must include the HTTP Cookie Header\nsent by the client to your server here. This ensures that CSRF and session cookies are respected.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-registration-flow.RequestSchema.json b/docs/reference/openapi/get-registration-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-registration-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-registration-flow.StatusCodes.json b/docs/reference/openapi/get-registration-flow.StatusCodes.json new file mode 100644 index 0000000000..3d066fb539 --- /dev/null +++ b/docs/reference/openapi/get-registration-flow.StatusCodes.json @@ -0,0 +1,1618 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the registration flow, this\nrepresents the id in the registration ui's query parameter: http:///?flow=", + "format": "uuid", + "type": "string" + }, + "identity_schema": { + "description": "IdentitySchema optionally holds the ID of the identity schema that is used\nfor this flow. This value can be set by the user when creating the flow and\nshould be retained when the flow is saved or converted to another flow.", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow occurred.", + "format": "date-time", + "type": "string" + }, + "oauth2_login_challenge": { + "description": "Ory OAuth 2.0 Login Challenge.\n\nThis value is set using the `login_challenge` query parameter of the registration and login endpoints.\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.", + "type": "string" + }, + "oauth2_login_request": { + "properties": { + "challenge": { + "description": "ID is the identifier of the login request.", + "type": "string" + }, + "client": { + "description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.", + "properties": { + "access_token_strategy": { + "description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token\nSetting the strategy here overrides the global setting in `strategies.access_token`.", + "type": "string" + }, + "allowed_cors_origins": { + "description": "OAuth 2.0 Client Allowed CORS Origins\n\nOne or more URLs (scheme://host[:port]) which are allowed to make CORS requests\nto the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`)\nwill be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration.\nBe aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.", + "items": { "type": "string" }, + "type": "array" + }, + "audience": { + "description": "OAuth 2.0 Client Audience\n\nAn allow-list defining the audiences this client is allowed to request tokens for. An audience limits\nthe applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list\nof URLs. URLs MUST NOT contain whitespaces.", + "example": "https://mydomain.com/api/users, https://mydomain.com/api/posts", + "items": { "type": "string" }, + "type": "array" + }, + "authorization_code_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "authorization_code_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "backchannel_logout_session_required": { + "description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "backchannel_logout_uri": { + "description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.", + "type": "string" + }, + "client_credentials_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "client_id": { + "description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.", + "type": "string" + }, + "client_name": { + "description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.", + "type": "string" + }, + "client_secret": { + "description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.", + "type": "string" + }, + "client_secret_expires_at": { + "description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.", + "format": "int64", + "type": "integer" + }, + "client_uri": { + "description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.", + "type": "string" + }, + "contacts": { + "description": "OAuth 2.0 Client Contact\n\nAn array of strings representing ways to contact people responsible\nfor this client, typically email addresses.", + "example": "help@example.org", + "items": { "type": "string" }, + "type": "array" + }, + "created_at": { + "description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.", + "format": "date-time", + "type": "string" + }, + "device_authorization_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "device_authorization_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "frontchannel_logout_session_required": { + "description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.", + "type": "boolean" + }, + "frontchannel_logout_uri": { + "description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.", + "type": "string" + }, + "grant_types": { + "description": "OAuth 2.0 Client Grant Types\n\nAn array of OAuth 2.0 grant types the client is allowed to use. Can be one\nof:\n\nClient Credentials Grant: `client_credentials`\nAuthorization Code Grant: `authorization_code`\nOpenID Connect Implicit Grant (deprecated!): `implicit`\nRefresh Token Grant: `refresh_token`\nOAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer`\nOAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`", + "items": { "type": "string" }, + "type": "array" + }, + "implicit_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "implicit_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "jwks": { + "description": "JSON Web Key Set", + "properties": { + "keys": { + "description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.", + "items": { + "properties": { + "alg": { + "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.", + "example": "RS256", + "type": "string" + }, + "crv": { "example": "P-256", "type": "string" }, + "d": { + "example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE", + "type": "string" + }, + "dp": { + "example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0", + "type": "string" + }, + "dq": { + "example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk", + "type": "string" + }, + "e": { "example": "AQAB", "type": "string" }, + "k": { + "example": "GawgguFyGrWKav7AX4VKUg", + "type": "string" + }, + "kid": { + "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.", + "example": "1603dfe0af8f4596", + "type": "string" + }, + "kty": { + "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.", + "example": "RSA", + "type": "string" + }, + "n": { + "example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0", + "type": "string" + }, + "p": { + "example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ", + "type": "string" + }, + "q": { + "example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ", + "type": "string" + }, + "qi": { + "example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU", + "type": "string" + }, + "use": { + "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).", + "example": "sig", + "type": "string" + }, + "x": { + "example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU", + "type": "string" + }, + "x5c": { + "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.", + "items": { "type": "string" }, + "type": "array" + }, + "y": { + "example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0", + "type": "string" + } + }, + "required": ["use", "kty", "kid", "alg"], + "type": "object", + "title": "jsonWebKey" + }, + "type": "array" + } + }, + "type": "object", + "title": "jsonWebKeySet" + }, + "jwks_uri": { + "description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.", + "type": "string" + }, + "jwt_bearer_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "logo_uri": { + "description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.", + "type": "string" + }, + "metadata": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "owner": { + "description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.", + "type": "string" + }, + "policy_uri": { + "description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.", + "type": "string" + }, + "post_logout_redirect_uris": { + "description": "Allowed Post-Redirect Logout URIs\n\nArray of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the\npost_logout_redirect_uri parameter after a logout has been performed.", + "items": { "type": "string" }, + "type": "array" + }, + "redirect_uris": { + "description": "OAuth 2.0 Client Redirect URIs\n\nRedirectURIs is an array of allowed redirect urls for the client.", + "example": "http://mydomain/oauth/callback", + "items": { "type": "string" }, + "type": "array" + }, + "refresh_token_grant_access_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_id_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "refresh_token_grant_refresh_token_lifespan": { + "nullable": true, + "pattern": "^[0-9]+(ns|us|ms|s|m|h)$", + "type": "string", + "title": "NullDuration" + }, + "registration_access_token": { + "description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.", + "type": "string" + }, + "registration_client_uri": { + "description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.", + "type": "string" + }, + "request_object_signing_alg": { + "description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.", + "type": "string" + }, + "request_uris": { + "description": "OpenID Connect Request URIs\n\nArray of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the\ncontents of the files referenced by these URIs and not retrieve them at the time they are used in a request.\nOPs can require that request_uri values used be pre-registered with the require_request_uri_registration\ndiscovery parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "response_types": { + "description": "OAuth 2.0 Client Response Types\n\nAn array of the OAuth 2.0 response type strings that the client can\nuse at the authorization endpoint. Can be one of:\n\nNeeded for OpenID Connect Implicit Grant:\nReturns ID Token to redirect URI: `id_token`\nReturns Access token redirect URI: `token`\nNeeded for Authorization Code Grant: `code`", + "items": { "type": "string" }, + "type": "array" + }, + "scope": { + "description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.", + "example": "scope1 scope-2 scope.3 scope:4", + "type": "string" + }, + "sector_identifier_uri": { + "description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.", + "type": "string" + }, + "skip_consent": { + "description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "skip_logout_consent": { + "description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.", + "type": "boolean" + }, + "subject_type": { + "description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.", + "type": "string" + }, + "token_endpoint_auth_method": { + "default": "client_secret_basic", + "description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.", + "type": "string" + }, + "token_endpoint_auth_signing_alg": { + "description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.", + "type": "string" + }, + "tos_uri": { + "description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.", + "type": "string" + }, + "updated_at": { + "description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.", + "format": "date-time", + "type": "string" + }, + "userinfo_signed_response_alg": { + "description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.", + "type": "string" + } + }, + "title": "OAuth 2.0 Client", + "type": "object" + }, + "oidc_context": { + "properties": { + "acr_values": { + "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n> Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.", + "items": { "type": "string" }, + "type": "array" + }, + "display": { + "description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.", + "type": "string" + }, + "id_token_hint_claims": { + "additionalProperties": {}, + "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.", + "type": "object" + }, + "login_hint": { + "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.", + "type": "string" + }, + "ui_locales": { + "description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "Contains optional information about the OpenID Connect request.", + "type": "object" + }, + "request_url": { + "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.", + "type": "string" + }, + "requested_access_token_audience": { + "description": "RequestedAudience contains the access token audience as requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "requested_scope": { + "description": "RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client.", + "items": { "type": "string" }, + "type": "array" + }, + "session_id": { + "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.", + "type": "string" + }, + "skip": { + "description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.\n\nThis feature allows you to update / set session information.", + "type": "boolean" + }, + "subject": { + "description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type\nwhen accepting the login request, or the request will fail.", + "type": "string" + } + }, + "required": [ + "challenge", + "skip", + "subject", + "client", + "request_url" + ], + "title": "Contains information on an ongoing login request.", + "type": "object" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "session_token_exchange_code": { + "description": "SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed.\nThis is only set if the client has requested a session token exchange code, and if the flow is of type \"api\",\nand only on creating the flow.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. registration with email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the registration challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the registration to a webhook", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "state" + ], + "type": "object", + "title": "registrationFlow" + } + } + }, + "description": "registrationFlow" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-registration-flow.api.mdx b/docs/reference/openapi/get-registration-flow.api.mdx new file mode 100644 index 0000000000..68834d62a8 --- /dev/null +++ b/docs/reference/openapi/get-registration-flow.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-registration-flow +title: "Get Registration Flow" +description: "This endpoint returns a registration flow's context with, for example, error details and other information." +sidebar_label: "Get Registration Flow" +hide_title: true +hide_table_of_contents: true +api: eJztvWt74riyKPxXtFnvPp08L5B7Osnas84mkAu5EiCdpJs+RNgCFGzZsWwImen/fp4qSb6ASadn9cysszbzYTrYslQqlapKddOvBZtJK+B+yD1ROCi0h1wSJmzf4yIkAQujQEhCScAGXIYBhWak73iTD5JYngjZS0gmPBwWSd8LCHuhru+wImFB4AXEZiHljiRU2MQLhywgXPS9wMVeyh3REYeBN5EswB4lYS8+s0ISDhmhIuSlaqt5TCzPG3FGQo/0GOHCciKb2YQLbBaw54jJ8IMkp+12g1RV21NGbRaUO+LYC0jlrHJv2kky9SLiRjIkTMgoYCQc0lAPIQkNFo5AvCDpZMIdh/Qpd3AO9T72GkmGH/TUlEowJUSKZMGYBSXJbUao78siNoOn3GKSCMZsmF0QCeIJQonlua4nSOj5JYeNmVOyPZdy0RGARhjJfNH3ggkNbOyOC8tzuRhk8DBEPEDTML2sBwD14+Pjk+wIX7LI9kqWZzOzeh0ReFHIgvKAhSsf1tIr/6FIqJwKi/QjYSEprATsuUgCJlfJrx1heUKGuJjkF0InlIfEcjgTIfTVTHV07HgT+LSsQFz5oJbgwyr09Vx+jlgw/fIB6ezrKoAbMFkOmMC2MxBBq9WO+LaKk4LGSMRm4Vw6xbUidoRUJNmYBdQhAaPSE7JM2kNGHpFgy9x+JBYVQGmeYMTrK1RJJiX3RJc6AaP2tEvHlDu057DHA/w6AhLmkuj3RPKBQAoq48dOv6tXuwuwdtmLzwNm648RWxyJH54Ss8py6EWOHU+DEsEmABXS3KWHpBpvJgN134uETWhIvlwHU3Ie0NCT5BbAu/AGXHxdGYahLw/W1iaTSdkLpmXLc9dsz5JrI2y7BtCWNLRruCvXYHYlBz5fReC+YH/p1SQ1z4pcJkL89fsHSS/sarlQLHg+U7/qduGgkENDhWLBpwF1WcgCWTj48uscO2NZSOEjUq8pKmFkTJ2I4S7FHRL3BZuQSdIPPJc8AoSP5LZ5QW6ALlOtJBMh0NTUi4KOoL7vcEuNs8LKgzJ5zOye/w0d/UJ7ls0ecXocQERaLxQLgrqscFDgdqFYgEUHYigchEHEigVpDZlLCwe/FsKpD61kGHAxKHz7VpydcWr/S5jl3ZAJEklgDcAnWrVz4GzUsCngSEXgO4YnwayAU8WMUjNEbDDPZDsCcdCb4nu12Q1GTH9DFjDYZsiCgOtKxXaRvQNF6f2V4cMBkyAMmB0jSrGKBFMKjsJb2PkKqJS+JyST8H5zfR3+QcElQvgztWZrTxIw+GuqPz8ACgy5+ppaIR8z+CuL8go+LxLeJ5KFRZSLlAup5UeK+lwWDj1bzZ5L0mOwLJFkdpnU8QkXPOTUcaYdIbwQuit3hE+lnHiBTaoBs5mABrI99VlDP+8Ij9vW7Nvreq3aEaEX+rNv2tftRkc4njeK/K5kVsDC2SYX+LIjJqxHo3AoZt/fsV4FngPLt9ns26pnM3itQB+xaR7kIzbtCD/w+tyZ66ChHneEpK4z+7JVubzoCJsB98gFroavNHwc3/Q5C7p9Hsi5mdbj98fwuiMcLkbdgFneGPb6TOumfn7BxYi8+RLEAQES5tQhVtyQAIkSGEPJcCAR+EWQRthgChJVj42CrUw0aQA9AKmguqWVk6RfSbzeEyhPPATuWlYL8915wEoVigUmIrdw8KVgKA1YL7etQrEA9FMoFjLEUigWDF0UigVLdaFXGv5Siwcbk7pOoVhILRXs5ZkFgd7TKNddJr+/Fmf2dbHwUhp4JQC6BDuxcFBYbpHlFvkjt8i3YkHpZ7JLw3kJcKTeVRAKGDXkLiMrt+3qKpmAAA6Noqd7KZN6Hx+i6ihDOFBMuByCaPSI4w0IF8WOUEoffjikMj4DgYzQklFpgIWDgk1DVoJhC7Pb5RvsuXmY6zUSMD9gIL9lDOAHSSLBnyNG6rUyQeXBZwGMYjSIuZNgEXUnUNEzvfHUESr1RcQ/SPKc1aMOCGiMB2tr/wULoxXDMiqG5fTH5Yh3o8D5x5rSpP6L2/9IoyCKUHnKmT0sazjtJoJ9BhW6QQvfEw+fgxQmQ8+x1XTqNeL19cRUa6K6i6U5UF5HxLokgKi1HqVlahVdslhdwsVH+rACRkODYVxvKuyO0GeAHuAQVAog7Qw5cUkkHTMbjqeWJ8YsCNWmoUIduBGKXKRIGTE7l5rr+OodxOxZVhQEP0KIHnCjzS6eJrrWkDoOE4MclQpOL9fAnshmeV2dXUjVNC/HZzyFWEACC1NK7uNM/4+zBGeWMkOZoInih/FBWZbxdA+d45Hf8tSBhCGDITGQm/jttc9EvYbIt0JCwexhXmtFeM20aQTemIOJ4rs40se/eWX0DeTVa2blEs5uZqwmqHvNHV7p8DlLEi9HFVsoNR3ZbegZJpFatBRKqp4QwHjVjia3MoLNVUw1tpIuO2LABGLZxoNZSkOXZDLk1pBMqDpkgLkhcpk6bCSdecHswBb1aY87HJBXVipKRq+3mJTd0Bsx0TVC5i0EVPAD0oYPSEt/AESpXuBz89gsRSy8DMbMLIkanuDwQHGfqMNtzYQUkh+fJuEjIvTR8+lzxB7L+hmK0B61YaVpkUjGyMLDt6KrEihCa0+TsKTGLeG4HdFiYcyAYljh5EZACgbcZmoeA8frUQf2BDbngjzq5oDbNCofc8mLOo43YXbX8gLZ9QI+4EJ+n9hIRX1GqtfNFrlWnwHGr8FMExAX7CG3zQtJVpArs4O1taEnwy8HvheEX1c14QAyNQCwBC4dMdWjMe2BNojTVNhaw4nE/EBLbUB6EFBcWub64bSYOj1/kKpHNTUg0T4fRJrFrDzCu27l4uL67qjWvW7WT+pXrcfVjkD+0tP7iQsZMmrnDIfnS7SP6lloDKqZ+T5YyGKl6fsAlTvikIGhzlhCmRjzwBNgyyFjGnAwchEF9NFV5fDiqPZILm9bbSPIQo88goniMbGhhB6ZeMEIj+0hc2XOuTwmC5wXUkVkcyasPEkwRwm6Ke43oRBRcrgMic36XBgaNj1KBZW2TKCRLl5/Y1tTWw+mUCbQpf6UONzlSBNDZtgQcpEpcFPD3ec5QujNWMMtFoD0JpVGPSVbSGKAwm0Mc+gIr490XFbUjLi+um4bmwLQccikTy3FyPQQYB3R296dKnMx7nvqc7SsySJZ+N73ZCh/cLHCoRfwVyShLirRg4CKsJthpA7vA6BoURGRg/ZSY8/yaRiyAJb3/3xZL+1//f9XhPwtkr+58jf5m/vbcPX/m2MdxULIQ5zpVeQ4NU3Ab4LD7X8ZUALWD5gc/tnw9Kg1soZUCOaAPuFFYdfYshMT49yOy8rOQ2qNSlXVCWhiXhSSljbYNXUn6MrxPIdRoSkaj3X9KezGyZChKgq7qNkgemBtA6RgbSQrxgJYr62SqkO5m+fsUYN3hNllRr2Zmq5NL6idwbPrRqKx5uAiCrhR3JWm57k8DJmtWKzN+jRywmSL9qkjWUqo9dSMFyA6Cvjvwu1tsw7obDbQ4oxIUsonNR6mZiM+JOJJlsBnOE+0xVLTk8KTPmtcN97Q9rqpU/Jfupc1OHnn1TlBkFjxlcLLXTcKATKUm8LTj32la9tFQsntbb22TYysjfXMtzCjjM3fBeaKusyAM4xcKkrgCkLxCT0Y9TsxkPcY0cflWGB3BBN2CQ+FdgRgkAw/eQtKbZj7PpwtbGgg1ZYtg5DZDYen0sQFSkGMMhqA07eI6mg4BNVRgEeN0AFIFZLqlksyYj54EMB6MVT6vAubXtjGXKOtL4goD2Wu9+a5RM+0+5Y1ZsGkibbSkEo8/z5nDoKC51gROlMESkY+qI3aGcfD1EGTOhM6lWQ9c+TlItzdTmDmImQDFqSAzucFs2Dqna9+3TbrSi0ALqCwgFoHmbAe8emAacJWSnjiCKQ92PoJrSnGpkktraiS1un17UWN2Fz6Dp0qNQlZjtIeY1pE1zP0Zo1wmfpUDheSI6gpVvgejb6qmho1DjVcr6+nKhPbFIoQwLk68ME3xGee7ygfkSck74EdNFZA1byLYEbkFlpxmAv+X2rbAZNyTnFijv/f+mfZCwY/pAqpHZJvRpmfMRp5wF1KQ2QWVfV1JQm0MOYWGVLXzzINCLjQHbzf3qJMwN2sXvJXMvg3APrz1bU3gPmLFLZ+4Inwn9XYjqGTP05l41KSFTQfBiogYE6Dm7G2gaOzI2Lh8qOKWx5Ofp7mtqD334fkf0Z3U9EtSvhSQXgfsJfS3uBkmkE9Yhn8R8aoCWuRo0/P2j4vKw8ZYR8PAZAxgTw+AXUM1ijQAlBBiVUBgetoQ4cuF0zbVzTD8r1QKZPOlLiRE3Jg1hokSbhxZDjeYAAmjCj8O/jOGVchYjKhlSLpeeHQWBxyJY7arvD4PULnBFoTcO/IWcGTtMUu0Qsl00pb1nYQSVYm1ThWCA7uB4n0TjuT1KAH5HFe137siEqa+RBwNsXt50+Tjx0xQ4Z1F8wS3MxsxQaxaYFU+Y/VA/LI9evHjmgqjqZPBWaMDJ+D7mMsqHZHL7A3BuyAPEaBOOAs7B8gKckDtJAdILJKgKwDMCr2GA1YkOlI+RqzU/tuX5o146R/SCKbGf+lUm4GiD9fsj1NRjnb4ax1fUXuWI+csylpoSM/awkfsWnOZxdgXPP6JP25zEZQ6Y3fwR46hRS34egHiXdZBoSVs7vz1Y7ALmSZHE4N51Zs3AvsxHFxdneuxpJp767q1/ZgO4PmDoifwoDxt37A+ixAcx51PWUcdIuEOuHQiwbDjHsBrW8wUIuFEv111tDzJIYNUglRfYQSl1FlZPRSQCrlk/GgI/wo8D3JJMYD2Uxy7SCLSXjG+eAM5jHeRlxSZ9ApkBXqDLyAh0N3NY1W49mR2hys2xA4fKARuO8FHQFiJxaqIzYtk8TqqMSniTPU3LdnnGJGFCHbr1euKqST0E+LDwQNIX4WBMGRsIIpgk4qBg4gAu1dm3YE6LM9h+MZsDclX87uKl/BbN9jhGoK0oG4OnKKkqrnOBwERglYl+QypPqYnVXfm63Nnd3co0gwBsQmLRulBS3tbLt292qvXto9ZVuXe/Tj/cb4Ltxtn9Rftl8OuyeNrcvedkt+blW2xyUvGJ+9vjb5zfDCaTb3NgS9e3jp31Qewh0ua/XdbnXzYr9n33nbx8eNp5Ob4/GV17wvdeXh2fSw3g2cUvtwID8/eLdO5WnrbH/zzn3Y5KJXKTUm07O+pPV6zWIPh9USuy+98Gq0+3z5PPrMty4nN5Xji93epd04ulx/3T47tCbH7a1PNr+r1Ju3UaV6dzMJ7i+fdz9uvnzsX0a0Tk/5x/vaySDc4OFwc6t60afNI/dsFO03bixr2Au70dFDafgcHD/sirAdtrZ9end387S3+3Jxsb/dKrX7u+Pdl9HF/sZeo3/Rum4/795XX1/GzvHk9fDsueKLyrA3eb548hvDwe3J+vZRrRk8B61Da+dh4/CCjcVu3d8ZblSGTMpDf2tyMboZvHYDj1mjsDTtjV/P209HrcuIDoT/fDG+bn982B+zejTYvJw0zj7XNz89Wa9Na2P8eik3d+6D45u9mn87LfWubH9vv+2OK/cTK7y95Gf24NTxziabW9Xx+tagflsZ1YRsP392R36v3i9ZgT+4Oj92bxrdo9q5x/b8buP+8+dBv9cM+NaVd/TppPHxcrQ7PYr2Lp7OhlVn+JkeXj1Fd5PN0rlz2L+ubA0+7rvD/qEY1QVjO+fX++5Jc2f9uTHa+FS69ILbh6v28eXnurs+Oj7aZQ+f7o4PJ2enF+cPw9Pbre2ax883PjVKcvzZr25Glcvjq0r39uxocrlfvdns7T2z7dIO26fTyeV4YkWVoDmqHO64h/X+Nb0+o96W249G55WjXGr2s+R8si0b9yNr94HuT/e8s7v9bv3iafsl8v1o3Xnl3dOPn9qj1t7L007Lvt+yvKN1j7sPk5c632RuuxKx9dtrumP7g+OT6eHZtrUX3mx+Ot5e37xvRoPzWruxR0cPw2NvJ6xUPn68Yd0rN4wePltb1S13q765fbJ5Mm7uyFbt5XZaudp8fd676Iv9o1tX7gYPW9e9vQfGz0dtfvi0njud5+x05L5TOd3vDwaH0jtu7l1Ta7PZPdocTDb3NoP25ujkujIc1x3nqH20wfpBZXcY3d6OL/uH1qUv9pxndrc7fn0VDw87rdbN8Uf/0q526aC+JU726j1/4/C2t352ywPavHq+7V8MrZte194/Od6uDT+yj9t3vab0ek1PRE/th6uNlypt7LavdzeexnfBfeliYy98uZ9s72/fdK3BKG86LDubyk3lMK/ZaGYN6WQwiI6nJ8HdOR1/rNxvfzq/HeR+mGc6VeJkxG0QJxBrBseCjIg2TmmXhuAm1WdBbsUyA7Vy1U45t8BHSYXFimiXUWJSCViKnkGvD9/GwpoaudoR2rYJcASe44D5T4slGQaRhWIl0ScQaHOQ64hIaNAgZlbFJ2UapaISZkcuEpv3URcIOyINm1EvWiw0RjGQmzaXIRdWODNAmZCVa1D49fIQ5ZWzhkn3auYuHwzDOC1Ewmludj6E99G7OCVDOmapDjqFUTg1qwWLvGqm14tCnCLEPnB1YMTTVEfAIX1MHXQBOKBKUghLluZ8l45Oj0Nl3PKqQr2GTCtjyvJoUclKkgnJoSNtmctK343d9S27z9Zpf6+/vbOfK15HYU4whR5zdpILFRzUMLxBQP0htxJ1pyP61OXONFlxo+kUiYyAlCXpFJqtSqcA+kancFTtFMrxyBqnSgXqiDd0IDKrAoH+qs6Rf5yiEy9NAuy7V6bZquQthsgylnH7OXi5nd40nO7mOn3u74zuTye1zwFzSufeuO7vyY9scubZm0f3p85eeOc0D7e6TeZubZ9PDvvPzvnNib8hnumwtLNxun32GkTPbN06buzsDRtH9XD37jkYC/esev8irqL64c4Wv+9Gt7f396e100NGG9VW07s6e72ayifvbGu9Xb+V54ecB8ND+rG/ubXTuO+d81M7si7Y+NNuwzp/OduxHvZerzf3dp/PLg7vWg23dF1n48mzrMtW/XR7+yZ09yX3jvloOOpdTLznyd1186TysC6c3fvxp2tnWKnZF0+HredWhbU3jhtRtVYV95PXaq25d7VfPz7s1p/sVng8qpaCT+Hm+c7hQ79hr1tb02O/Oz5tbuywpr3+erZ3f/Nx4h1W9z4JSa3do3DDP2/t7Pv3u5s7u7XGXbR3W7OPrj3nvNIYWHZ3sHnlVz7uWhV63H2y2nvrT/vnwdHrZK89XhdnhydMRtWnxtXTieyev9qju/btfbi5dSr2b86kbW1cfo7o3Tp/vj9k/ulD/8F7vmLO66eQbWx8DLcPJ5/89dHt5e6Erdefp/dVh34eXNf3WqW72uFks3s9tt09tnPlDh8qPefokzcdWPd7D9u73ulu75zT6k3/vHpcu7Sag+rQZR8r3tHG9PPnB9no0ZPuVv2pEVS3Lw4vT28me8Hlvn33dLZXd5+4Nf684VfcdfuldH5abWxNdxqfzoOXw1p/47V1LQ+bo+vW0+Feu3FdE2eXr7ulJ3tn2A4/v/ifG5OGV7erVLQ/b32u7UbNQ7/t1iah3zxxd7dub+SGu3N815j01tub9eNc5WBG1dm96o3uJ7W72yEvsebOTnXQ629+PB7d1Gp3depe01qwHjxtPK/3N/rHR68bdzuV7vr+w/hkff+Yjzcq15ul2l7T2Ru0Nj6NXjf5+mu19Sym073K+ubO/bXVHPPry/OPov5ytH192m0cyZG3Z4f1oLfVdo82h7f34+rIfZ3sH8n28cbFzeH1SXWXR/Kifc/8enXjZT8aVc+PP9+M7UF4dN272Rm92vtXw+eSZT+7LXb56cJ7aVzYGz1nzD+19z+5e6XpxmY1fPDZ2ek1rdfCT40L53B4xg+9xvndYGv80nK371/qDr+6Zv1nNqg70m3X6dal39q9u3Oq51vT0yEN129KQfOl9mJP+Sf7pDt5PRv76/VJd3Piyo8+KzUGV42H8e3d6f6ZP7xr7Jxv7T08Hx3ys+P7mzzEzyhl65WNY9e/vmvub3SblTv/OWB3LTq+op97++KenfNDb712c3L4urVZ6z2fP9/stbbp4Znbaw7PLCt8ql48US5KfByF2x8/hpXbS/f1bPLprFZ73rz8fDyp7t+Utj89fHaPb7dPz3g4vYlar6cPbHe7+XRVOupe3axvtu+GJ1s3J3e7gfe8a+18tPb3g+BWHrUnZ2d80tq73PE3di559LqzVaPXT+NS9Px8XDnuTydXO3ejl9NeQA+tp9Pwkt9E05vezfOoejwseVScjiYPV2wayqthO9p0b9xJc6fW3Ay8z5uiwY+fqrtC2qNS5ePRVmtrcvn68HA8+fg07t3deQ933v74cHu9e/mw+bB+/HDTerZqr9Zh3XrurodCUNnf+nS3fWy/7Lp7683X697msRSO+Dg+v6/kI57PaIbTy66/exbcT1v8dSP0jgfnvbtPpTO7vvV0sz31o/2gd3n3shXcnB323XD92Ht4HdzWPx99Oj6yrp8nzG1e7W28erUKpaXD0fr53dVJ7ens9HPNrrnHw7utytVHp17yo5dR1z39fHK2sRG8TJt71zs79xctttVquM3++eRzfXd6u7n9+WV8c378UA9tx749P3m93q3T3df2+bDyqXmbN51I5jjXbyUjK52CH/UcpYGCdO8UVmd1gtjUATqWpzQpknxV1tITP86qu8z1HW+qfRHCBrWIGacHODtTQxvlGAO6tKFDDIhNQwqCfcwC7TNBJc/YRTrCE9imTD4laqnK7HWmpFOQHG078QerSj1hwoLHLLaorGaluuS5Wv9Llij6e1vXZ1u1zZfjjcPB3jjq7YcXbGNwevn66eMu22tHcj9qnI6bn45yF+Vlx1qksL3sIHz35Z31fQxrg0MCIM8aUsgPTSdQxhoOvgOVXtnJdbRm47x+n+5Cki/N4+rO5t76V634zPVPMmkG4J6H7lEliw2M6Y+0X0t5lMuEHFFr2BHamZ6xIOo4Wsl2t0sM80JsstJiKsd5G/oF4LZ3t/e+klJJ2RpV8yhwzBerpHbUJF/q7dvy/e7+enljf3/769w8FVRlZT2de6nRZggKKFDNwkRdokdMpeGkvvuxaMtpllxeusdHr81o393aPb246oYR293Zv7jy7+92/eq0FfLRw9N5/a6+Q3OE8Ld0tuoX3NBK5Vdn0SIaOJMULpWCk7JcQ9LlHeuds+k8pN/e8xnYsbXF+51xFrNmcHDWgTkbfHbakKubfpDzjb+c3Z1/JbbOeI4TeXTfsKFlUilAG4lbGHFRJDzR/BW3gub6MLwiV1NtgenIjP8tZhU6LTkZVDE6c4IF9x51pBeHjKIFN55PwlrwlLoiV4up4GhkdfrAqAFBpyB+Q+JcWjMvMz6ew9FVpyekihXMjIUjuBTKIJgEegjKAu69Ati9lZkTYHzeaR7d3NabRzWVDuA4qrM4uUib9+2OMChIc3VGrSF88EGm5QUdsDKpGB+A9NyUCV27+ZJTOx5PvTg6G6CAuXZEakmy0y0S24NllR7AD/G7zaPq9eXl0VXtqAY1FIASuCQOBA1LZkUqQVot4suONe+tVclFkGihwtmIYsExM9T5EcbqYoLe9NIos42KggxSXEUHGKv8syQiDWcDbzpCGYTCIZh3TFRYlu3McZunSdhVbsC/1AcHvvx3MgTw3hvffSUdcGWIy7DjOBIHOs+dvMtCCnIf+bCGDFhIk04umQS6S2fdUQJ8rJx6qWIGvGAkyYRhUmA4RB5UJK2bCxV115rQwSCTPKTZIyQPTQQL3jHla2iHCRTwh07F1IJRB2eYSWOXxiI321EuEnzP4db0nchvYGODfvUrL/gNMaNC59EfNxtm6Qd8TK0pUYPHDBr4LIXcAACixyQZ6q1tM9ABMdPBCwZUGBe85TkOs0JZRBZcBIUDGbbCvc2l5YB7DzKeJGQJKjUvHw0yNCElAbN5wCyMLclxsZr0loYnw1JTt01FlahoBaPjYGoABCk6PGHXKlxDsXKuxECc3wAYgDZHwi5B9Y4PuihIZYDFG4Am1ZDIHPXCd8SiCaTYE+3j/4lqhVmqPZYkjc64Pr+rmXwHTXPEE6PK4Mg8gN+zvmcTvWEGIVHgyFjiWzE9Z5MqUjkTOikIggoh4PsHZ5YOKPsrGWMeJH9+hEIeFH9R0F06CzSzJt8NAqtNBXW5lVBjKp00nRKkKDN5mcoTNGnBxgMT+aDtFckAHBZYQ8thKvrKJJMapUvlvKO8zuYQU03L4P6H329Amcu3Mvh4M4L5/djQKnb6WSbOGeYHzP6H0ZA/AeR7XSUWu1on7eaGWszMoalZ5rUqFdDS+nklcTiAmtmCU0DrK+iMqdALZe1HZmtOa7HCaBT9bP8yriAUB/k5zmybjtD6PpcGtab7gD0h08ZYE4xcV5WntCMEI9Y0dG8iagG3zUfNnDhK9WLUSpXbE6BGWUo5UxJZBUgBzV9LJpi7OnBIFF0WtYY65lBX65FGBYGyFzKl9+tOJUPIUEqrzIIw4GyMnbhmGExlR4dbfNpBF6FJiO6I64aK/NGHWjWTnBmqk9LcBGMXlP6+m/q0m95YHQGqhKo8EYvTHxWW6jj27ujHpv4gPwAyq96ZzlU1DhOVH2sSOibSokIFGenHmZDFVN5sda6o2hVjOkppNlk7G9J4AExDBcfXa3GCZSLDb5t1iHO04whG07qSSquebW7apoB4Iw7zx4MQpeX578kaakE7wAb+kdHCU4YgcMdTCxx+QCigozk6Ig/HMRS5QiXUfFF6LtK1MWBtlbeyEa5gzNr9uL3/dXV2RTsCiB/DxlRQMlIvQpFJU89aJQGMDQVNaVP9W95S/x5s5zEeyazQC7qpyjPvETAt/Iok9WjMqUFJDnNgwVRXVZ2DpQ/ukP1MHStylJhsYOlDMXW9SKb6lOmY67YWSzG3kYR2BNbjwZ0O4dZi4LAZI2RGWdZhA7loGHG/C5783IoLrRH3q+olgZbaE26eWAEo2jNpL7riiEpsgqUEe3NH6HTt2HBEbVflI+cHxSNcWvF/Ezx1QpkHUh8H/hRYIyXl1ZvvUZBqjAzQRLA+pnuQ3Tj565HU5jl0yq4NdZDUNkRLUZwzlu7O7M145ir3Cr0C3NYx5qbC3qNPeTDhkulaD8oLkV9GQanIhsFiCktXVZdTOMAw2sLBTNZcj0puYUWufLakY75N+Vd4DttCR41cYv9KjUO2APUYTFJ+pqWuc2eOVtlu1a5K1bdQRTZzIH08gIB2nMoqaTHASZwgqnGU+eoRLGuP6ZJ+L6XJZFKCk2gpChxtp38kxsSvLVpY1jArAIamhOwMXHAkfjz4qcCkgeh59hQGRWNGyLojNu1CoY8DOK8ntui2KlgAZpAE8Syb9fcoPMHUh2oltFPLlFpZUfFBuiSt6/WAqcEPUywDdiQoUhiapOaUz8XyaPFtnXsRweWq298jNqNaJ4r4ArrLh/29XoM2C1zUQVuqPlWuwRAH0tHhcxaq0PSgK1x1hDFSzRghyIzJiiLXCagVRli41lHW3iH3gVuGE6YzpeKUTZ2bm+ku28CymA+VjDGB12htWTNnLr7UueydCY8XFI4L+EWc86h+fjfn0YFP1WDvz3aEqUEubFcdg7qxgvwjJ79b3QkSI7MTpXnuDJh3+sv4KgxlQpd16NL0JZPSLiATTERjUZ8c9IAmLfvsrt0RX87u2l+Bcjh1+Cums2PqHcKodJ+zu5birXEWBU8lxvHE1DUHj9KoYTm0W4dyV3YEuldv28elvZhjIgvSdfQSjWu2iirRZzbM5cmho2+JMWaWaHKN2ty2urraeF5Z1qCrxGyOXbXa1P53bWOY4R0Zpl/V9cyrDpWSNOO8kSBmQJpVp+q+ZIRGcopUthma0huwOI06rM4QHrqOXnyVm6x5Lxb+RptlFl5VVnjzuLJKdIlrTC9BQ362VzUeOpoorDzYPuVBR/yDJPz09yDDBMG2Zo4kaSu9IWidm2JpX57UtnizDgnitKsxLombYFxl2in5FXhwAlGjcDkLvZ5WMT6Cm8QirItEjc8/JzFIbZr3I0PSkMt+yvSeXaSOiI3fapFgX6lgBYMOVeIEKRO9gTEHSJ/aNhVcSfukqLkOfeiIT54TiZBC9UpVNWU6U8j6xywKuhbA/D6q6SIB6RNqKpw1WXDjXcldX929zEEa7gJzXNBlB0IW9KnFsNpB7HI2LgwdQGG2VRL8fQApsZCw2F4ExlzhgzeBua2rWGsZoqVVnfr6keOkXShYkGHM2SSOBzC9Z+KO0ESX5vY8ZkwmZ9l853o2BIn4nh/5f+xccIj0ZCZc2Kp2JVv0kiSVKVUpLOoDUw64ilR4VTuWqnKDpb5n4QHc5hQyn1Fwqe8BIV5PWuoqBlBQQjC66UFUujmyUt/zfSyW7WM9ujL4wiNr+MdiRiWhKjAcvDZggNoYDp0QaLkjJvQPXqROoc9Uxp0/hDCqgrLL6S7L5iybO3wcEQJOE9cPTea2vmojXRzRqF+pBQfQkriAzEKb0fOLrmo3zhDOBBZqFCitbZuHWF61kZbi32YPpfUaau+nXIRKHSE0MCcc/KkhjY2CfsDG3IukA1wKCpga7pyLEyVnoPayCSMDOJPqKR2R8pXq6jDgh/BBL00fuuz54gVznolEk1FFPWGonDRbeAfzRVBkqpKLKtqZKuaZZoTpPBNTOpisgD+AgbikwXS1rMul4hTT/qYe5so2G6Ao8lDFlREqRzI7QpzdSlgpXUqFrHiBudglBm5Vxf4AhrBQJ3JuQLTaR0pqJBjXbN0Yw2E1MutlqgGnK+nGBA1pFR2BO4KIyO2h2FBOAlVpKBGsRvfFxl3dGCmrbO7wUCSVuQaCy7gacP5xiHcdz6JOnu55W79QrwyLjymK21r7gOk6VAwixViAL2IHiaqeFYVFMhv92BGLbMOH1cb2RxVTubu9+zUeh4RUy25ZVNqQIoS0PnScTfAyGcMd0Sn0g1K1QvoQDIuZL6lYllSqNYB/DH8OlXqDOxRq+FJBbVpU1KEbrMDGAVJXtwxB4CxTkVUQ/1qEyj7acd+bkiMxgPSa73yExTLUHUSa90IMVsAkSFi4pgECvnQwWVwKWGtWUPZdLRswnGw5KGMZnq/i+14dK3XyqRpLoqGwBXWcZhT7+dq9CXtJnE3OPD1qBRmsFZogVUlQ6iw80CjTt1E5zexnqvYaT7Rx4eIJBmp4qDLl8s0jEzpavHT13tj9kyqgbWCOKzrBsgh03hQhI64jFBOEW1tUuTFhT2Gh4RYTUy3YZlTHUyUyKA6RSYrVvOUoBcNHOmZjcdnS+JBlypVmbwVJO1OSeqNUvoXtRKz8iIvQwL3AJRXDqTxQGSCTodXLnwybqWuUl7GqqxUllayVCEzK2mQK6JcoaioBw6BZOtN4ZcypuUVsjQTMZcj7+w4drMKJlKNnEY0tAVQKE3HkZ94gNrcTqygVhL1w7R+bsUqa0fHEHo9qihGZkY2NR1X6D6iwPVdHiJNsifNIJmdIyB+ws0kNIqsNYeE6QeCGC12qaA2LTXaErnWkXTSweT+kK9Srooiwx1JBKVRKz+I6Ph3iVdFynKkljm4zGpe6BYwtdHnl+5LQXIXhPVjGg7N5d/Mws0PiAF2k7VRYND5EyZkohapMlOoeuALMFWABdceYsfATKM2tCgClpYIew1jdsMxI+v4186n6KHY2XyS16o3+jlFo6iK6OM6FrKHLy9BM+pa8t3xeOXjU/i29axCq5OaC2PyrwjPSWmyZXKmbHLAItK2+BA4rE4RgGI5QW18qz/V7hINWqjK1+tFdAujHEubJqmBgS3LjFLTWMwrRY4dOaWW8NouWoUKMFUotXOqqvu+mLiQV9TWVJniOq+JnRezXHGGeluF4sCOeGGAw+KLS+yk7ZyoOVbPFzOUW4EqfjYR7K8gNyp3+DrVAX0KVqmGW2Xa4zZLr5VD8pw4VGKVutkbmijqFosSMetu8+ADKdjiEVVNlylJ1sxcIYrCmdUMvbyLwqu2Rmfu3DNzxp7gv86MSlETSDi1d+gqLUC0UUchuTZUs1GaSO0N0HVS8/ycncsac2eJIJRpzAK0YYHBtaK7biINrLQ/wE6Lht61tSJhXBluL9xdzzNkBzBQRRMXb9OfmdhHgHGBo6BSozzuFojrc4WBezrUl+WgNaZiHwFAVl83cGoNt44OYhhwdxKrGhHZyHwDbzjBeU4LC+J6N3E3FIKLuh7VAV9W1dV38caB4Ix5sYxSn4/JgCHVPE9xbYLjEQZbPwDEnQq2uHzmxAy4zfvwptlb9lVEzCqiQ6Dr26dTxaF4JD9OkoVqki3bg4RoTEmMJmBkXfZET1ht63iiP7eRHTsR3U+L6A7km5REeqc8fYdM+6msEVZCCZj0QXGF4SdzDguPz/Liak7Ige7g8bV9ewLlUH9etuBVABgkTankxCQld6dAW1wFdVkZLybn8Q42bd6kfqHGxnTOtf+FVJ+pL5JKP/5V68kun8OuvpKw7+PatU9A0+UsHUwI6hX/kx3S4KgcEwVpQLSzlBJtfLf19cjMvXLXCgBxVfHAkQ89VXl4zVK4YmpE8C6obJ+uthMx34SIKpLsAHJJoDaAuCzhSljrV53voF1Jn3C+QFxw4+x4Bt2ZHqKP/Efy/I/S2JC31b+q6O/gCfkI7lPaqwXsunHvvYLNKhrqhClClB3kjNTLibWg4e3SabSB13lEc+5PGk4rZiXcjUGmGQTauW+3V3EIhnj1DidmOr+C9vqkzY5LCjcoc5qqYXWM51NEmt3WS1KmRytJk7snA+85AVmptggry+F/cHfzjEWxWqNqpR8KPQjPEPx5VSRwwBz6iXcd38AzHXsLHnLt+wjDgvSjUBjsOU3K5oKGHWVMuRTcDtpzffcOA9fNJEe6n+yAJNICQJTgRKktUfAZQ2+mAQLDJO29oq5ir2BLj6qKVWhD9BouE3DgjZdERZQOfwPgzY7+hxOVIyl6fPEKDMrx+VDeRYSF97tIgLrYDUgXzJEEboSHXN6Oom7F8JuCyk63yOlzOJ7Qqj+WdwNAcMmsotClHV1TnUKiHdgrg2QFXK1A27GlY6jr8vyO4OyB1lw4YEEoFFALYcDhd0sJ/IKh6TGp8jAV1UjudvmtT/7SBEyvfkoEvGfhsF8hGTKui6jHZxKlDpSK1SsyyZpXlhJkZLyx+gLs7lzBsPs7z7SuqheNKHJOZZK6g80FdfUwm3B6wUCZJEeCspQQUS3Ooq11fkjXlCp9jvhaET+TxOXyB92SocILUtYdxUWytjNeuL3OpzCTdLvAv5pXGzyAB1GfFBKmv06hLymQBUbnpjBblM4z9Vgp5xgM7xfvm05k/jwBZqVwuP6bW641t+1fIgD9aBLxfAijI/ygxAPT/5wqCPO6Ru9fNJ3m7HUIRZjZpPgG5gxylhYFrZJ4uTvF5fKkpzOp9d5osVRUgVO4O/igqhWX8s9UVGSyo+YOE8UES6UUBBj2/S52dcDscznd4B49/mORm9hCAqqWmGqZoaHzB1kJc/IAURcAWC1HE9fzcEPk/MgoumdC3p2cPKVHoGRtf/qqkWyRdx1ED2He5I5RRKwtZJfXpEbwHGn6rUZs5HREFbzW5DZyO0FEypfgu9sXtq6ppcju7YJP3fHfFJqkb3YWKBC+hfXXxR9eCtbmLtlnMVQxQ0YivbX9jVrrtXXLZvdmiiFhUBOH/YFcvFmbnD+SYmlahWMhAXFDx6hlg3rXtl4v6UxdVhb2CSyXXD21uM4cOP0himuqsNdACgwgjGN64Y8ahPeYsz4LLsyCuiEtfwAuQJx8v6csFvsJTRKqAV0x/Ln3hbuQS1cM7b6HLv8OwnepWG9PwrsLchft30txQS/qjdDdUDv5s7c0TeD1fTo4TVNmwRhlyeqJjqvtTySbJcZu9QGwH3Mkk1IV/OgglvTDIbtXR9o71wN2vDr+1+OYhyDkEvmQGT10fFsdZsjF1VkymocoqgDJosLgBlyNkdqaDdsCh3lV8LXYefWoM6KYLEWG6SuODxvMgoX79fbyYgOsw7tDXZanO6JiqdSL9SCgnkCnHhtk/wdRU3NMfS+04knHJcpCHUBEv48bzAhVCUIYamlMDc6bKinmopynzGmW+xpjjhZ/hW2wPAI3YNL95+uVc67TsrQsevvn1bON0b29ONKdN+lt9ub18Tx95bVMbfAHqQbubQat6lJ7e/JPZCWdazPf/Fojv4TlLuvmT6QY5U75H/1pcgB//d3Bm6O+fZMw49D/Bl+H797FlJ2m5CAc/gSkjSpY8+X/U3lry5CXd/F6erIqPLLCt6WyTTOkWfVRKbqWNwDHlYJFUDDDCckMUCjCpvGuIVIBlftQleOMbuE39Dc3IlIdLRWegSUFn9TAoQrpmB55vexNBAqov5AUvH+kHjGEhETyGa3OfGof2cJiOMOMAR+Ui0pGGOBhNxUioj4tQqjhMqvFAoXUocYlBnObsZYoe3da1O8z2MBTeAfcfZmpmEgBmozNTwVy6aJKaJNbGUK62vgrxMKj2TM2TLHLtNHKTOyiT29kpkRZ1aKA+xvi1FbUBizpNrIh16LWJZjVVVgEK+vdoyN1UNDkOvmAZO2J+HX2K2YJqFlTJ0MxqzntGcQb55JhKszbJAjLqqaoOhhzjNDVUCLg1Utci6wKRb8wthV2NUUjBBWkIpatDpINcpCqoZrFKUkgtz5lL1CTftJGALWHGkH7tm107m0ASFwF9y7KhGy3M6sm/UfuSBiOdno2rGG/NuORCrqFvsXlr1tCizVy4A7MTBlOKMgsssJ1Cg5SRVWUyzje5whcQN8usUc97yWlS1a86Yshtm82aTaHJKb7I9yTA+4XGZjUNB4xoQKw5b1v4oiN6URh6eWMf4ouOgAwJtAljYl5OQ6gtA9ZgzLdU7Re0yrN5w7vbZj2lT2iTXtqQj8gEI79GGTidEDXwWcYZoOZbKBbUvAoYmpCCXz/QboN3W4qWRPIvQSTfim/xarPLVQLXXLbGLENEu6wmgJQXYtaN+SPcUlWfBKhyCuXIqVjg5dWnTmxBNDzz7M0KPClV0uib3WA7nV2q67H/5JhHNG7DqfQtOPSVD9gOIvuH/y8atv9VQmc0Uf3Zlm3h5abXXnkmy7zaaqgqbNgSk8jAjmCSfnWKDXfhuI+vA1JVxamg0I6ybKhLB8od8eBFRqnF/E7TQZK/BrHGM3nF2b4BHCR5yF800EAnPCyTB514qO5nie8Wh9f4NWj6ah442n/kKy1YOCDQ++qtfWiavrEHF8Z96C5U2MePufL0p5f1y6MZXrIg805FdCj2NDfBLNtJb/2Yc+qoKoGA5oaAKPLKja3S0GK8u6m+BdaxxBiX61fNr0W2jI0CTgS4+aP4EOL9Tw/mzl3spf/+f6D/fqYL/fXiuE746t1RYcoisyDy7FtsNJheoUM/NSCa2tl1v3DwZRmX9j8uhGkZl/ZvuKjLuLSlXFvGpS3j0pZxacu4tGVc2tKXvYyBWNLNMi5tGZe25Mn/4ntryZOXdLOMS1vGpS3j0pZxacu4tGXI0TIubUkky7i0b8VlrMQyVmLpU/qf5FP662Il5pjNsgrWsgrWsgrWz6uCtSyNuyyNuyyNu1QR/l1K4y5zZZa5MstcmWWuzDJX5ufnyiwLji8Lji8Ljv/7FRxPq2O5ihiNLyNOqWPq3plH0PR+6RT6ntcpPCLdwkFRruKFWIPAi3JuiTyBx/GdzoYDYWPdbex1SF1u6AWrCf2RHnM8MYD4mzL6bSlcCVxT/2L/KdeFcVTo5x63LX0br76M13wQeH3uMLgQGP7VT2E+5IKLkf6NmQOQGKB/h17ok/Z1u2Hae94o8rv60rgL/KVfxfkDJp4gBemITYkOK9BPk53bVTd61+MHx/DbwEP90BpSUlX/6qeSug5pVS4v9G+bwfXbavQa/p0AkCZ0hcGsdwoQpngyoKVQLABKQEipNBNAADxMzxvMGUlai54fiq3snKAXBTccbqiL7qsEVBgc/tjs4oWl4n3K2JIc/jlyWN5htjzn/3N3mNE8LHFJ1PXe5mJYSjBzCW/38zD+KH3PKCpOsCLmXnUIQU1dZqwjYm7rcl5hXGZELUk2ZZqK1RtypXTXSxZSHF8TW25lgIWYSynAf5y/11xQoa6DKRZQQCqDRPGv10f1KXSg1YfUdXwp2aFZQUq/BPRnNUu4WPSD0unk4lXIYTd4ceEcXPoa0PgiRXMB4pt0El9VuoDe1FzZiw/R7F2KayJlxGz1d/paZrwL1VyV+8ag6SjvY8ebFL59mztazrcpFrbXt2JGJpBhUN939GX1a09SXYGqIu4WWCpCKmwIu4SrnzHWDk5baheq/TDPTtUWn+sONy0JmPRBOZv7yma9aDD/VQ0eJ5c7Y6vMVelx6kEkIzzngW2KjinHUBeUFnC/b+hhlL7AoJYyLhDeP6nnCafnHoWrhG3qw/3LcFlvhK3h0z7XV/vqiLk83rlg2pC1b27iVHgzaY1ZCNJXVmuHo4X2CZhPD0x5kbAXjtvNDDqPxPhXgsp+FMxJUU9ZV4S6tN5cIA8DZAG+Vtez4xG8XiMbm1vbO8T2mERo2QuXuSjKMz3Ua8okoA0QCkX1Wrkj+gzB6Aov7CYLehQEx+rFlRdWzOOOeI68kML13YxBHsVRENzAkyP9IMUwc/stFAvZHt7FMX8uiIkmnRMDquVv5ppzhSz9zcJbuCO54DLz6gx/TbpUn6k7zFe217eLZHt9C/63USTlcnk1Qw3w/l2e7EXsbcAE6CbIILTpeY63qt2VEg4xM1J8pZnwlRmpMM8qsa8TNahik9tLNrlkk0s2uWSTSzb5BpvcWF+yySWbXLLJJZtcssnFbNI4RZascskql6xyySqXrHIBqwTA6EAiZQQ4Oq79S8kLpqWAhszhLg9LvcgaMZjgKKChJ0t+1HO4VRrywRApA3DVQoxILITpUDGArQ35esYCrj08hf/2gumaSpYGu6sK3ToocNf3gpD82hGEEHKsgan4vKieVD3R54PIpP9/UynLH1K9ffg7ROaA2zkESklak1+IYJNsDyurfzdtqc/rAni9xXTL1OgrmZ5WcQiHhYTbB0RR2t/J2hrwsEz5AbD+AnNIZaOrsgEQWkMD6jLgs5bnQj0BmMgjmNUfITKf3EQsmKZaYVxI6Kngu5QMMwEda2mz8/+Gfn6hPctmj6tliPtXnnUI4DPZ8qtqCpbnjThLT+O03W6QKj6WRKW3R1gfBjZHq3aOPizSC7yJZAhK0TBNyYIxgMptHd0YycRrCA1SXZNTRm0zr94UX6sVjGepuxuygGkZx4SMVGUaGpJqq3mMwk0yKRVfVzBD1BYIWWaFzC6TFeOIXF2ICEMEv+ptX0RpSL6RXwidUJ6hjvKAhc0ZE/+Kok5uazJVkHTE6t8x/k5vhBMvtQEgC2PM0rTvU2sE/M2lUGMDnD24F1Y6ohN2jA+0U1A/+278pyfVX57PBPW5RmKnMODhMOqVLc9dS7ZHaeBBa5wz1LzB0VZWYcd1Qm6Tg18grcjuatbWKZC1NU0b5Dfyr0rhALzCuZqA+nvBJP596RsWFRCR5noHv5AMYZSv2GSGB8JH1OdVBV3eB5VGXb2dYYTwJUBSJEER5CZ8HPdUjhloo14+ydk0xl9/SK0ReCSFvbK6Wq7bK9xeLSssrqg5r5aPVFUnBSzv42D/8QsR3FGk2wn7blg+9gMuwv6KJ8ut0GZBUCQdrXWrYADqOLDSj98B7fHxgPznuNMRnQLOa/U7QxxHjqMW3yj3qe/V19/gf2trcQO9HfIGPyCzj+Db+cE9KNDSKTSzPX5vamnImPRXO+Jbmkk1puEQPbGGUYEOsFBQe8G0q152BA6fPCi7ns0cWU7v2i7sWqK/nZ/kbA8Bg/2lWld8DlqirwQ/tvQRG6aB+gVb4G8QQcaF2dJDT2Kwq9kmuKe0IMBT0TAMfXmwtuY7dKrosOwHHqhOsuwFU+pzCVwUOm4xltUqyv5UladJYi0dh8jIB5iYPaOCxMxOllHkZLST1MSzG1TJFJwGMLf3gmvYPMB9BEHdhJoQGXVswZI6WuXRBx3QJs16YpsUUBWzsWeYANay8bludqCg/RupBgxqKSwchEqpmsK3PFG9UiOmNbBkhFUjbMkv5EMiqj6QvwGP/5eWUoluALBnpVQC/7+3gAIchMFU04milRMWzq9Y0gDWPuabv2QIBrSx7hyLWeF2UUPzi5YgSW/IJ1Y62uSge/X6aX2/9I/cbg+Qb6a7Un2l4dNvGfIqErMs2CTsYB6IpEFGQL0DFvKfEsEh/0nYKkaDv5SkPSrZnoXWpNSxCyxcfKBMGnjYnJfFqxjuG1BXHd1UaehUHE3KBDBvIvsX2mz/628vW7W/mx1XSJ+gsdRKMZ6boovvzu/fbDNmMIK16YFyAhZGgWgrRMzSBmYEeLNElKvQhS8pTe3fn6IU/pYk9btIyleK5jxvymHn76Kl/4cJ6fusaUlEc0S0Mvug7NqraMxkLyETUpXy/PJrAVJYDhZZM+PCXXlWTVgT83UsW1OlvpYydiljlzJ2KWP/VUlqKWOXMvYPkbHwoU7VQHpC2oFiW4U1yZx+CQDmFsss0BosEIhPNRtFZpB8cRCbtH7VhqyudKLBt1yz1hrK34CDP9lkN8afKAevjvooJAayuZV9AKxCQMcVCydeMIJkUfTnQy9J8QsMeoB6x2pVv6S/qHpCeg77umKAt9QDALYsh2sG+DV9V9ragIUlGVIwC2IVZMChuUWhBQEoaj49KrkVB6XAoqgnMaXCeLC5e4wG6vaEpKV6NNdUJeNifhuugbpMcOgF/BWXpqqd45mHt5mlGU7tgJZt5npmgqrTNfg/5jh5vpqA1+87XKi8LXwaV0dWNg4d5gH7KGD9gMkhCb0RE5KsUIdTVVr9UffSpZhR9gjcKfvox/uHLnwmIASj0FSNwDypcoiJTiIG3tWG5pjFBH+8Ew+h+ijl5FdI/4bXAVQQZtXxfJhRqnYLE7bvgVkb2IZgqqp5hvDAfDpi04TwJpMJwgK7AzRUoESwKsk1nwUSDG8lhbISwoh88fskE0zvvGAkfWqxis/PWV79lrfhJhPTQclhY+b8+dPA8kt9z0SAUQv1dFWY+aCgrfT/rdaxYC5EKwBkLfVuvnDI30hdhIFnR5byRNQ8K4J4KCWY0BXgOEQdIpAnU9vlQjPBMUOmU2nUZZlUsi/gocqbFQ5WFFGTZba2xFOQptwmDY0MokhKEWuZNNSI2AuwfdeToanbwYURUhLrlvztbyC9JBQw4ZLYegZETbSnb35RPcURPZoFplZQFdmPB0wFnEnsPr4ioe9B0RDYj+BjiiDH8ADA+I1c6N/aKPobqXkTvBoGpevv+Q+6SC/IT/rvN4C2lPmPzD748f9+Qhf53QK0NRqEGcR88aNe2WbjZMfpB2s68kCuJb6X1VzcfmkeVWqXR0kPMzEG0h6t9Ryvt+ZSGbJAxxxI/e+aTYNwTXUBekQat+Wro3Z2KBENWFj2gkGWQ8SPE6ivg2lZeabWVn8mtF4o2By8CO2Rw194kB5qyF7KvpsMpX6/F7M/AVqGIOVCe+LNDpV0vXC4OFzkD6GEgTdPBxpauJQpO5RLx0xkKUEyGljDcvxmjQYh71MrXJNDECJridd69Z+HFuprLaDb1BVShm5990lmUYt0ax4bmlhLBa2t/kzcYq0/BCkN8yy0K3cgVPostIarvxfskv78DwFedZ6ZAoE5NE4bM6SoIONyhltkHmd24gzW/2mg/aGfQ86IcRVOkYF26vMZQPUTc2RIEe/a/O7756FFkHI5RTPqTbNDBVFvOmCuzEKcfroGf2T220+FFoZasPeacKjODGWBeVeWuZc6lZlH+q+FkP4kaGW+hMPqSxaD8NyD2AZR8ak1ZGSzvK6v/UiOGbD3KL5GHOtv5dpFvXp01ToqbZbXy8PQdVQNksCV1/2WOnPDGTz0ZCq42KiccHJmgVR6rAPIQP3W92ToUpGCK9cdP3uGTiVVFNqZE4CyKEBEe+ZSPF0yIh2CUkQdUQdAFHXktc1Cyh2ZX14G9ddDbXHBwyxhL2DfUGVnRchLaA3RURYq50EbXmyjxOoT4geZY4Ypd8SxF5DKWeXetJOJCUeZXXSNm5SRZcEIBNM9dCd4TVOfcgfnUFeVOdX5iRn9vIQBUoAUZSQpoQWJ+r4sxnYlbkGSAdPVdCJMWYDIHtcF45Pnq8NWyfZUICmgMT6TQSKHF+D1XeryMstzQTFP42GozFGhlz3Yocr++Pj4JDvClyyyPXUZuwmyFIEXhSyAgIyVDxnDz4eirtYbX7K4ErBnDD/DwFMVe4szN/G2OgAoz4sSsOeyAnFFR9B8WIW+nsvPYD788gHp7CvGmgQM4s8Etp2BCFpB7NsqTkpVc+QyXjio6ghrRWx1RZpkYxZQhwSMSk9IdfZ5VHkh3H7Eg1uPEU9AKIlClTbGdakTMGpPk+yIxwP8Gq6nV7eT4XsCJlqkoDJ+7PS7erXRPttVdUxs/bEKpEPiR8uHWeX42jFt3sBIdk8wpLlLD0k1SXbRUGNiDVzVhgf0c/SDQRGlgOCVfW8c0ZXPLGvzw125BrMr4SWYqwjcF+wvw1UyJ7XfP0h6YVdTKSDAZdbwRjvgcshef9VWyi+FdGdoF83c36isZF+LBQi6g+a//gqpUbeB8+0bPEZKQ/tlfDuPMqi+wSNXmtpKtbowQM3cVPoTzeYd8WMxaovQp7yg6A0w/lKMOTKm2MLBl6/f4A4E2Jg/iJm0mR1Q8Acb2jviz7C0v4HFqnE9JJiM/cxg1PHTXum5dMWM6f3kqF349u3/AlD3DTU= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns a registration flow's context with, for example, error details and other information. + +Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure +that cookies are included in the request or requests will fail. + +If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward +the incoming HTTP Cookie header to this endpoint: + +```js +pseudo-code example +router.get('/registration', async function (req, res) { +const flow = await client.getRegistrationFlow(req.header('cookie'), req.query['flow']) + +res.render('registration', flow) +}) +``` + +This request may fail due to several reasons. The `error.id` can be one of: + +`session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should +request a new one. + +More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and +[User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration). + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-relationships.ParamsDetails.json b/docs/reference/openapi/get-relationships.ParamsDetails.json new file mode 100644 index 0000000000..a3448cdcca --- /dev/null +++ b/docs/reference/openapi/get-relationships.ParamsDetails.json @@ -0,0 +1,64 @@ +{ + "parameters": [ + { + "description": "Items per Page\n\nThis is the number of items per page to return.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).", + "in": "query", + "name": "page_size", + "schema": { + "default": 250, + "format": "int64", + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).", + "in": "query", + "name": "page_token", + "schema": { "type": "string" } + }, + { + "description": "Namespace of the Relationship", + "in": "query", + "name": "namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Relationship", + "in": "query", + "name": "object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Relationship", + "in": "query", + "name": "relation", + "schema": { "type": "string" } + }, + { + "description": "SubjectID of the Relationship", + "in": "query", + "name": "subject_id", + "schema": { "type": "string" } + }, + { + "description": "Namespace of the Subject Set", + "in": "query", + "name": "subject_set.namespace", + "schema": { "type": "string" } + }, + { + "description": "Object of the Subject Set", + "in": "query", + "name": "subject_set.object", + "schema": { "type": "string" } + }, + { + "description": "Relation of the Subject Set", + "in": "query", + "name": "subject_set.relation", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-relationships.RequestSchema.json b/docs/reference/openapi/get-relationships.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-relationships.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-relationships.StatusCodes.json b/docs/reference/openapi/get-relationships.StatusCodes.json new file mode 100644 index 0000000000..8cbb5dcc83 --- /dev/null +++ b/docs/reference/openapi/get-relationships.StatusCodes.json @@ -0,0 +1,174 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Paginated Relationship List", + "properties": { + "next_page_token": { + "description": "The opaque token to provide in a subsequent request\nto get the next page. It is the empty string iff this is\nthe last page.", + "type": "string" + }, + "relation_tuples": { + "items": { + "description": "Relationship", + "properties": { + "namespace": { + "description": "Namespace of the Relation Tuple", + "type": "string" + }, + "object": { + "description": "Object of the Relation Tuple", + "type": "string" + }, + "relation": { + "description": "Relation of the Relation Tuple", + "type": "string" + }, + "subject_id": { + "description": "SubjectID of the Relation Tuple\n\nEither SubjectSet or SubjectID can be provided.", + "type": "string" + }, + "subject_set": { + "properties": { + "namespace": { + "description": "Namespace of the Subject Set", + "type": "string" + }, + "object": { + "description": "Object of the Subject Set", + "type": "string" + }, + "relation": { + "description": "Relation of the Subject Set", + "type": "string" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "subjectSet" + } + }, + "required": ["namespace", "object", "relation"], + "type": "object", + "title": "relationship" + }, + "type": "array" + } + }, + "type": "object", + "title": "relationships" + } + } + }, + "description": "relationships" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-relationships.api.mdx b/docs/reference/openapi/get-relationships.api.mdx new file mode 100644 index 0000000000..02a1eda92e --- /dev/null +++ b/docs/reference/openapi/get-relationships.api.mdx @@ -0,0 +1,37 @@ +--- +id: get-relationships +title: "Query relationships" +description: "Get all relationships that match the query. Only the namespace field is required." +sidebar_label: "Query relationships" +hide_title: true +hide_table_of_contents: true +api: eJztXP9T4ziy/1f0PLW1SZVx2LnZ9yVbvDoW2Dlu94ADrq6uCMUodifRYkseSQayDP/7q5ZkW7aTkDDMq53b8MNMLEvdrVbro1a7pccgARVLlmsmeDAM3oMmNE2JhJRikZqxXBE9o5pkVMczomdAPhYg5xE55encPHOagcppDGTCIE0IU0TCx4JJSKIgDEQO0hA7ToJhMAV97hMPwiCnkmagQapgePXYkuhYQ6ZIDpKc0SmM+IhfzphCHoZ1kY1BEjEhrKqX0ykQLYgEXUgejfhPQpIENGWpIoLje8aNACRPgSogM6AJEXcgsRmSvfLqJCIuMuDaPF33ZlrnajgY3N/fR0LOo1hkg0TEagCxUHOlIRvQnO0koNiUv6np9FEVDHtk1BeEAaotGAYo7o1iv0EQBiqeQUaDISphQotUB8O33++GwUTIjOpgGDCu//NdEAYZfWBZkQXD73Z3d8MgY9w9hoGe52BrwhRk8PQUtlV6Ag/aaJNcilvgVqdAOBY75d3CV6I4I2pDc67/SkvGpwu7X5mrmBihfXtcwqsy8c1YnY5/hVhvwEeYBpsxKcluwKac3psxuiiMdMeHG3BSts0NSz5zkBxzcgH6GVYKdPQq47UZy9cYus04rjWK12EgQeWCK1D4/u3uLv4XC66Ba/xJ8zxlsaE0+FWhXI8NIPIFPrPTEpLG2JNfmEKBc4lYr5nlhHhy403SDjEEHZHTj4VDHASRXIo7lgBhnFCiirGCjwVwbRYUUHrEtSBT0Bb8S8CKyLEuVwTIcj0ntvuETVCvZrkYcXybUuWaBGFbVWE1LW50kae2E2ZZ6YresvxWxyvj67Rbij3kElkuEsrZVYfUYmxZTqeylqWdWZ+WN6s71JaihCWHq80R0zOQpbVfgCaiejo+JDHlZAylKSQLh8qbByjCywegOeVeqP1niKyv+pWEDCXrVwXDq8aaVIFPxeq6al6900ynHoYgj1ej6TuM2GVXj0pJ54bLOg1V8IRVmypqVQiDd7vvPgPBEHSUpjyhMiGnck7+enF6QvbPjglIKSSxrlbUmdTmbZfckWlUImynVQLjYtptdYjFBHtAGVfE1CKMW95M8IiUTm6hCpqmc8KFJvSOspSOUyCUJ2RGFQLmGAhwLDTzBB5olhu9Yj8TqukY/TSa0FyDJPdUkcLUxqYTxhOLmSmgo7bIdJd0G6dRhbhGBWg5XQkcbEOCKhKFjIHEokgT058xkIkoeLKU702DaVeJ1VOtykkhDbZ4ykTX1W5TdCGreW8YNAV2c/qe6Rk5PiTfvf3Tu+9JIkAZaeHBLnIdUReB4PEhaoeSgjNc3qyKjg+jEZ+AEeOGC31TD+iRlD/ZFydC75fFI/6xEJrewEMMkECC1f6OJUeuAMXn6PdfBQvpBmHQpOBNYdeBMHjYmYodJIO+dxwMF5N6sYhPYZCBUnS6AI3/Zl/Uw1fbk2uzGPw11YW6iUWygOaBSNDucgkKuPZJ2mYEm5Heu913IXm3+yf857uQRFHUb1gDvu/uu7qbq6XANgUOksUGIA4cVrXh1s6u67pRBUYWV85rXGmyWYCThtZ7yzQwb90OcguVW6jcQuUWKrdQuRgqUUsQF5LpuYk/Cjnfj2NQ6tJuW6+ucROt6RTDk01H9xpNQsj5jqQaUpYxvTMu4lvckwS3oMUOTTLGdzJIWJEZ+0GNXhi92WBnSvkUAWCew4WRMAiDlI4hDYbBn4WcD+KUWbyxmIAazXIhNXkccUJIYx++n7PQlh4IPmHTwsZdR/yJTKTIyLcexW9/wJ1YLLjSaFN1bbJHONw3KfT6P5R1ac6OOa4KMbiaLQl6DWp9wyYFu+u+YL/B0AVtfyCDQTO4S8iGoV3yOwlQkp4wpkXTPum5dRcZvv1+t1933pjT0IUmsPetOCx2vxuF/b33seAJTBiHxPW02kE2eroq5LouZTuffbLLw6vr0ixns091VTx1Xbpui32c+IRXxk83pHwB+mQtTXsRhc1ZnD6j8s8ifr6G7jdkUILUo1vAQuPXkSeyR+g9ZQ30itpfonoWOkucCutHMz3dc2Xf7tlapXsozck9VlbQfPbHrvPm1KfXVdaI938IMJDsFo73wlswcK7egb9W5DS+RSzJKDPfedza0RvxkR7ZfcGDHgX2cZJVP4Wyv0QOnObMLhlkFEyZnhVjAxv1UrIzFVjb6H9S8Nhw6/VxhRrpUp1kuEeMa9D7r//+nz4ZDOwT+UT+EIuAVYTF+eEeGQXV443zo0YBKsUFrj+Rr3VxwK7WH4RNV6vHZV1dc3UwBmnxwNC1v5cQXWttQIrlnLU0q08Ai6muuTYg3WryW8LV4xLK6y4OHmkfRxpM/Bfr6nwx0ja5nXrKb5euNQzrMDlvjEe3fM2RWcqKj3TT3x3ukQbMRSdw3/J+sRHN2YGFwUUN9s+O7duW+2stTOUhkSHurbBxRSlquM5nx9H79pLkEDr6kca3U4kRgF6/H505TO2V4GqLDFD0KmDpR9Ug96op2I/siPTs5OlXIvRKy+9HpSkmvcpoq0LftHoLzM2v6Di1LcWvUnHvjnM/OnqAuNBg1c8mRn3/sUc4S+3SMtKTTEc/5ZJxPekJFV3oBKQMycjFmu5nwElM0xRN5MNzyv7wYUi+uRuN+CgwQ9V/hsdPRZqSv1xenlUxLa+9bf2E/wwGVQW7DfvQ4TxszHaFrbpsRaGR7XmT1rO98oUClfdH/Ml3IM7memY+IZdOBG5nl246hZzf2JcjbvjXBVEmEkhV1Ewdcu1a3Ws3laB0WXU/ZxgQya23Y2rmRg9lBfuEM/kNOUTXD0cXp/xMKPMZuJztJvbnVmITACwXuDylczubolwKtDuFCx7NmcJFDwlfADS3xVE+x4AnoSRlygAa5kmpIkeZIGntoeuUpsj4pI3ttdfxJs5Yp890A7FvXXFL3+uN8RGcr5YV3sYejH5ooWfAtQv/Gu1gkZDst7bUSAw/wcexkInZ65tQH1LBkIsCiS5FGTYhuUhZPI+w1ZFFZ2WUBTSeGR4kAz0TCaGy/q5LxpCK+5AUyorncN1kmyElRTVTEwaKzEUhLRmsG1MFke3vQdW/H4FKkM3+DEkzlLPxSFDT1qYvYG0VAb9jUvCrUfDj0f750fnN5enPRyej4LoagiOO0WNKHHJbvVFOWBk0cesTqrGcSaaOJ8t+uUC0FhNCFS4ertrQCvmGHEigGpYzoUq5/uTshtXBG49jO4ZTc+nX2yCTpUb20KMlaB76j+K8VwooLeHb+ql0R74lb9AZ+ao998b+FrvZ8dy9Xq7ttNe7ZCTZdNpremv66/4uG8m1/fWa4NquurfRvmEJEq2fumTX99N9ugr0TUOzC1+soeVlbm2bWa3wbulzyl+Xhz8Oi8qfH5PlTjry0nLuMM7i3N8xFa6Zmly/RsSq3Ky9BtRhpOem0axXwdle9Sv0pvhe/TOsZ8ReHftxBr3noj+VUHtVBMgzqb36Z7jYIvYWloYLRnSvWxQuHJS9RYX9Wl/GieqN3KdHpzcxaUfzd/63o7yh8SZ9UpaWPwLuLRhHjlT+HC5gMOwKUVdouOxryEK+UUYc8g2BfvBkPsio5HYH0Q8/eHkfVvBLN5vaT5sLEtF7/TIV3X6Z8bKML2x2tvuuZJe1oP1R6d9kJQz8z24TmirAzYKnjEuXcd3+Nroyx/z3vQiu7LOfEvdMn59JLF/Oo/4iupLBynTy5dS9POHV9J/JJF/OoYoTPMviuRzyZ3n4wYbNR6SZX7kOs9OXDM3mbM5fOkarWZnsb8SXS0u0efTmKQymoo2L3RiUfvBiMWuCZJkFsMXILUZuMXKLkV8zRuY2RNr1H1ubiuXYWJ7vq8HxDwuN1Ym9egj/cMD4ZVHxi0Liq+OhPRm4gsFno2FzU73hQGyIUt62fJMxeQmXlw3PZ0Bhr/EUZUnf5E7CgwausNig3i3Mg+GyrMgwuKNpAQuzI7GbZeNqB1812O7kt17q1kvdeqlbL3W7k99i5BYjtxi5xcjtTn67k9/u5Lc7+e1O/jV28tjEZulZSDQQqGfBMBiUAu64e3HwwCQmAFp0LCSmjZbT7tGlKN6otJg+LUxYHJhtvWR4KFa521uqJo3Lz4I69bGjj39hUiCeSj8BfS/kLTmzVAhSici/RGEukjEnt5nGbEYDHH6LA8GVSKHGjNgWGNxQs0Ep/CAupASuB1PQO0pTTPjsR05nZRLkBZ6it/0ZU8Xi6mQ9qt+WVOOL/HA9GpusxWZNW9SpKjC18S1WnaTi3rBpJDseuBO+jcJ/NIZmNk8kjRLIRNlBS3SA/5pLpERuOyAmk5RxZL9PTGl1oZ9N0HBn1TFHQ8JEgppZKFekR1NGbfLnB0flxqZRfsBFtVm0OX17nSDHc+TBua2EeY+nOfDjQxxPjhZwfGiXG3MRDf5YUw92QfNPKlulo/pbh4I7dyUIl8fKFAGe5ALTI+eiIBwgQREbhod5mbcwX7FYxYJjSowa5CAVZkXtWJXtaJvaX975tdJk5PyfQt4aFNzP2c8YXNtQbnJfEthJ4Q7S//9u4K0BfCLKayyovYwJMspSA6Mm//rPdhzra9JQsgv7Lugc/35DjrmWIilibXLMD30HwiZ5pynJi3HKYpsljXFKprQ05+sM6OyfHauI7DdfYKEBHYFXY47BJRBD4lJ8KbmjKUvImVMGsSZljTUiZ5ajoYKJ0plQOp3j+CQIX2Mp7pXNKB/xN2/IxeHPyt2GWbpAxHZ0DKpM/1XeVRgOAr0RjIw/VjH0bs1QhrxRBraZiDQV9zgf8dhAQaeghijGJ/KLe3YZXZ/IobjnqaAJEiAv+UMS/oC80t8nlHan8UfaBZv/vQKJxWRR2kMqdUMxV3kxjhK4q2ecKxi4g55qUCd19xfq9ur8aP/wb0c1hdaRTpXcDsapGA8yqjRId8RTuf8HCZV6YEmg3+DrNjo5umyy4sUUL0aU0yZCVMW11KdyHtmU90H/NaUVmkNHXiPtUcoemPRZzeAhyrOalX1eV7OvIC0YkRZK+160WdWkl7KrTud+EUuYiq4dOGn/Su9ok1VG74A3LUEBlfEsqt4MqNRsQmM9UDNcRAb1QaT+50v7K72jS+wWpbUfliq7zbNfVVO1xm7L4tImBt59Gv3X1C2ugHbF8mVuS9v7Jy4qE9DxrP9SsXdc8y8ivCXe6ALBPpz95axlilYyplpo0ShuzMSW1j9b6HyWLzBno3F7Qq4h7TxnLUFdSbll8Ix30J19ny+tEWkhUpwX43mTlSzG8ylkqimxXzrAH4359qrSIqslc+8cT6k1WMX40VhFTHi7srLI/Voq6StJqxavcHhGksWAdwwNq338fk7jGZC30W4QtnbCOPeoeW107NqqwS/HB0cnF0c7b6PdaKaz1OxSQGbqdHIB8o6Z85YDLZR3Q1LpcuLOGaSyfmyKyjD+bS6Uzij35FpwVqK9g/buhfsi9747Nx5PweERRma2Y0ZFjy6yUN+mVEYWrsMAjz/iq8dHvI/tHzJ9esJiew+yuR+eKXOJmwt1rOjVv9Xd8QvVaRMm/MB0mWBh8inWV9VXeCf8cwopw9Mv1cgzkdwV7P0Q5Qu5r4z0rmBdRSxfyPeZIPAKzl4U84W8n4sPr2DeCEG/1oAvvIx5Fff2zfOvMvYvkuK1zeBFQiy0iOs69muu1gsDBAwMglbJYxgVyX3hO5eWNmLV748ug9DEPb3776tgUhlivapeUT73aD8+2hoG9p6egrIjLhZ4/fT09H9CymKY +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Get all relationships that match the query. Only the namespace field is required. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-session.ParamsDetails.json b/docs/reference/openapi/get-session.ParamsDetails.json new file mode 100644 index 0000000000..188514f949 --- /dev/null +++ b/docs/reference/openapi/get-session.ParamsDetails.json @@ -0,0 +1,20 @@ +{ + "parameters": [ + { + "description": "ExpandOptions is a query parameter encoded list of all properties that must be expanded in the Session.\nExample - ?expand=Identity&expand=Devices\nIf no value is provided, the expandable properties are skipped.", + "in": "query", + "name": "expand", + "schema": { + "items": { "enum": ["identity", "devices"], "type": "string" }, + "type": "array" + } + }, + { + "description": "ID is the session's ID.", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-session.RequestSchema.json b/docs/reference/openapi/get-session.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-session.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-session.StatusCodes.json b/docs/reference/openapi/get-session.StatusCodes.json new file mode 100644 index 0000000000..0af9254098 --- /dev/null +++ b/docs/reference/openapi/get-session.StatusCodes.json @@ -0,0 +1,472 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "A Session", + "properties": { + "active": { + "description": "Active state. If false the session is no longer active.", + "type": "boolean" + }, + "authenticated_at": { + "description": "The Session Authentication Timestamp\n\nWhen this session was authenticated at. If multi-factor authentication was used this\nis the time when the last factor was authenticated (e.g. the TOTP code challenge was completed).", + "format": "date-time", + "type": "string" + }, + "authentication_methods": { + "description": "A list of authenticators which were used to authenticate the session.", + "items": { + "description": "A singular authenticator used during authentication / login.", + "properties": { + "aal": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "completed_at": { + "description": "When the authentication challenge was completed.", + "format": "date-time", + "type": "string" + }, + "method": { + "description": "The method used in this authenticator.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "organization": { + "description": "The Organization id used for authentication", + "type": "string" + }, + "provider": { + "description": "OIDC or SAML provider id used for authentication", + "type": "string" + }, + "upstream_acr": { + "description": "UpstreamACR is the `acr` claim reported by the upstream OIDC\nprovider, if any. Populated only for OIDC login methods when the\nupstream ID token contained an `acr` claim.", + "type": "string" + }, + "upstream_amr": { + "description": "UpstreamAMR is the `amr` claim reported by the upstream OIDC\nprovider, if any. Populated only for OIDC login methods when the\nupstream ID token contained an `amr` claim.", + "items": { "type": "string" }, + "type": "array" + } + }, + "title": "AuthenticationMethod identifies an authentication method", + "type": "object" + }, + "title": "List of (Used) AuthenticationMethods", + "type": "array" + }, + "authenticator_assurance_level": { + "description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.com/kratos/docs/concepts/credentials", + "enum": ["aal0", "aal1", "aal2", "aal3"], + "title": "Authenticator Assurance Level (AAL)", + "type": "string" + }, + "devices": { + "description": "Devices has history of all endpoints where the session was used", + "items": { + "description": "Device corresponding to a Session", + "properties": { + "id": { + "description": "Device record ID", + "format": "uuid", + "type": "string" + }, + "ip_address": { + "description": "IPAddress of the client", + "type": "string" + }, + "location": { + "description": "Geo Location corresponding to the IP Address", + "type": "string" + }, + "user_agent": { + "description": "UserAgent of the client", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "sessionDevice" + }, + "type": "array" + }, + "expires_at": { + "description": "The Session Expiry\n\nWhen this session expires at.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Session ID", + "format": "uuid", + "type": "string" + }, + "identity": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + }, + "issued_at": { + "description": "The Session Issuance Timestamp\n\nWhen this session was issued at. Usually equal or close to `authenticated_at`.", + "format": "date-time", + "type": "string" + }, + "tokenized": { + "description": "Tokenized is the tokenized (e.g. JWT) version of the session.\n\nIt is only set when the `tokenize_as` query parameter was set to a valid tokenize template during calls to `/session/whoami`.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "session" + } + } + }, + "description": "session" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-session.api.mdx b/docs/reference/openapi/get-session.api.mdx new file mode 100644 index 0000000000..2d14aad7bf --- /dev/null +++ b/docs/reference/openapi/get-session.api.mdx @@ -0,0 +1,39 @@ +--- +id: get-session +title: "Get Session" +description: "This endpoint is useful for:" +sidebar_label: "Get Session" +hide_title: true +hide_table_of_contents: true +api: eJztPf132zaS/wqOed1IbyUqSbO9nnrprWq7WbVu4vpj8/bMPBkihxJqEmAB0IrW1f9+b/DBD4lKnCZtdnvOD4mIj8FgZjCYGQyQ2yABFUtWaCZ4MA7Ol0wR4EkhGNeEKVIqSMuMpEKOIx7x56A14wtCiQKlmOBEzH+CWJMV00tCs4yoAmKWMkgIvCkoT+g8A0X0kmoCb5jShHFCOaFJzjhTWlLNboDEgmt4o8NgEIgCsFDwaRKMgwXoMztSMAgKKmkOGqQKxpe3W6gfmeFemk+FqFPycwlyTapeBHgsEkhIhniI1OBbSBxQM49kXipN5uCwhwTx1UsgDosw4kdvaF5kQIbkf2yjZ9MEuGZ6/Sf3fQg3LAYV8WlKuCA3NCsBMSqkuGEJJAMDsaZPEwkqgahrVhSQIDUYTs3MIxgEnOYQjAPbMRgEKl5CToPxbcA05Ap/AC/zYHwZMIdSMAgSi03wehDodYEAlJaML4JNVUClpOtgsxlsE3V6iHgjto7fDxWZHlaIFVQva7wY4iTh55JJSIKxliU0cdwafPMaG6tCcAUG9SePHuE/RhS4xp+0KDIWG2EY/aQQodsGvDamE9KQk4qcBkqMItbRw5QTpamGkExTktJMQXOyOHcuSCb4AiSxcHDubiZzITKgHOlIS71EgsdUQzKjene081qGyKRujZ/nLAelaV7gCnu1BBQ4piokVlSRFnxCtcE3LzPNhimNtZDNFr5TqSAxoCLumKhZDmRlRwCSUaWJ6747SA/CRWjanb88PyG4cki8pFkGfAGmfSxwHWhI+kiUVMgcJx4kVMMQRwo6BK6N5iwHvRSJ6mJntUjrHkIqslqyeElWIMHNT7TwbrLPiKlfGNvgFeOLMqOyDd/CTEpplFybpCOSiQUzULcEjGbd/G6DpkqVkvIYSAY3kJGYclQ0ggNOM0Iwj6NgYH89wV9C2o/PoyAkE7JkiyVIwst8DpLkQLnTWcyo6iWVCciIpzgWJ1RrGl+DRAohp6TImRNvGsei5Dq0Gp2DpFm2HlQoEJYXWaUQEb8tSjRkxtBrtWQZkMnk+Em7q14J11ZZcYp4QZVaCZmQPxux6pMlvQEyB+AGlEHpXJAMqOQkFxIInYtSI9rKEU6RIgOqgCyBJkTcmCmOyVLrQo1Ho9VqFQq5DmORj64l1UKNEhGrUSx4DIVWo1iCUY40U8GgUpiUZo+CgaGA/eeJ/edzozeZzlCOJy2GTiqGHhuG9iaT436X0FcLpVMzvPLrcYvKexbb3deaXVzdomnrLPuYUzgtcW3y6qCm2Pm6gBNXHnHBkni79uX08CDiWuhiuwYZHvFMiOuymCmIJejtJsemMuIrmCM2fLv+FcyRBzwyO/l27YFIAKst6tew7sL8GtYRL6RIUWa3621xxBXNs+3Ks8kPxxG3u2kncnbbd/jZDThlIGcpk2pnptOq/lusjnjG+PVMQowCvYP4qSs/ZvyavLXSGD7GCKMZqUWdoHQQHMPqTKP/sb0xwWCxJr1q7DQTq35IyFTbDVC7Vc700hlDjSXkDUCmFWRpaBnzznkgpxqLz0samn8siVGYhS6CQdASlmAQeLkIcFEZEI7TVikj89AuonlWGT6+/TZDEHqT5A5k/b1jLw2CN8OFGCLSQ1xRxgC6XyL3S+S3WyKbQSDkgnL2T2qVd5cuf9loQZhT6umOTdi1RTiPRO4CRhlFAwRZ6h0X+Z7Qy0JpCTSf0bhjhAtXOzk49U7GFY3lFYkzynIioRASDdH52tR5YMSuHo/SgLCUUL4OyYkoysyYroJna4OimYSx2tyGpyrrN+IVwOkh0eIauPFCKeNoYfMmLuHbJ5e/bXI/NCaX/wtNLm9OrrKS3+kgdplCTPAfrDlRrWhlLNC2PePMkQqmXRVBA+axM/l7FwqSPukaQgXbOLV8CiFnlZk9M9bivWV+b5nvt8x9bGRHSFwIhyypIkumtJBrHzHy4TGz3GQ7YOAJv9/ztIBJLKQNfiToaaITuzd+wTpMeAcF9xCZkOlh0ycoS5Z0zZUVM5okElQHVtOTia3CSZrtK2MYhOkAk4l4z170HAQ5Ft572Z4gQp2eEDdOp0ZVIGd04YI/W/pUgZxg1bsQ3DRDUBgHa9hxTuPUUuPYZqm5q+4GGGpjEtQ7IzpH2G7dHb9xMDBqc2fXrYvnfqw7ctsHAHdjH5xc+trXva7FaValW6HV4vRdhsimYS4SyPq4j0lQgIuBkt6yzCnv4wKQ6FS+lOvdYEksYW+M7MDWTbQ10ZaQFSDR/CpjTVIGmTU8FmJepinNRFiI4u40bWoXjNokCcNxaXbSQnAHpcqMa03WxbnjbQNyd8KCp2xhNlcndd+dvXxxSlc/gFJ0AW2wGOYMG5VGW6+EvFZkBVlm4+wIYEDOfjweEMoTcraiiwXIsGtr/XTkrq37Ln1TV9bzJ7QK+pWc/Ywx80Yzs6a2rfWc6ngJ6n1sGP+9s5wRXsKwKGecalBkDnqF+1/C0hQkYohdjY5sCNN9pOTeDbyPlNxHSu6XyCeOlJRFsnevu7B1v9FedwNSdZrEf7cVREJq9jBLK9e8MmWraYXkwp63G0c+XlK+MNbz0pyQp2xB7PFnCzPG9RdPa6wY17AAaZ31PXavt+UaBLXe0F1MnyxrscxYKM5j7owNmQkwRfygnXYKvNEgOc1mXZbvkau0p9GUE1FYy434bhjmcNSshiEmmYGp6pwQRTTizTbG8eI1FLVWGnJzuKpA+2P6egifHGDNk4jTWAplSeJAMmuM3Mmgrw/XPT4P1a7lYx1vdJ480tNDQ29cS3OwUmKiOkm7WCjgjgjAVYkuSFrqUgIuq7ygms1ZhvCwJ1I09zFE5GCCyRlsXmLICd1fUESV8ZJQRQ5EfC0FjZeH34R3cUVy0DShms5M0scuHV6UWfYb2cTmN1PkxcXxMWZaDDFbocwy/O0zFPYtEmz3nRK8Hrk1maKcZyz+N59NM7jsll6LnU/3j1Bt9X4EnPjFxfQwMC64Vc0+4tDlWnn1PfFNfIjSLigTDquqdrSMFsQNgiu4qVsqR6Dth80l0OvZIqNKzVIhZ9tx9Y8y70/pbu1Mojtq/cn2SMyC6vTPblhnflA7kGO728Zvieh4wfPK0oebtt1AtFBFjqJSYIwEOWwGXHRu46em3Gvrl3JNXoDGNUtsj/YGZ0K+Ijcn6yE5A03ma7vv2Iwd16dAK0BpkF8RgwURnLw8OzOLHLNTMvAtEygysc5RgYQRh3IYA9eSZuTo4sD+ijhVjA65kHoJmNYzUYy+wK8jivZgqYam+OKs+l6B+X4F+A0lObqwQExXbEEuziK+yMScZuS5+afhh9RIYDC2NXaAkbxh/QsHwp6la2lKg0FgQd/JefiEU974FLZOy+TMVNUbeW2GoAYnthp1VdM4uqEZS7xh1Nr8taRMdxsQDolSdpxo2GEuTo89GvjT4VElc9bB6p0BnVXp9WsKGFRJSCpFbqwPu8DHBAfvQg0z6DqwwuIOC8cm3FmrhimXHYlx9riUGGTJ1ph0B2kKMR6E2LQ7YqDZlL2Is1bp1H01zwx8gW95JzF7j6H8tGfO/HIKtVsVNjYKzPUzRzFgljNRP2dhVZ6WPLaGbdtMboSyDL86gleWj41QGu+QK3LetH1RyWPyKZ5Cma1pQHKRsHRtbY4EMN3IdUU6mKTfLB0qkObwIaecg3RAeVFiEnCWEZqt6BpjZ17O0TZd4LaudxZGAimeSBroV7WEX4Udvoqd4if381jKkGpvM2z+XrV6b9PGDtA4F1Y2rrvnMGlnJOcfNVhfo+yHfK+QfH2cgVp3bVPRbHtcbjYVOhgHTx49fjp89Hj46PH5k8/HT74c/+WL8D+/fPK/H3TiYbyeO5124Fos70KgM9PQOnLoKcGbGCAhj79AP0rSGJPL0cexp7fKhTZypl12hUsG//HYifAOMruCuweHd0lyF+VNxq7r9HHJX1lnHWflTrRME1TbbliSCvFXI6CxyPevFujyfHlisnUV5jc0VoPZBmgmgSZre/RcwWjMtmWON5KwfdvfSRc7s3WXYAlkzMSrqoyHymrKKcMtVOUmHb/mn6+4ow1cE+XG2FNO/N9iF9dq4NdYxruHqk2rqGWcVHtU43C+ilw0HWFzPki+N6eMpHFdYSc0xJQq75BUP1WqNEf+d0intyBNHv2FKjHHgsDPJc0wryPOhDKb4tV2Uv/V3TcKk3LD/tkl++e+yquXqq1Luf/u1Xl/O0SoqtsnEbeRVJMGpEDX6fxXHtCMqquduy84bWxuUg3MzlwNTJDXmFzkE99jmmUmWHk1cgOPVktBc3bVsRB+zYF7sNnshBurqkHw9INugqBQKI1Xa2RiZMxYHJOTKQEphSSWg7sn06a2I/hoOvmbKju9EpiXi64EjXm5qHd904owZ0kjJxvRSSuAuBvRG8oyu1fzxChD6zoAx0KT+l3rDKNqqKZzzLihCS08m0vu7bqU8cR6AVbHdYnqnmm/oHllvFu64S2fXQyQ96DQyJOgRClNbkuZJT4OmYqSd27ZBuisNeguEauvmpRpiQ6fbBKTCLsCOMXwZuX54ABthF82LqtND8njJ58//QtJBChnCzDVSaL9wVvq47WWRNPDMOIpGDRmXOhZzdAjKb+1FS+EnvjiiP9cCk1n1gyBBJv9iCVHrqCxeXTCDQZBG8KdHJ2Pi6KJitqQ4g6ZfJSzYl8tT65Pt7drNrSZObncDaThaV1jK6lB2m72rlLv6aOnA/L00ef41+MBCcOw35IGrP+gU5QFJuix2CiIA6erttWhXV2NvbBSRlavnNZ6ZWvj29WQBtZzO6g9rklpmel7VXmvKu9V5b2qvFeV+1QlUgniUpp0yMvbQMj1JI5BKWOLB+PL13gZWdOFal2dfm1cIbkeYlKDCQIM52V8DUgDmx05NCeaQ0z/NrKD1DwzNLM31DPKFy617Mxgh6k0dI5Z6cFfhVyPqixWqw+QmjneDCC3ESeEVGe+k4INbMmByQMo7RX5iG9MlJY8bEB7+FVkUlow4BY3W5NnhMOqDaHX/8q3pQWbctwNYnAtG6P3WpD6ZogMNGHJmFhZ/IqMRjvXxaPIXhgnPbdZoaotuYv79S0Me599TCbof/73wyp4RX4hD12C9sOvEfzvdMWf3PmGP/nAC/6k5zMZ+nsp5Nlz65bswOxkZEOeEbqirMW3sH4uoWfFhSVObiwyEe9/FeA1fyeZz0VDIjl1QfNKGAsaX6NKyinjiIkTzl7EIx0F7tGGKLCfaV79FMr+EgVwWjArlyQKFkwvy7nJMa7ldbgQ2NpMFaMuZrReH5dApFlCxs9IFLBk5rRRFJDRyMkc+YXseaEA+9opY//L17b9beSeiaiBbRCarye/kD+yjCGFI93WCeNnpMWl8AWstjQEdqIFO7Bc7OowOZna2i01gT3RHBwQOcB9BztXkMJKvZxMw+e14Pq3QL6h8fVCok3U6w8IS/qh5U3Pzhk/IS41WARZagb4j2eEs8zKTqTTXIffFpJxnfaECs90AlLidRq7o9gsK5plyPqrbnSursbks5so4njtB6TsvwPyt2WWkb+dn59UdnCjv+29wb9Go6qBVeFXjTHHXk6w5e5QotQ41Gm7/x78m8ODKvoR3zQ1wMlaL82lE68FcMPbuy0JuZ7ZyoibUeuC0FwJUGH1dobtUU1ku7nEw1jXaFIwNJEKXbcszIx9A/uF8vuAHKJq9IenS6FsOMxnhNmjK6NJjUvg7zcUGV1baQoLKdBuUHjfgRZMoT5CwGcA7Q0zLOxNO9pa6qos3OW99kqqX6cxiYvtjbcx8fbqstrZTAP13F3R9QrzgTl+cwrWKB0/MnS9KYDUwSIhfa5XjTUCw1O+GO8UGSvAGP8IBY0wPPbDozRnSJFCZCxeh9jL6TJliAUUs8RKvfRvDKAy8kqLzCETqwGeazn1ZbUg6kyEpKhmytwfXIvSphGatjFV9sj4QWW+APkGqATZns+YtI279+YENX1n9s7kMyJUCPyGScEvo+Cbo8np0ens/OX3Ry+i4HXFgiOO2wL1rxi5x5DwtMiZU87NQjL61WPaNHCZeLW4pULxMIoWzDUbWyQfEJtMtH8QqpSbT8FmrDbrGiM2rbt6hL63G8gz8rDedR+SB7jnvm3Dra0M8oxcPoTWRvvwNXlA8H7npdLy9f+DfRapoeXaMcwy7Tk09KEvRtJXO8GzFr/QnJs5KvdYMnBYPHMbYA3DaMde5KIMDpZImwb88OsGsLHZEJoALIQmLn3PUdTLpFLPKI8w3h26btDaVfdiQD5TBgnyGYF+sDG+lkquh3j3DP3Yhs+EASy2sBGL1pNgvb5/FMy6W813qLYd+3e8a+UdlZ0XrHCr3H53y8F+m7+Cvx8/fvzl0y8f/dfDr3fG/2TS/6cHbz4//GprCdjCj7QOWhQ0T2rZl750Kfm5JdxZfdSzENvsbVqC+k3DyvtovH5/Tnv/4J6P+/hYWDNyd6lW+utO/PstmFftOj2lZZgn/XsudnGx59FECm3clQyOJZZheHVsvC8gViWQdATGkDW+c6XhGxkn95r+Dy9b95r+j8PHe03/787FLU2PzfxTgchHwz29DMbByGhxnwOkRrcs2WBQyEQCLHNNPnoVtbh1sYqZysrFpjNyMTKqX5pUNH9Lp+piD7DcqXZQx0B2+PgPjA4072GcWCgEoYTkH6I0GbXmUJdpz57LZo8DwZXIoH4BI7YF5hUMtRx55EcuLX20AD1Umkr74Kmlm4+GmGRQd8+IKnstzBy6mxRFU1JJKY6HC2luwhftlrZop6nAGMcTk9SYiZV9vqIZ9Thwh3+twosWa5brRNIwgVz4CVqgI/zbpPCJwk5ApGnGONhXUrGUeLmyrp07xkbvTkIqQS1tJpkiPZoxaqNAVw7KzMZTrnAptoveH759HJrjEXNwahuZNMIC+PQQ+clRAqaHxB7r+TS8O9JB206NQ0xLdHNLrn1euJvS5wJazcez16IkHOxzWy3BwwDNNbzt6ZXqzRW8IoQRhaEl2dDgaI5m3y0ycv0KLxUWNIZJwb6Hjpdg3oG3vZWIAIb2XazffRqYUMBT4TNcaGxMRJssOw5cIPavlo/1O9SI2Zmt273V/IBMuZYiKWMbbD4UcYn5HvXNV6PwzeVOGy5tv1SOJJicTFVIJu0KLDRKx2RmzsFFEvF2g40HuqzLE0cMYkXKCmtITuyIBgqq9VwovAnjH2idS7FSNrQc8QcPyNnh98pdoEncDIid6ByUjwOqRpaMU4ENDtqbG9WAjYQaZcAbYmCfVGSZWOF6xDODki5AmcfgfyHH7tvFgn4hh2LFM0ETBEB+zR8E0WTIR/rzC2I7bP0h2wXv/+cjgOgGi9geUqlbhLksynmYwE294lzByB3TqlEd3e130vby9Ghy+MNRDWHrQFYl16N5JuajnOLFRHdAq9y/o4RKPbIg0HZo0jZ8cXTeHoqXC9ChkIu2hqiKa6zxnSgb+x71Pya2QnPYwddge5SxN0w2h1rCm7DI66Hs910p+xGwBYNSJ7bPxfZQNei9w1Vn67+JJCzErhw4bL+jN7Q9VE5vgLclQQGV8TKsakZUaoYPEo7UEjeRUX0K2f9wbH+iN3SP3CK2NvhQyW2R/6TapDVy64u9TIwaKTf9j0lb88aUQamJ8za2vVe4qZirmv1fi/bQdf9NkLfAW1MgOIeTv51siaLFjKktbdEqbq3ELap/MNLFsugQZ0NxezzewnZdsC1EXYl3GRrCO9pdfR+OrUGpU1OclvN1eyhZztcLyFUb42bpCH+01ttHxRaH2rP2TtGLbg0VY2BRhUw0vDJf5H7txfQjYau6dzjzBlYMmH44ruIPk4LGSyBPQnyftO0J49qjptrQ2PVVo+PpwdGLs6Phk/BRuNS5uV+uQebqZXpm79Wi362FaiRPepMzaDw0FOB9HWXs20IonVPewKtxzrjtOTdSxf8V/rMfZ+3jJ6Y8MOO1uTvuNghxGdhXYwb+ghCSYWxvGWHWBLa4vcXE7guZbTZYbP+7HPM/BDFlssFdQOQttPhj/u9BneS1sfgqduYD9+YM1kdm3pN6vVPnwff3pQfsQ8ZfPeTrJioeSZYEm9ebQYDvCWOopDqGQN+paB477Nx6aEW1nh+dB/ad6MZDI5XL6QMxl7fd6Nze2hbGU9tsKuxcxOD1ZrP5Px7vt1o= +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint is useful for: + +Getting a session object with all specified expandables that exist in an administrative context. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-settings-flow.ParamsDetails.json b/docs/reference/openapi/get-settings-flow.ParamsDetails.json new file mode 100644 index 0000000000..6f8fd856b7 --- /dev/null +++ b/docs/reference/openapi/get-settings-flow.ParamsDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": [ + { + "description": "ID is the Settings Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/settings?flow=abcde`).", + "in": "query", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "The Session Token\n\nWhen using the SDK in an app without a browser, please include the\nsession token here.", + "in": "header", + "name": "X-Session-Token", + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies\n\nWhen using the SDK in a browser app, on the server side you must include the HTTP Cookie Header\nsent by the client to your server here. This ensures that CSRF and session cookies are respected.", + "in": "header", + "name": "Cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-settings-flow.RequestSchema.json b/docs/reference/openapi/get-settings-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-settings-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-settings-flow.StatusCodes.json b/docs/reference/openapi/get-settings-flow.StatusCodes.json new file mode 100644 index 0000000000..0d746b8062 --- /dev/null +++ b/docs/reference/openapi/get-settings-flow.StatusCodes.json @@ -0,0 +1,1732 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "This flow is used when an identity wants to update settings\n(e.g. profile data, passwords, ...) in a selfservice manner.\n\nWe recommend reading the [User Settings Documentation](../self-service/flows/user-settings)", + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.", + "type": "string" + }, + "continue_with": { + "description": "Contains a list of actions, that could follow this flow\n\nIt can, for example, contain a reference to the verification flow, created as part of the user's\nregistration.", + "items": { + "discriminator": { + "mapping": { + "redirect_browser_to": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + }, + "set_ory_session_token": { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + "show_recovery_ui": { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + "show_settings_ui": { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + "show_verification_ui": { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + } + }, + "propertyName": "action" + }, + "oneOf": [ + { + "description": "Indicates, that the UI flow could be continued by showing a verification ui", + "properties": { + "action": { + "description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString", + "enum": ["show_verification_ui"], + "type": "string", + "x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the verification flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the verification flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + }, + "verifiable_address": { + "description": "The address that should be verified in this flow", + "type": "string" + } + }, + "required": ["id", "verifiable_address"], + "type": "object", + "title": "continueWithVerificationUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithVerificationUi" + }, + { + "description": "Indicates that a session was issued, and the application should use this token for authenticated requests", + "properties": { + "action": { + "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString", + "enum": ["set_ory_session_token"], + "type": "string", + "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString" + }, + "ory_session_token": { + "description": "Token is the token of the session", + "type": "string" + } + }, + "required": ["action", "ory_session_token"], + "type": "object", + "title": "continueWithSetOrySessionToken" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a settings ui", + "properties": { + "action": { + "description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString", + "enum": ["show_settings_ui"], + "type": "string", + "x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the settings flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the settings flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithSettingsUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithSettingsUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString", + "enum": ["show_recovery_ui"], + "type": "string", + "x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString" + }, + "flow": { + "properties": { + "id": { + "description": "The ID of the recovery flow", + "format": "uuid", + "type": "string" + }, + "url": { + "description": "The URL of the recovery flow\n\nIf this value is set, redirect the user's browser to this URL. This value is typically unset for native clients / API flows.", + "type": "string" + } + }, + "required": ["id"], + "type": "object", + "title": "continueWithRecoveryUiFlow" + } + }, + "required": ["action", "flow"], + "type": "object", + "title": "continueWithRecoveryUi" + }, + { + "description": "Indicates, that the UI flow could be continued by showing a recovery ui", + "properties": { + "action": { + "description": "Action will always be `redirect_browser_to`\nredirect_browser_to ContinueWithActionRedirectBrowserToString", + "enum": ["redirect_browser_to"], + "type": "string", + "x-go-enum-desc": "redirect_browser_to ContinueWithActionRedirectBrowserToString" + }, + "redirect_browser_to": { + "description": "The URL to redirect the browser to", + "type": "string" + } + }, + "required": ["action", "redirect_browser_to"], + "type": "object", + "title": "continueWithRedirectBrowserTo" + } + ], + "type": "object", + "title": "continueWith" + }, + "type": "array" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting,\na new flow has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the flow's unique ID. When performing the settings flow, this\nrepresents the id in the settings ui's query parameter: http://?flow=", + "format": "uuid", + "type": "string" + }, + "identity": { + "description": "An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.", + "properties": { + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "credentials": { + "additionalProperties": { + "description": "Credentials represents a specific credential type", + "properties": { + "config": { + "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.", + "type": "object" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "identifiers": { + "description": "Identifiers represent a list of unique identifiers this credential type matches.", + "items": { "type": "string" }, + "type": "array" + }, + "type": { + "description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode", + "enum": [ + "password", + "oidc", + "totp", + "lookup_secret", + "webauthn", + "code", + "passkey", + "profile", + "saml", + "deviceauthn", + "identifier_first", + "link_recovery", + "code_recovery" + ], + "type": "string", + "x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\nidentifier_first CredentialsTypeIdentifierFirst\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "Version refers to the version of the credential. Useful when changing the config schema.", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "identityCredentials" + }, + "description": "Credentials represents all credentials that can be used for authenticating this identity.", + "type": "object" + }, + "external_id": { + "description": "ExternalID is an optional external ID of the identity. This is used to link\nthe identity to an external system. If set, the external ID must be unique\nacross all identities.", + "type": "string" + }, + "id": { + "description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.", + "format": "uuid", + "type": "string" + }, + "metadata_admin": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "metadata_public": { + "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-", + "nullable": true, + "type": "object", + "title": "nullJsonRawMessage" + }, + "organization_id": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "recovery_addresses": { + "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.", + "items": { + "properties": { + "break_glass_for_organization": { + "format": "uuid4", + "nullable": true, + "type": "string", + "title": "NullUUID" + }, + "created_at": { + "description": "CreatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "id": { "format": "uuid", "type": "string" }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "value": { "type": "string" }, + "via": { "type": "string" } + }, + "required": ["value", "via"], + "type": "object", + "title": "recoveryIdentityAddress" + }, + "type": "array", + "x-omitempty": true + }, + "region": { + "description": "Region is the Ory Network region this identity is homed in. Set by\nthe multi-region persister; empty on OSS and single-region deployments.\neu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global", + "enum": [ + "eu-central", + "asia-northeast", + "us-east", + "us-west", + "eu", + "asia", + "us", + "global" + ], + "type": "string", + "x-go-enum-desc": "eu-central EUCentral\nasia-northeast AsiaNorthEast\nus-east USEast\nus-west USWest\neu EU\nasia Asia\nus US\nglobal Global" + }, + "schema_id": { + "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.", + "type": "string" + }, + "schema_url": { + "description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url", + "type": "string" + }, + "state": { + "description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive", + "enum": ["active", "inactive"], + "type": "string", + "x-go-enum-desc": "active StateActive\ninactive StateInactive" + }, + "state_changed_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "traits": { + "description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.", + "title": "identityTraits" + }, + "updated_at": { + "description": "UpdatedAt is a helper struct field for gobuffalo.pop.", + "format": "date-time", + "type": "string" + }, + "verifiable_addresses": { + "description": "VerifiableAddresses contains all the addresses that can be verified by the user.", + "items": { + "description": "VerifiableAddress is an identity's verifiable address", + "properties": { + "created_at": { + "description": "When this entry was created", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "The ID", + "format": "uuid", + "type": "string" + }, + "status": { + "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema", + "type": "string", + "title": "identityVerifiableAddressStatus" + }, + "updated_at": { + "description": "When this entry was last updated", + "example": "2014-01-01T23:28:56.782Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The address value\n\nexample foo@user.com", + "type": "string" + }, + "verified": { + "description": "Indicates if the address has already been verified", + "example": true, + "type": "boolean" + }, + "verified_at": { + "format": "date-time", + "title": "NullTime implements sql.NullTime functionality.", + "type": "string" + }, + "via": { + "description": "The delivery method", + "enum": ["email", "sms"], + "example": "email", + "type": "string" + } + }, + "required": ["value", "verified", "via", "status"], + "type": "object", + "title": "verifiableIdentityAddress" + }, + "type": "array", + "x-omitempty": true + } + }, + "required": ["id", "schema_id", "schema_url", "traits"], + "title": "Identity represents an Ory Kratos identity", + "type": "object" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the flow occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this flow. It knows two states:\n\nshow_form: No user data has been collected, or it is invalid, and thus the form should be shown.\nsuccess: Indicates that the settings flow has been updated successfully with the provided data.\nDone will stay true when repeatedly checking. If set to true, done will revert back to false only\nwhen a flow with invalid (e.g. \"please use a valid phone number\") data was sent." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the settings flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": [ + "id", + "type", + "expires_at", + "issued_at", + "request_url", + "ui", + "identity", + "state" + ], + "title": "Flow represents a Settings Flow", + "type": "object" + } + } + }, + "description": "settingsFlow" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "410": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-settings-flow.api.mdx b/docs/reference/openapi/get-settings-flow.api.mdx new file mode 100644 index 0000000000..67534a67c1 --- /dev/null +++ b/docs/reference/openapi/get-settings-flow.api.mdx @@ -0,0 +1,56 @@ +--- +id: get-settings-flow +title: "Get Settings Flow" +description: + "When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie" +sidebar_label: "Get Settings Flow" +hide_title: true +hide_table_of_contents: true +api: eJztfW13G7ex8F/BZU5r6Vxq6Ti5fe5R6tyqkpOokV9qSXXvY+aI4C5IotoFNgBWFOv6v98zM8AullzKdCwnbrL5EItYvMwMZgaDwWDwZpAJmxpZOqnV4HDwaiEU42kqrJVqztxCWiZUVmqpHHMLo6v5gj03K/a94U7bB+xFNc1lyo5enLKVrlhRWceEspURzC24Y0K6hTDMLUTUjJ1D/1qxY62vpRgrvbXGhb4GiIxgVrhkrMbqRJRCZQCdVjCmYalWMzmvDAck1mAu5HzhmBGuMopx9uXDL5gwRhsmZzik9eMsuGWc5XopDDuq3EIoJ1PutBmrI2srw1Uq2Jm4ETnbOzo62wfsFJOWldpaOc0Fm3kkZAZt3SphFwBJyqHzshQqDBkq4Jglt3apTcb+ky3FlFduocYqNQLr8NyyveVCpgu21FWeMSNslTsmFTs6Onu0z6aV28BCq3wFnz9P2OnMUwMx1mlaGTtk3F5jo8oKM1ZOMyvnCvpcSrfw3aVaZWzGUwftDEsXXM0FfmsRGyfkf3WFWBLbrNEf+tSVYzFKS2CyChksZqWjrADEXpxirzXsoSekZZ6LjN1IzrhiR385+jsz4sdKWDdE2IywpVYWgXRcKouls1wvazg4MyKTRqQuYafALGKsUm4F0zPoEylFnU3w70RmE/gGJX85f/6sGWOqsxXiPRVMK+jgEOCeWJFWRrrVVWrN7OpG6hxJNTlkl4oDozjNZsKliwa4qUh5ZQXj7Pj85TesbkNTZkSWYL84x1dS8dTJGzE5ZM80EjDIypJbNtOVythBPaccp5nNpLEuiaELXHhVSFtwly4mh+yipha3TConjKlKJzLijBoCI2ZG2MUV0F4akU2QD3lZciOUy1fM6kIwDYI/VjW353o+FxnAJJV1gmc4zU+1EUyqmTYFoewpSnhwx15HSuESUDkXzkk1t+z37IXRM5kL9pQrPheFUI6d6LSCP7CzH/aSZGRFPjuwwtzIVIwAOzsCkhxY389+MhgOdCmIo0+zweFgLlwY5ZtcLwfDQckNL4QTxg4OX79ZU5qnJ8CcMJs1bNCMnZ4AhkDUG55XQUOAzgi9sVQXwrKZ0QWbAGwTdvnyjP21EmYV1bKAmdOo7caKl2UOugmotSeSecImo4DM/0Anj/k0zcQEEZMA4I/Q32A4ULwQg8OBzAbDQZi8waEzlRgObLoQBR8cvhm4VQm1rDNSzQdv3w7X8b1ATCP9DGi+aoQaKXHyPbKfAr6IpG9q9NIKM2RlLkDspErzKhMkiEGNOVT6C2FEjcJC8EyYBoe/H3gIDhCCwXsh8N3FxQu/9tg7YA/AAgpDhksL6EZzA1MiM9GseBEWLOqcfYdQA2LKsemKFGguo+kM/SGytGLQ8mlp/USFwFVWq/iUwMYlEXSRSJ3ItpKJ4LiTOj8AL5BOs/D90cOH8A+oUKEc/Bkx3OgfFij4JupvnTekJR0iLaiejLQ9rJVBESy5chbwr8qMO1zYkXfHiri59FKdcceH9QJphyxJkn2aGJBpL9Ks4EoJg8rkFZAk1UUhFKyVPAsz+rqtOX6CkgAdYEBLOElkIiW8SYAjLB/CYm+FG7aXIiPm0jpvqBTCLXRG0ywtmwqAFkiWsFMskUrCgpmvxkpphwbQYLg+f0OcKakqcQVStgnQcQCAs1xahwtdCt/skMZO0bSY6RxmzYX5wzXYgToeouISt7woc1EjhCvpTBgBhpHTiN6NMHIWVBN0MoR1n8MKgqaOcWEpBeI+sGMVEwSZ2IkCyZtJwKGQCmwwKCh4WQLCh28GYQW/8vJ55fQm2qcqA0hEwBJGvTwl1iSMp2QnAOkyEE670EuYAo5MdAMquJKd804isDnvsAbLPGc8X/IVzCibdMA6AbQ3Stmxh+WVdAvq7KWv9WeqdKHPac6HA6GqYnD4upMSP6yzyHBwezDXB9DmAGAeHHa1e4/x3w53mwJYJ2A5c7o2unAaglp1epOd38Yr0+tA7e4BG0z19B8iddCbdDkUpBEyG2gAAla4K21WV8GmwSXnDi4iJuK1GkYLydpKZENUz4BXvDDbBfIYWHUoUrSkgSDxZnchsmC/2g/ls058JrDydJR3zPW5cM/Nyq+puKRuMFs3yXZhtw8G4u1wsMNk0V7Rm2I0hm7t8nZnt7vwvJPZNlFAblvo5VXQKleV/GTV1TqgwEFrRV3zttDLl77G5ekm46xjvxPP/MRh3w4HQDTAuE0JmXVrqNOTwCU1HWdk9NOmZHA4qCo0mTdW3srk27VeV6fxxpb2BNKSmdBSkLQ6RnqSWly+PPMmYt3WrUoJu+IVq0DUUcEoDhaItzMtG6FzBm2aDvNhTQBktrtW9YSXuEXaKklIy/fusxaaYIDdu9CEju9LaCJAg9BERVu4N1ik24Qmxn5nofkJw36A0NR0vE+haXX6KxKamvD3KDRNn7XQxHb4vQtOy8i/J+FZAzgI0FrxFm7+W1RrmyCtU2RnYfoAED5AqDY2UvclWBsdf3rCNRwQkOArveJZZoS13Xj5j8TC3uCeBhzJ1VhvZ3cR4s6Rd5TCFgfco3S3+8U+PTOtnpGLx3cLJrISz2dd/sle2ntp76X931DaNzzXvT+i90d8uD+i30f1+6hPQfl/uvuo3j3Xu+f+rSXko7vnPlEJ6c/bPsXzth1bAqa+HjeGr+C3uC2lEfaKu02En9C3I1cbWbIQbO/y4nifwg7qCCvfiw+JIxFm1gHzLKVdiDgeIVo4h2PFmRJL6gSi65wGNqOTeR94UeshaH0AIHQpoy79dnrCjCiNsKgJArAPLKuU/LEC3ZcwjE0phYFRQjhDa1kfovYBHm/1JP2OSMQW2gPLfmzHFh2yhXPl4Wj0xyimIiF1FBomlbyqTP41BRf9UWZf76J9Q7xHh+gq9jp8/WEPxreHo9FyuUy0WSWpLkaZTu3oGoO+RqlWqSidHYUmBxiZUehM5Psx/TjbW1QFV/s0u1JBcFyyoVB8REInQx3TN2IozhYiL5FPTJU6NpMC4yQMm+tpNZvxXCelLndngSgGEjVblkkYl+cvWgBugFQHTraQhdAf2CxGoZUMh9xAGCM2MfTHyxwEMr7ky6fCWj4X7W4hwCeJPqIyX2pzbdlSoLi4BUZCDtn5X89os3m+5PO5MNH65cWckP6FyE38MpMYtLches3HBv8oRMZLYNQHLfJrxGYYOilsK3ZlA5J1nUa/N9Q39BfFvQhY0dxSCMUyOcNQG4eDWgAwYqZkrOow4ohdoL8XvnystMzS9a/PT0+OIQLYletfLp5fvBirXOvrqryyIjXCrVc5w49jFcKW17+/EtMjH86sM7H+9VhnAj4T6Ndi1QX5tViNVQgHW/9OxWNleZGvfzw/eno2VpkAZdYJ3Al+8vA1k3yFcbLrlRte+QY+j1Uu1XVt/K7XDlbSmVTX7M6PshZjnm8wFowhshBZBb8YBkqJ+YrttazW/YT5gDGIEqOYO+kWXvvHgdcklUw60PUJTcw78YCZikygwGnglJBZCoKnXTkYDlrMMhgOAl8MIEINu/AzTQoKJg/iEnmRD4aDaKoGseTShEDvMcl9l83vXWywXkR6EfmYIgIbTjQgu9e6S/r2kda6G2Fs5zbpb/SBYjVtFKiJpX4T3BAggRj7WZWT+YzXPoLRSWYEo8DfFmRSuT982UAFFwfmwuDeYpvVH2y5iKCAxm6mT563poyCWOnaAE7tmle7vshU38zpslPErRNG8fyqy1B/4j9SpD9XTJdkubHQLPJTrF0ACnHQTiOLjlXrDpDTeO0k9GJX1okCtynod4C68RAYbQ54onkyVjw12hJJfJdSdB+zbNl/SNuCudl7NBKfhFsMpwHo0xOkN8gSbOrxclCGlmCrWFuh1mLaZ5WrDFy50UXJnZzKHPqDlkDRQv7Tn1VpA5aQM3JawamEdRpa2ypdQCTxsU6vjebp4uTPyS5bkUI4DtHkVxyuGG3S4VmV5x/JJsa/pWXPLs/O4KTpAGLzqzyHv8PVi21CAvX+YrVqRm4hU+LVu39zbLSZc+Wn3Yteazq/3D5CvdSHEQDxy8vTE3KYeNekP9nr2loF9X0UqjTB+iBQrjl0FB1aBr0s2EF8u6G1EWjvw6ZG8Ourec6tvZppcxWjfm94/5LbrQ0kOp2yv9waCV7Zzv3Zjey+N9RyjVFzqnyHPyswXlCWnrk2toFgoeoCWKUEHwnMMA4471zGX2J50NZwJe6ZcCCzjFq0Fziot9AFHooncO2FTVe07hRV7uSBb1OCFWCdMF8xhAKuOD0/P6frRlLNcxFqZqLM9QquzMBmU1QHqVDO8Jw9uTymv8aKW8kPlDZuIbh17MhK/gx+PeFgD1b2AIsvz+vfS4G/Xwn4LSr25JI6waZQg12ej9U811Oes2/xn2gf0gAxGA7aYw+GAz8c/QUDQcvK18TSwXBAXe+0efgFUX4bLm91Wibn+KlZyBszBG+r0mfvtayNoxueyywYRq3F3xkuXbcB4YHoPFShYcD37MGITliaq8Bwx617QG9V1pc/4XoswGp0gdYHCfghg8G7QHPcdThUzqG4w8LB6t6qqU9rwLmLl23xBqvSTMxmcEt47K/bMuyNbneNlWyVnvpfEXvWBaHmTmz2HkMFtK+8+eUVarcqjBaKC3CRS7jKheLM7I95UpfPKpWSYds2kyNXFs5Xh/OK5jFypakOvsIbxrGWCheiadkaskJncrYimyMTuQB3PDYFOviLfwdrN/+oU1VWbv00yPM52KZzWNbdhmBkYiaVyLD3ScPhk6Rjr0Io/uL7vLWQpS7D5m91rfc2bepwKn9bFVzp7Yt5d4/k90fR1DcghyHfyyX/is5xcA/hzAoDnXx9EDe6lTg4HDx6+PmXBw8/P3j4+cWjLw4f/ffhf/0h+X///ej/f9ABDR1A77LFAFmsdiHQOVakjRzslMRtKkTGPv8D7KMMT+GOOexxwrVQcm0Uki6rhjOd87+eeRbeAGaTcbfA8C5O7qJ8Dguab3S/5K+ts+2Rf1gF1LYfls20/hMyaKqL7dIiuna+dRydT8oRxsA8IDncHV6xKbje6z4ibFvm+FTrXHAVj/cz6WJvtm4SLBO5RH8VXTGOraaCS1hCbYGxjs38hQ872sANUW7QnvLsf4dd3KiBn2IZd4VvNlZRyzip16gfmsFrz0W8EVZxvpn6tLLDNURxlZ0ycoqfdjiArjN57CwQPhKz2+B6SR8ji8tfFqcAANzRcxuiOb0pFeGLV8yj3SzmgZlps+Qma6fjoGVD1KfJly/PHsBdbreAxDB0mhzdD+9kVEq/0xmz8BI/Xej1e/IB7rophte8t/G3diiOdckw9ZHCSIhrpZeWuaWmChYTuWCEExAC86zgkTK4XVBDoGZIdZ5j9oUhUEL6K/toc4QY3Mqf6mtTRCHL0DOkzrEVZsw5ZGtRvRtH/M2YXvUy33RWQWxRnbenNPpGZiJDQJOxOoG8NGgTWcdXDCSJ2NKIElfQfMXShUivpZoHnyO6iEG/saxubcSNMI5NeXqN2Wt4DglzFCQmoOwOTY6dQAGfmWQ88Hk+KL0NfSoX0LOqiqkw48E+kRXYFSYq8VamshAfdVXyVa5519IcqrygGrGfFc5LqFdk+016Os0WWl9bnCZUfQzUTQ5z0KUBthzYBuHG0wiQJp/tCgKReCknwBcTH0DTMinxqFdG6Ymgh07u7rq95TM6CNP263138fSMfaNNQRZxWtcCyNBXgBM01W5BSUqgLlLAJzb6aZHfDV8j+XnE8tQSVdLkj1HJ4/HgzRuW+A7evh0P/Er1eDwotXXjwdeTTmoU5DikgMFuLxvmLbntUNVAE9/+AZnD4tatnXdU1ulC/hM2xmGozsOCNV/XlgOQaP1B39w74WIE0isjnROUvqkQRiJnqXku7aJ7T7aVO+t+gb1gkzPT7FTN9FhRSrAn8P9aEbFz+jeyF6AF/IR6sMz6CrvsZXcdrHNtR1L5Qe4wKip5ARU3LYh2Bev95mALbdDpKaVhkRHf+swspMJePD+/2O8iu9LZGieu+eHhu8/T48WU5AMFVQSjj9LGyTow9PKUATVueI7uNpDSOvkKhqPBUbFfurlikz/KYv71hDk+x3WIinA37If42ufnyq1mE0zNVeaQwAVoPNmMj+LOH7u8Mw8L35S+hRGzblaEs68HlkEFtpcJ66BLqdU+LuxtJ4/cdX92tHlatW2mrrqlBCYJtXHLUsCD4gz0BMbbhIQ8nBWSUunN2AQqJPB5Ajp0rCCvl5EFNxLCff1KxHOKf41Pu1ALPy+FgsDfL5KHcDbtN1reTSAdcyJdKB877B0a0rLxgI8HyRhVFwPOBpmGqT6F/4+VLObstOBzOBlkRypdoMAhuuwc/xmrTN6wE3kj/QWU2mG1k1Df28BvaxntFXivwNe7QDUSag2px0aIo40dsdpRrbLWDf5GmfkEjxwboHR3MkYmbzZnInAtJMaEItLqtTsdMyV6J+1SZnPhvCHvUQI3oNbXYQd18vwpG7EbKZYdwalwOtil5/ADJHVbv/9ohMqEwf2ZD+44ef60k8vAIL4r7nSzQZsIYE+TEuQlUPNarA7Id15yacKNRCPQ/G7icjJPvBBGsGIFX7WOIyYA2UGSJJNovu4Q219iDfjYS8DuKwBB/rGWAeD/n3ch6NIenbIemnRJO+M1nwUh7WagYt5htAhIErzJF99heR3WA1jtEvbUmyrEqLKYfywuhWn8uc0VazpibS4CY8Cxoq5MKnY1Z5cy68rW+AqK35vl1mQIQPWrJg0zDDy+RbSQFu+xiiJg2xdRpHWX072s3PuMglOmfPBwe5NSOQ2sCieEWw4NohpN102WbugbYhnQ+dOG7Chq+gS+Aw/fVelC5GNVmbuqXJp8rPz58kEdiry9/jFVbYKTlVju0u6ZWEYBzYrcywcYXry90XMl4MgBwlghCAGiDQtR5yO/Cytf91UT671+0uAE/J8c8+v4AztGaA0whUkDMcZprAGzW7RGP6n3OaloFls4uukKQBHhwhl0+MCyUNUfdnt3Mrgm0G8cKYzo5CznU5H3e8F+L4gzUvDbXKh51/r4lN+e4SfcRYRcxDH/FfxWFlXBqIedAtVDuuzO1d13651pDGp2TtyvyXJDK+lj2W5oHPzc1ptWaS7T6825ea6O4UOLnf7Bb7jvj17faLbb4lakGJIOZ6PQsInyrycG1S1tbcMNn/ByiRGYZueQXdLzF35wLzI2hNzA3Isbnu/tewDoHox/u4EZaa9R2YUOLozE8OzwskIXf3oK+KpbCRG6iunBazyY85/fTZdwa8DVHZZ4/4Szv/AbTvNUBzk0R5fTFRxTD/0AvrENKcvrKwCwHn4vVu2M6trAKxMSqK3NKsD8Mq4SCj2atqtSq/UZdLi1GX7F+v4yVnf1+ONG7XjtPVXS3dl6vXLc252IdtSJ24bsJ7v00VU3EvAtpKcsRi3CUVGM3mbJOsKtGpv93wXiLjqn55ufmW9QM3Uf8T9XZ3Cw/xM0M/T3gYoZh/4AvQztd1PLeVNzGw3uQSkjSXqd/JuSrV4n93zzU3UyKqBtqThhwwEPscHpj2371Jq4xwoOpvIVqFMMMKIYTbhzDjH3GIA5gWmehCQ3tDUa1qmxvCKjEy6KzkCXAoToQiZJiL4bZUaXmV4qZrh/aZBjQJoR4gCDOXAXQe4+GodPcZixCuOEFER0pQ8H41GMBDUeMuvzfBEQkHIHAuIwYjLsvXJBG6/LU38clmkM8oYsAfCYmXR3xNK/bGV3wftXjJDE4PnmDbHaNbqEK7ZdxM1i4jYPkMFqRds8zmzKc26oMcav7ZEADn1g3hBfZfQumn14pkryXP4TZl2YKXeyiILr6E549zRiJOXaPNJLcR4LTmtoazY3T0bviA8n5CjoFcIVIcSymhbgd8kCO0rr72yjQSDTa3xUj3bcd+IWUddTlMLhkR8w6HOsOolKUK1TlUVETbbEV9/pIwFfwpoj/XkZpHY90UzJHdwdv9uz4SttidwNwG06Ysy1v3WIs1iLZmjS7ejb7t5ad7R4NxdKYBthzL6BboEtvtN2Wg+ifEeVZxSBqjAEdqpvO6oc+09jtZBZJtbdplDlO/zQfZIA37c6mwmNHJxowKwdX8/xw1hNK+d019h/xg9jBUHB6BPOdcq7xjnhDr3BZ/Cd6m+p1eXzhm+XL08je8K79GJHPhITnPyeZHDohKSBZq3DAMJ3MBwQXgMMTYjg9wX+2GBnT1HPJJ8Ek9x9lydIOVZJNi65rytE9Mt6BohOIdaPMd9HW9JdVoBq87yB25Xacsrrd51YI+RZ21RvmI5DGznvSjMRdUNpO6giK3Uu01WX+v2AQAJ0bpvO/HsNHA/omVesB5cMFv+Oju1PJXTGM9XP7dlWkB+xa2rgYUYwF4/PX8C+/4hhTXq0lNMznJj10qLhKwvY7gt6lPSYHv9k58Gz8QJZNKHHnr1Ru+A3ou6guUgNscZyhsOEIdp9AzjI8vCMaYAGOpEuYfVj0hCtnC60tvUY2BosfcIDR/uPbqNlJowRxsvVXXIYqt4hg1vjPnwXFPbxfkd5vunT06dP1nTJlot3FNFB6mkDwbbaiUW/1pw+qkohoJ0hIMRenbFVHlqMd/c+ILxx0zjjOs9Vwwnpu/M8//Zio4A2H0sPId1/9mDuzsnuz+9/g+f3a1341tvjOqHVzlFh5JHZEnm2+ThSM+Cd7yP1cWm/8hCmPi7tVzipfVxav671cWl9XFofl9bHpfVxaf1Zdh8D0fNNH5fWx6X1OvkTl61eJ/d808el9XFpfVxaH5fWx6X1IUd9XFrPJH1cGryp3MdK9LES/ZnSb+dM6ZeLldhQNn0WrD4LVp8F6/6yYPWpcfvUuH1q3N5E+LWkxu3vyvR3Zfq7Mv1dmf6uzP3flekTjvcJx/uE47++hOOxOdZpiHGWS4vOlcgco3dnJmDpPR4PZlqPBxPkW9go2n18IWtudFVucta3UMxsKVLgy6CBsLLvtj51gBh64N8UXnbZb/iPTUWu4aUspxM8t+VV7tgJ/Yv9R0cX4aDCl2uZpchmpyfHWimR1g2MnslcsBf0ry8FfNiZVNf+N94cgIsB/rfTrmQXzy9ehPpaX1fllRWpEY6d4S//qb4/EOIJIkivxYr5sAJf2kju1Uwa69hpXfAN/A7w8NKlC86O6V9fanmRs/Ojp2f+dybgNVoa/QT/bgCIGZ0o2D6dAoKRTgayDIYDIAksUnTNBAgAhTHe4M5orrV4/HDZauMEvRDcsLnhBR5fNaDC4PDHo6tUK2DGnaSwZ4cPY4f+DbN+n/9hb5h1PvkqLSvQSy9VmlcZGIB4cwlf99MYfxQ/6lk/+EyhJ7Dij1UwkJpgo8tTu2kw9jeiepaNXFO1ecOeke36VDiO43tm68wMsJVykQH88c57wwMV9BzMcIALJDkkhr+8Pep3oXNvPkTP8UVrh1cFkX0J5G9blvCw6AOy6e541LRD3eDDhRtw+WdA64cUwwOId/JJ/VTpFn4jXMVtCdHs8MJy/Npy+w1kfAt1OIgeaqaXfyMafAMbnxYNQhgpg08dF8Y3Np3hnVis/3Y4+PLh57V6U6hGeFnmYDRLrUb/sPQwKsXhbfFfOK4yCMaE15cxAg/2YCSbJCWbSpYEf6M7FGVmhC3BZNtolYlpNd9sdQLFzfvKWCteDpoLCZWtcPcHHit+wyUGwOAaAg8QO42x+wpDXZLW6+/46Dh3fApP/fKMlw6i/rllFdbGR4MlvogsQhxdl0bdgjbc5Q/vcxLdwmXHNgTxq9H+GDJFrwXgMwUHX6WyreNetQbdJGL9qyHlrDIba6smn4virjIiHGHiAG2AnyML0sb89IR9/uiLL/+LZVpYhFbcSttJoi6HxOkJOQq8W4JIdHqSjNVMIBhXSrurZkKfGPMNfXim3VEoHqsfK+34lbhNhYDbFU+M+SuUPPEFkRrt7HcwHLR72EmP3i+IjX3dERnqV+XWS+NELN9m6/vilb3CHVnHU8zZxiPj1CU1Y7iH2fvy4ZdD9uXDL+B/nw9ZkiT7LW6A7zudb2/TtHOhwGJBBeEd0hsal6QrUpe1MiK98rLRK+9Uk9jXtzQoqckvejXZq8leTfZqsleTd6nJL3s12avJXk32arJXk3eoyc8f9mqyV5O9muzVZK8mt6vJcKLcq8peVfaqsleVvarcoioBMD63yBkGR8e5vz3QZnVguBO5LKQ7mFbptQAErw132h6U1TSX6cFCzhfIGUCrc6SIxSzCOVdzEG247ByOD/3x+OBP2qxGlGkCTqoo7vVwIItSG8fejBVjjH3jgTkq5ZBKjrWayXkVcqe8pXwPD6LeHnwFYY0Qs+OAU5ra7DFTYtnuYW//q1CXl/JUga5Pha8Zjb7X6mkfh8iFYzI7ZMRpX7HRiOQYWKh1rAbqIUrmQVlXIDKRG14I0LSpLiAdC6AygVPJCVxsYn+thFlFtTCszmmKXY5WsRAPNwpnc/8DfTzm0zQTk/0ErkxRUBLEPodEI/uEwO25sHDKeqGvhYpxuUAs8BvDj4yyhFSYZgtxPPkeQwEUwIJ6UENSEDY1emkhY0aZC1hOQsgFJhzxPTrscSGMSNheCLLYvxPSVOtrKWIQv7u4eMGOsdhuhS6AA0AOg3K3wtwAQWXmQ9gr61pwRl2z7wTPAvWnK/xMnFbPhe+O0MG1WChbUfox7tjx+ctvcBEO2KceZgjNBWNApE5kOxEiMOsbr56GuGqzt+wx40suW1yczIU7j05r90iCZOZFqTX1vowgG6v9rzDo2gvwtzoSXLh6dyNimS15eg16ueCQWAlO+FGG98Zq7MYh8GU8oJ+zov5TW/pLl0LxUnqijgdz6RbVNEl1MWrE+mCuoTbSABKd4Wh7+6Apxk5m7PAx3CXNrrxKHg/YaOR5hf2LfZqSCaC3ZoGwaBVtQeiXEE8AlxiE4KS/twD46xVO4EAgRLy0HD5mLS5Ononl2kIDjXgpjwm6rgZHL07p69pqAy0BkiEzQzBOoHHdU1KvUi9Ok2/XJD5Ek/2Zp9cQL6Oyvf395DTbk9l+8veYzfZaTLefEHn3iBj7yRNKSEhYyBlC8R+PmZI5CeDYzQqXfFMaqdxsT9vk3GXCmCEb+z0PxbHxPAcWmNwB82RyyH53Mx6r8QCR3X9H999UeU4cEbZVUXtq/Rb+NxrVFbw4rw98yOKf0GZzUA35xMaDl+2e7kInhkbYcn+s3saq9cXKLTBoKKhXsLi2mkXarK7o41jh0E1BUuhM5DYJmuYKNA3z7dqIrbc0AgSMah6VEmzxkswrrFkiBUIF+gUy8BkEOUsVZHqhLd7HCHKCQuWXMdx7Lpwr7eFoVOZ8RcyYlEaDgWoTbVa8lBZ0PnR8LkTbdkvKFWVQa64D5DmzVQkwiWzN0KsVs01wwWzZgBHibQmlFRDRAO22K7hhUQK4n8C9I8ZDFCdtDjHrmzcs/XYSbPYwj1gnAuooSPaaFsB0a6X01Q4J2s/YsRGQ7mfrINxaqgptZWPgRiPGdm4zwn4wF9hj9qBZWB+wz0DJf8JrKto2V16dX9FS9pg9WCvaxOeXWVIbqwuAbC+pDWy/7tUUaODMyvM08fW3wrX5qvkIPFrr8sctxgab96qlAvdkNlxnh8drv4cezMd+uWuGQmW3N/beKT+knsVbw4OvN8Y8RIUfd0P9xID7rwKVLat1Lki5ONwEoKnQWknfAQf7nUVQ2O+Y2MfbVrcHNrs+yHSKDsdoZw5OUDknrxf6I9qWxD5epTG8oJ09PbsQxahGHqIu39YnoiV+/9ntFydfBVUxiN0rmMRsWGPWMofeieTPpjpaIOOzLBHMxL3vBPZXpks6SPIDFLnKqAsixPlazPJcr7P7huHsbiOj99fO++uM1DP/r5j5S9pxbOr7tXVzJ67/t2X5dXXfNgjuxvGTZfie21vcvhf/SIpsHw86xK0TylKO9NdvBnA3+HDbSUedEbXrxAPmIrSujaooh2pvXPXG1W9M4nrjqjeuftPM3xtXvXH12+D2LuMKGvjLz8j0yOSQvnYwsiKfHQCgMhU1H42Aj8BmIgxIFuAq82HtfX/jfe5XNq/mbzs98CM0uoyEAKOQK6RuQhE/Pgxw0PjyN2bzf4GSEOH3TLilNteQegUDvKCXJpUcRsHB6yE0k6/jFsdaWZ2LH/YC8CkVALCJXYwC8CP/8vBoLtyBdRxOMPBNEaBfeJPsHCISCZ8ptzKtoxRhIqik5k4YD7TPVHBDb5E1NalooyqltsFsETgH9DT3Qhv5T5T5Yx8t1Sq8bE3NYpUZnmSi0AFB6nQE/8eMAbokBPRslkslMAsCltZvjZA308f9gewYMTPCLkhQLdvjueT0UNHE93LFMT/DBFRou+j9+4cuSqEgJm/wkiqBXqGMPMyn5AH1Sos1hEnBHzvSgbRdHPVFRH+Lj2sdIczU8WbcaZQJUais1HACB6pCCXojqMV4cNJzLVYN4y2XS4QFpAO2JcCJ4D+2o1IYC373AyLZgaPjXpyud7GMWb3S5tqWPBVHpfxedGVDvBtutgwdHOTiRuQ/PxqYzHSmQ0gwT3FzRs+cHA78geKfaB4H4XnhAUB2Tt820/B9xk6VMzqrUjo0PdFpBQGytHbiqWWeM9o5oh7mWSGVf7TrRqDSOXpxahN21P4AhZSFRuWYn4+QFZk/NOSw4MuMvfDEYMRSxKwJe0EjYi+g6gttXciCJ1VYmCxmAfzsM1ixLKQDlJZlHgNGiE79O4rUUx3i6VVgNIP0ZFU9YBSBbLH7+sGxmYYUfCCPcAxeQcaOQwDjX+zM//bHH/9iJ3qJDy3iivpT/oMu4gm5p//+BdAetP5j6wXv/989dNHdLUB7wo1rEeZ1WU2TTNw0EucLRj6ky46aY+L9Ttq+fvnk6OTpk6aHteAtm12PprmejgpunTA+mMv6f0cZN25EXYANEdM2efbkoj2UqubCJdrM2xqiLm6gfm5WCR2ij/bvE1rtlNiAF6F9kstbaeKhFuI2KYtmKPq9K2XvAVqBIHVC+61eH6rpeutwdRzeR+GEud7kAw8tPHHaHqrgN0K1OcEKbtJFUn8ZcePkjKduZBewiIyawJr9D4cWstVu4dvoQdbAt2XxD9smLfJtKA48MYqimPfvk7aYORtBimFeh3bvFSwqM+HSxf5PBfvAN/8owFPnLRQY4PDiuxdrrEiQSbumLVrFLUlco/oHA10uyg52RopTxFcL2lUp1wD1JWHLEDHvaFP6PhxaBKlTU7yspqv2UKaaruaisG2I49IR/NGSt3uFFobaInsvYSPdGioFn75NpI52ZaHI/7UV0nuC1navcJjLNBVwX+Ow9jsclTxdCPYoeegf0Wu2GSB7HD8jjX1bOzo7PX7y7PzJwaPkYbJwRU4Z/Uxhn8/Oab8N+2+nbXTbJJicsHMWxpIdmwMx0L4ttXUFVxFcG9E46/vn6IbdgB5rRVuU3CHxZsAtjK7mCzQbv8dDlQeRpdq4Q8iFQR4MIf0LsSJqVnuJjn3Mut5ag/xIYJJa4cLD4UJlAJ1W5ERphwm2YabUkeQKYRzuAfk7QnLW8i4t8EVUeGLXsKM4e/BYHVlbGQy9O8ONz97R0dk+vXkLnjptLT5CW7/I65O4eX8ObAIWvCwh+eKsVQHHrNPL/icLeV3HKjUC6/Dcsj1Kc7z0z7lauFkgFTs6Onu0jzn217HAHcfR0dnnCTudeWpQku00rYwdMm6vw9vqBhLPMvB3Qp+4M6HuUq0yBkswtDMsXXA1J/9WO7YTJqRO1U9bmDb9g48vRmnZ+NtiVsItFHAS9lrDHnpCWuY5PBgrOeyjj/5y9PfgHxgibHWYV+uaGUbTNr5GIzJpROp8mnABuW8pMgxyYgKlqLMJXRyU2SREZeKdrXqMqc5WiPdUMK2gA9wHTYIX6Cq1ZnZ1I3WOpJocssvmQiashg1wU5Fy2HtzcvjVbWjKDD6bOwmOWKkoO/7kkD3TSMAgK0t0t1QqYwf1nHKcZoapf5MYusCFV4W0BXfpYnKIW0CiFqcHQYypSnzQFzijhsA7Yq6Cp2aCfMhLemE4XzGrC0GpWUP+YbeCF+nntH2FiD/BM5zmp9qI1h1OT1HCgztyM3ilcAmo1Lrs9yHFMnvKFZ/TC7atDeMPe0nSdl+ix2wEJDkInsz96OYhRP6O8BVq0KWoxN94P+jrQdwROj6pPbzehX64H4YDiECGqm/ewG3cS5O/fQvFP4K3Hj2k9Wua5Ka9QxPvvfTU3b8jWte/AnCfpwdjtXvA7jbC0dE6HomEQ3iMYAyu3sHh6x/ewotl4B5/T7psHDIADT78mAHeNu86Z7gDv78feDgOwnlgg+zwfVCKTyPuwOa+ziPG6uc4kLiDcMfhhKZFL/oGfrAyjt7YuPLfOqn49snF4O3b/wOuiXgF +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory +Kratos Session Token are set. + +Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level +(AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result +in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the +configuration. + +You can access this endpoint without credentials when using Ory Kratos' Admin API. + +If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the +`error.id` of the JSON response body can be one of: + +`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was +found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but +apparently some other identity logged in instead. + +More information can be found at +[Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings). + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.ParamsDetails.json b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.ParamsDetails.json new file mode 100644 index 0000000000..09535fa635 --- /dev/null +++ b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.ParamsDetails.json @@ -0,0 +1,11 @@ +{ + "parameters": [ + { + "description": "The id of the desired grant", + "in": "path", + "name": "id", + "required": true, + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.RequestSchema.json b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.StatusCodes.json b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.StatusCodes.json new file mode 100644 index 0000000000..bbcda7bf84 --- /dev/null +++ b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.StatusCodes.json @@ -0,0 +1,158 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "OAuth2 JWT Bearer Grant Type Issuer Trust Relationship", + "properties": { + "allow_any_subject": { + "description": "The \"allow_any_subject\" indicates that the issuer is allowed to have any principal as the subject of the JWT.", + "type": "boolean" + }, + "created_at": { + "description": "The \"created_at\" indicates, when grant was created.", + "format": "date-time", + "type": "string" + }, + "expires_at": { + "description": "The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\".", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "9edc811f-4e28-453c-9b46-4de65f00217f", + "type": "string" + }, + "issuer": { + "description": "The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT).", + "example": "https://jwt-idp.example.com", + "type": "string" + }, + "public_key": { + "description": "OAuth2 JWT Bearer Grant Type Issuer Trusted JSON Web Key", + "properties": { + "kid": { + "description": "The \"key_id\" is key unique identifier (same as kid header in jws/jwt).", + "example": "123e4567-e89b-12d3-a456-426655440000", + "type": "string" + }, + "set": { + "description": "The \"set\" is basically a name for a group(set) of keys. Will be the same as \"issuer\" in grant.", + "example": "https://jwt-idp.example.com", + "type": "string" + } + }, + "type": "object", + "title": "trustedOAuth2JwtGrantJsonWebKey" + }, + "scope": { + "description": "The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749])", + "example": ["openid", "offline"], + "items": { "type": "string" }, + "type": "array" + }, + "subject": { + "description": "The \"subject\" identifies the principal that is the subject of the JWT.", + "example": "mike@example.com", + "type": "string" + } + }, + "type": "object", + "title": "trustedOAuth2JwtGrantIssuer" + } + } + }, + "description": "trustedOAuth2JwtGrantIssuer" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "Error responses are sent when an error (e.g. unauthorized, bad request, ...) occurred.", + "properties": { + "code": { + "description": "The status code", + "example": 404, + "format": "int64", + "type": "integer" + }, + "debug": { + "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.", + "example": "SQL field \"foo\" is not a bool.", + "type": "string" + }, + "details": { "description": "Further error details" }, + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + }, + "id": { + "description": "The error ID\n\nUseful when trying to identify various errors in application logic.", + "type": "string" + }, + "message": { + "description": "Error message\n\nThe error's message.", + "example": "The resource could not be found", + "type": "string" + }, + "reason": { + "description": "A human-readable reason for the error", + "example": "User with ID 1234 does not exist.", + "type": "string" + }, + "request": { + "description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.", + "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6", + "type": "string" + }, + "status": { + "description": "The status description", + "example": "Not Found", + "type": "string" + } + }, + "required": ["message"], + "title": "Error response", + "type": "object" + } + } + }, + "description": "genericError" + } + } +} diff --git a/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.api.mdx b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.api.mdx new file mode 100644 index 0000000000..4f1ec5b3fb --- /dev/null +++ b/docs/reference/openapi/get-trusted-o-auth-2-jwt-grant-issuer.api.mdx @@ -0,0 +1,38 @@ +--- +id: get-trusted-o-auth-2-jwt-grant-issuer +title: "Get Trusted OAuth2 JWT Bearer Grant Type Issuer" +description: "Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you" +sidebar_label: "Get Trusted OAuth2 JWT Bearer Grant Type Issuer" +hide_title: true +hide_table_of_contents: true +api: eJztO21TGznSf6VPqa3YVfaYEGB3vZWrZQPJkd1LOCCVusKUI8+0bYUZaVbSYOZh/d+faknjmbENJJvc1X44PoCtl1a/qV/FHUvQxFrkVijJhuy9QbBzYQBlkishLVgFM7TAwerCWEzgzYcL+AW5Rg2vNZcWLsoc4cSYAnUEF3OEkyMQBuwcQUkEjbbQEhNYzFFCqYqRjDVyAkVLHFjQmHJCwcxFHrEeUzlqN3CSsCGbob3wp787LOx8983CuqP9oazHcq55hha1YcPLuzWaCCWRgJq68xI0QmMCMwLAekzQkpzbOesxyTNkQyYS1mMafy9oIRtaXWCPmXiOGWfDO2bLnFYZq4WcseXyihabXEmDhuZ3d3boT6ykRWnpI8/zVMSOnsEnQ0jdNeC1sfUUPshlcMyAswbPiAeamGaFR4KnqVqMuSzHpph8wthunkR8GW0uHDEQMiF0kYTIrWOb8CcLA24DCU/BnN8gcFlCroWMRc5T4F7wAVbF9DcfLkiqgXMTpVLkki17LGjCmN+LX72iiVjPa5MTIiy4gbCMTpkqnRE8lnCLfSsyrI+uhNZjeJsLjeaBk+sV958s0hT8uh4YBQv0Qxod9dwYkoiSMNUqgxHzXBwxsFzP0Ao5gxFb8f3zkRcJIY23PMtTmvkRk/iHZ8+m/T3c/aG/t/887v842Tvo7yV4sD/d2dl99v10Kxx/ge5hwApbkaC0YirQC7eWtlMPtyyp5NwgumN4hqQRDtSIQZxykYGQtK5L1NYUzK3NzXAw+LSwfZHkUZiJYpVtQzwvJqmIx9dYfsUNImN2/u4tfMAJ/Irlxh269mzexpprLMciIdYYuMYSCil+L7BmlK6JvxYJzJEndHskfFoYonGN+me7z3Fv/+D7Pv7w46T/bDd53ud7+wf9vd2Dg/39vb2dnZ2dbWwweK/2GrQevQk3IuZpWgIHMnAwVRo4zLQq8o5B26VLeo2lieAD6e4E/Q1uyi6oQVD7r5DccjWivFXqMSusg2O3Wfg3RskPOCHpELmxor33EEyTpGRKWi6kgVQYZ4DcBNzwtEADHW7A755gQhSdY+yU9Xn0nBa742E32oHLs1cvD77f+/Gq2yT3klyTdB5CTaepkMiuekxYzMwW37CilmvNPQkPW+OGDX7kzj1gZmvZZOIaf/6mAgkud0kb2wQ8uJwWT3mR2q/wjMdaKw0rVwtcIxgkK0wGmUtAt6CD0SyCQvLCzpUW/4dJDyY8AXLoaGwPoijqgorjQmvvMNq3PlbJPTpmLLeFAbegweW9nb2G3RbSHuzVfBbS4qziwKSYbUI+omEQ0kMQSo7kSF5QDDYVmCYkajW1KEEqS75GGe98c62sczIz0nYLKfJrIWcjaVAaYcUNNoG29eL8X78F6CM2VcobCoLPgZxztM3WJGi5SM0mAa8KbeeoA/urZeRiaeAxOW7w/0E2rS53ss41Cj2FIToKUzhz5+i54SLlk5TClATmFJ0osnAoaTBpc4VknHDLJ9wg8ITnFrULLgq3mrZOhfSeDlPM0AWQm5HFdrLfkkEN99aziqzxJgZBT5E01qhCxwixKtLE0TMh813I5N5zx61DN5m4+lazchrk12AmKOnwlNwWGivz4g5oI/zO25+FsHMK+5/tPt/bh0ShCdoqzFYWbXOsPmvglSv1LDo5ikZyig6NsVR2XAv0WOtXfuKtsofV8Ej+XijLx3gbIyaY0LJ/0chxGCD0ZZGRJd8Kl/VYGwLZ9zYBPXbbn6k+gekTDWy4HdSfRnHZYxkaw2dbDNE//UQtvlqfwp6tt9fbrvF24/ZSJaR3uUayp02QDZMHHTJ0sLfznH4983Y0+nJD+IDHmaFELWJnIF4GJ3GPtlzMaxUhg/ne4LRIvSuwuqTI2qrKiZZww7VQhfFbDPn9hueBVM1EvJVt94rhuMlxb7EDQk9NUxDrd/uLbrRGbrZd40OYFxmXfY08cYrmF7rIbiW71uHvDZmyxi1du6RbiQ+WaDvzw2Rgf3uk9lmVvyLpa+nMspCgNEXDVoHVPMaRDFLhsVbGgEF9I2IEruO5IBdXaDS1efeAObx/f3LU5nDyPU739ybP+hg/2+/vHeBBfxLHk/7+7t7kh9145/k+Htx/Nx70+c2J5pFvlYVX28W3bNYQLleadFWr+4YjbN+LLTFW84K4EwzGhRa2dGUPpcvDOEZjLtQ1Sja8vKLahOUz4+JWF5jR+bd9pcu+5hZTkQnbnxTxNSUSbF4mmvd5kgnZzzARReZsHd3+c0exL6+kXM6IPWWO5w451mMpn2DKhuxnpctBnArvG7220+3PcqUt3I0kAPgge/cwFz3//aWSUzErdAh/lj5dftqA9fQn0rJYUaATN1fDC5C4aEPodH+q1vJcnEhjuYwxrFyd3WnB6boDUrQgkiF4Gf4Eg8EDxSPohJiWNLmQCU6FxKRbI3oXtKfnogpYwgvgCy5aWEUP17Y6nkEiGcnuT2zZWzH/tWowXXIK95r8znl8TV4i48LFk4H/nZEc2ZEPwG/tiPmv02z1URn/iZIcngvPfBixmbDzYkIpxKAWSn+maLWjeFrI2J3W6ZKUR1YkMHxB2WMyDtdlxGAwCKyFP+ABzhLAkW3LefgCWkhFb3GxJnXaxHPx0iO9bcPh6YmfXRM+7aR72APdI+tJm1eQoqAypyfR64eFFfga/cLja8qvZdLp9kAk3ej4FuPCosdRTN0Zf3sBUqSeWyM7zWz0irI8O+0oE53bBLXuwShYCefYKI0n5n38XIw+fhzCdzejkRwxR1f3kbNeFWkK/7i4OF1ZpcZ+v3tJvwaD1QJ/Vz8+gscQHpgliJsoqcISSmftcz6b8ibiaPLuSC6b9+e0tHNny6s7RCbxXruldDn2kyPp8KgHokwlmJoopL9jNabEc3f8aWHHTpnHVenUg3qQD+uwNfnTsPEwFxQg5t5GupW5Y1i1wH+ju/MEjsgYuSBojjBXxlUMlNtLRVqZQLBdLiGqSjh5ykuvt1GuFTkhEyld8lwYuvoE+ByxbYCjvAwVparewtMUTJETTpisWeu6UB85K9ky5A3C2zfbG0FHBpmUz0W3sk1PnK0JtiwrGi7El7pIYBQnhmiQuFMVD9axJmAUPMax0onzKi6oIiiHpycudEENlVeGXKUiLiPadeyNoHHMQh7P3RmQoZ2rxNUycq1uBOUDE0zVogeF8egF8+kKPwTJcCuMKwyVqtAeDK2NucHI0/tyRV+ogLboGUI7UvhiSXC3d2xpM602EcoboZW8HLFfjg/Pjs/GF+9+PX47YlcrERxTBAgcgo30fOMSROWegyMgNlZXza1p4HJYmeQ18011Sp6LsGzokXwCL11P4P5DuDGBnlyMRR0mNE6so4UafrfyyfACntbu7Sk8Ief2uGejzVaXAU2P6mtcWQb4jPp1vZXQWpniFy1KKLQYP2aWOiLp1tCcBemMqlzFQ62qosSG/t8/B+jQGd4mXA+4iWyYRWfSYGXZSJQ43MSoXtDyhF+KGHxnHG7wHWCXLV0wbJLrfqJilwA0YlqqRIqZr4A82oPsdKsupA+Rm53E9eLBl3Qn211I32qkduqFh/lQV3TZYzO1TsVjAYy9bcQqf0WScu+3N4XzuKZ/Fj3/NWI6D8xFWdJ16R3eWirmKulRdu2u+9K3HnMtju1pHEU+1e6Vvq92/E/v/6f3fyG9J3A+LvIkOvztnA3ZwCn1wJE8cLi4bmp/4vzkwBNsBnciWVIU76IxT3Wh00av8i7Ei2OTFrPl1uhx4K6HFlRfc66hucXXikJDi9Vx6AYX/00R2jtdwlu0C6Wv4dRDAYISwb9VATGXvq0gLIWWxO3L5o6XShqV4lWnQj72A4RsZOaDCvmBa2hJO5ih7RvLKfruRoGdVUR6Tr01T4/rC6/6be5dhhtZaQWdR6rnmdte6Yc2liqngrR0mqqFf4jSjDxfhvJza/B9SzTOeEUJZqoi0AMd0G8WesAOctV/pXqo7/FWWuljhFCPpDBB41SjmYOLWKkJnAruI/GPAcrYx7Qfu3VjNwx9OXz/fomaxEN2FoqiXMK7HOXJEclTkgacHIGv01FBnD58Jh+s39Qoo3umE/vXCoAbBU0VkormA69SFSARE0KxpXgUJF9jWSveYrFwuNDtIAdCmkhRmRnkqA1lln3Psr7D0TUHHlcZXX5Q+trkPMbDXPy67UXHI3jDogLQT/EG0/8+GdSkkFNVNbe5b/BjxgWJNCTDP3s51u/MCLNzP8c2Sr1P4ERarZIi9gn/kYoL6jj6FM1l3GkK/h2MT1nJNApjtSsGOqNzeHpiIjhsT9CgMzpKpiW1HzyxmIR8i9NTCZHAaWAGeJXyyhrBqT/RQaGsNVPGpiXJxz2nmGi1MD69H8knT+D86FcT2tlJoGD1/sJUuZhp9GmDCWxI0D8qXB3YaOkaB37V9pgqeppG95GKPAWfoRkSGn/Ab+F7SCr+gCO1kKniCQGAP/NDIJoC+UY/fxC2/dYPrA98+c83ALEdLGF7xLVtMeYyLyZRgjf1jQsDg1CVNoM6w+5u5e3l2fHh0T+Pawhr9WeTXA8mqZoMMm4s6lCPNuHvIOHaDjwICimavI3eHl+0j5LFDG2k9KxtIVbDNdbvdBn5+sOg+y2xVVbiBr4O2+NU3ArdPGqOt1Ge1Uf575/L2W+ALTqUtmL7Wq0fVYO+97hVK+E/ogkztakHAds3/Ia3j8r4Dcq2JhikLmS0mhlwbcWUx3Zg5uREBnXZuPv12H7iN/wevSVsfYK20ts8+2TarHV6Ww1XOjFotNG635K35AG9x2rivI5t5wM5lSnaeN79s2j3w/b/CPIeeIsEIBpO/3G6pooeM+qWt3SkNdy6iWtc/2qk83m+RZ0dx30/o4VtmYs1RMNIlTI0lHewefu+HluH0lZLcVZMyvZRupiUM8xMG+Pm6IA+tO7bN8WWjrrn7p1Ry6B1VEzVFxMJ1cjKqqHw6V5MvxG2ZruHo46WiJHeEwxXuf5hzuM50qtW1lvLhOnucTfteBz2msFvJy+P354f93ejnWhus9RlKagz82567t9nUDpulWk836lCTsqcURsfx6bEDBff5srYjMsGXl9Y9V7PrhsvSf8y/7gS0gJqcVB/Srj0zrH8LhQxLpmL1GktQWA95gsZrMfqUgar3ubT8FC4R2jU/6Ltd3f0QPG9TpdLGv69QE3vP67qeoX/Jxhh3BtHNpzy1OADvOuchby2+1Dr4j7iqhfOsmyUIFkvlBtFwpZXyx7zL+AbVUzKKvJm1XLjKXCrDPT6+IL1XN2g8cx6xauqRHF5tx2duzu/wuUwy+UKu5BLXy2Xy/8H6EYyZw== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust +relationship. + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-verification-flow.ParamsDetails.json b/docs/reference/openapi/get-verification-flow.ParamsDetails.json new file mode 100644 index 0000000000..2727235935 --- /dev/null +++ b/docs/reference/openapi/get-verification-flow.ParamsDetails.json @@ -0,0 +1,17 @@ +{ + "parameters": [ + { + "description": "The Flow ID\n\nThe value for this parameter comes from `request` URL Query parameter sent to your\napplication (e.g. `/verification?flow=abcde`).", + "in": "query", + "name": "id", + "required": true, + "schema": { "type": "string" } + }, + { + "description": "HTTP Cookies\n\nWhen using the SDK on the server side you must include the HTTP Cookie Header\noriginally sent to your HTTP handler here.", + "in": "header", + "name": "cookie", + "schema": { "type": "string" } + } + ] +} diff --git a/docs/reference/openapi/get-verification-flow.RequestSchema.json b/docs/reference/openapi/get-verification-flow.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-verification-flow.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-verification-flow.StatusCodes.json b/docs/reference/openapi/get-verification-flow.StatusCodes.json new file mode 100644 index 0000000000..79a6d7f93f --- /dev/null +++ b/docs/reference/openapi/get-verification-flow.StatusCodes.json @@ -0,0 +1,1118 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Used to verify an out-of-band communication\nchannel such as an email address or a phone number.\n\nFor more information head over to: https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation", + "properties": { + "active": { + "description": "Active, if set, contains the registration method that is being used. It is initially\nnot set.", + "type": "string" + }, + "expires_at": { + "description": "ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address,\na new request has to be initiated.", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "ID represents the request's unique ID. When performing the verification flow, this\nrepresents the id in the verify ui's query parameter: http://?request=\n\ntype: string\nformat: uuid", + "format": "uuid", + "type": "string" + }, + "issued_at": { + "description": "IssuedAt is the time (UTC) when the request occurred.", + "format": "date-time", + "type": "string" + }, + "request_url": { + "description": "RequestURL is the initial URL that was requested from Ory Kratos. It can be used\nto forward information contained in the URL's path or query for example.", + "type": "string" + }, + "return_to": { + "description": "ReturnTo contains the requested return_to URL.", + "type": "string" + }, + "state": { + "description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. verify your email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the verification challenge was passed." + }, + "transient_payload": { + "description": "TransientPayload is used to pass data from the verification flow to hooks and email templates", + "type": "object" + }, + "type": { + "description": "The flow type can either be `api` or `browser`.", + "title": "Type is the flow type.", + "type": "string" + }, + "ui": { + "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests", + "properties": { + "action": { + "description": "Action should be used as the form action URL ``.", + "type": "string" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "method": { + "description": "Method is the form method (e.g. POST)", + "type": "string" + }, + "nodes": { + "items": { + "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `` tag, or an `` but also `some plain text`.", + "properties": { + "attributes": { + "discriminator": { + "mapping": { + "a": { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": [ + "href", + "title", + "id", + "node_type" + ], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + "div": { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { + "type": "string" + }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + }, + "img": { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + "input": { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + "script": { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + "text": { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + } + }, + "propertyName": "node_type" + }, + "oneOf": [ + { + "description": "InputAttributes represents the attributes of an input node", + "properties": { + "autocomplete": { + "description": "The autocomplete attribute for the input.\nemail InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn", + "enum": [ + "email", + "tel", + "url", + "current-password", + "new-password", + "one-time-code", + "username webauthn" + ], + "type": "string", + "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode\nusername webauthn InputAttributeAutocompleteUsernameWebauthn" + }, + "disabled": { + "description": "Sets the input's disabled field to true or false.", + "type": "boolean" + }, + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "maxlength": { + "description": "MaxLength may contain the input's maximum length.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The input's element name.", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["input"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "onclick": { + "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnClick requires the use of eval() which is a security risk. Use OnClickTrigger instead.", + "type": "string" + }, + "onclickTrigger": { + "description": "OnClickTrigger may contain a WebAuthn trigger which should be executed on click.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "onload": { + "description": "OnLoad may contain javascript which should be executed on load. This is primarily\nused for WebAuthn.\n\nDeprecated: Using OnLoad requires the use of eval() which is a security risk. Use OnLoadTrigger instead.", + "type": "string" + }, + "onloadTrigger": { + "description": "OnLoadTrigger may contain a WebAuthn trigger which should be executed on load.\n\nThe trigger maps to a JavaScript function provided by Ory, which triggers actions such as PassKey registration or login.\noryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration", + "enum": [ + "oryWebAuthnRegistration", + "oryWebAuthnLogin", + "oryPasskeyLogin", + "oryPasskeyLoginAutocompleteInit", + "oryPasskeyRegistration", + "oryPasskeySettingsRegistration" + ], + "type": "string", + "x-go-enum-desc": "oryWebAuthnRegistration WebAuthnTriggersWebAuthnRegistration\noryWebAuthnLogin WebAuthnTriggersWebAuthnLogin\noryPasskeyLogin WebAuthnTriggersPasskeyLogin\noryPasskeyLoginAutocompleteInit WebAuthnTriggersPasskeyLoginAutocompleteInit\noryPasskeyRegistration WebAuthnTriggersPasskeyRegistration\noryPasskeySettingsRegistration WebAuthnTriggersPasskeySettingsRegistration" + }, + "options": { + "description": "The allowed values for the input when the underlying JSON schema\ndefines an `enum`. When present, clients should render the field as a\nselect/dropdown rather than a free-form text input. When absent,\nclients continue to render a plain text input, so this field is\nbackward compatible with UIs that do not look at it.", + "items": { + "description": "Represents a single selectable value for an input whose JSON schema\ndefined an `enum`. The value is always a scalar JSON type (string, number,\nor boolean) serialized verbatim from the schema. When present, clients\nshould render the parent input as a select/dropdown.", + "properties": { + "value": { + "description": "The value that will be submitted when this option is picked.\nIt is serialized verbatim from the JSON schema `enum` entry, so it is\nalways a scalar JSON value (string, number, or boolean)." + } + }, + "required": ["value"], + "type": "object", + "title": "uiNodeInputAttributesOption" + }, + "type": "array" + }, + "pattern": { + "description": "The input's pattern.", + "type": "string" + }, + "required": { + "description": "Mark this input field as required.", + "type": "boolean" + }, + "type": { + "description": "The input's element type.\ntext InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI", + "enum": [ + "text", + "password", + "number", + "checkbox", + "hidden", + "email", + "tel", + "submit", + "button", + "datetime-local", + "date", + "url" + ], + "type": "string", + "x-go-enum-desc": "text InputAttributeTypeText\npassword InputAttributeTypePassword\nnumber InputAttributeTypeNumber\ncheckbox InputAttributeTypeCheckbox\nhidden InputAttributeTypeHidden\nemail InputAttributeTypeEmail\ntel InputAttributeTypeTel\nsubmit InputAttributeTypeSubmit\nbutton InputAttributeTypeButton\ndatetime-local InputAttributeTypeDateTimeLocal\ndate InputAttributeTypeDate\nurl InputAttributeTypeURI" + }, + "value": { + "description": "The input's value.", + "nullable": true + } + }, + "required": [ + "name", + "type", + "disabled", + "node_type" + ], + "type": "object", + "title": "uiNodeInputAttributes" + }, + { + "properties": { + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["text"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "text": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["text", "id", "node_type"], + "title": "TextAttributes represents the attributes of a text node.", + "type": "object" + }, + { + "properties": { + "height": { + "description": "Height of the image", + "format": "int64", + "type": "integer" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["img"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "src": { + "description": "The image's source URL.\n\nformat: uri", + "type": "string" + }, + "width": { + "description": "Width of the image", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "src", + "id", + "width", + "height", + "node_type" + ], + "title": "ImageAttributes represents the attributes of an image node.", + "type": "object" + }, + { + "properties": { + "href": { + "description": "The link's href (destination) URL.\n\nformat: uri", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["a"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "title": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "required": ["href", "title", "id", "node_type"], + "title": "AnchorAttributes represents the attributes of an anchor node.", + "type": "object" + }, + { + "properties": { + "async": { + "description": "The script async type", + "type": "boolean" + }, + "crossorigin": { + "description": "The script cross origin policy", + "type": "string" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "integrity": { + "description": "The script's integrity hash", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["script"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + }, + "nonce": { + "description": "Nonce for CSP\n\nA nonce you may want to use to improve your Content Security Policy.\nYou do not have to use this value but if you want to improve your CSP\npolicies you may use it. You can also choose to use your own nonce value!", + "type": "string" + }, + "referrerpolicy": { + "description": "The script referrer policy", + "type": "string" + }, + "src": { + "description": "The script source", + "type": "string" + }, + "type": { + "description": "The script MIME type", + "type": "string" + } + }, + "required": [ + "src", + "async", + "referrerpolicy", + "crossorigin", + "integrity", + "type", + "id", + "nonce", + "node_type" + ], + "title": "ScriptAttributes represent script nodes which load javascript.", + "type": "object" + }, + { + "description": "Division sections are used for interactive widgets that require a hook in the DOM / view.", + "properties": { + "class": { + "description": "A classname that should be rendered into the DOM.", + "type": "string" + }, + "data": { + "additionalProperties": { "type": "string" }, + "description": "Data is a map of key-value pairs that are passed to the division.\n\nThey may be used for `data-...` attributes.", + "type": "object" + }, + "id": { + "description": "A unique identifier", + "type": "string" + }, + "node_type": { + "description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": ["div"], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": ["id", "node_type"], + "title": "DivisionAttributes represent a division section.", + "type": "object" + } + ], + "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)." + }, + "group": { + "description": "Group specifies which group (e.g. password authenticator) this node belongs to.\ndefault DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup", + "enum": [ + "default", + "password", + "oidc", + "profile", + "link", + "code", + "totp", + "lookup_secret", + "webauthn", + "passkey", + "identifier_first", + "captcha", + "saml", + "deviceauthn", + "oauth2_consent" + ], + "type": "string", + "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup\npasskey PasskeyGroup\nidentifier_first IdentifierFirstGroup\ncaptcha CaptchaGroup\nsaml SAMLGroup\ndeviceauthn DeviceAuthnGroup" + }, + "messages": { + "items": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + }, + "type": "array", + "title": "uiTexts" + }, + "meta": { + "description": "This might include a label and other information that can optionally\nbe used to render UIs.", + "properties": { + "label": { + "properties": { + "context": { + "description": "The message's context. Useful when customizing messages.", + "type": "object" + }, + "id": { + "format": "int64", + "type": "integer", + "title": "ID" + }, + "text": { + "description": "The message text. Written in american english.", + "type": "string" + }, + "type": { + "description": "The message type.\ninfo Info\nerror Error\nsuccess Success", + "enum": ["info", "error", "success"], + "type": "string", + "x-go-enum-desc": "info Info\nerror Error\nsuccess Success" + } + }, + "required": ["id", "text", "type"], + "type": "object", + "title": "uiText" + } + }, + "title": "A Node's Meta Information", + "type": "object" + }, + "type": { + "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division", + "enum": [ + "text", + "input", + "img", + "a", + "script", + "div" + ], + "type": "string", + "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division" + } + }, + "required": [ + "type", + "group", + "attributes", + "messages", + "meta" + ], + "title": "Node represents a flow's nodes", + "type": "object" + }, + "type": "array", + "title": "uiNodes" + } + }, + "required": ["action", "method", "nodes"], + "type": "object", + "title": "uiContainer" + } + }, + "required": ["id", "type", "ui", "state"], + "title": "A Verification Flow", + "type": "object" + } + } + }, + "description": "verificationFlow" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + }, + "default": { + "content": { + "application/json": { + "schema": { + "description": "The standard Ory JSON API error format.", + "properties": { + "error": { + "description": "Error response", + "properties": { + "debug": { + "description": "Debug contains debug information. This is usually not available and has to be enabled.", + "example": "The database adapter was unable to find the element", + "type": "string" + }, + "error": { + "description": "Name is the error name.", + "example": "The requested resource could not be found", + "type": "string" + }, + "error_description": { + "description": "Description contains further information on the nature of the error.", + "example": "Object with ID 12345 does not exist", + "type": "string" + }, + "id": { + "description": "ID is a unique error ID.\nfeature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded", + "enum": ["feature_not_available", "quota_exceeded"], + "type": "string", + "x-go-enum-desc": "feature_not_available ErrFeatureNotAvailable\nquota_exceeded ErrQuotaExceeded" + }, + "message": { + "description": "Message contains the error message.", + "type": "string" + }, + "status_code": { + "description": "Code represents the error status code (404, 403, 401, ...).", + "example": 404, + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "title": "genericErrorContent" + } + }, + "required": ["error"], + "title": "JSON API Error Response", + "type": "object" + } + } + }, + "description": "errorGeneric" + } + } +} diff --git a/docs/reference/openapi/get-verification-flow.api.mdx b/docs/reference/openapi/get-verification-flow.api.mdx new file mode 100644 index 0000000000..f9b6e555a6 --- /dev/null +++ b/docs/reference/openapi/get-verification-flow.api.mdx @@ -0,0 +1,55 @@ +--- +id: get-verification-flow +title: "Get Verification Flow" +description: "This endpoint returns a verification flow's context with, for example, error details and other information." +sidebar_label: "Get Verification Flow" +hide_title: true +hide_table_of_contents: true +api: eJztfW1z4zaS8F/BMbVnq0qickme54Ozkz2vPZN4My/esedyV6MpCyJbEmIS4ACgZe2s//tVd4MUKVEeT+Jkcwnnw9gGgUaj0W9oNIAPUQousarwyujoKLpcKidAp4VR2gsLvrTaCSluwKq5SiRWE/PMrA6cSIz2cOvFSvnlUMyNFXAr8yKDoQBrjRUpeKkyJ6ROhfFLsELpubE5QYkneqL/as3KgSWITsBtAYkXfglCaq9GJxevn4nEmGsFwhsxA6F0kpUppEJpqmbhfQnOHzjx3eXluTjhut+BTMHGE/3MWHH8t+P/ruo5sTalyEvnBWhXWhB+KX3owglp9/YgjN0AWaksE3OpMhrD2Zyglg6owYyHNMIhEVEc2BuwI6dSELIo3JCqYalKwAkNkOLobKmF0UKKxOS50cKbYpTBDWSj1ORS6YlGMmJPVYu5sStpUwKndGJypRctOiyJDljVN6f1CLGeTqc/uokuHJSpGSUmhWr2Jtqa0oONF+APD8YWEnMDdn0wFNKtdSLmpU6IDQ4tvB8KC24gPkx0YrTzNJHiiZArqbxIMgXaI5z/arDPs8yssGnM6B0eMPkPBgjrffy+BLt+e0A89m6AqFpwsQVNdZt8eDCk7gYTfTegAWHlF4YmsWYzkUiNnDM3pU6F9OLtK7sW31vpjRNPc6kyYs/zpdEgmmiKU5OUOWhPf707XHpfuKPxeLVaxcau48Tk49QkbnxNsMYOsvkozOqY+HlMyK5HgL2MZJKYUvuRTLy6IZiDOBpGpgBLf52l0VHUQapoGBXSyhw8WBcdvf2wI7EgsJ44O8Xx4583MiuBeI/mvW6OrAVOzK3JxTRw81S8ef1c/B2J3qjoQHvkm7Up7UTLosgqqhxCvIjFdNyciL/gcJ/IWZLClAalEDGayGgYaZlDdBSpNBpG2KmykEZH3pYwjFyyhFxGRx8ivy6wlvNW6UV0dzfcHmeDsR0O9IclaFE65HkUgIvT71F8KtHCMaDA1fIe5Joq7OqKiTZWLZSWWbZuDZ7rLqVOM7BiCRbq8TH7bgbIbBzdN6h3SAFXGO3A4fcvPv8cf5Ai1R5/bZB6/KPDgX9owGtT5I1jPcBsJqQWpvQjMx/NkKNRjZQ6wJroZCm1hky4MlkKiTpZAHN/mlpwDhWcFAWJgS7zGelP1qD5tkjhyAUqBeHNkXh8wUCWtygYXjGd6BPsUuCYyodCzYUDPySLJJV2QXMvlPMsXCIHvzQpq3vlxAyQb0oHaSzOqERp5RVO/0Rr4xEcTvTWBA4juC2UBXcl/S42T/nbMcFDDLzKQRy+uTwZiBVya9OeBECxOJtTeYlm0Hm0LCvlluAaM0sGkadpONFSaFjVcJbS1bYRR+AhRcR5sqKjKJUeRohI12hUujuKs1NhobCAUuC2jGyp1fsSxNlpLEj8CrDYUSWDO07CkBQQavAWQFVb1zDAUh048b6tg5ixjsbjPyMDBf6JiX/iZkdxqa5Km33zl4Dmkz+r9BtkXRztkeDBTgL3HomyJEVU0yf8vUsa50pIO+f5jD49bJpNkpTWfsqchJY4pt2uX/NHVNmh88C3pMWJu1fSVb1Dyrp+Y/GI24NFRO6f6IYf0bKaLEkbP+jN6+cHaEr8EjUFz1XD5esUFnYfr7zpGgh+ujTbIlvhXTfFjjuBOy99h0q4wOJtDqa6wszZHoZeyA1KlsY4uGL1cCSku95IozeCPwtZ6Q+2foFryT6QDhtMNHZ2RX8cEQRWriidMwBd25QK+EQX0jlIr5KlzDLQCzhq8Q3OoiuTBJybl+yi7EhY3ZRqM7wYSeOt1A5dr6tCrjMjO6T8sqpyzjWQncpgTxCSSKWXzD2dko31lsZcs3PPg/WQF5n04DbTZWY/QuIJJyrocl4Y3LoAYkxQtFCYgZjKQk2R2abBpZ4SHyifIeRLbBBkoIbQySil2u33JLC3bXKKFN9dvngunhmbxwIxS+paiNnK2Gta64iZ8Ut2DLAuUeBvF69e1guETvvFtnzXfhkt3NKUWVrJJFpnGhXB5hoo3dM/N0qeTKIPH0QcANzdTaLAok8mUWGcn0TfTDupkYNzcsFoKQ85/dLGNqzrumcrtN8s/2LxxgHyKOm+pHTe5OofaBKqruIufmDTU6tEpf3//2pTT2kPC3Kuqvk+OyUu+hheglH6wSrvQaPykjlYRZylF5lyy06q7OfOGi6y10SjjhRnem4mmte4T/H/iQ6yKi74ZzSMQJd5dPQ2whb4J9ZD5zBUeLeNxTC6HS3MCJuNEA2iwsM6u7tretZv2dUmUoVO3m1PwIaupbrEijUNImmtXO9UcMw7yGG7dHrBylE1+LalL89fXVwOusiuTbrFiW3AL/E7LctrMWX5IEGFDHISXFrogLJCS/QHxZszgdS4kRl+jlFK69AE+U+42g1WUGox/bPKF99MhZeLIbnBVKSL0lddfDMVs9ILmTkjps7kIIpMomGEW09itiXu3ls1Kz3/lSocUq609MZiQS6LAgmANXelb2lh3s2KmdLXB05gBXGYgvMIEteRZCPRmtVOjlUPdfeOK6dOpaC9miuWuq6ZuuqWEpwk0sYto6sckfnAkeS4ys2WIlfEymYuplghxs9T1KETjWtVq3JpVbaurZHMULsnJi+kVzOVKb9mLfyqAH18fia+jD+PhTjT3Knztky8UF54SJa4/sElncxWcu0QgUkkJ1E84cgVcjbKNE71Gf4/0SpfiLNcLgAZ5Rj9AxQ4Gq64oB8TnaobcapulOO1SiXp8kFC/Wgd39Uy2ivwXoFvgyA1UtUaMsSNEL/btGdWO65V1rbvvFFmKLNSC0kNSLo7GSNVN7szUXGtcEAuC2t1knFcRSC7WF7li5VKF0CdSy/CkIQkb7NajJy+eiHG4kbBalf5Jpl0HabkWNAHjNUw5I3TxbFFWuoED/301YtOLkOnmNR2miqEK7PzVt+7DdpEQJ+alaAskJrXsB5xsK6QyoYhI2HYma8WDGkgXhwCfGuRy3XtLiL9pojZKI7jaWO+7hHbf4UN+KVNwMMtAGP+S5kB5P9f1xB0aY9OWa+adEm7kDWfVULazUD5osNpAbVYdij276icV94gFI6qGQjZYzR6VyUwqsoXvxSX4jT+2u6Ks0m3jSbGOHDCmdIm8FB3dqVSv9wF+AMWfzLLbckQohqsJnczrHh8j2gRLT7BihJi+40o0boj9IjFn9ILTRn2srtIKb1BVs2gK4yGs9KssQEd9pWAYccTzcGfNmbHjaa0yYY8fF+lS8gmurT3VXljs4mmaKr2IzSQK2PTe+qfcNXzUHOiNawe0u4lrDZtjOZILe+Q7m/0SsOlyuHEpDDRGOAjR2MFM1n6pb5vVKHuD6FqQ0SJsOQI4v8YDx5G2+NHdmwMCzcUmxhju21kHiT2/aQ+6qSSW+zkLIMOu3YB1b4IAjxwoqoq5goy9gJtCRiamMvMNRXGzJgMJMHP5Ayyfi3YrwVpRnJ5i1sDXfbxhbx9Tp9oFRFi3C3+y+WtystcMIT4YR4b74J3WvcANgTTBNbsnLjfk+dGXtIv5buRc/Bre29GJ5lKrnfn5pU+wQ8tdvpR3sgAb7VUybKx3IZbSEqM4+IWFjbEzRZFdKsnhtQtL21/gNkx6lDyCE9x9hPc5D4Sbyj3o+o8iIyrdthw7uFGZoeDgADxhYOktDi5VrlrUnYVgEurFgvKUHMeZNrJn4ECoepeQlSgmvSQ9TiED58/Tpcqn8fXAAva7Jfib/JG8jxt0rEKa24UZq7N1rjjOwwdhMYubBy5OgME7eH3sG7nSRgrMrNQSG1j1xXOr5tVqsIwTNdVqdX6OQLc24y+Un1E6BrW3dWbH3dqN23vmVb+3tbblZvQ7h1oR51m2wvwXumFewiMrroNAd9DevTutsjKRc3h7ZZsD7hVYxf+fSg+ROf0fPMr8w1ppu5t/lf6OW7u/wTNjPB+pmKmrn+GXsb2D1PL2abmPho8glImkvQ6+Q8lW71O7vnmp+pkUkAdW1EUW8MFB6Scqu3aMbVNFmGJG1PZGtUpJRhxJvBEpzBXGiiJd4rTPK3yMXlpNAyZ965SZLzDxdkZFFLABGDMWcsg8ePUmiI1Ky2spNwrv8RdPjG3ACNK5qBVBIf7uB85o24muuoHNarSJR3TCJ3JRo4ENx4KF04iMBKYGTqTyTUlH1Zrrwx44fXmLGyHpUZgQm6G23+YvEt5uXvyRV43k7nQCmWYDY6DxHhKIy++Do2ulpjf10HctEncTVI9Wite5knhEplJy40pf+2QBXAYEqiHyFEihGgGmJauZKb+gbMOdia9yjcJdtz5nmmc6N15LCTGwcIoJNvQ1mzu7ozSCLrZkQfH+aOYgjwD4cpZjnGXtGJH5QSzNDkEKrkGtIa84r53bA3qBooK0B6toTO4hkY+6CQqY7VNVdEgarwTLuFB3hsjwVjCViD9VVFJbSsL6g7PXngPtiN3rxnZCJX2JMFWyO0GYuw105VnsRbNqkl3oG9/eGs70BLCXCSB7QFjKIXDAntip1ihEWQlyndUeUkfMI0WkuuZue2ochI+TfRSpSlsh02xynf0oXsnAb/vDTbzMDIMoiGzdny9oA8TPSu9N119/5U+TDTmZFNMODOJ7OrnVHqKBj/H71x/T62umDd+e/P6rOFPhJBeM5BPxMQgfyAZbjoRabBZazOAxxsNIx5XRKkJDfxDQdg2eHCkqGeS3wST3A3v09WVlFOVmPgmy9C+8aGqbYVIcdnAAI1diO1tzE/RlrSXS1jt7jfQGcFuxMOqk08RBnx21VtijXN8GuteMFRPcEVRmEwl60fOeaTgNq5K78PjwIm6Hqb7L/8vBrZ/K6kzgal+7ci2NjrpnBqdsLt4cnGO6/5jQTX5UKFci5XkQx109NcIleNyH/hcyAmf6RMXVWTjnFg0nuj/MWXl1C7lDdQAcALY48FcY8Wniqsu2rARHWJ5PLVcYYNAlI8FwsctMspWDgdYQh/UGj19Hgf19m/dTsscrAUb5Oo+Oayq3iODe/M+AghO+/i0rbzQ9MXZi6dbumRzhLQjo4PV084A22qnKfq15gxZVZoQ7UwBYfbqzK0K2FK+e4gB0ambTTCuc1+12iFtq9g+Nwo1EdLml9JDRPdfPZm7c7L7/fs/4P79FojQen9eJ7Z6cFYYR2T2ZJ7d1UGD9Us+1r7pkELt8GrecQlBn5f2u09h6vPSfoeT2uel9Xatz0vr89L6vLQ+L63PS+v3svsciJ5v+ry0Pi+t18m/cdnqdXLPN31eWp+X1uel9XlpfV5an3LU56X1TNLnpeGt4X2uRJ8r0e8p/XH2lP51uRI7yqa/Bau/Bau/BevxbsHqr8btr8btr8btXYTfy9W4/VmZ/qxMf1amPyvTn5V5/LMy/YXj/YXj/YXjv78Lx5vuWKcjJkWmHAVXGu5YeKUSPb0nk2huzCSaEt/iQtEN6JWshTVlsctZ32KxcAUkyJeVBqLKAWy964A59Mi/Cb7sMtjwn5hBZvQC829i2reVZebFKf8k+I2ti2qjIpQblSbEZmenJ0ZrSOoG1sxVBuKcf4ZSHI94rvR1+JtODuDBgPC3N74Ql68uz6v6xlyXxZWDxIIXz+mv8Kk+P1DlEzQwvYa1CGkFoXQjuVdzZZ0XZ3XBM/y7wkcWPllKccI/Q6mTeSYujl88D3+ngI/7ce+n9PsGgSajMwXbu1NIMNbJSJZoGCFJ0EjxMRMkABY2x43hjM2xljA+MlvtMSEUxhsXNzKn7asNqtg5/vLFFb59iw94PkQKe3b4eezQv2HWr/N/3htmHU/pUj5pTlH66qFgKejkUvfj5eHdcHxyt2C/DFNQKwdpk2z05sztOoz9iaieZRuhqdq9ES/Zd30BXlL/gdk6bwbYS7mGA/zL7fdWD1TwczDDiAwkBySG/3p/NKxCF8F9aDzH17AdQRU0/Eskf9uzpEfo2ae751HTDnVDDxfu4BWeAa0fUqweQLyXT+qnSvfwG4+1xF0NfhK36TG3X7QPz8lvDeNuZ9l4s/0E/d0w+urzL6Of/lT5JT/Cq1NMqcTniCmPDldSLGHM67uqksV396VtalQ9pb7TKoVZudhtdYrFmweHqVZTqW+OFZSupDUcxp3kjVSUxkKWYPPcNmhKWEGcw9uSYZy4Mp5JfDU4lYXH3H2JL2cTCHxtWYW3fEM2XJde3DNsPJFfvbLJdKuOLLYxaD6jHDYTE4o94HhmGKYrdeej1wT0qtXpLhHrvzaknJd2x0Iajpxo6UsL1UYkddBG+BWxIS+vz07Ff3zx5Vf/T6QGHGELt8p1kmjP0+W03A/BBSbR2Wk80XMgNK608VebCX1q7TP+8NL446p4ot+XxssruE0A8IzEU2v/jiVPQ0FDGXbCjYZRG8KDtOHjorjxkjvyO4NtbT29zcQKbfY+uF26K1pXdTyonO68us0guZmglcjhV59/NRRfff4l/vcfQxHH8aDFDfj9QbvU+/TlAjT6HaQgQlh5R2+ydDXUZK2MWK+83uiVj6pKgvUtd8pq8qteTfZqsleTvZrs1eR+NVlF8npV2avKXlX2qrJXlXtUJSImF444w1LvNPe3I2PXIys9ZCpXfjQrk2vAAV5b6Y0bFeUsU8loqRZL4gyk1QVRxNHtbZnUCxRtPGRShW1CWDL6T2PXYz7hhzEFzjc4ilReGOvFh4kWQohnAZnjQg255MTouVqU1ZnVOz5nd9CAdvA1bifjXolHTtnUFk+EhlUbwuHg66quLNSZRl2fQKjZ6P2wBWlAXWTghUqPBHPa12I8Rh2GkQzUB41Tk3y8FbeApZU5oGpNTI7nXhH3adB6U0wiFX8vwa4bFWkL0xvOE2lYrmrvcdyMovwFI0lP5CxJYTqIMUWVN4Ew16Q62DlgxBNjrhU0kf/u8vJcnFCxE3wSs6SrDFAkLk6/rxSjA3uDiKk0pN2UbhPOxgoNQOI7kBig5iwOMk2tAVHVpdRpBlYswUIsDqtQ92Av/tWMfQgyOiTTJe7EEyFXUrWmMl6A/6+tQNMhs5JKA08xLSZ68DVleASu/dY0uBXzfG+gyaiFTK5RGeUST3FjOJEY93CiJ35SRdknEf85z+tfjePfTAFaFop5VkyihfLLchYnJh9veHm0MFibxoy3KlBvhwMUj4lXqTh6gonr6VXQQ5NIjMdhSsU/xW+LHRFlpjSjzb/vQf03x4w4A4h/U58cPRGtWYxfwmpLu2AjWagTnuWuBsfnZ/x1S8VgS3QUh8IO0SJh4xpSXKum87P42w4Or7Zv/iqTawxQ6/RwMIjP0kOVDmImxyFPwCB+ypd8MLJqTp392xOhVcZ8NvHz3MfPCqu0nx8aF1/4FKwdiknwZ3lvSGYZTtD0I6hNp0fiTzeTiZ5ENK7BR7p4VmYZT03lNjfac+s7/G88risERu7q/EhsF2Hb3c4NntefRK/bED82tCZm4IrBRN81Ncr52i8pMF9pFbSue02gsesr/jjR1P2mIM5NCpmLm8J2hcImQtvdQW5DsICCwrWPC4X+V8EmlWoWRI2qAv+FIvAZJhQoXUni0jjKfarEhJYaQWvTemPpfeGOxuMik2vmw7iwBp0SFxu7loVyqPIQ8AVA217HxZpvK9ik3mSZcGWBOEG6ZdxrHeVisg8tu98YeFtA2QDQMFAnPRTdSicj3k8xx0/IaseUFwR0w0JwJsISAv20aj6pTgOp40qwt5QAXW1QqFDtiLH9TJxYwKO1ezuRznFVbKs2Tk2jx6Zvs+lhUFlG8UQcbOzKgfgMVfNv0KRszDdi3DYpG6x/k9YEUfd2HSaVJ/Zb8Lt7aZsKOFG1knvSml30c6529MGhSoeBPk+Cut9AI6E+nISVd4Bq5k23d/RNJ9gjUnJNUAyriV/4CqRYRK1fkKPhaBeJTYWWNXkALuJPjtARfxIwoEy+25FLr0epSSio0lh9YKBHLXhlT2uuXcM5oFQtK3NewfC1no090MZKeDdS9C+XjH//7PbL068r8Yiay0c6HD+sR8Tc8NFR/TYkpzUQugQYp9mCL62+ZPy3J5JSL832jHe6Sv624QP9XqefqfbHmv+C/a1dqe9QlA+a+P9zs/5xof/9zPjhdkGcpwMKbcGtB+34NrK3HyLMwj3aF9uq7x7pinEhKavWtYlp3FbSm5re1PSmpjc1van5Y5oabBiSLmnyaaLx2oxo7CCbj3AgKoEWXcdIV7QiPErmCby27KiORnwIMYgrl5WLu86IxJjMkFW4yVadU6ib8K5X2AqPNrGNnQn5H6QQ7nK/BL8y9hqPfdAmJ0LZHGOlnWC8uZCn522zxYnRzmTw7rBCPuECRDZ2y3GF/Di8ejJegB85LzGiQ/cZIg2r+5AvcFeexzOTTiX1Tj0dUKeSmsGwP5TEGUjL9yBvanLRTlU+VkOZ6jQH/CzQ0lj1D5qak7Bj2Cp805qa5Tq1Mk4hN9UAGegY/6dsZVPwAMx8ninN6bJUWt9zyCveIKnI/hbmFtxSeHMN2olDmSnJl6ROA5QrSbnhU1Ql7aJPh48gCtC4Lx295koYWeLTQCIcB0Ktc4nVKR8Zf3kgHTw3aux8MtHv6GLfY8KZAe/mXjROYYNOC4MRSZR/DXw/aYvxMPJ1DesN461WK8IFpQMdNeREjDG4cQHWYRhmxCQbEY6kzj7OMnb9g7HXrpAJHBfqe+g6iX0/3mJVARhlcAPZrz8Mukhhbqq0GJmQu8pXLB5FIcD6nzyPUfW0SYSYXfC33SPAn4kz7a1Jy4SDyKcmKTFJhO0JRXGzTLAvTUFimeZKhwuDb4CUzvH5mYvFcfsDFvIJGJ3R2WAeLKQhiCrRDqpUnAdiCGYpZtZYnHOPBAUPIOfG+eoErtJiZs3Kcch4oj/7DI2Ow6PIyok0jEDwQGfhDneGVKc5BBXYmEG+LrfusJGF4wh8fdnx3ODxX5RH3B4o8bTAEaLxT/E8/B1CZP8Up2ZFl7yTUfwp/xBEc0Ie6d8/EdtR65/YLvj0f48AohssYnsqrW8R5m1RzuIUbjYSFwrGYYfXjTdh80Enbd++fnp8+uLpBsLWXq5Lr8ezzMzGuXQebNjbdeHnOJXWjxkE+hFN2sYvn162u9LlAnxs7KKtIeriDdav7DrmTYXx4DGxNV7DDr6E7dNM3Srb7GoJt3GRb7rivx9K2UfAFgilTmy/NdtdbUDv7a7elv9FOGFhdvkgYIvPK7S7yuUN6DYnOJA2Wcb1l7G0Xs1l4sduiUZkvNlwHPx8bPGmjD1823gMouLbIv/RtUlLfFsVVzwxbmTyDB6TtnRrD6HUxHkb28Mf0KjMwSfLwU9FexSa/yLIM/DWEASO4fy78y1WZMyU29IWreKWJG5R/WcjXSyLDnYmivNOeAvbdaG2EA0l1ZKhwbzjXen7+dgSSp2a4nU5W7e7suVsvYDctTFulo7xl5a8PSq22NUe2XuNq+NWVwlGOV2sTGNVVhWF3/Zi+kjYum4LR/coJIA5i0d16OC4kMkSxBfx5+EC780yA2VP0meicWjrxs/PTp6+vHg6+iL+PF76POPTxDZ3r+YXvObGNbg3rpFxWbmcuHIG69iPzZAY5N8Wxvlc6gZenZuz22voRqY5H/euVwAcUcA03+byvzr82cweGJKPGHaxhyEdNQUvVea6D4qT//pXdmYJohNwW+C6jS6Q016NTi5eP6u2yjkRPERQ0sqJDSvEA9cRT4kn+pmx4vhvx/9d1XObWAxoh7nSfFo9xHPQ+d3Tg6Ac+ACEHlyYS5XRGM74ji1eP0Hln48otwWJwkGSEYWCZFG4YR0gUglmXkM4F19SHjcmZeQ5RpFMwYutUWo4YQ/JWK/JMLvdWHqIg58hSUyOjnmTDkuOK3nTXtiRyz6dTn90E104KFPDz6pWaW3amtKDxe35w4OxhcTcgF0fDMOde/VTSYcW3lPWECX3cX4jjbrKaQx5G10bCRbex4zeYUiBOBggrPfxe4z4vT0gHntHWQcWXMy3BhweNPnwYEjdYcrSgAaElV8YmsRNbjwuxKo8fHyOhJau39NGiaAb6Ik9z5dGQ1tUWsuPexa3vOnSjpYRP3PMbD2iVSqueE2p/Yiu1uJUmUbqNwrSmJ5fQUEmDfIhBOLeRk3QLPo1lnh1LQWC3g0jTAnC6h8+4JGINza7u8NiIii/TF0/aEsxw3vUwOHrEIgZNNNnqpe0HjeMO9GflkGzj2i8y0Ux6Wo/jFIrqhhjdPT23R1e04tc94n0aIZ9kQqPGvjFR2c+IfJ7z+DrCPaGAPX2HwYZiuZm4c6ZolYo+Nunl9Hd3f8CBc4QfQ== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns a verification flow's context with, for example, error details and other information. + +Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure +that cookies are included in the request or requests will fail. + +If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward +the incoming HTTP Cookie header to this endpoint: + +```js +pseudo-code example +router.get('/recovery', async function (req, res) { +const flow = await client.getVerificationFlow(req.header('cookie'), req.query['flow']) + +res.render('verification', flow) +}) +``` + +More information can be found at +[Ory Kratos Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation). + + + Request + + + + + + + diff --git a/docs/reference/openapi/get-version.RequestSchema.json b/docs/reference/openapi/get-version.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-version.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-version.StatusCodes.json b/docs/reference/openapi/get-version.StatusCodes.json new file mode 100644 index 0000000000..771c0c2ad5 --- /dev/null +++ b/docs/reference/openapi/get-version.StatusCodes.json @@ -0,0 +1,21 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "version": { + "description": "The version of Ory Kratos.", + "type": "string" + } + }, + "required": ["version"], + "type": "object" + } + } + }, + "description": "Returns the Ory Kratos version." + } + } +} diff --git a/docs/reference/openapi/get-version.api.mdx b/docs/reference/openapi/get-version.api.mdx new file mode 100644 index 0000000000..3722eec7dc --- /dev/null +++ b/docs/reference/openapi/get-version.api.mdx @@ -0,0 +1,38 @@ +--- +id: get-version +title: "Return Running Software Version." +description: "This endpoint returns the version of Ory Kratos." +sidebar_label: "Return Running Software Version." +hide_title: true +hide_table_of_contents: true +api: eJztWV9z2zYS/yp7yHQqzVBkJo/K5KaOraS+pInHdq/XsTI2RC4lxCDAAqBknqLvfrMASZGyPW0a956qB5sEsLs/LBb7j1uWoU2NKJ3Qik3Z5UpYQJWVWigHBl1llAW3QlijsUIr0Dl8NDW8M9xpG8/VXJ3mfoFFsxYpgq3KUhtn4fL9BcyyJcIlmkIoTiIicAMJmUYLSpOo3yphkDjN1c1/Jm+02XCTYTY5M9rpG1ghz9CA07AgWc6Lfo3AN9yTcQcih1pXQO+mUkqoJRSVdKKUCEpnaAm8l99gjQY72wgpQeEazVwZzIMwWpDKyjo0YB13GIFWsqYpDlaopUQQyjquUoxZxHSJxu/0NGNTtkT378CdRcygLbWyaNl0y148f07/Uq0cKkePvCylSD1t8tnSaWyZTVdYcHoqDXF2IlA3kOnx8PweOykWMVeXyKbMOiPUku12BMlrPWPTq47np26hXnzG1LEdrRyKOe8Zxl5GKzn2vC2mlRGuZtOrLdOmPkpTtPZS36Ji06tPO5LDl5ZEF+h4xh0n2XeTVGd4wYtS0l6vtkxytaSt1SVeeAwsYpIvULIp+0GbOkmlIB1GzOrKpIRcFGSCsJ0rAICfGvZHpYjCyLFWuVhW4aTmage50QV83+P2/Uuyr1Qr6yDtr4ZXoHAz5DAav2zX8lKcNubQrOxJHw04jXsitt64KhsBLYUdvCLDFgN+8d6aRuOXbBd1qnmreyqhi7bGvjZKnt7yJULBhSKRjXZGczV382CCd27OwmtedI/ahiddouKlCIqBOVsKt6oWcaqLZK+wyVLT6jEJyCuVemmjMZ0B8RjqcPoKBkzjD7g50CgR8VIcB6EPERydnYbZA7USJd21CEwEaAwRd5zi7jjOTuO3e4U2Wohf8/R2aXSlstF4HM/uMK0cBjQi99z+8QqUkH5fbu7ywsVvSiOUy0faxhcuQ2MimLOZMdrAZoUKUi4lOaObh2Xf3Ezhu/V8rubM4x3/Duc3lZTw4+XlGbQepUcfqHf0J0m6BcG+b3oyp7B/efH8+XmzkOjuC9aVI8HnQ26P7KYPBm05nqtd31bParfy7rC1V23qyaM3WJv6OkzOlZe6H4gLnaG0dCuu191GrrstNxwe2eYhM4PWtSRHpZjdpVgG5+BXll4f7YLwRob9DE4wFz7UkC9caeJiQXtaLoGrDDLMeSWdpZixcq600yQpJa+DmcWl0eRmbaxNzUth6V4R4wvEoeeJyxpybYCDFNaRe+dStuEWswM3VXLDC3RoKEgferDexofXLrhHv41XMGd/FG578Z/BpY+X/s4WVc93+sgOvHIrVK4Jc147NKSN+O8hamImFPA01Sbz7nQj3MpzOTo79RGcQnITZKDUUqR1TFSzuxA8vLKQpysvAwp0K5357KA0ei0yzGCBUm8iqGyAh4HSZxPEyXInbC7QUl5hAhtam3KLcdjvcbe/18gNmuF+pjAMfF99EtzTXjsiptU2RrUWRqurOXs9OzqfnV9ffnw3+zBnn7ojmClKVjg0Li3ojasuTQlZUFBje7f8mh6Wo9ZfHvhW4JZ8abNsGkA+g2OD3OHjQri1zX5KcS328bEnsR8m9xL8lojQmbqRFiSGDATOmzzvQufOJ4LNXY/3a4lZ5xReDRD0fQf5+JbEX+/R3GdTHanO+6F88s8e7dT7uz6DwKEvuplF71ig8y+kUJzeF71fMAghjyKA76wHAd8BjtnOJ1I2u51kOvUZYy97orxSLBV3lcFBjjoas4j5G0iJ1ydKD0nJlyEbfNCRsl3ElvqQZT+uurteGP1T/MsQMe7D3h/dV/MdPTgaF9nY565451DRZMhAb7Fm075CI7bmssK/Fft1iiWzDG44yPHc3YpNWbLuyqTg2YPiK0MZQhuFtk3subayWu4ejESJPxoj+EKGSqlPEsolH4wpK+5iGjssb34lb091zQd0G21u4SxwAeISw6+6gpQryIXKQDgKU+TqrvoUx1pZLfHTqAWfhgECG9tV0oJP0soYVC5ZoptYxymSj+NGV210u6AyMOxnwa1Iu9KQjiGMdEUbyaPDXfhwNFwZhu4t1RSzXtDSXOqNFzOIYsc6w3uDPw+OZlVnhscZFrrdYGCa0F861FSXYQM6z6VQJP4I/Ghb+mfB09EbWkfOzmBu0K7ARz8LIy4FD1H9puFyHeLjDdnpcOjr+YfiXYnM17d+EQW0jyWq0xM6T0UWcHoCoYTdRczT/UE9uEC02xfXQemk/oPa+F5Nr5sEpd84oUaHQswI4sDwKODeYr03vM1m47HQ7SDnRZZIscUmJRpLWeokqGziMY5jf1y/ZzKm/kWbW1vyFI9K8Y4c5Ffihk3LYCJxjfL/v41dxITKdduH4al34VhwQUfaJNY/hHNkEVPc8yJkF2GO3WuMPINT5YzOqjQUDyc6rQpULqR7PnuXEspqIUUa0t+sEEpYZ3zV7p3O0dmpjeFoOEGD3un47tMCm8wQsyZ347DmUmRw1igDgkkFY43hLEj0XChNKrR1sqbzych9LYze2FAqzNWzZ3Bx8s7OlW8GZs0OIGx0gbbN6yzwNReSXG3rAnsnGPtSoBO4X8qtZ++VQTS5llJv6D5ShVjxJdopwfgC75v3JjX6Aid6o6TmGTGAP/MjFv0DeaLfF0I7GfzgcODrf0/A4mG2hPaEGzdQzFVZLeIM1/sb1wwkTfvIJvtsffygbq/OZ0cnP832HA4aRTa7TRZSL5KCUz+1aRzZ5n+SceOSwILyhb5u4w+zy6EoVS3Rxdoshx6iG96j/mjqONQyyfgp0Wqn8B5ej3YmxZ0wfVErvIvLYi8qvP9RzT4BWvSQHkT7Vh+K2rN+VFzX8/tLLGGp79tBg/ZffM2Hogq+RjW0BIvcpKu4m0m4cSLnqUvsioJIsu85jb8d7We+5o/YLaENxUFnt2Xx2Q5V6+22HW5tIun1osdPqVuKgCFi9TEfoh39QkElR5euxn8W9qQh/0vAB+aDLQDt4ezHswNTDMiEPfAWg+HBTTzQ+jeDLlflA+bsNR6aoQO0dSkOgDYjbcnQM97k/u37drQe0oOe4rxa1ENRplrUSyzsEHF/NKGHwX17UrQk6pG7d07tx4Go1HCHNha6V5W1Q83To0ifCK19OMJRO1ykSHX5dNslmiVPVwgv4ucsOqiE6e5xP+113NDa5P3p8ezDxWzyIn4er1whfZWCprAf84vwyZNqbaep2HHCSXptU06qnNvPikySMnx+W2rrCq56uH6v9XZYTve+cv79fflbvy83BQw1dqkrL3wh6o1j2/RSBl9yqZNPQ9vtglv82cjdjoZ/q9DUoaXTdkv8N9mIBTX0ul5UR/hPrk3H6/536kFX5+3skkW+U0CIGrRd+dU2Ja66Ka7qHu/tNqzwVctux6IGRFM9f9rtdv8DDS4gsw== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint returns the version of Ory Kratos. + +If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. + +Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a +single instance. + + + + + + diff --git a/docs/reference/openapi/get-web-authn-java-script.RequestSchema.json b/docs/reference/openapi/get-web-authn-java-script.RequestSchema.json new file mode 100644 index 0000000000..e9fcb6db7c --- /dev/null +++ b/docs/reference/openapi/get-web-authn-java-script.RequestSchema.json @@ -0,0 +1 @@ +{ "title": "Body" } diff --git a/docs/reference/openapi/get-web-authn-java-script.StatusCodes.json b/docs/reference/openapi/get-web-authn-java-script.StatusCodes.json new file mode 100644 index 0000000000..32ecd87b73 --- /dev/null +++ b/docs/reference/openapi/get-web-authn-java-script.StatusCodes.json @@ -0,0 +1,12 @@ +{ + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "type": "string", "title": "webAuthnJavaScript" } + } + }, + "description": "webAuthnJavaScript" + } + } +} diff --git a/docs/reference/openapi/get-web-authn-java-script.api.mdx b/docs/reference/openapi/get-web-authn-java-script.api.mdx new file mode 100644 index 0000000000..2404ca2b2c --- /dev/null +++ b/docs/reference/openapi/get-web-authn-java-script.api.mdx @@ -0,0 +1,42 @@ +--- +id: get-web-authn-java-script +title: "Get WebAuthn JavaScript" +description: "This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration." +sidebar_label: "Get WebAuthn JavaScript" +hide_title: true +hide_table_of_contents: true +api: eJztWVtz27YS/it7kMlUmpHITB6VulPVdlI3aeKxncl0rIwNkUsRMQiwACiZx9F/P7MAKZGy3Fx7nqIHW4QWux8We+cdS9EmRpROaMUm7CIXFlClpRbKQWn0UqRo4Q++5OeeDFa5SHIQFhRiiikIBdqkaMBpKNFk2hTwDufTyuUKpF4IBVylYHAhrDOc5EQzNVMnGdS6Am4Q5pWQqVAL4F1Bvxm9smhgWpYwwGgRkagz5In74xy0galaVJKbP86HntFKSOkxERCpeQqOzpIJiROSd319nbtCztTP4bxgTXIwY7lzpZ3EcVnNpUjGN4Y7bSO85UUpMdJmEUcrlHJ8o/RKxdrU8QrnnA4XfbAzBq4u8WDGAs8ZA25rlUD8ixdIcv/UBkEo0os/PCRcwRwh05VKgTu4fGNqeOnlwls68CtS2vtBi2y1WkXa1FGiizjViY0DxtiizMYWzVIkGGdSr2xcWTRjr/OhV/ql53fWUT0c6aQqUDn/9PVCutc5jNiI6RLD00nKJmyBrrWB7Y2yETNoS60sWja5Y0+fPKF/iVYOlaOvvCylSDyb+IMlg7xjNsmx4PSNVM0mzDoj1IKNmBNO0sLqvqT1ej3asey9VCPm+MKyySXLjIeRsvcjdjvWph4b7lCKQrjxvEpu0LEJy+vU8HFjKrlY5IyIE53iubcX4nTHJFcLcqW6xM3BJZ+jZBP2K1lQIgUdeMSsrkxCRxBFqY2Du5kCAHjeYJmWYhRWDrXKxKIKGp6pNWRGF/BTh9tPz8jYEq2sg6RLDQegcNXnMBg+a2l5KU6UdVwl2FB2pA96nIYdEXdgHXeVHUHKHYc1HABfcdHjF+21gsHwGVuPNlp6oTvaUdyJJXYVU/Lkhi8QCi4USW8UNZipmZsF07l1MxYes2LzVdvwTZeoeCmCjmDGFsLl1dyb+VZ344Um6iEJyCqVeGmDIV0H8eirc3IAPabRa1ztKJc28VIcBqH7NkxPT8KvOxqmneQjIzAjQGNo84ZTtLmZ05PoxV7dNgqJfuPJzcJQhBkMh9HxLSaVwwBMZJ7xfw5ACemP6GYuK1z0vDRCuWygbXTuUjRmBDN2bIw2sMqR4paUFKSvPwnj+noCj5ezmZoxf4rhJ4Q8r6SE3y8uTqGND539Yfea/sTxhiA4wPV+8RMIMYL23BeqK0dCz/qcPn2oLia05XCm1l1DPq1drlXHmCmGPOjp2tRX4ceZ8gC2C5FB66Chm5bi+DbBMvi9pyz9aVqC8ESG+giOMBOKrsjlCLkmLha038ulTwgpZrySzlKO3GQ+yetgK1Fp9AdMnKVUwEthyU+I8TliP6hEZQ2ZNsBBCutAZ8ClBFuVhAnTnQhUcsMLdGhs5ONHLzh1Dt53oxD5/DEOoJOoPwG3dWTCfawcEsjGLWAlXA5cgWgjns68rqanJ9DehqfpgJq27rfjqsAtuWZDNgloH8GhQe7wYSHc2kBKe8U28nYkdgPwVoI/FG10pm6kBYkv0G0Lrq29bkmIx8ZvDnqCKURfrXB+5Suaqw98ya9sE6a3DLyJDWbsIsetA+qsmynGvzzIaeKdpssu8OvCan5Fb+qwsXjSMU7uA9kS9CLTZ+KBx9ZDgseAQ7b2Cd+mN2Oqe6jO6CRuqj/EQnFXGXyorBkM2Yh5E6f0/56KHFcZddGrVtYjttC77B6I4e62E7I/j3cZgs99uA9d7ifY+tIIbx0qK7QKZc0N1mzyUG00YksuK9xbI1GQbDdv9LzZ8EPfQd9khwW6XDf1s9/hcjZh/9SBUGpBs0QT7qgylHnaUHnXBMgrK6vFem+4jP1FGMHnMhTl3S303GQMKsU2gZft1tZ/6coAtTGv0a20uYHTwAWISwR/6cp3PZlQKQhHfRwFxMvujkOtrJa47UiSsOC7EpvHLfg4qYxB5eIFurF1nNLNMGr0ZzGpjHD1OfUM4TxzbkWy6SNI3WFl1LYTJI+udI7coOlThqV7pJq0/5RIfUfkO5fK5dqI//rccKhTvLf4tnc13kuiFAvdHjAwjekvXWqiy3AAnWVSKBI/Bb8KBv+uhME0BD96Quso/hnMDNocnL5BZWHApeDW5+nrhssVTxK09prssb/05fxD06cE2etZIKK096ZEdXJE96nIAk6O4ILISW9+32fqwYVN643yG6WT+k099ZgDY2+kvRmGhspiaP83owwaEfjpAFd9w6O0fIP1P7TCiVaUbmxcorFUSo2DysYeo+9+P20ypn6nzY0teYLTUrykcPiFuGHVMhhLXKL8/x9jPWI0yGibdp74gI0FF3SlTfX3a7hHNmKKe16E7Dz8xu515Y/gRDmj0yoJFW5vPBFKTCkhZBNfwfK0EKoZPSzRB53p6YmNYNr/gRZ90NFK1jRvCYfFtKnwOCy5FCmcNsqAYFLBWCM4DRI9FxpRFdo6WdP9+InXPMymrJ9kPXoE50cv7Uz54VnanADCQedo2+rPAl9yISnUtiGwc4MRXGzIDHZIufXsvTJoT6al1CvyR+o8Kr5A6wdcH+FV89xUSx/hSK+UH4WdH72Er/l87M+LvorHPraEdtz7wO7Cl3++A4v9bAntETeup5jLsppHKS63HtcsxM3Mwsbbmn64V7eXZ8fToz+Ptxx2phM2vYnnUs/jgluHpplW2OZ/nHLj4sAiKtJhV7fR6+OLvihVLdDRPLMfITbLW9RvTB2Fjicefk+02im8h9ejPZbiVpiuqBxvo7LYigrPn6vZ74AWPaS9aF/oXVFb1g+K2wya/hVLWOj7dtCgpUK3L6rgS1R9S7DITZJHm19ibpzIeOJim1MSibezjOG3o6XC+AG77Yz/W7stiw+2r1pvt+1yaxNxZxY6/J66pQwYMlYX8y7awTtKKhm6JB9+Lexxs/1fAR+Y944AdIbT3093TDEgE3YnWvSWe564o/VvBl3m5R5z9hoPQ7Ye2roUO0CblbZl6BhvfN/7vh2th7Q3UpxV87ovylTzeoGF7SPursb0pedv3xUtiXrA984qu5PhEmrzbSR0pytrl5pvDyL9Tmjt/gxHY1aRoLK+z2oLzZInOcLT6Akb7XTC5Hvc/+x13Oy18auTw+PX58fjp9GTiN4O+i4FTWHfZOfhpRf1307bzuumtuSkzhmNDXWsJGX4+rbU1hVcdXA9MKDb7aI7b8J+vIb98Rr2617DNv0aTbtpUi583+194a4ZJ12yjiaZ70zZiHVHSu9HjKbuRHp3N+cW3xq5XtPy3xWaOkyw2qERPa1HLEee0vRkMyekdqrszgXvvdvtDbxeHF+w9fp/acEajQ== +sidebar_class_name: "get api-method" +info_path: reference/openapi/ory-apis +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint" +import ParamsDetails from "@theme/ParamsDetails" +import RequestSchema from "@theme/RequestSchema" +import StatusCodes from "@theme/StatusCodes" +import OperationTabs from "@theme/OperationTabs" +import TabItem from "@theme/TabItem" +import Heading from "@theme/Heading" +import Translate from "@docusaurus/Translate" + + + + + +This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. + +If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: + +```html +