WorkOS · Schema

EnrollUserlandUserAuthenticationFactorDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
type	string	The type of the factor to enroll.
totp_issuer	string	Your application or company name displayed in the user's authenticator app.
totp_user	string	The user's account name displayed in their authenticator app.
totp_secret	string	The Base32-encoded shared secret for TOTP factors. This can be provided when creating the auth factor, otherwise it will be generated. The algorithm used to derive TOTP codes is SHA-1, the code length

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EnrollUserlandUserAuthenticationFactorDto",
  "title": "EnrollUserlandUserAuthenticationFactorDto",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of the factor to enroll.",
      "example": "totp",
      "const": "totp"
    },
    "totp_issuer": {
      "type": "string",
      "description": "Your application or company name displayed in the user's authenticator app.",
      "example": "WorkOS"
    },
    "totp_user": {
      "type": "string",
      "description": "The user's account name displayed in their authenticator app.",
      "example": "[email protected]"
    },
    "totp_secret": {
      "type": "string",
      "description": "The Base32-encoded shared secret for TOTP factors. This can be provided when creating the auth factor, otherwise it will be generated. The algorithm used to derive TOTP codes is SHA-1, the code length is 6 digits, and the timestep is 30 seconds \u2013 the secret must be compatible with these parameters.",
      "example": "JBSWY3DPEHPK3PXP"
    }
  },
  "required": [
    "type"
  ]
}