swagger.json

{
  "consumes": [
    "application/json",
    "application/x-www-form-urlencoded"
  ],
  "produces": [
    "application/json"
  ],
  "schemes": [
    "http",
    "https"
  ],
  "swagger": "2.0",
  "info": {
    "description": "Welcome to the Ory Kratos HTTP API documentation!",
    "title": "Ory Kratos",
    "version": "latest"
  },
  "basePath": "/",
  "paths": {
    "/.well-known/ory/webauthn.js": {
      "get": {
        "description": "This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration.\n\nIf you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file:\n\n```html\n\u003cscript src=\"https://public-kratos.example.org/.well-known/ory/webauthn.js\" type=\"script\" async /\u003e\n```\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "produces": [
          "text/javascript"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get WebAuthn JavaScript",
        "operationId": "getWebAuthnJavaScript",
        "responses": {
          "200": {
            "description": "webAuthnJavaScript",
            "schema": {
              "$ref": "#/definitions/webAuthnJavaScript"
            }
          }
        }
      }
    },
    "/admin/courier/messages": {
      "get": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Lists all messages by given status and recipient.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "courier"
        ],
        "summary": "List Messages",
        "operationId": "listCourierMessages",
        "parameters": [
          {
            "maximum": 1000,
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 250,
            "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.sh/docs/ecosystem/api-design#pagination).",
            "name": "page_size",
            "in": "query"
          },
          {
            "type": "string",
            "description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
            "name": "page_token",
            "in": "query"
          },
          {
            "type": "integer",
            "format": "int64",
            "description": "Status filters out messages based on status.\nIf no value is provided, it doesn't take effect on filter.",
            "name": "status",
            "in": "query"
          },
          {
            "type": "string",
            "description": "Recipient filters out messages based on recipient.\nIf no value is provided, it doesn't take effect on filter.",
            "name": "recipient",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/listCourierMessages"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/courier/messages/{id}": {
      "get": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Gets a specific messages by the given ID.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "courier"
        ],
        "summary": "Get a Message",
        "operationId": "getCourierMessage",
        "parameters": [
          {
            "type": "string",
            "description": "MessageID is the ID of the message.",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "message",
            "schema": {
              "$ref": "#/definitions/message"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/identities": {
      "get": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Lists all [identities](https://www.ory.sh/docs/kratos/concepts/identity-user-model) in the system.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "List Identities",
        "operationId": "listIdentities",
        "parameters": [
          {
            "maximum": 1000,
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 250,
            "description": "Items per Page\n\nThis is the number of items per page.",
            "name": "per_page",
            "in": "query"
          },
          {
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 1,
            "description": "Pagination Page\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.",
            "name": "page",
            "in": "query"
          },
          {
            "type": "string",
            "description": "CredentialsIdentifier is the identifier (username, email) of the credentials to look up.",
            "name": "credentials_identifier",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/listIdentities"
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "post": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Create an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model).  This endpoint can also be used to\n[import credentials](https://www.ory.sh/docs/kratos/manage-identities/import-user-accounts-identities)\nfor instance passwords, social sign in configurations or multifactor methods.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Create an Identity",
        "operationId": "createIdentity",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/createIdentityBody"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "identity",
            "schema": {
              "$ref": "#/definitions/identity"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "409": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "patch": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Creates or delete multiple\n[identities](https://www.ory.sh/docs/kratos/concepts/identity-user-model).\nThis endpoint can also be used to [import\ncredentials](https://www.ory.sh/docs/kratos/manage-identities/import-user-accounts-identities)\nfor instance passwords, social sign in configurations or multifactor methods.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Create and deletes multiple identities",
        "operationId": "batchPatchIdentities",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/patchIdentitiesBody"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "batchPatchIdentitiesResponse",
            "schema": {
              "$ref": "#/definitions/batchPatchIdentitiesResponse"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "409": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/identities/{id}": {
      "get": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Return an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) by its ID. You can optionally\ninclude credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Get an Identity",
        "operationId": "getIdentity",
        "parameters": [
          {
            "type": "string",
            "description": "ID must be set to the ID of identity you want to get",
            "name": "id",
            "in": "path",
            "required": true
          },
          {
            "type": "array",
            "items": {
              "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.",
            "name": "include_credential",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "identity",
            "schema": {
              "$ref": "#/definitions/identity"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "put": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "This endpoint updates an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model). The full identity\npayload (except credentials) is expected. It is possible to update the identity's credentials as well.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Update an Identity",
        "operationId": "updateIdentity",
        "parameters": [
          {
            "type": "string",
            "description": "ID must be set to the ID of identity you want to update",
            "name": "id",
            "in": "path",
            "required": true
          },
          {
            "name": "Body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/updateIdentityBody"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "identity",
            "schema": {
              "$ref": "#/definitions/identity"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "409": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "delete": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "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 when the identity was not found, in which case it is\nassumed that is has been deleted already.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Delete an Identity",
        "operationId": "deleteIdentity",
        "parameters": [
          {
            "type": "string",
            "description": "ID is the identity's ID.",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/responses/emptyResponse"
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "patch": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Partially updates an [identity's](https://www.ory.sh/docs/kratos/concepts/identity-user-model) field using [JSON Patch](https://jsonpatch.com/).\nThe fields `id`, `stateChangedAt` and `credentials` can not be updated using this method.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Patch an Identity",
        "operationId": "patchIdentity",
        "parameters": [
          {
            "type": "string",
            "description": "ID must be set to the ID of identity you want to update",
            "name": "id",
            "in": "path",
            "required": true
          },
          {
            "name": "Body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/jsonPatchDocument"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "identity",
            "schema": {
              "$ref": "#/definitions/identity"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "409": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/identities/{id}/credentials/{type}": {
      "delete": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Delete an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) credential by its type\nYou can only delete second factor (aal2) credentials.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Delete a credential for a specific identity",
        "operationId": "deleteIdentityCredentials",
        "parameters": [
          {
            "type": "string",
            "description": "ID is the identity's ID.",
            "name": "id",
            "in": "path",
            "required": true
          },
          {
            "enum": [
              "totp",
              "webauthn",
              "lookup"
            ],
            "type": "string",
            "description": "Type is the credential's Type.\nOne of totp, webauthn, lookup",
            "name": "type",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/responses/emptyResponse"
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/identities/{id}/sessions": {
      "get": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "This endpoint returns all sessions that belong to the given Identity.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "List an Identity's Sessions",
        "operationId": "listIdentitySessions",
        "parameters": [
          {
            "maximum": 1000,
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 250,
            "description": "Items per Page\n\nThis is the number of items per page.",
            "name": "per_page",
            "in": "query"
          },
          {
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 1,
            "description": "Pagination Page\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.",
            "name": "page",
            "in": "query"
          },
          {
            "type": "string",
            "description": "ID is the identity's ID.",
            "name": "id",
            "in": "path",
            "required": true
          },
          {
            "type": "boolean",
            "description": "Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.",
            "name": "active",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/listIdentitySessions"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "delete": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Delete \u0026 Invalidate an Identity's Sessions",
        "operationId": "deleteIdentitySessions",
        "parameters": [
          {
            "type": "string",
            "description": "ID is the identity's ID.",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/recovery/code": {
      "post": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "This endpoint creates a recovery code which should be given to the user in order for them to recover\n(or activate) their account.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Create a Recovery Code",
        "operationId": "createRecoveryCodeForIdentity",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/createRecoveryCodeForIdentityBody"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "recoveryCodeForIdentity",
            "schema": {
              "$ref": "#/definitions/recoveryCodeForIdentity"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/recovery/link": {
      "post": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "This endpoint creates a recovery link which should be given to the user in order for them to recover\n(or activate) their account.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Create a Recovery Link",
        "operationId": "createRecoveryLinkForIdentity",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "schema": {
              "$ref": "#/definitions/createRecoveryLinkForIdentityBody"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "recoveryLinkForIdentity",
            "schema": {
              "$ref": "#/definitions/recoveryLinkForIdentity"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/sessions": {
      "get": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Listing all sessions that exist.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "List All Sessions",
        "operationId": "listSessions",
        "parameters": [
          {
            "maximum": 1000,
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 250,
            "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.sh/docs/ecosystem/api-design#pagination).",
            "name": "page_size",
            "in": "query"
          },
          {
            "type": "string",
            "description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
            "name": "page_token",
            "in": "query"
          },
          {
            "type": "boolean",
            "description": "Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.",
            "name": "active",
            "in": "query"
          },
          {
            "enum": [
              "identity",
              "devices"
            ],
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "ExpandOptions is a query parameter encoded list of all properties that must be expanded in the Session.\nIf no value is provided, the expandable properties are skipped.",
            "name": "expand",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/listSessions"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/sessions/{id}": {
      "get": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "This endpoint is useful for:\n\nGetting a session object with all specified expandables that exist in an administrative context.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Get Session",
        "operationId": "getSession",
        "parameters": [
          {
            "enum": [
              "identity",
              "devices"
            ],
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "ExpandOptions is a query parameter encoded list of all properties that must be expanded in the Session.\nExample - ?expand=Identity\u0026expand=Devices\nIf no value is provided, the expandable properties are skipped.",
            "name": "expand",
            "in": "query"
          },
          {
            "type": "string",
            "description": "ID is the session's ID.",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "session",
            "schema": {
              "$ref": "#/definitions/session"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "delete": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Calling this endpoint deactivates the specified session. Session data is not deleted.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Deactivate a Session",
        "operationId": "disableSession",
        "parameters": [
          {
            "type": "string",
            "description": "ID is the session's ID.",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/admin/sessions/{id}/extend": {
      "patch": {
        "security": [
          {
            "oryAccessToken": []
          }
        ],
        "description": "Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it\nwill only extend the session after the specified time has passed.\n\nRetrieve the session ID from the `/sessions/whoami` endpoint / `toSession` SDK method.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Extend a Session",
        "operationId": "extendSession",
        "parameters": [
          {
            "type": "string",
            "description": "ID is the session's ID.",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "session",
            "schema": {
              "$ref": "#/definitions/session"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/health/alive": {
      "get": {
        "description": "This endpoint returns a 200 status code when the HTTP server is up running.\nThis status does currently not include checks whether the database connection is working.\n\nIf the service supports TLS Edge Termination, this endpoint does not require the\n`X-Forwarded-Proto` header to be set.\n\nBe aware that if you are running multiple nodes of this service, the health status will never\nrefer to the cluster state, only to a single instance.",
        "produces": [
          "application/json",
          "text/plain"
        ],
        "tags": [
          "health"
        ],
        "summary": "Check alive status",
        "operationId": "isInstanceAlive",
        "responses": {
          "200": {
            "description": "healthStatus",
            "schema": {
              "$ref": "#/definitions/healthStatus"
            }
          },
          "default": {
            "description": "unexpectedError",
            "schema": {
              "$ref": "#/definitions/unexpectedError"
            }
          }
        }
      }
    },
    "/health/ready": {
      "get": {
        "description": "This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.\nthe database) are responsive as well.\n\nIf the service supports TLS Edge Termination, this endpoint does not require the\n`X-Forwarded-Proto` header to be set.\n\nBe aware that if you are running multiple nodes of this service, the health status will never\nrefer to the cluster state, only to a single instance.",
        "produces": [
          "application/json",
          "text/plain"
        ],
        "tags": [
          "health"
        ],
        "summary": "Check readiness status",
        "operationId": "isInstanceReady",
        "responses": {
          "200": {
            "description": "healthStatus",
            "schema": {
              "$ref": "#/definitions/healthStatus"
            }
          },
          "503": {
            "description": "healthNotReadyStatus",
            "schema": {
              "$ref": "#/definitions/healthNotReadyStatus"
            }
          },
          "default": {
            "description": "unexpectedError",
            "schema": {
              "$ref": "#/definitions/unexpectedError"
            }
          }
        }
      }
    },
    "/schemas": {
      "get": {
        "description": "Returns a list of all identity schemas currently in use.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Get all Identity Schemas",
        "operationId": "listIdentitySchemas",
        "parameters": [
          {
            "maximum": 1000,
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 250,
            "description": "Items per Page\n\nThis is the number of items per page.",
            "name": "per_page",
            "in": "query"
          },
          {
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 1,
            "description": "Pagination Page\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.",
            "name": "page",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/identitySchemas"
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/schemas/{id}": {
      "get": {
        "description": "Return a specific identity schema.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "identity"
        ],
        "summary": "Get Identity JSON Schema",
        "operationId": "getIdentitySchema",
        "parameters": [
          {
            "type": "string",
            "description": "ID must be set to the ID of schema you want to get",
            "name": "id",
            "in": "path",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "identitySchema",
            "schema": {
              "$ref": "#/definitions/identitySchema"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/errors": {
      "get": {
        "description": "This endpoint returns the error associated with a user-facing self service errors.\n\nThis endpoint supports stub values to help you implement the error UI:\n\n`?id=stub:500` - returns a stub 500 (Internal Server Error) error.\n\nMore information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get User-Flow Errors",
        "operationId": "getFlowError",
        "parameters": [
          {
            "type": "string",
            "description": "Error is the error's ID",
            "name": "id",
            "in": "query",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "flowError",
            "schema": {
              "$ref": "#/definitions/flowError"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "500": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/login": {
      "post": {
        "description": ":::info\n\nThis endpoint is EXPERIMENTAL and subject to potential breaking changes in the future.\n\n:::\n\nUse this endpoint to complete a login flow. This endpoint\nbehaves differently for API and browser flows.\n\nAPI flows expect `application/json` to be sent in the body and responds with\nHTTP 200 and a application/json body with the session token on success;\nHTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;\nHTTP 400 on form validation errors.\n\nBrowser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with\na HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded;\na HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise.\n\nBrowser flows with an accept header of `application/json` will not redirect but instead respond with\nHTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;\nHTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;\nHTTP 400 on form validation errors.\n\nIf this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`session_already_available`: The user is already signed in.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!\n`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.\nMost likely used in Social Sign In flows.\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "consumes": [
          "application/json",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json",
          "Header:",
          "Set-Cookie"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Submit a Login Flow",
        "operationId": "updateLoginFlow",
        "parameters": [
          {
            "type": "string",
            "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`).",
            "name": "flow",
            "in": "query",
            "required": true
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/updateLoginFlowBody"
            }
          },
          {
            "type": "string",
            "description": "The Session Token of the Identity performing the settings flow.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "successfulNativeLogin",
            "schema": {
              "$ref": "#/definitions/successfulNativeLogin"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "loginFlow",
            "schema": {
              "$ref": "#/definitions/loginFlow"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "422": {
            "description": "errorBrowserLocationChangeRequired",
            "schema": {
              "$ref": "#/definitions/errorBrowserLocationChangeRequired"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/login/api": {
      "get": {
        "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.\n\nIf a valid provided session cookie or session token is provided, a 400 Bad Request error\nwill be returned unless the URL query parameter `?refresh=true` is set.\n\nTo fetch an existing login flow call `/self-service/login/flows?flow=\u003cflow_id\u003e`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make\nyou vulnerable to a variety of CSRF attacks, including CSRF login attacks.\n\nIn the case of an error, the `error.id` of the JSON response body can be one of:\n\n`session_already_available`: The user is already signed in.\n`session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n\nThis endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Login Flow for Native Apps",
        "operationId": "createNativeLoginFlow",
        "parameters": [
          {
            "type": "boolean",
            "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.",
            "name": "refresh",
            "in": "query"
          },
          {
            "type": "string",
            "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\".",
            "name": "aal",
            "in": "query"
          },
          {
            "type": "string",
            "description": "The Session Token of the Identity performing the settings flow.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "type": "boolean",
            "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.",
            "name": "return_session_token_exchange_code",
            "in": "query"
          },
          {
            "type": "string",
            "description": "The URL to return the browser to after the flow was completed.",
            "name": "return_to",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "loginFlow",
            "schema": {
              "$ref": "#/definitions/loginFlow"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/login/browser": {
      "get": {
        "description": "This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate\ncookies and anti-CSRF measures required for browser-based flows.\n\nIf this endpoint is opened as a link in the browser, it will be redirected to\n`selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session\nexists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter\n`?refresh=true` was set.\n\nIf this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`session_already_available`: The user is already signed in.\n`session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!\n\nThe optional query parameter login_challenge is set when using Kratos with\nHydra in an OAuth2 flow. See the oauth2_provider.url configuration\noption.\n\nThis endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Login Flow for Browsers",
        "operationId": "createBrowserLoginFlow",
        "parameters": [
          {
            "type": "boolean",
            "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.",
            "name": "refresh",
            "in": "query"
          },
          {
            "type": "string",
            "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\".",
            "name": "aal",
            "in": "query"
          },
          {
            "type": "string",
            "description": "The URL to return the browser to after the flow was completed.",
            "name": "return_to",
            "in": "query"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          },
          {
            "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`).",
            "name": "login_challenge",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "loginFlow",
            "schema": {
              "$ref": "#/definitions/loginFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/login/flows": {
      "get": {
        "description": "This endpoint returns a login flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code example\nrouter.get('/login', async function (req, res) {\nconst flow = await client.getLoginFlow(req.header('cookie'), req.query['flow'])\n\nres.render('login', flow)\n})\n```\n\nThis request may fail due to several reasons. The `error.id` can be one of:\n\n`session_already_available`: The user is already signed in.\n`self_service_flow_expired`: The flow is expired and you should request a new one.\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get Login Flow",
        "operationId": "getLoginFlow",
        "parameters": [
          {
            "type": "string",
            "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`).",
            "name": "id",
            "in": "query",
            "required": true
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "loginFlow",
            "schema": {
              "$ref": "#/definitions/loginFlow"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/logout": {
      "get": {
        "description": "This endpoint logs out an identity in a self-service manner.\n\nIf the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other)\nto the `return_to` parameter of the initial request or fall back to `urls.default_return_to`.\n\nIf the `Accept` HTTP header is set to `application/json`, a 204 No Content response\nwill be sent on successful logout instead.\n\nThis endpoint is NOT INTENDED for API clients and only works\nwith browsers (Chrome, Firefox, ...). For API clients you can\ncall the `/self-service/logout/api` URL directly with the Ory Session Token.\n\nMore information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Update Logout Flow",
        "operationId": "updateLogoutFlow",
        "parameters": [
          {
            "type": "string",
            "description": "A Valid Logout Token\n\nIf you do not have a logout token because you only have a session cookie,\ncall `/self-service/logout/browser` to generate a URL for this endpoint.",
            "name": "token",
            "in": "query"
          },
          {
            "type": "string",
            "description": "The URL to return to after the logout was completed.",
            "name": "return_to",
            "in": "query"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/responses/emptyResponse"
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/logout/api": {
      "delete": {
        "description": "Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully\nrevoked, the server returns a 204 No Content response. A 204 No Content response is also sent when\nthe Ory Session Token has been revoked already before.\n\nIf the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned.\n\nThis endpoint does not remove any HTTP\nCookies - use the Browser-Based Self-Service Logout Flow instead.",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Perform Logout for Native Apps",
        "operationId": "performNativeLogout",
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/performNativeLogoutBody"
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/logout/browser": {
      "get": {
        "description": "This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user.\n\nThis endpoint is NOT INTENDED for API clients and only works\nwith browsers (Chrome, Firefox, ...). For API clients you can\ncall the `/self-service/logout/api` URL directly with the Ory Session Token.\n\nThe URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns\na 401 error.\n\nWhen calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create a Logout URL for Browsers",
        "operationId": "createBrowserLogoutFlow",
        "parameters": [
          {
            "type": "string",
            "description": "HTTP Cookies\n\nIf you call this endpoint from a backend, please include the\noriginal Cookie header in the request.",
            "name": "cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "logoutFlow",
            "schema": {
              "$ref": "#/definitions/logoutFlow"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "500": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/recovery": {
      "post": {
        "description": "Use this endpoint to complete a recovery flow. This endpoint\nbehaves differently for API and browser flows and has several states:\n\n`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent\nand works with API- and Browser-initiated flows.\nFor API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid.\nand a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired).\nFor Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended.\n`sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It\nworks for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state.\n`passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\")\ndoes not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL\n(if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with\na new Recovery Flow ID which contains an error message that the recovery link was invalid.\n\nMore information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).",
        "consumes": [
          "application/json",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Complete Recovery Flow",
        "operationId": "updateRecoveryFlow",
        "parameters": [
          {
            "type": "string",
            "description": "The Recovery Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/recovery?flow=abcde`).",
            "name": "flow",
            "in": "query",
            "required": true
          },
          {
            "type": "string",
            "description": "Recovery Token\n\nThe recovery token which completes the recovery request. If the token\nis invalid (e.g. expired) an error will be shown to the end-user.\n\nThis parameter is usually set in a link and not used by any direct API call.",
            "name": "token",
            "in": "query"
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/updateRecoveryFlowBody"
            }
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "recoveryFlow",
            "schema": {
              "$ref": "#/definitions/recoveryFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "recoveryFlow",
            "schema": {
              "$ref": "#/definitions/recoveryFlow"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "422": {
            "description": "errorBrowserLocationChangeRequired",
            "schema": {
              "$ref": "#/definitions/errorBrowserLocationChangeRequired"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/recovery/api": {
      "get": {
        "description": "This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on.\n\nIf a valid provided session cookie or session token is provided, a 400 Bad Request error.\n\nTo fetch an existing recovery flow call `/self-service/recovery/flows?flow=\u003cflow_id\u003e`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make\nyou vulnerable to a variety of CSRF attacks.\n\nThis endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).\n\nMore information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Recovery Flow for Native Apps",
        "operationId": "createNativeRecoveryFlow",
        "responses": {
          "200": {
            "description": "recoveryFlow",
            "schema": {
              "$ref": "#/definitions/recoveryFlow"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/recovery/browser": {
      "get": {
        "description": "This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to\n`selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session\nexists, the browser is returned to the configured return URL.\n\nIf this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects\nor a 400 bad request error if the user is already authenticated.\n\nThis endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.\n\nMore information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Recovery Flow for Browsers",
        "operationId": "createBrowserRecoveryFlow",
        "parameters": [
          {
            "type": "string",
            "description": "The URL to return the browser to after the flow was completed.",
            "name": "return_to",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "recoveryFlow",
            "schema": {
              "$ref": "#/definitions/recoveryFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/recovery/flows": {
      "get": {
        "description": "This endpoint returns a recovery flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code example\nrouter.get('/recovery', async function (req, res) {\nconst flow = await client.getRecoveryFlow(req.header('Cookie'), req.query['flow'])\n\nres.render('recovery', flow)\n})\n```\n\nMore information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get Recovery Flow",
        "operationId": "getRecoveryFlow",
        "parameters": [
          {
            "type": "string",
            "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`).",
            "name": "id",
            "in": "query",
            "required": true
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "recoveryFlow",
            "schema": {
              "$ref": "#/definitions/recoveryFlow"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/registration": {
      "post": {
        "description": "Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint\nbehaves differently for API and browser flows.\n\nAPI flows expect `application/json` to be sent in the body and respond with\nHTTP 200 and a application/json body with the created identity success - if the session hook is configured the\n`session` and `session_token` will also be included;\nHTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;\nHTTP 400 on form validation errors.\n\nBrowser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with\na HTTP 303 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded;\na HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise.\n\nBrowser flows with an accept header of `application/json` will not redirect but instead respond with\nHTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;\nHTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;\nHTTP 400 on form validation errors.\n\nIf this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`session_already_available`: The user is already signed in.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!\n`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.\nMost likely used in Social Sign In flows.\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "consumes": [
          "application/json",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Update Registration Flow",
        "operationId": "updateRegistrationFlow",
        "parameters": [
          {
            "type": "string",
            "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`).",
            "name": "flow",
            "in": "query",
            "required": true
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/updateRegistrationFlowBody"
            }
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "successfulNativeRegistration",
            "schema": {
              "$ref": "#/definitions/successfulNativeRegistration"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "registrationFlow",
            "schema": {
              "$ref": "#/definitions/registrationFlow"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "422": {
            "description": "errorBrowserLocationChangeRequired",
            "schema": {
              "$ref": "#/definitions/errorBrowserLocationChangeRequired"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/registration/api": {
      "get": {
        "description": "This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on.\n\nIf a valid provided session cookie or session token is provided, a 400 Bad Request error\nwill be returned unless the URL query parameter `?refresh=true` is set.\n\nTo fetch an existing registration flow call `/self-service/registration/flows?flow=\u003cflow_id\u003e`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make\nyou vulnerable to a variety of CSRF attacks.\n\nIn the case of an error, the `error.id` of the JSON response body can be one of:\n\n`session_already_available`: The user is already signed in.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n\nThis endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Registration Flow for Native Apps",
        "operationId": "createNativeRegistrationFlow",
        "parameters": [
          {
            "type": "boolean",
            "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.",
            "name": "return_session_token_exchange_code",
            "in": "query"
          },
          {
            "type": "string",
            "description": "The URL to return the browser to after the flow was completed.",
            "name": "return_to",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "registrationFlow",
            "schema": {
              "$ref": "#/definitions/registrationFlow"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/registration/browser": {
      "get": {
        "description": "This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate\ncookies and anti-CSRF measures required for browser-based flows.\n\n:::info\n\nThis endpoint is EXPERIMENTAL and subject to potential breaking changes in the future.\n\n:::\n\nIf this endpoint is opened as a link in the browser, it will be redirected to\n`selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session\nexists already, the browser will be redirected to `urls.default_redirect_url`.\n\nIf this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`session_already_available`: The user is already signed in.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!\n\nIf this endpoint is called via an AJAX request, the response contains the registration flow without a redirect.\n\nThis endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Registration Flow for Browsers",
        "operationId": "createBrowserRegistrationFlow",
        "parameters": [
          {
            "type": "string",
            "description": "The URL to return the browser to after the flow was completed.",
            "name": "return_to",
            "in": "query"
          },
          {
            "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.",
            "name": "login_challenge",
            "in": "query"
          },
          {
            "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.",
            "name": "after_verification_return_to",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "registrationFlow",
            "schema": {
              "$ref": "#/definitions/registrationFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/registration/flows": {
      "get": {
        "description": "This endpoint returns a registration flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code example\nrouter.get('/registration', async function (req, res) {\nconst flow = await client.getRegistrationFlow(req.header('cookie'), req.query['flow'])\n\nres.render('registration', flow)\n})\n```\n\nThis request may fail due to several reasons. The `error.id` can be one of:\n\n`session_already_available`: The user is already signed in.\n`self_service_flow_expired`: The flow is expired and you should request a new one.\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get Registration Flow",
        "operationId": "getRegistrationFlow",
        "parameters": [
          {
            "type": "string",
            "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`).",
            "name": "id",
            "in": "query",
            "required": true
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "registrationFlow",
            "schema": {
              "$ref": "#/definitions/registrationFlow"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/settings": {
      "post": {
        "security": [
          {
            "sessionToken": []
          }
        ],
        "description": "Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint\nbehaves differently for API and browser flows.\n\nAPI-initiated flows expect `application/json` to be sent in the body and respond with\nHTTP 200 and an application/json body with the session token on success;\nHTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set;\nHTTP 400 on form validation errors.\nHTTP 401 when the endpoint is called without a valid session token.\nHTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.\nImplies that the user needs to re-authenticate.\n\nBrowser flows without HTTP Header `Accept` or with `Accept: text/*` respond with\na HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded;\na HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise.\na HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.\n\nBrowser flows with HTTP Header `Accept: application/json` respond with\nHTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;\nHTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;\nHTTP 401 when the endpoint is called without a valid session cookie.\nHTTP 403 when the page is accessed without a session cookie or the session's AAL is too low.\nHTTP 400 on form validation errors.\n\nDepending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator\nAssurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn\ncredentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user\nto sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.\n\nIf this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect\nthe identity to the login init endpoint with query parameters `?refresh=true\u0026return_to=\u003cthe-current-browser-url\u003e`,\nor initiate a refresh login flow otherwise.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`session_inactive`: No Ory Session was found - sign in a user first.\n`security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other\nidentity logged in instead.\n`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!\n`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.\nMost likely used in Social Sign In flows.\n\nMore information can be found at [Ory Kratos User Settings \u0026 Profile Management Documentation](../self-service/flows/user-settings).",
        "consumes": [
          "application/json",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Complete Settings Flow",
        "operationId": "updateSettingsFlow",
        "parameters": [
          {
            "type": "string",
            "description": "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`).",
            "name": "flow",
            "in": "query",
            "required": true
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/updateSettingsFlowBody"
            }
          },
          {
            "type": "string",
            "description": "The Session Token of the Identity performing the settings flow.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "settingsFlow",
            "schema": {
              "$ref": "#/definitions/settingsFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "settingsFlow",
            "schema": {
              "$ref": "#/definitions/settingsFlow"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "422": {
            "description": "errorBrowserLocationChangeRequired",
            "schema": {
              "$ref": "#/definitions/errorBrowserLocationChangeRequired"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/settings/api": {
      "get": {
        "description": "This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on.\nYou must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK.\n\nTo fetch an existing settings flow call `/self-service/settings/flows?flow=\u003cflow_id\u003e`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make\nyou vulnerable to a variety of CSRF attacks.\n\nDepending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator\nAssurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn\ncredentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user\nto sign in with the second factor or change the configuration.\n\nIn the case of an error, the `error.id` of the JSON response body can be one of:\n\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`session_inactive`: No Ory Session was found - sign in a user first.\n\nThis endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).\n\nMore information can be found at [Ory Kratos User Settings \u0026 Profile Management Documentation](../self-service/flows/user-settings).",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Settings Flow for Native Apps",
        "operationId": "createNativeSettingsFlow",
        "parameters": [
          {
            "type": "string",
            "description": "The Session Token of the Identity performing the settings flow.",
            "name": "X-Session-Token",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "settingsFlow",
            "schema": {
              "$ref": "#/definitions/settingsFlow"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/settings/browser": {
      "get": {
        "description": "This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to\n`selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid\nOry Kratos Session Cookie is included in the request, a login flow will be initialized.\n\nIf this endpoint is opened as a link in the browser, it will be redirected to\n`selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session\nwas set, the browser will be redirected to the login endpoint.\n\nIf this endpoint is called via an AJAX request, the response contains the settings flow without any redirects\nor a 401 forbidden error if no valid session was set.\n\nDepending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator\nAssurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn\ncredentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user\nto sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.\n\nIf this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`session_inactive`: No Ory Session was found - sign in a user first.\n`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!\n\nThis endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.\n\nMore information can be found at [Ory Kratos User Settings \u0026 Profile Management Documentation](../self-service/flows/user-settings).",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Settings Flow for Browsers",
        "operationId": "createBrowserSettingsFlow",
        "parameters": [
          {
            "type": "string",
            "description": "The URL to return the browser to after the flow was completed.",
            "name": "return_to",
            "in": "query"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "settingsFlow",
            "schema": {
              "$ref": "#/definitions/settingsFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/settings/flows": {
      "get": {
        "description": "When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie\nor the Ory Kratos Session Token are set.\n\nDepending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator\nAssurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn\ncredentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user\nto sign in with the second factor or change the configuration.\n\nYou can access this endpoint without credentials when using Ory Kratos' Admin API.\n\nIf this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`session_inactive`: No Ory Session was found - sign in a user first.\n`security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other\nidentity logged in instead.\n\nMore information can be found at [Ory Kratos User Settings \u0026 Profile Management Documentation](../self-service/flows/user-settings).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get Settings Flow",
        "operationId": "getSettingsFlow",
        "parameters": [
          {
            "type": "string",
            "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`).",
            "name": "id",
            "in": "query",
            "required": true
          },
          {
            "type": "string",
            "description": "The Session Token\n\nWhen using the SDK in an app without a browser, please include the\nsession token here.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "settingsFlow",
            "schema": {
              "$ref": "#/definitions/settingsFlow"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/verification": {
      "post": {
        "description": "Use this endpoint to complete a verification flow. This endpoint\nbehaves differently for API and browser flows and has several states:\n\n`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent\nand works with API- and Browser-initiated flows.\nFor API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid\nand a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired).\nFor Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended.\n`sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It\nworks for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state.\n`passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\")\ndoes not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL\n(if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with\na new Verification Flow ID which contains an error message that the verification link was invalid.\n\nMore information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).",
        "consumes": [
          "application/json",
          "application/x-www-form-urlencoded"
        ],
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Complete Verification Flow",
        "operationId": "updateVerificationFlow",
        "parameters": [
          {
            "type": "string",
            "description": "The Verification Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/verification?flow=abcde`).",
            "name": "flow",
            "in": "query",
            "required": true
          },
          {
            "type": "string",
            "description": "Verification Token\n\nThe verification token which completes the verification request. If the token\nis invalid (e.g. expired) an error will be shown to the end-user.\n\nThis parameter is usually set in a link and not used by any direct API call.",
            "name": "token",
            "in": "query"
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/updateVerificationFlowBody"
            }
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "verificationFlow",
            "schema": {
              "$ref": "#/definitions/verificationFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "verificationFlow",
            "schema": {
              "$ref": "#/definitions/verificationFlow"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/verification/api": {
      "get": {
        "description": "This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on.\n\nTo fetch an existing verification flow call `/self-service/verification/flows?flow=\u003cflow_id\u003e`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make\nyou vulnerable to a variety of CSRF attacks.\n\nThis endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).\n\nMore information can be found at [Ory Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Verification Flow for Native Apps",
        "operationId": "createNativeVerificationFlow",
        "responses": {
          "200": {
            "description": "verificationFlow",
            "schema": {
              "$ref": "#/definitions/verificationFlow"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/verification/browser": {
      "get": {
        "description": "This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to\n`selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`.\n\nIf this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects.\n\nThis endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...).\n\nMore information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Create Verification Flow for Browser Clients",
        "operationId": "createBrowserVerificationFlow",
        "parameters": [
          {
            "type": "string",
            "description": "The URL to return the browser to after the flow was completed.",
            "name": "return_to",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "verificationFlow",
            "schema": {
              "$ref": "#/definitions/verificationFlow"
            }
          },
          "303": {
            "$ref": "#/responses/emptyResponse"
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/self-service/verification/flows": {
      "get": {
        "description": "This endpoint returns a verification flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code example\nrouter.get('/recovery', async function (req, res) {\nconst flow = await client.getVerificationFlow(req.header('cookie'), req.query['flow'])\n\nres.render('verification', flow)\n})\n```\n\nMore information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get Verification Flow",
        "operationId": "getVerificationFlow",
        "parameters": [
          {
            "type": "string",
            "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`).",
            "name": "id",
            "in": "query",
            "required": true
          },
          {
            "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.",
            "name": "cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "verificationFlow",
            "schema": {
              "$ref": "#/definitions/verificationFlow"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/sessions": {
      "get": {
        "description": "This endpoints returns all other active sessions that belong to the logged-in user.\nThe current session can be retrieved by calling the `/sessions/whoami` endpoint.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Get My Active Sessions",
        "operationId": "listMySessions",
        "parameters": [
          {
            "maximum": 1000,
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 250,
            "description": "Items per Page\n\nThis is the number of items per page.",
            "name": "per_page",
            "in": "query"
          },
          {
            "minimum": 1,
            "type": "integer",
            "format": "int64",
            "default": 1,
            "description": "Pagination Page\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.",
            "name": "page",
            "in": "query"
          },
          {
            "type": "string",
            "description": "Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/responses/listMySessions"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      },
      "delete": {
        "description": "Calling this endpoint invalidates all except the current session that belong to the logged-in user.\nSession data are not deleted.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Disable my other sessions",
        "operationId": "disableMyOtherSessions",
        "parameters": [
          {
            "type": "string",
            "description": "Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "deleteMySessionsCount",
            "schema": {
              "$ref": "#/definitions/deleteMySessionsCount"
            }
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/sessions/token-exchange": {
      "get": {
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Exchange Session Token",
        "operationId": "exchangeSessionToken",
        "parameters": [
          {
            "type": "string",
            "description": "The part of the code return when initializing the flow.",
            "name": "init_code",
            "in": "query",
            "required": true
          },
          {
            "type": "string",
            "description": "The part of the code returned by the return_to URL.",
            "name": "return_to_code",
            "in": "query",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "successfulNativeLogin",
            "schema": {
              "$ref": "#/definitions/successfulNativeLogin"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "404": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "410": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/sessions/whoami": {
      "get": {
        "description": "Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated.\nReturns a session object in the body or 401 if the credentials are invalid or no credentials were sent.\nWhen the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header\nin the response.\n\nIf you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:\n\n```js\npseudo-code example\nrouter.get('/protected-endpoint', async function (req, res) {\nconst session = await client.toSession(undefined, req.header('cookie'))\n\nconsole.log(session)\n})\n```\n\nWhen calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token:\n\n```js\npseudo-code example\n...\nconst session = await client.toSession(\"the-session-token\")\n\nconsole.log(session)\n```\n\nDepending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator\nAssurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn\ncredentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user\nto sign in with the second factor or change the configuration.\n\nThis endpoint is useful for:\n\nAJAX calls. Remember to send credentials and set up CORS correctly!\nReverse proxies and API Gateways\nServer-side calls - use the `X-Session-Token` header!\n\nThis endpoint authenticates users by checking:\n\nif the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie;\nif the `Authorization: bearer \u003cory-session-token\u003e` HTTP header was set with a valid Ory Kratos Session Token;\nif the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token.\n\nIf none of these headers are set or the cooke or token are invalid, the endpoint returns a HTTP 401 status code.\n\nAs explained above, this request may fail due to several reasons. The `error.id` can be one of:\n\n`session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token).\n`session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.",
        "produces": [
          "application/json"
        ],
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Check Who the Current HTTP Session Belongs To",
        "operationId": "toSession",
        "parameters": [
          {
            "type": "string",
            "description": "Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "200": {
            "description": "session",
            "schema": {
              "$ref": "#/definitions/session"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "403": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/sessions/{id}": {
      "delete": {
        "description": "Calling this endpoint invalidates the specified session. The current session cannot be revoked.\nSession data are not deleted.",
        "schemes": [
          "http",
          "https"
        ],
        "tags": [
          "frontend"
        ],
        "summary": "Disable one of my sessions",
        "operationId": "disableMySession",
        "parameters": [
          {
            "type": "string",
            "description": "ID is the session's ID.",
            "name": "id",
            "in": "path",
            "required": true
          },
          {
            "type": "string",
            "description": "Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.",
            "name": "X-Session-Token",
            "in": "header"
          },
          {
            "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.",
            "name": "Cookie",
            "in": "header"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/responses/emptyResponse"
          },
          "400": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "401": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          },
          "default": {
            "description": "errorGeneric",
            "schema": {
              "$ref": "#/definitions/errorGeneric"
            }
          }
        }
      }
    },
    "/version": {
      "get": {
        "description": "This endpoint returns the service version typically notated using semantic versioning.\n\nIf the service supports TLS Edge Termination, this endpoint does not require the\n`X-Forwarded-Proto` header to be set.\n\nBe aware that if you are running multiple nodes of this service, the health status will never\nrefer to the cluster state, only to a single instance.",
        "produces": [
          "application/json"
        ],
        "tags": [
          "version"
        ],
        "summary": "Get service version",
        "operationId": "getVersion",
        "responses": {
          "200": {
            "description": "version",
            "schema": {
              "$ref": "#/definitions/version"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "DefaultError": {},
    "Duration": {
      "description": "A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.",
      "type": "integer",
      "format": "int64"
    },
    "ID": {
      "type": "integer",
      "format": "int64"
    },
    "JSONRawMessage": {
      "type": "object",
      "title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger."
    },
    "OAuth2Client": {
      "type": "object",
      "title": "OAuth2Client 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.",
      "properties": {
        "allowed_cors_origins": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "audience": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "authorization_code_grant_access_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "authorization_code_grant_id_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "authorization_code_grant_refresh_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "backchannel_logout_session_required": {
          "description": "OpenID Connect Back-Channel Logout Session Required  Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.",
          "type": "boolean"
        },
        "backchannel_logout_uri": {
          "description": "OpenID Connect Back-Channel Logout URI  RP 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": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "client_id": {
          "description": "OAuth 2.0 Client ID  The ID is autogenerated and immutable.",
          "type": "string"
        },
        "client_name": {
          "description": "OAuth 2.0 Client Name  The human-readable name of the client to be presented to the end-user during authorization.",
          "type": "string"
        },
        "client_secret": {
          "description": "OAuth 2.0 Client Secret  The secret will be included in the create request as cleartext, and then never 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  The field is currently not supported and its value is always 0.",
          "type": "integer",
          "format": "int64"
        },
        "client_uri": {
          "description": "OAuth 2.0 Client URI  ClientURI is a URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.",
          "type": "string"
        },
        "contacts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "created_at": {
          "description": "OAuth 2.0 Client Creation Date  CreatedAt returns the timestamp of the client's creation.",
          "type": "string",
          "format": "date-time"
        },
        "frontchannel_logout_session_required": {
          "description": "OpenID Connect Front-Channel Logout Session Required  Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.",
          "type": "boolean"
        },
        "frontchannel_logout_uri": {
          "description": "OpenID Connect Front-Channel Logout URI  RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.",
          "type": "string"
        },
        "grant_types": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "implicit_grant_access_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "implicit_grant_id_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "jwks": {
          "description": "OAuth 2.0 Client JSON Web Key Set  Client's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks parameters MUST NOT be used together."
        },
        "jwks_uri": {
          "description": "OAuth 2.0 Client JSON Web Key Set URL  URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.",
          "type": "string"
        },
        "jwt_bearer_grant_access_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "logo_uri": {
          "description": "OAuth 2.0 Client Logo URI  A URL string referencing the client's logo.",
          "type": "string"
        },
        "metadata": {
        },
        "owner": {
          "description": "OAuth 2.0 Client Owner  Owner is a string identifying the owner of the OAuth 2.0 Client.",
          "type": "string"
        },
        "policy_uri": {
          "description": "OAuth 2.0 Client Policy URI  PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.",
          "type": "string"
        },
        "post_logout_redirect_uris": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "redirect_uris": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "refresh_token_grant_access_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "refresh_token_grant_id_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "refresh_token_grant_refresh_token_lifespan": {
          "description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
          "type": "string"
        },
        "registration_access_token": {
          "description": "OpenID Connect Dynamic Client Registration Access Token  RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration.",
          "type": "string"
        },
        "registration_client_uri": {
          "description": "OpenID Connect Dynamic Client Registration URL  RegistrationClientURI 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  JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.",
          "type": "string"
        },
        "request_uris": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "response_types": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "scope": {
          "description": "OAuth 2.0 Client Scope  Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.",
          "type": "string"
        },
        "sector_identifier_uri": {
          "description": "OpenID Connect Sector Identifier URI  URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.",
          "type": "string"
        },
        "subject_type": {
          "description": "OpenID Connect Subject Type  The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.",
          "type": "string"
        },
        "token_endpoint_auth_method": {
          "description": "OAuth 2.0 Token Endpoint Authentication Method  Requested Client Authentication method for the Token Endpoint. The options are:  `client_secret_post`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `client_secret_basic`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `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  Requested Client Authentication signing algorithm for the Token Endpoint.",
          "type": "string"
        },
        "tos_uri": {
          "description": "OAuth 2.0 Client Terms of Service URI  A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.",
          "type": "string"
        },
        "updated_at": {
          "description": "OAuth 2.0 Client Last Update Date  UpdatedAt returns the timestamp of the last update.",
          "type": "string",
          "format": "date-time"
        },
        "userinfo_signed_response_alg": {
          "description": "OpenID Connect Request Userinfo Signed Response Algorithm  JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.",
          "type": "string"
        }
      }
    },
    "OAuth2ConsentRequestOpenIDConnectContext": {
      "description": "OAuth2ConsentRequestOpenIDConnectContext struct for OAuth2ConsentRequestOpenIDConnectContext",
      "type": "object",
      "properties": {
        "acr_values": {
          "description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.  OpenID Connect defines it as follows: \u003e Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "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. The defined values are: page: 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. popup: 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. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \\\"feature phone\\\" type display.  The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.",
          "type": "string"
        },
        "id_token_hint_claims": {
          "description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client.",
          "type": "object",
          "additionalProperties": {}
        },
        "login_hint": {
          "description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone 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 space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value \\\"fr-CA fr en\\\" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "OAuth2LoginRequest": {
      "description": "OAuth2LoginRequest struct for OAuth2LoginRequest",
      "type": "object",
      "properties": {
        "challenge": {
          "description": "ID is the identifier (\\\"login challenge\\\") of the login request. It is used to identify the session.",
          "type": "string"
        },
        "client": {
          "$ref": "#/definitions/OAuth2Client"
        },
        "oidc_context": {
          "$ref": "#/definitions/OAuth2ConsentRequestOpenIDConnectContext"
        },
        "request_url": {
          "description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.",
          "type": "string"
        },
        "requested_access_token_audience": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "requested_scope": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "session_id": {
          "description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the \\\"sid\\\" parameter in the ID Token and in OIDC Front-/Back- channel 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. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL.  This 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 requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail.",
          "type": "string"
        }
      }
    },
    "RecoveryAddressType": {
      "type": "string",
      "title": "RecoveryAddressType must not exceed 16 characters as that is the limitation in the SQL Schema."
    },
    "UUID": {"type": "string", "format": "uuid4"},
    "authenticatorAssuranceLevel": {
      "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.sh/kratos/docs/concepts/credentials",
      "type": "string",
      "title": "Authenticator Assurance Level (AAL)"
    },
    "batchPatchIdentitiesResponse": {
      "description": "Patch identities response",
      "type": "object",
      "properties": {
        "identities": {
          "description": "The patch responses for the individual identities.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/identityPatchResponse"
          }
        }
      }
    },
    "continueWith": {
    },
    "continueWithSetOrySessionToken": {
      "description": "Indicates that a session was issued, and the application should use this token for authenticated requests",
      "type": "object",
      "required": [
        "action",
        "ory_session_token"
      ],
      "properties": {
        "action": {
          "description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionToken\nshow_verification_ui ContinueWithActionShowVerificationUI",
          "type": "string",
          "enum": [
            "set_ory_session_token",
            "show_verification_ui"
          ],
          "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionToken\nshow_verification_ui ContinueWithActionShowVerificationUI"
        },
        "ory_session_token": {
          "description": "Token is the token of the session",
          "type": "string"
        }
      }
    },
    "continueWithVerificationUi": {
      "description": "Indicates, that the UI flow could be continued by showing a verification ui",
      "type": "object",
      "required": [
        "action",
        "flow"
      ],
      "properties": {
        "action": {
          "description": "Action will always be `show_verification_ui`\nset_ory_session_token ContinueWithActionSetOrySessionToken\nshow_verification_ui ContinueWithActionShowVerificationUI",
          "type": "string",
          "enum": [
            "set_ory_session_token",
            "show_verification_ui"
          ],
          "x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionToken\nshow_verification_ui ContinueWithActionShowVerificationUI"
        },
        "flow": {
          "$ref": "#/definitions/continueWithVerificationUiFlow"
        }
      }
    },
    "continueWithVerificationUiFlow": {
      "type": "object",
      "required": [
        "id",
        "verifiable_address"
      ],
      "properties": {
        "id": {
          "description": "The ID of the verification flow",
          "type": "string",
          "format": "uuid"
        },
        "url": {
          "description": "The URL of the verification flow",
          "type": "string"
        },
        "verifiable_address": {
          "description": "The address that should be verified in this flow",
          "type": "string"
        }
      }
    },
    "courierMessageStatus": {
      "description": "A Message's Status",
      "type": "integer",
      "format": "int64"
    },
    "courierMessageType": {
      "description": "It can either be `email` or `phone`",
      "type": "integer",
      "format": "int64",
      "title": "A Message's Type"
    },
    "createIdentityBody": {
      "description": "Create Identity Body",
      "type": "object",
      "required": [
        "schema_id",
        "traits"
      ],
      "properties": {
        "credentials": {
          "$ref": "#/definitions/identityWithCredentials"
        },
        "metadata_admin": {
          "description": "Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/\u003cid\u003e`.",
          "type": "object"
        },
        "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.",
          "type": "object"
        },
        "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.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/recoveryIdentityAddress"
          }
        },
        "schema_id": {
          "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.",
          "type": "string"
        },
        "state": {
          "$ref": "#/definitions/identityState"
        },
        "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.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/verifiableIdentityAddress"
          }
        }
      }
    },
    "createRecoveryCodeForIdentityBody": {
      "description": "Create Recovery Code for Identity Request Body",
      "type": "object",
      "required": [
        "identity_id"
      ],
      "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`.",
          "type": "string",
          "pattern": "^([0-9]+(ns|us|ms|s|m|h))*$"
        },
        "identity_id": {
          "description": "Identity to Recover\n\nThe identity's ID you wish to recover.",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "createRecoveryLinkForIdentityBody": {
      "description": "Create Recovery Link for Identity Request Body",
      "type": "object",
      "required": [
        "identity_id"
      ],
      "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`.",
          "type": "string",
          "pattern": "^[0-9]+(ns|us|ms|s|m|h)$"
        },
        "identity_id": {
          "description": "Identity to Recover\n\nThe identity's ID you wish to recover.",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "deleteMySessionsCount": {
      "description": "Deleted Session Count",
      "type": "object",
      "properties": {
        "count": {
          "description": "The number of sessions that were revoked.",
          "type": "integer",
          "format": "int64"
        }
      }
    },
    "errorAuthenticatorAssuranceLevelNotSatisfied": {
      "type": "object",
      "title": "Is returned when an active session was found but the requested AAL is not satisfied.",
      "properties": {
        "error": {
          "$ref": "#/definitions/genericError"
        },
        "redirect_browser_to": {
          "description": "Points to where to redirect the user to next.",
          "type": "string"
        }
      }
    },
    "errorBrowserLocationChangeRequired": {
      "type": "object",
      "title": "Is sent when a flow requires a browser to change its location.",
      "properties": {
        "error": {
          "$ref": "#/definitions/errorGeneric"
        },
        "redirect_browser_to": {
          "description": "Points to where to redirect the user to next.",
          "type": "string"
        }
      }
    },
    "errorFlowReplaced": {
      "description": "Is sent when a flow is replaced by a different flow of the same class",
      "type": "object",
      "properties": {
        "error": {
          "$ref": "#/definitions/genericError"
        },
        "use_flow_id": {
          "description": "The flow ID that should be used for the new flow as it contains the correct messages.",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "errorGeneric": {
      "description": "The standard Ory JSON API error format.",
      "type": "object",
      "title": "JSON API Error Response",
      "required": [
        "error"
      ],
      "properties": {
        "error": {
          "$ref": "#/definitions/genericError"
        }
      }
    },
    "flowError": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "created_at": {
          "description": "CreatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "error": {
          "description": "The error",
          "type": "object"
        },
        "id": {
          "description": "ID of the error container.",
          "type": "string",
          "format": "uuid"
        },
        "updated_at": {
          "description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "genericError": {
      "type": "object",
      "required": [
        "message"
      ],
      "properties": {
        "code": {
          "description": "The status code",
          "type": "integer",
          "format": "int64",
          "example": 404
        },
        "debug": {
          "description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.",
          "type": "string",
          "example": "SQL field \"foo\" is not a bool."
        },
        "details": {
          "description": "Further error details",
          "type": "object",
          "additionalProperties": {}
        },
        "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.",
          "type": "string",
          "example": "The resource could not be found"
        },
        "reason": {
          "description": "A human-readable reason for the error",
          "type": "string",
          "example": "User with ID 1234 does not exist."
        },
        "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.",
          "type": "string",
          "example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6"
        },
        "status": {
          "description": "The status description",
          "type": "string",
          "example": "Not Found"
        }
      }
    },
    "healthNotReadyStatus": {
      "type": "object",
      "properties": {
        "errors": {
          "description": "Errors contains a list of errors that caused the not ready status.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "healthStatus": {
      "type": "object",
      "properties": {
        "status": {
          "description": "Status always contains \"ok\".",
          "type": "string"
        }
      }
    },
    "identity": {
      "description": "An [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.",
      "type": "object",
      "title": "Identity represents an Ory Kratos identity",
      "required": [
        "id",
        "schema_id",
        "schema_url",
        "traits"
      ],
      "properties": {
        "created_at": {
          "description": "CreatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "credentials": {
          "description": "Credentials represents all credentials that can be used for authenticating this identity.",
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/identityCredentials"
          }
        },
        "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.",
          "type": "string",
          "format": "uuid"
        },
        "metadata_admin": {
          "$ref": "#/definitions/nullJsonRawMessage"
        },
        "metadata_public": {
          "$ref": "#/definitions/nullJsonRawMessage"
        },
        "recovery_addresses": {
          "description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/recoveryIdentityAddress"
          },
          "x-omitempty": true
        },
        "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": {
          "$ref": "#/definitions/identityState"
        },
        "state_changed_at": {
          "$ref": "#/definitions/nullTime"
        },
        "traits": {
          "$ref": "#/definitions/identityTraits"
        },
        "updated_at": {
          "description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "verifiable_addresses": {
          "description": "VerifiableAddresses contains all the addresses that can be verified by the user.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/verifiableIdentityAddress"
          },
          "x-omitempty": true
        }
      }
    },
    "identityCredentials": {
      "description": "Credentials represents a specific credential type",
      "type": "object",
      "properties": {
        "config": {
          "$ref": "#/definitions/JSONRawMessage"
        },
        "created_at": {
          "description": "CreatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "identifiers": {
          "description": "Identifiers represents a list of unique identifiers this credential type matches.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "type": {
          "$ref": "#/definitions/identityCredentialsType"
        },
        "updated_at": {
          "description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "version": {
          "description": "Version refers to the version of the credential. Useful when changing the config schema.",
          "type": "integer",
          "format": "int64"
        }
      }
    },
    "identityCredentialsOidc": {
      "type": "object",
      "title": "CredentialsOIDC is contains the configuration for credentials of the type oidc.",
      "properties": {
        "providers": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/identityCredentialsOidcProvider"
          }
        }
      }
    },
    "identityCredentialsOidcProvider": {
      "type": "object",
      "title": "CredentialsOIDCProvider is contains a specific OpenID COnnect credential for a particular connection (e.g. Google).",
      "properties": {
        "initial_access_token": {
          "type": "string"
        },
        "initial_id_token": {
          "type": "string"
        },
        "initial_refresh_token": {
          "type": "string"
        },
        "provider": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        }
      }
    },
    "identityCredentialsPassword": {
      "type": "object",
      "title": "CredentialsPassword is contains the configuration for credentials of the type password.",
      "properties": {
        "hashed_password": {
          "description": "HashedPassword is a hash-representation of the password.",
          "type": "string"
        }
      }
    },
    "identityCredentialsType": {
      "description": "and so on.",
      "type": "string",
      "title": "CredentialsType  represents several different credential types, like password credentials, passwordless credentials,"
    },
    "identityPatch": {
      "description": "Payload for patching an identity",
      "type": "object",
      "properties": {
        "create": {
          "$ref": "#/definitions/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.",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "identityPatchResponse": {
      "description": "Response for a single identity patch",
      "type": "object",
      "properties": {
        "action": {
          "description": "The action for this specific patch\ncreate ActionCreate  Create this identity.",
          "type": "string",
          "enum": [
            "create"
          ],
          "x-go-enum-desc": "create ActionCreate  Create this identity."
        },
        "identity": {
          "description": "The identity ID payload of this patch",
          "type": "string",
          "format": "uuid"
        },
        "patch_id": {
          "description": "The ID of this patch response, if an ID was specified in the patch.",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "identitySchema": {
      "description": "Raw JSON Schema",
      "type": "object"
    },
    "identitySchemaContainer": {
      "description": "An Identity JSON Schema Container",
      "type": "object",
      "properties": {
        "id": {
          "description": "The ID of the Identity JSON Schema",
          "type": "string"
        },
        "schema": {
          "description": "The actual Identity JSON Schema",
          "type": "object"
        }
      }
    },
    "identitySchemas": {
      "description": "List of Identity JSON Schemas",
      "type": "array",
      "items": {
        "$ref": "#/definitions/identitySchemaContainer"
      }
    },
    "identityState": {
      "description": "The state can either be `active` or `inactive`.",
      "type": "string",
      "title": "An Identity's State"
    },
    "identityTraits": {
      "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"
    },
    "identityVerifiableAddressStatus": {
      "description": "VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema",
      "type": "string"
    },
    "identityVerifiableAddressType": {
      "description": "VerifiableAddressType must not exceed 16 characters as that is the limitation in the SQL Schema",
      "type": "string"
    },
    "identityWithCredentials": {
      "description": "Create Identity and Import Credentials",
      "type": "object",
      "properties": {
        "oidc": {
          "$ref": "#/definitions/identityWithCredentialsOidc"
        },
        "password": {
          "$ref": "#/definitions/identityWithCredentialsPassword"
        }
      }
    },
    "identityWithCredentialsOidc": {
      "description": "Create Identity and Import Social Sign In Credentials",
      "type": "object",
      "properties": {
        "config": {
          "$ref": "#/definitions/identityWithCredentialsOidcConfig"
        }
      }
    },
    "identityWithCredentialsOidcConfig": {
      "type": "object",
      "properties": {
        "config": {
          "$ref": "#/definitions/identityWithCredentialsPasswordConfig"
        },
        "providers": {
          "description": "A list of OpenID Connect Providers",
          "type": "array",
          "items": {
            "$ref": "#/definitions/identityWithCredentialsOidcConfigProvider"
          }
        }
      }
    },
    "identityWithCredentialsOidcConfigProvider": {
      "description": "Create Identity and Import Social Sign In Credentials Configuration",
      "type": "object",
      "required": [
        "subject",
        "provider"
      ],
      "properties": {
        "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"
        }
      }
    },
    "identityWithCredentialsPassword": {
      "description": "Create Identity and Import Password Credentials",
      "type": "object",
      "properties": {
        "config": {
          "$ref": "#/definitions/identityWithCredentialsPasswordConfig"
        }
      }
    },
    "identityWithCredentialsPasswordConfig": {
      "description": "Create Identity and Import Password Credentials Configuration",
      "type": "object",
      "properties": {
        "hashed_password": {
          "description": "The hashed password in [PHC format]( https://www.ory.sh/docs/kratos/concepts/credentials/username-email-password#hashed-password-format)",
          "type": "string"
        },
        "password": {
          "description": "The password in plain text if no hash is available.",
          "type": "string"
        }
      }
    },
    "jsonPatch": {
      "description": "A JSONPatch document as defined by RFC 6902",
      "type": "object",
      "required": [
        "op",
        "path"
      ],
      "properties": {
        "from": {
          "description": "This field is used together with operation \"move\" and uses JSON Pointer notation.\n\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).",
          "type": "string",
          "example": "/name"
        },
        "op": {
          "description": "The operation to be performed. One of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\".",
          "type": "string",
          "example": "replace"
        },
        "path": {
          "description": "The path to the target path. Uses JSON pointer notation.\n\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).",
          "type": "string",
          "example": "/name"
        },
        "value": {
          "description": "The value to be used within the operations.\n\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).",
          "example": "foobar"
        }
      }
    },
    "jsonPatchDocument": {
      "description": "A JSONPatchDocument request",
      "type": "array",
      "items": {
        "$ref": "#/definitions/jsonPatch"
      }
    },
    "loginFlow": {
      "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.",
      "type": "object",
      "title": "Login Flow",
      "required": [
        "id",
        "type",
        "expires_at",
        "issued_at",
        "request_url",
        "ui"
      ],
      "properties": {
        "active": {
          "$ref": "#/definitions/identityCredentialsType"
        },
        "created_at": {
          "description": "CreatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "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.",
          "type": "string",
          "format": "date-time"
        },
        "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://\u003cselfservice.flows.login.ui_url\u003e/?flow=\u003cflow_id\u003e",
          "type": "string",
          "format": "uuid"
        },
        "issued_at": {
          "description": "IssuedAt is the time (UTC) when the flow started.",
          "type": "string",
          "format": "date-time"
        },
        "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": {
          "$ref": "#/definitions/OAuth2LoginRequest"
        },
        "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": {
          "$ref": "#/definitions/authenticatorAssuranceLevel"
        },
        "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"
        },
        "type": {
          "$ref": "#/definitions/selfServiceFlowType"
        },
        "ui": {
          "$ref": "#/definitions/uiContainer"
        },
        "updated_at": {
          "description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "logoutFlow": {
      "description": "Logout Flow",
      "type": "object",
      "required": [
        "logout_url",
        "logout_token"
      ],
      "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"
        }
      }
    },
    "message": {
      "type": "object",
      "required": [
        "id",
        "status",
        "type",
        "recipient",
        "body",
        "subject",
        "template_type",
        "send_count",
        "created_at",
        "updated_at"
      ],
      "properties": {
        "body": {
          "type": "string"
        },
        "created_at": {
          "description": "CreatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "dispatches": {
          "description": "Dispatches store information about the attempts of delivering a message\nMay contain an error if any happened, or just the `success` state.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/messageDispatch"
          }
        },
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "recipient": {
          "type": "string"
        },
        "send_count": {
          "type": "integer",
          "format": "int64"
        },
        "status": {
          "$ref": "#/definitions/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\notp TypeOTP\nstub TypeTestStub",
          "type": "string",
          "enum": [
            "recovery_invalid",
            "recovery_valid",
            "recovery_code_invalid",
            "recovery_code_valid",
            "verification_invalid",
            "verification_valid",
            "verification_code_invalid",
            "verification_code_valid",
            "otp",
            "stub"
          ],
          "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\notp TypeOTP\nstub TypeTestStub"
        },
        "type": {
          "$ref": "#/definitions/courierMessageType"
        },
        "updated_at": {
          "description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "messageDispatch": {
      "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",
      "type": "object",
      "required": [
        "id",
        "message_id",
        "status",
        "created_at",
        "updated_at"
      ],
      "properties": {
        "created_at": {
          "description": "CreatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "error": {
          "$ref": "#/definitions/JSONRawMessage"
        },
        "id": {
          "description": "The ID of this message dispatch",
          "type": "string",
          "format": "uuid"
        },
        "message_id": {
          "description": "The ID of the message being dispatched",
          "type": "string",
          "format": "uuid"
        },
        "status": {
          "description": "The status of this dispatch\nEither \"failed\" or \"success\"\nfailed CourierMessageDispatchStatusFailed\nsuccess CourierMessageDispatchStatusSuccess",
          "type": "string",
          "enum": [
            "failed",
            "success"
          ],
          "x-go-enum-desc": "failed CourierMessageDispatchStatusFailed\nsuccess CourierMessageDispatchStatusSuccess"
        },
        "updated_at": {
          "description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "needsPrivilegedSessionError": {
      "type": "object",
      "title": "Is sent when a privileged session is required to perform the settings update.",
      "required": [
        "redirect_browser_to"
      ],
      "properties": {
        "error": {
          "$ref": "#/definitions/genericError"
        },
        "redirect_browser_to": {
          "description": "Points to where to redirect the user to next.",
          "type": "string"
        }
      }
    },
    "nullJsonRawMessage": {
      "description": "NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-",
      "type": "object"
    },
    "nullTime": {
      "type": "string",
      "format": "date-time",
      "title": "NullTime implements sql.NullTime functionality."
    },
    "pagination": {
      "type": "object",
      "properties": {
        "page": {
          "description": "Pagination Page\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.",
          "type": "integer",
          "format": "int64",
          "default": 1,
          "minimum": 1
        },
        "per_page": {
          "description": "Items per Page\n\nThis is the number of items per page.",
          "type": "integer",
          "format": "int64",
          "default": 250,
          "maximum": 1000,
          "minimum": 1
        }
      }
    },
    "patchIdentitiesBody": {
      "description": "Patch Identities Body",
      "type": "object",
      "properties": {
        "identities": {
          "description": "Identities holds the list of patches to apply\n\nrequired",
          "type": "array",
          "items": {
            "$ref": "#/definitions/identityPatch"
          }
        }
      }
    },
    "performNativeLogoutBody": {
      "description": "Perform Native Logout Request Body",
      "type": "object",
      "required": [
        "session_token"
      ],
      "properties": {
        "session_token": {
          "description": "The Session Token\n\nInvalidate this session token.",
          "type": "string"
        }
      }
    },
    "recoveryCodeForIdentity": {
      "description": "Used when an administrator creates a recovery code for an identity.",
      "type": "object",
      "title": "Recovery Code for Identity",
      "required": [
        "recovery_link",
        "recovery_code"
      ],
      "properties": {
        "expires_at": {
          "description": "Expires At is the timestamp of when the recovery flow expires\n\nThe timestamp when the recovery link expires.",
          "type": "string",
          "format": "date-time"
        },
        "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"
        }
      }
    },
    "recoveryFlow": {
      "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)",
      "type": "object",
      "title": "A Recovery Flow",
      "required": [
        "id",
        "type",
        "expires_at",
        "issued_at",
        "request_url",
        "ui",
        "state"
      ],
      "properties": {
        "active": {
          "description": "Active, if set, contains the recovery 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 update the setting,\na new request has to be initiated.",
          "type": "string",
          "format": "date-time"
        },
        "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://\u003cselfservice.flows.recovery.ui_url\u003e?request=\u003cid\u003e",
          "type": "string",
          "format": "uuid"
        },
        "issued_at": {
          "description": "IssuedAt is the time (UTC) when the request occurred.",
          "type": "string",
          "format": "date-time"
        },
        "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": {
          "$ref": "#/definitions/recoveryFlowState"
        },
        "type": {
          "$ref": "#/definitions/selfServiceFlowType"
        },
        "ui": {
          "$ref": "#/definitions/uiContainer"
        }
      }
    },
    "recoveryFlowState": {
      "description": "The state represents the state of the recovery flow.\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.",
      "type": "string",
      "title": "Recovery Flow State"
    },
    "recoveryIdentityAddress": {
      "type": "object",
      "required": [
        "id",
        "value",
        "via"
      ],
      "properties": {
        "created_at": {
          "description": "CreatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "updated_at": {
          "description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
          "type": "string",
          "format": "date-time"
        },
        "value": {
          "type": "string"
        },
        "via": {
          "$ref": "#/definitions/RecoveryAddressType"
        }
      }
    },
    "recoveryLinkForIdentity": {
      "description": "Used when an administrator creates a recovery link for an identity.",
      "type": "object",
      "title": "Identity Recovery Link",
      "required": [
        "recovery_link"
      ],
      "properties": {
        "expires_at": {
          "description": "Recovery Link Expires At\n\nThe timestamp when the recovery link expires.",
          "type": "string",
          "format": "date-time"
        },
        "recovery_link": {
          "description": "Recovery Link\n\nThis link can be used to recover the account.",
          "type": "string"
        }
      }
    },
    "registrationFlow": {
      "type": "object",
      "required": [
        "id",
        "type",
        "expires_at",
        "issued_at",
        "request_url",
        "ui"
      ],
      "properties": {
        "active": {
          "$ref": "#/definitions/identityCredentialsType"
        },
        "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.",
          "type": "string",
          "format": "date-time"
        },
        "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://\u003cselfservice.flows.registration.ui_url\u003e/?flow=\u003cid\u003e",
          "type": "string",
          "format": "uuid"
        },
        "issued_at": {
          "description": "IssuedAt is the time (UTC) when the flow occurred.",
          "type": "string",
          "format": "date-time"
        },
        "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": {
          "$ref": "#/definitions/OAuth2LoginRequest"
        },
        "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"
        },
        "transient_payload": {
          "description": "TransientPayload is used to pass data from the registration to a webhook",
          "type": "object"
        },
        "type": {
          "$ref": "#/definitions/selfServiceFlowType"
        },
        "ui": {
          "$ref": "#/definitions/uiContainer"
        }
      }
    },
    "selfServiceFlowExpiredError": {
      "description": "Is sent when a flow is expired",
      "type": "object",
      "properties": {
        "error": {
          "$ref": "#/definitions/genericError"
        },
        "expired_at": {
          "description": "When the flow has expired",
          "type": "string",
          "format": "date-time"
        },
        "since": {
          "$ref": "#/definitions/Duration"
        },
        "use_flow_id": {
          "description": "The flow ID that should be used for the new flow as it contains the correct messages.",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "selfServiceFlowType": {
      "description": "The flow type can either be `api` or `browser`.",
      "type": "string",
      "title": "Type is the flow type."
    },
    "session": {
      "description": "A Session",
      "type": "object",
      "required": [
        "id",
        "identity"
      ],
      "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).",
          "type": "string",
          "format": "date-time"
        },
        "authentication_methods": {
          "$ref": "#/definitions/sessionAuthenticationMethods"
        },
        "authenticator_assurance_level": {
          "$ref": "#/definitions/authenticatorAssuranceLevel"
        },
        "devices": {
          "description": "Devices has history of all endpoints where the session was used",
          "type": "array",
          "items": {
            "$ref": "#/definitions/sessionDevice"
          }
        },
        "expires_at": {
          "description": "The Session Expiry\n\nWhen this session expires at.",
          "type": "string",
          "format": "date-time"
        },
        "id": {
          "description": "Session ID",
          "type": "string",
          "format": "uuid"
        },
        "identity": {
          "$ref": "#/definitions/identity"
        },
        "issued_at": {
          "description": "The Session Issuance Timestamp\n\nWhen this session was issued at. Usually equal or close to `authenticated_at`.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "sessionAuthenticationMethod": {
      "description": "A singular authenticator used during authentication / login.",
      "type": "object",
      "title": "AuthenticationMethod identifies an authentication method",
      "properties": {
        "aal": {
          "$ref": "#/definitions/authenticatorAssuranceLevel"
        },
        "completed_at": {
          "description": "When the authentication challenge was completed.",
          "type": "string",
          "format": "date-time"
        },
        "method": {
          "$ref": "#/definitions/identityCredentialsType"
        },
        "provider": {
          "description": "OIDC or SAML provider id used for authentication",
          "type": "string"
        }
      }
    },
    "sessionAuthenticationMethods": {
      "description": "A list of authenticators which were used to authenticate the session.",
      "type": "array",
      "title": "List of (Used) AuthenticationMethods",
      "items": {
        "$ref": "#/definitions/sessionAuthenticationMethod"
      }
    },
    "sessionDevice": {
      "description": "Device corresponding to a Session",
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "description": "Device record ID",
          "type": "string",
          "format": "uuid"
        },
        "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"
        }
      }
    },
    "settingsFlow": {
      "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)",
      "type": "object",
      "title": "Flow represents a Settings Flow",
      "required": [
        "id",
        "type",
        "expires_at",
        "issued_at",
        "request_url",
        "ui",
        "identity",
        "state"
      ],
      "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.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/continueWith"
          }
        },
        "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.",
          "type": "string",
          "format": "date-time"
        },
        "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://\u003cselfservice.flows.settings.ui_url\u003e?flow=\u003cid\u003e",
          "type": "string",
          "format": "uuid"
        },
        "identity": {
          "$ref": "#/definitions/identity"
        },
        "issued_at": {
          "description": "IssuedAt is the time (UTC) when the flow occurred.",
          "type": "string",
          "format": "date-time"
        },
        "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": {
          "$ref": "#/definitions/settingsFlowState"
        },
        "type": {
          "$ref": "#/definitions/selfServiceFlowType"
        },
        "ui": {
          "$ref": "#/definitions/uiContainer"
        }
      }
    },
    "settingsFlowState": {
      "description": "show_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.",
      "type": "string",
      "title": "State represents the state of this flow. It knows two states:"
    },
    "successfulCodeExchangeResponse": {
      "description": "The Response for Registration Flows via API",
      "type": "object",
      "required": [
        "session"
      ],
      "properties": {
        "session": {
          "$ref": "#/definitions/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"
        }
      }
    },
    "successfulNativeLogin": {
      "description": "The Response for Login Flows via API",
      "type": "object",
      "required": [
        "session"
      ],
      "properties": {
        "session": {
          "$ref": "#/definitions/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"
        }
      }
    },
    "successfulNativeRegistration": {
      "description": "The Response for Registration Flows via API",
      "type": "object",
      "required": [
        "identity"
      ],
      "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.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/continueWith"
          }
        },
        "identity": {
          "$ref": "#/definitions/identity"
        },
        "session": {
          "$ref": "#/definitions/session"
        },
        "session_token": {
          "description": "The Session Token\n\nThis field is only set when the session hook is configured as a post-registration hook.\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"
        }
      }
    },
    "tokenPagination": {
      "type": "object",
      "properties": {
        "page_size": {
          "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.sh/docs/ecosystem/api-design#pagination).",
          "type": "integer",
          "format": "int64",
          "default": 250,
          "maximum": 1000,
          "minimum": 1
        },
        "page_token": {
          "description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
          "type": "string",
          "default": "1",
          "minimum": 1
        }
      }
    },
    "tokenPaginationHeaders": {
      "type": "object",
      "properties": {
        "link": {
          "description": "The link header contains pagination links.\n\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).\n\nin: header",
          "type": "string"
        },
        "x-total-count": {
          "description": "The total number of clients.\n\nin: header",
          "type": "string"
        }
      }
    },
    "uiContainer": {
      "description": "Container represents a HTML Form. The container can work with both HTTP Form and JSON requests",
      "type": "object",
      "required": [
        "action",
        "method",
        "nodes"
      ],
      "properties": {
        "action": {
          "description": "Action should be used as the form action URL `\u003cform action=\"{{ .Action }}\" method=\"post\"\u003e`.",
          "type": "string"
        },
        "messages": {
          "$ref": "#/definitions/uiTexts"
        },
        "method": {
          "description": "Method is the form method (e.g. POST)",
          "type": "string"
        },
        "nodes": {
          "$ref": "#/definitions/uiNodes"
        }
      }
    },
    "uiNode": {
      "description": "Nodes are represented as HTML elements or their native UI equivalents. For example,\na node can be an `\u003cimg\u003e` tag, or an `\u003cinput element\u003e` but also `some plain text`.",
      "type": "object",
      "title": "Node represents a flow's nodes",
      "required": [
        "type",
        "group",
        "attributes",
        "messages",
        "meta"
      ],
      "properties": {
        "attributes": {
          "$ref": "#/definitions/uiNodeAttributes"
        },
        "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",
          "type": "string",
          "enum": [
            "default",
            "password",
            "oidc",
            "profile",
            "link",
            "code",
            "totp",
            "lookup_secret",
            "webauthn"
          ],
          "x-go-enum-desc": "default DefaultGroup\npassword PasswordGroup\noidc OpenIDConnectGroup\nprofile ProfileGroup\nlink LinkGroup\ncode CodeGroup\ntotp TOTPGroup\nlookup_secret LookupGroup\nwebauthn WebAuthnGroup"
        },
        "messages": {
          "$ref": "#/definitions/uiTexts"
        },
        "meta": {
          "$ref": "#/definitions/uiNodeMeta"
        },
        "type": {
          "description": "The node's type\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script",
          "type": "string",
          "enum": [
            "text",
            "input",
            "img",
            "a",
            "script"
          ],
          "x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script"
        }
      }
    },
    "uiNodeAnchorAttributes": {
      "type": "object",
      "title": "AnchorAttributes represents the attributes of an anchor node.",
      "required": [
        "href",
        "title",
        "id",
        "node_type"
      ],
      "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\".",
          "type": "string"
        },
        "title": {
          "$ref": "#/definitions/uiText"
        }
      }
    },
    "uiNodeAttributes": {
      "type": "object",
      "title": "Attributes represents a list of attributes (e.g. `href=\"foo\"` for links)."
    },
    "uiNodeImageAttributes": {
      "type": "object",
      "title": "ImageAttributes represents the attributes of an image node.",
      "required": [
        "src",
        "id",
        "width",
        "height",
        "node_type"
      ],
      "properties": {
        "height": {
          "description": "Height of the image",
          "type": "integer",
          "format": "int64"
        },
        "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\".",
          "type": "string"
        },
        "src": {
          "description": "The image's source URL.\n\nformat: uri",
          "type": "string"
        },
        "width": {
          "description": "Width of the image",
          "type": "integer",
          "format": "int64"
        }
      }
    },
    "uiNodeInputAttributes": {
      "description": "InputAttributes represents the attributes of an input node",
      "type": "object",
      "required": [
        "name",
        "type",
        "disabled",
        "node_type"
      ],
      "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",
          "type": "string",
          "enum": [
            "email",
            "tel",
            "url",
            "current-password",
            "new-password",
            "one-time-code"
          ],
          "x-go-enum-desc": "email InputAttributeAutocompleteEmail\ntel InputAttributeAutocompleteTel\nurl InputAttributeAutocompleteUrl\ncurrent-password InputAttributeAutocompleteCurrentPassword\nnew-password InputAttributeAutocompleteNewPassword\none-time-code InputAttributeAutocompleteOneTimeCode"
        },
        "disabled": {
          "description": "Sets the input's disabled field to true or false.",
          "type": "boolean"
        },
        "label": {
          "$ref": "#/definitions/uiText"
        },
        "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\".",
          "type": "string"
        },
        "onclick": {
          "description": "OnClick may contain javascript which should be executed on click. This is primarily\nused for WebAuthn.",
          "type": "string"
        },
        "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",
          "type": "string",
          "enum": [
            "text",
            "password",
            "number",
            "checkbox",
            "hidden",
            "email",
            "tel",
            "submit",
            "button",
            "datetime-local",
            "date",
            "url"
          ],
          "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."
        }
      }
    },
    "uiNodeMeta": {
      "description": "This might include a label and other information that can optionally\nbe used to render UIs.",
      "type": "object",
      "title": "A Node's Meta Information",
      "properties": {
        "label": {
          "$ref": "#/definitions/uiText"
        }
      }
    },
    "uiNodeScriptAttributes": {
      "type": "object",
      "title": "ScriptAttributes represent script nodes which load javascript.",
      "required": [
        "src",
        "async",
        "referrerpolicy",
        "crossorigin",
        "integrity",
        "type",
        "id",
        "nonce",
        "node_type"
      ],
      "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\".",
          "type": "string"
        },
        "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"
        }
      }
    },
    "uiNodeTextAttributes": {
      "type": "object",
      "title": "TextAttributes represents the attributes of a text node.",
      "required": [
        "text",
        "id",
        "node_type"
      ],
      "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\".",
          "type": "string"
        },
        "text": {
          "$ref": "#/definitions/uiText"
        }
      }
    },
    "uiNodes": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/uiNode"
      }
    },
    "uiText": {
      "type": "object",
      "required": [
        "id",
        "text",
        "type"
      ],
      "properties": {
        "context": {
          "description": "The message's context. Useful when customizing messages.",
          "type": "object"
        },
        "id": {
          "$ref": "#/definitions/ID"
        },
        "text": {
          "description": "The message text. Written in american english.",
          "type": "string"
        },
        "type": {
          "description": "The message type.\ninfo Info\nerror Error\nsuccess Success",
          "type": "string",
          "enum": [
            "info",
            "error",
            "success"
          ],
          "x-go-enum-desc": "info Info\nerror Error\nsuccess Success"
        }
      }
    },
    "uiTexts": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/uiText"
      }
    },
    "unexpectedError": {
      "type": "string"
    },
    "updateIdentityBody": {
      "description": "Update Identity Body",
      "type": "object",
      "required": [
        "schema_id",
        "traits",
        "state"
      ],
      "properties": {
        "credentials": {
          "$ref": "#/definitions/identityWithCredentials"
        },
        "metadata_admin": {
          "description": "Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/\u003cid\u003e`.",
          "type": "object"
        },
        "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.",
          "type": "object"
        },
        "schema_id": {
          "description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set\nwill update the Identity's SchemaID.",
          "type": "string"
        },
        "state": {
          "$ref": "#/definitions/identityState"
        },
        "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_id`.",
          "type": "object"
        }
      }
    },
    "updateLoginFlowBody": {
      "type": "object"
    },
    "updateLoginFlowWithLookupSecretMethod": {
      "description": "Update Login Flow with Lookup Secret Method",
      "type": "object",
      "required": [
        "method",
        "lookup_secret"
      ],
      "properties": {
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "lookup_secret": {
          "description": "The lookup secret.",
          "type": "string"
        },
        "method": {
          "description": "Method should be set to \"lookup_secret\" when logging in using the lookup_secret strategy.",
          "type": "string"
        }
      }
    },
    "updateLoginFlowWithOidcMethod": {
      "description": "Update Login Flow with OpenID Connect Method",
      "type": "object",
      "required": [
        "provider",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "The CSRF Token",
          "type": "string"
        },
        "method": {
          "description": "Method to use\n\nThis field must be set to `oidc` when using the oidc method.",
          "type": "string"
        },
        "provider": {
          "description": "The provider to register with",
          "type": "string"
        },
        "traits": {
          "description": "The identity traits. This is a placeholder for the registration flow.",
          "type": "object"
        },
        "upstream_parameters": {
          "description": "UpstreamParameters are the parameters that are passed to the upstream identity provider.\n\nThese parameters are optional and depend on what the upstream identity provider supports.\nSupported parameters are:\n`login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session.\n`hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`.\n`prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`.",
          "type": "object"
        }
      }
    },
    "updateLoginFlowWithPasswordMethod": {
      "description": "Update Login Flow with Password Method",
      "type": "object",
      "required": [
        "method",
        "password",
        "identifier"
      ],
      "properties": {
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "identifier": {
          "description": "Identifier is the email or username of the user trying to log in.",
          "type": "string"
        },
        "method": {
          "description": "Method should be set to \"password\" when logging in using the identifier and password strategy.",
          "type": "string"
        },
        "password": {
          "description": "The user's password.",
          "type": "string"
        },
        "password_identifier": {
          "description": "Identifier is the email or username of the user trying to log in.\nThis field is deprecated!",
          "type": "string"
        }
      }
    },
    "updateLoginFlowWithTotpMethod": {
      "description": "Update Login Flow with TOTP Method",
      "type": "object",
      "required": [
        "method",
        "totp_code"
      ],
      "properties": {
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "method": {
          "description": "Method should be set to \"totp\" when logging in using the TOTP strategy.",
          "type": "string"
        },
        "totp_code": {
          "description": "The TOTP code.",
          "type": "string"
        }
      }
    },
    "updateLoginFlowWithWebAuthnMethod": {
      "description": "Update Login Flow with WebAuthn Method",
      "type": "object",
      "required": [
        "identifier",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "identifier": {
          "description": "Identifier is the email or username of the user trying to log in.",
          "type": "string"
        },
        "method": {
          "description": "Method should be set to \"webAuthn\" when logging in using the WebAuthn strategy.",
          "type": "string"
        },
        "webauthn_login": {
          "description": "Login a WebAuthn Security Key\n\nThis must contain the ID of the WebAuthN connection.",
          "type": "string"
        }
      }
    },
    "updateRecoveryFlowBody": {
      "description": "Update Recovery Flow Request Body",
      "type": "object"
    },
    "updateRecoveryFlowWithCodeMethod": {
      "description": "Update Recovery Flow with Code Method",
      "type": "object",
      "required": [
        "method"
      ],
      "properties": {
        "code": {
          "description": "Code from the recovery email\n\nIf you want to submit a code, use this field, but make sure to _not_ include the email field, as well.",
          "type": "string"
        },
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "email": {
          "description": "The email address of the account to recover\n\nIf the email belongs to a valid account, a recovery email will be sent.\n\nIf you want to notify the email address if the account does not exist, see\nthe [notify_unknown_recipients flag](https://www.ory.sh/docs/kratos/self-service/flows/account-recovery-password-reset#attempted-recovery-notifications)\n\nIf a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code.\n\nformat: email",
          "type": "string"
        },
        "method": {
          "description": "Method is the method that should be used for this recovery flow\n\nAllowed values are `link` and `code`.\nlink RecoveryStrategyLink\ncode RecoveryStrategyCode",
          "type": "string",
          "enum": [
            "link",
            "code"
          ],
          "x-go-enum-desc": "link RecoveryStrategyLink\ncode RecoveryStrategyCode"
        }
      }
    },
    "updateRecoveryFlowWithLinkMethod": {
      "description": "Update Recovery Flow with Link Method",
      "type": "object",
      "required": [
        "email",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "email": {
          "description": "Email to Recover\n\nNeeds to be set when initiating the flow. If the email is a registered\nrecovery email, a recovery link will be sent. If the email is not known,\na email with details on what happened will be sent instead.\n\nformat: email",
          "type": "string"
        },
        "method": {
          "description": "Method is the method that should be used for this recovery flow\n\nAllowed values are `link` and `code`\nlink RecoveryStrategyLink\ncode RecoveryStrategyCode",
          "type": "string",
          "enum": [
            "link",
            "code"
          ],
          "x-go-enum-desc": "link RecoveryStrategyLink\ncode RecoveryStrategyCode"
        }
      }
    },
    "updateRegistrationFlowBody": {
      "description": "Update Registration Request Body",
      "type": "object"
    },
    "updateRegistrationFlowWithOidcMethod": {
      "description": "Update Registration Flow with OpenID Connect Method",
      "type": "object",
      "required": [
        "provider",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "The CSRF Token",
          "type": "string"
        },
        "method": {
          "description": "Method to use\n\nThis field must be set to `oidc` when using the oidc method.",
          "type": "string"
        },
        "provider": {
          "description": "The provider to register with",
          "type": "string"
        },
        "traits": {
          "description": "The identity traits",
          "type": "object"
        },
        "transient_payload": {
          "description": "Transient data to pass along to any webhooks",
          "type": "object"
        },
        "upstream_parameters": {
          "description": "UpstreamParameters are the parameters that are passed to the upstream identity provider.\n\nThese parameters are optional and depend on what the upstream identity provider supports.\nSupported parameters are:\n`login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session.\n`hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`.\n`prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`.",
          "type": "object"
        }
      }
    },
    "updateRegistrationFlowWithPasswordMethod": {
      "description": "Update Registration Flow with Password Method",
      "type": "object",
      "required": [
        "password",
        "traits",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "The CSRF Token",
          "type": "string"
        },
        "method": {
          "description": "Method to use\n\nThis field must be set to `password` when using the password method.",
          "type": "string"
        },
        "password": {
          "description": "Password to sign the user up with",
          "type": "string"
        },
        "traits": {
          "description": "The identity's traits",
          "type": "object"
        },
        "transient_payload": {
          "description": "Transient data to pass along to any webhooks",
          "type": "object"
        }
      }
    },
    "updateRegistrationFlowWithWebAuthnMethod": {
      "description": "Update Registration Flow with WebAuthn Method",
      "type": "object",
      "required": [
        "traits",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "CSRFToken is the anti-CSRF token",
          "type": "string"
        },
        "method": {
          "description": "Method\n\nShould be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing.",
          "type": "string"
        },
        "traits": {
          "description": "The identity's traits",
          "type": "object"
        },
        "transient_payload": {
          "description": "Transient data to pass along to any webhooks",
          "type": "object"
        },
        "webauthn_register": {
          "description": "Register a WebAuthn Security Key\n\nIt is expected that the JSON returned by the WebAuthn registration process\nis included here.",
          "type": "string"
        },
        "webauthn_register_displayname": {
          "description": "Name of the WebAuthn Security Key to be Added\n\nA human-readable name for the security key which will be added.",
          "type": "string"
        }
      }
    },
    "updateSettingsFlowBody": {
      "description": "Update Settings Flow Request Body",
      "type": "object"
    },
    "updateSettingsFlowWithLookupMethod": {
      "description": "Update Settings Flow with Lookup Method",
      "type": "object",
      "required": [
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "CSRFToken is the anti-CSRF token",
          "type": "string"
        },
        "lookup_secret_confirm": {
          "description": "If set to true will save the regenerated lookup secrets",
          "type": "boolean"
        },
        "lookup_secret_disable": {
          "description": "Disables this method if true.",
          "type": "boolean"
        },
        "lookup_secret_regenerate": {
          "description": "If set to true will regenerate the lookup secrets",
          "type": "boolean"
        },
        "lookup_secret_reveal": {
          "description": "If set to true will reveal the lookup secrets",
          "type": "boolean"
        },
        "method": {
          "description": "Method\n\nShould be set to \"lookup\" when trying to add, update, or remove a lookup pairing.",
          "type": "string"
        }
      }
    },
    "updateSettingsFlowWithOidcMethod": {
      "description": "Update Settings Flow with OpenID Connect Method",
      "type": "object",
      "required": [
        "method"
      ],
      "properties": {
        "flow": {
          "description": "Flow ID is the flow's ID.\n\nin: query",
          "type": "string"
        },
        "link": {
          "description": "Link this provider\n\nEither this or `unlink` must be set.\n\ntype: string\nin: body",
          "type": "string"
        },
        "method": {
          "description": "Method\n\nShould be set to profile when trying to update a profile.",
          "type": "string"
        },
        "traits": {
          "description": "The identity's traits\n\nin: body",
          "type": "object"
        },
        "unlink": {
          "description": "Unlink this provider\n\nEither this or `link` must be set.\n\ntype: string\nin: body",
          "type": "string"
        },
        "upstream_parameters": {
          "description": "UpstreamParameters are the parameters that are passed to the upstream identity provider.\n\nThese parameters are optional and depend on what the upstream identity provider supports.\nSupported parameters are:\n`login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session.\n`hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`.\n`prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`.",
          "type": "object"
        }
      }
    },
    "updateSettingsFlowWithPasswordMethod": {
      "description": "Update Settings Flow with Password Method",
      "type": "object",
      "required": [
        "password",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "CSRFToken is the anti-CSRF token",
          "type": "string"
        },
        "method": {
          "description": "Method\n\nShould be set to password when trying to update a password.",
          "type": "string"
        },
        "password": {
          "description": "Password is the updated password",
          "type": "string"
        }
      }
    },
    "updateSettingsFlowWithProfileMethod": {
      "description": "Update Settings Flow with Profile Method",
      "type": "object",
      "required": [
        "traits",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "The Anti-CSRF Token\n\nThis token is only required when performing browser flows.",
          "type": "string"
        },
        "method": {
          "description": "Method\n\nShould be set to profile when trying to update a profile.",
          "type": "string"
        },
        "traits": {
          "description": "Traits\n\nThe identity's traits.",
          "type": "object"
        }
      }
    },
    "updateSettingsFlowWithTotpMethod": {
      "description": "Update Settings Flow with TOTP Method",
      "type": "object",
      "required": [
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "CSRFToken is the anti-CSRF token",
          "type": "string"
        },
        "method": {
          "description": "Method\n\nShould be set to \"totp\" when trying to add, update, or remove a totp pairing.",
          "type": "string"
        },
        "totp_code": {
          "description": "ValidationTOTP must contain a valid TOTP based on the",
          "type": "string"
        },
        "totp_unlink": {
          "description": "UnlinkTOTP if true will remove the TOTP pairing,\neffectively removing the credential. This can be used\nto set up a new TOTP device.",
          "type": "boolean"
        }
      }
    },
    "updateSettingsFlowWithWebAuthnMethod": {
      "description": "Update Settings Flow with WebAuthn Method",
      "type": "object",
      "required": [
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "CSRFToken is the anti-CSRF token",
          "type": "string"
        },
        "method": {
          "description": "Method\n\nShould be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing.",
          "type": "string"
        },
        "webauthn_register": {
          "description": "Register a WebAuthn Security Key\n\nIt is expected that the JSON returned by the WebAuthn registration process\nis included here.",
          "type": "string"
        },
        "webauthn_register_displayname": {
          "description": "Name of the WebAuthn Security Key to be Added\n\nA human-readable name for the security key which will be added.",
          "type": "string"
        },
        "webauthn_remove": {
          "description": "Remove a WebAuthn Security Key\n\nThis must contain the ID of the WebAuthN connection.",
          "type": "string"
        }
      }
    },
    "updateVerificationFlowBody": {
      "description": "Update Verification Flow Request Body",
      "type": "object"
    },
    "updateVerificationFlowWithCodeMethod": {
      "type": "object",
      "required": [
        "method"
      ],
      "properties": {
        "code": {
          "description": "Code from the recovery email\n\nIf you want to submit a code, use this field, but make sure to _not_ include the email field, as well.",
          "type": "string"
        },
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "email": {
          "description": "The email address to verify\n\nIf the email belongs to a valid account, a verifiation email will be sent.\n\nIf you want to notify the email address if the account does not exist, see\nthe [notify_unknown_recipients flag](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation#attempted-verification-notifications)\n\nIf a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code.\n\nformat: email",
          "type": "string"
        },
        "method": {
          "description": "Method is the method that should be used for this verification flow\n\nAllowed values are `link` and `code`.\nlink VerificationStrategyLink\ncode VerificationStrategyCode",
          "type": "string",
          "enum": [
            "link",
            "code"
          ],
          "x-go-enum-desc": "link VerificationStrategyLink\ncode VerificationStrategyCode"
        }
      }
    },
    "updateVerificationFlowWithLinkMethod": {
      "description": "Update Verification Flow with Link Method",
      "type": "object",
      "required": [
        "email",
        "method"
      ],
      "properties": {
        "csrf_token": {
          "description": "Sending the anti-csrf token is only required for browser login flows.",
          "type": "string"
        },
        "email": {
          "description": "Email to Verify\n\nNeeds to be set when initiating the flow. If the email is a registered\nverification email, a verification link will be sent. If the email is not known,\na email with details on what happened will be sent instead.\n\nformat: email",
          "type": "string"
        },
        "method": {
          "description": "Method is the method that should be used for this verification flow\n\nAllowed values are `link` and `code`\nlink VerificationStrategyLink\ncode VerificationStrategyCode",
          "type": "string",
          "enum": [
            "link",
            "code"
          ],
          "x-go-enum-desc": "link VerificationStrategyLink\ncode VerificationStrategyCode"
        }
      }
    },
    "verifiableIdentityAddress": {
      "description": "VerifiableAddress is an identity's verifiable address",
      "type": "object",
      "required": [
        "value",
        "verified",
        "via",
        "status"
      ],
      "properties": {
        "created_at": {
          "description": "When this entry was created",
          "type": "string",
          "format": "date-time",
          "example": "2014-01-01T23:28:56.782Z"
        },
        "id": {
          "description": "The ID",
          "type": "string",
          "format": "uuid"
        },
        "status": {
          "$ref": "#/definitions/identityVerifiableAddressStatus"
        },
        "updated_at": {
          "description": "When this entry was last updated",
          "type": "string",
          "format": "date-time",
          "example": "2014-01-01T23:28:56.782Z"
        },
        "value": {
          "description": "The address value\n\nexample foo@user.com",
          "type": "string"
        },
        "verified": {
          "description": "Indicates if the address has already been verified",
          "type": "boolean",
          "example": true
        },
        "verified_at": {
          "$ref": "#/definitions/nullTime"
        },
        "via": {
          "$ref": "#/definitions/identityVerifiableAddressType"
        }
      }
    },
    "verificationFlow": {
      "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.sh/docs/kratos/self-service/flows/verify-email-account-activation",
      "type": "object",
      "title": "A Verification Flow",
      "required": [
        "id",
        "type",
        "ui",
        "state"
      ],
      "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.",
          "type": "string",
          "format": "date-time"
        },
        "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://\u003cselfservice.flows.verification.ui_url\u003e?request=\u003cid\u003e\n\ntype: string\nformat: uuid",
          "type": "string",
          "format": "uuid"
        },
        "issued_at": {
          "description": "IssuedAt is the time (UTC) when the request occurred.",
          "type": "string",
          "format": "date-time"
        },
        "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": {
          "$ref": "#/definitions/verificationFlowState"
        },
        "type": {
          "$ref": "#/definitions/selfServiceFlowType"
        },
        "ui": {
          "$ref": "#/definitions/uiContainer"
        }
      }
    },
    "verificationFlowState": {
      "description": "The state represents the state of the verification flow.\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.",
      "type": "string",
      "title": "Verification Flow State"
    },
    "version": {
      "type": "object",
      "properties": {
        "version": {
          "description": "Version is the service's version.",
          "type": "string"
        }
      }
    },
    "webAuthnJavaScript": {
      "type": "string"
    }
  },
  "responses": {
    "emptyResponse": {
      "description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201."
    },
    "identitySchemas": {
      "description": "List Identity JSON Schemas Response",
      "schema": {
        "$ref": "#/definitions/identitySchemas"
      },
      "headers": {
        "link": {
          "type": "string",
          "description": "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited list of links to the following pages:\n\nfirst: The first page of results.\nnext: The next page of results.\nprev: The previous page of results.\nlast: The last page of results.\n\nPages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted.\n\nThe header value may look like follows:\n\n\u003c/clients?limit=5\u0026offset=0\u003e; rel=\"first\",\u003c/clients?limit=5\u0026offset=15\u003e; rel=\"next\",\u003c/clients?limit=5\u0026offset=5\u003e; rel=\"prev\",\u003c/clients?limit=5\u0026offset=20\u003e; rel=\"last\""
        },
        "x-total-count": {
          "type": "integer",
          "format": "int64",
          "description": "The X-Total-Count HTTP Header\n\nThe `X-Total-Count` header contains the total number of items in the collection."
        }
      }
    },
    "listCourierMessages": {
      "description": "Paginated Courier Message List Response",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/message"
        }
      },
      "headers": {
        "link": {
          "type": "string",
          "description": "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited list of links to the following pages:\n\nfirst: The first page of results.\nnext: The next page of results.\nprev: The previous page of results.\nlast: The last page of results.\n\nPages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted.\n\nThe header value may look like follows:\n\n\u003c/clients?limit=5\u0026offset=0\u003e; rel=\"first\",\u003c/clients?limit=5\u0026offset=15\u003e; rel=\"next\",\u003c/clients?limit=5\u0026offset=5\u003e; rel=\"prev\",\u003c/clients?limit=5\u0026offset=20\u003e; rel=\"last\""
        },
        "x-total-count": {
          "type": "integer",
          "format": "int64",
          "description": "The X-Total-Count HTTP Header\n\nThe `X-Total-Count` header contains the total number of items in the collection."
        }
      }
    },
    "listIdentities": {
      "description": "Paginated Identity List Response",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/identity"
        }
      },
      "headers": {
        "link": {
          "type": "string",
          "description": "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited list of links to the following pages:\n\nfirst: The first page of results.\nnext: The next page of results.\nprev: The previous page of results.\nlast: The last page of results.\n\nPages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted.\n\nThe header value may look like follows:\n\n\u003c/clients?limit=5\u0026offset=0\u003e; rel=\"first\",\u003c/clients?limit=5\u0026offset=15\u003e; rel=\"next\",\u003c/clients?limit=5\u0026offset=5\u003e; rel=\"prev\",\u003c/clients?limit=5\u0026offset=20\u003e; rel=\"last\""
        },
        "x-total-count": {
          "type": "integer",
          "format": "int64",
          "description": "The X-Total-Count HTTP Header\n\nThe `X-Total-Count` header contains the total number of items in the collection."
        }
      }
    },
    "listIdentitySessions": {
      "description": "List Identity Sessions Response",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/session"
        }
      },
      "headers": {
        "link": {
          "type": "string",
          "description": "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited list of links to the following pages:\n\nfirst: The first page of results.\nnext: The next page of results.\nprev: The previous page of results.\nlast: The last page of results.\n\nPages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted.\n\nThe header value may look like follows:\n\n\u003c/clients?limit=5\u0026offset=0\u003e; rel=\"first\",\u003c/clients?limit=5\u0026offset=15\u003e; rel=\"next\",\u003c/clients?limit=5\u0026offset=5\u003e; rel=\"prev\",\u003c/clients?limit=5\u0026offset=20\u003e; rel=\"last\""
        },
        "x-total-count": {
          "type": "integer",
          "format": "int64",
          "description": "The X-Total-Count HTTP Header\n\nThe `X-Total-Count` header contains the total number of items in the collection."
        }
      }
    },
    "listMySessions": {
      "description": "List My Session Response",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/session"
        }
      },
      "headers": {
        "link": {
          "type": "string",
          "description": "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited list of links to the following pages:\n\nfirst: The first page of results.\nnext: The next page of results.\nprev: The previous page of results.\nlast: The last page of results.\n\nPages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted.\n\nThe header value may look like follows:\n\n\u003c/clients?limit=5\u0026offset=0\u003e; rel=\"first\",\u003c/clients?limit=5\u0026offset=15\u003e; rel=\"next\",\u003c/clients?limit=5\u0026offset=5\u003e; rel=\"prev\",\u003c/clients?limit=5\u0026offset=20\u003e; rel=\"last\""
        },
        "x-total-count": {
          "type": "integer",
          "format": "int64",
          "description": "The X-Total-Count HTTP Header\n\nThe `X-Total-Count` header contains the total number of items in the collection."
        }
      }
    },
    "listSessions": {
      "description": "Session List Response\n\nThe response given when listing sessions in an administrative context.",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/session"
        }
      },
      "headers": {
        "link": {
          "type": "string",
          "description": "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited list of links to the following pages:\n\nfirst: The first page of results.\nnext: The next page of results.\n\nPages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted. Examples:\n\n\u003c/admin/sessions?page_size=250\u0026page_token={last_item_uuid}; rel=\"first\",/admin/sessions?page_size=250\u0026page_token=\u003e; rel=\"next\""
        },
        "x-total-count": {
          "type": "integer",
          "format": "int64",
          "description": "The X-Total-Count HTTP Header\n\nThe `X-Total-Count` header contains the total number of items in the collection."
        }
      }
    }
  },
  "securityDefinitions": {
    "oryAccessToken": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header"
    }
  },
  "x-forwarded-proto": "string",
  "x-request-id": "string"
}