WorkOS · Schema

MagicAuth

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
object	string	Distinguishes the Magic Auth object.
id	string	The unique ID of the Magic Auth code.
user_id	string	The unique ID of the user.
email	string	The email address of the user.
expires_at	string	The timestamp when the Magic Auth code expires.
created_at	string	An ISO 8601 timestamp.
updated_at	string	An ISO 8601 timestamp.
code	string	The code used to verify the Magic Auth code.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MagicAuth",
  "title": "MagicAuth",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the Magic Auth object.",
      "const": "magic_auth"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the Magic Auth code.",
      "example": "magic_auth_01HWZBQZY2M3AMQW166Q22K88F"
    },
    "user_id": {
      "type": "string",
      "description": "The unique ID of the user.",
      "example": "user_01E4ZCR3C56J083X43JQXF3JK5"
    },
    "email": {
      "type": "string",
      "description": "The email address of the user.",
      "example": "[email protected]"
    },
    "expires_at": {
      "format": "date-time",
      "type": "string",
      "description": "The timestamp when the Magic Auth code expires.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "code": {
      "type": "string",
      "description": "The code used to verify the Magic Auth code.",
      "example": "123456"
    }
  },
  "required": [
    "object",
    "id",
    "user_id",
    "email",
    "expires_at",
    "created_at",
    "updated_at",
    "code"
  ]
}