Stytch · Schema

api_password_v1_MigrateResponse

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
request_id string Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug
user_id string The unique ID of the affected User.
email_id string The unique ID of a specific email address.
user_created boolean In `login_or_create` endpoints, this field indicates whether or not a User was just created.
user object The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
status_code integer The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server
View JSON Schema on GitHub

JSON Schema

stytch-api-password-v1-migrateresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_password_v1_MigrateResponse",
  "title": "api_password_v1_MigrateResponse",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue."
    },
    "user_id": {
      "type": "string",
      "description": "The unique ID of the affected User."
    },
    "email_id": {
      "type": "string",
      "description": "The unique ID of a specific email address."
    },
    "user_created": {
      "type": "boolean",
      "description": "In `login_or_create` endpoints, this field indicates whether or not a User was just created."
    },
    "user": {
      "$ref": "#/components/schemas/api_user_v1_User",
      "description": "The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details."
    },
    "status_code": {
      "type": "integer",
      "format": "int32",
      "description": "The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors."
    }
  },
  "required": [
    "request_id",
    "user_id",
    "email_id",
    "user_created",
    "user",
    "status_code"
  ]
}