docs: bump to a620c56adf99f3d2cb385b1414b24e5ddd64aeb6

Author: aeneasr

docs/reference/api.json

@@ -1149,6 +1149,10 @@
             "description": "Configures the Ory Kratos Session caching max-age feature flag\n\nThis governs the \"feature_flags.cacheable_sessions_max_age\" setting.",
             "type": "string"
           },
+          "kratos_feature_flags_choose_recovery_address": {
+            "description": "This governs the \"feature_flags.choose_recovery_address\" setting.",
+            "type": "boolean"
+          },
           "kratos_feature_flags_faster_session_extend": {
             "description": "Configures the Ory Kratos Faster Session Extend setting\n\nIf enabled allows faster session extension by skipping the session lookup and returning 201 instead of 200.\nDisabling this feature will be deprecated in the future.\n\nThis governs the \"feature_flags.faster_session_extend\" setting.",
             "type": "boolean"
@@ -1165,6 +1169,10 @@
             "description": "Return a form error if the login identifier is not verified\n\nIf true, the login flow will return a form error if the login identifier is not verified, which restores legacy behavior. If this value is false, the `continue_with` array will contain a `show_verification_ui` hook instead.\n\nThis flag is deprecated and will be removed in the future.\n\nThis governs the \"feature_flags.legacy_require_verified_login_error\" setting.",
             "type": "boolean"
           },
+          "kratos_feature_flags_password_profile_registration_node_group": {
+            "description": "Configures the group for the password method in the registration flow.\n\nIf true, it sets the password method group value to \"password\" if it is the only method available. This is the legacy behavior.\nIf false is, it sets the password method group value to \"default\".",
+            "type": "boolean"
+          },
           "kratos_feature_flags_use_continue_with_transitions": {
             "description": "Configures the Ory Kratos Session use_continue_with_transitions flag\n\nThis governs the \"feature_flags.use_continue_with_transitions\" setting.",
             "type": "boolean"
@@ -3183,6 +3191,10 @@
           "credentials": {
             "$ref": "#/components/schemas/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/\u003cid\u003e`."
           },
@@ -4063,6 +4075,10 @@
             "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",
@@ -5878,6 +5894,10 @@
             "description": "Configures the Ory Kratos Session caching max-age feature flag\n\nThis governs the \"feature_flags.cacheable_sessions_max_age\" setting.",
             "type": "string"
           },
+          "kratos_feature_flags_choose_recovery_address": {
+            "description": "This governs the \"feature_flags.choose_recovery_address\" setting.",
+            "type": "boolean"
+          },
           "kratos_feature_flags_faster_session_extend": {
             "description": "Configures the Ory Kratos Faster Session Extend setting\n\nIf enabled allows faster session extension by skipping the session lookup and returning 201 instead of 200.\nDisabling this feature will be deprecated in the future.\n\nThis governs the \"feature_flags.faster_session_extend\" setting.",
             "type": "boolean"
@@ -5894,6 +5914,10 @@
             "description": "Return a form error if the login identifier is not verified\n\nIf true, the login flow will return a form error if the login identifier is not verified, which restores legacy behavior. If this value is false, the `continue_with` array will contain a `show_verification_ui` hook instead.\n\nThis flag is deprecated and will be removed in the future.\n\nThis governs the \"feature_flags.legacy_require_verified_login_error\" setting.",
             "type": "boolean"
           },
+          "kratos_feature_flags_password_profile_registration_node_group": {
+            "description": "Configures the group for the password method in the registration flow.\n\nIf true, it sets the password method group value to \"password\" if it is the only method available. This is the legacy behavior.\nIf false is, it sets the password method group value to \"default\".",
+            "type": "boolean"
+          },
           "kratos_feature_flags_use_continue_with_transitions": {
             "description": "Configures the Ory Kratos Session use_continue_with_transitions flag\n\nThis governs the \"feature_flags.use_continue_with_transitions\" setting.",
             "type": "boolean"
@@ -10123,6 +10147,10 @@
           "credentials": {
             "$ref": "#/components/schemas/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/\u003cid\u003e`."
           },
@@ -10483,6 +10511,22 @@
             "type": "string",
             "x-go-enum-desc": "link RecoveryStrategyLink\ncode RecoveryStrategyCode"
           },
+          "recovery_address": {
+            "description": "A recovery address that is registered for the user.\nIt can be an email, a phone number (to receive the code via SMS), etc.\nUsed in RecoveryV2.",
+            "type": "string"
+          },
+          "recovery_confirm_address": {
+            "description": "If there are multiple recovery addresses registered for the user, and the initially provided address\nis different from the address chosen when the choice (of masked addresses) is presented, then we need to make sure\nthat the user actually knows the full address to avoid information exfiltration, so we ask for the full address.\nUsed in RecoveryV2.",
+            "type": "string"
+          },
+          "recovery_select_address": {
+            "description": "If there are multiple addresses registered for the user, a choice is presented and this field\nstores the result of this choice.\nAddresses are 'masked' (never sent in full to the client and shown partially in the UI) since at this point in the recovery flow,\nthe user has not yet proven that it knows the full address and we want to avoid\ninformation exfiltration.\nSo for all intents and purposes, the value of this field should be treated as an opaque identifier.\nUsed in RecoveryV2.",
+            "type": "string"
+          },
+          "screen": {
+            "description": "Set to \"previous\" to return to the previous screen.\nUsed in RecoveryV2.",
+            "type": "string"
+          },
           "transient_payload": {
             "description": "Transient data to pass along to any webhooks",
             "type": "object"
@@ -12266,6 +12310,86 @@
         "tags": ["identity"]
       }
     },
+    "/admin/identities/by/external/{externalID}": {
+      "get": {
+        "description": "Return an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) by its external ID. You can optionally\ninclude credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter.",
+        "operationId": "getIdentityByExternalID",
+        "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",
+                  "link_recovery",
+                  "code_recovery"
+                ],
+                "type": "string"
+              },
+              "type": "array"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/identity"
+                }
+              }
+            },
+            "description": "identity"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/errorGeneric"
+                }
+              }
+            },
+            "description": "errorGeneric"
+          },
+          "default": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/errorGeneric"
+                }
+              }
+            },
+            "description": "errorGeneric"
+          }
+        },
+        "security": [
+          {
+            "oryAccessToken": []
+          }
+        ],
+        "summary": "Get an Identity by its External ID",
+        "tags": ["identity"]
+      }
+    },
     "/admin/identities/{id}": {
       "delete": {
         "description": "Calling this endpoint irrecoverably and permanently deletes the [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) given its ID. This action can not be undone.\nThis endpoint returns 204 when the identity was deleted or 404 if the identity was not found.",