Stytch · Schema

api_session_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.
session_token string A secret token for a given Stytch Session.
session_jwt string The JSON Web Token (JWT) for a given Stytch Session.
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
session object If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll receive a full Session object in the response. See [Session object](https://stytch.com/docs/api/ses
user_device object If a valid `telemetry_id` was passed in the request and the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `user_device` response field will conta
View JSON Schema on GitHub

JSON Schema

stytch-api-session-v1-migrateresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_session_v1_MigrateResponse",
  "title": "api_session_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."
    },
    "session_token": {
      "type": "string",
      "description": "A secret token for a given Stytch Session."
    },
    "session_jwt": {
      "type": "string",
      "description": "The JSON Web Token (JWT) for a given Stytch Session."
    },
    "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"
    },
    "session": {
      "$ref": "#/components/schemas/api_session_v1_Session",
      "description": "If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll receive a full Session object in the response.\n\n  See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.\n  "
    },
    "user_device": {
      "$ref": "#/components/schemas/api_device_history_v1_DeviceInfo",
      "description": "If a valid `telemetry_id` was passed in the request and the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `user_device` response field will contain information about the user's device attributes."
    }
  },
  "required": [
    "request_id",
    "user_id",
    "session_token",
    "session_jwt",
    "user",
    "status_code"
  ]
}