SuperTokens · Schema

User

A SuperTokens user object

AuthenticationOpen SourceSession ManagementSocial LoginPasswordlessIdentityAuthorizationMulti-TenancyNode.jsSelf-Hosted

Properties

Name Type Description
id string Unique user ID
emails array
phoneNumbers array
thirdParty array
timeJoined integer Unix timestamp when user joined
tenantIds array
loginMethods array
View JSON Schema on GitHub

JSON Schema

supertokens-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "type": "object",
  "description": "A SuperTokens user object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique user ID"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "thirdParty": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "userId": {
            "type": "string"
          }
        }
      }
    },
    "timeJoined": {
      "type": "integer",
      "description": "Unix timestamp when user joined"
    },
    "tenantIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "loginMethods": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}