Errors

All of the possible error messages that can be returned from the API.

InvalidEndpoint

interface InvalidEndpoint {
  code: 'INVALID_ENDPOINT_ERROR';
  message: 'Invalid Endpoint';
}

InsufficientPermissions

interface InsufficientPermissions {
  code: 'INSUFFICIENT_PERMISSIONS_ERROR';
  message: 'Insufficient Permissions';
}

EndpointRequiresSecondFactor

interface EndpointRequiresSecondFactor {
  code: 'ENDPOINT_REQUIRES_SECOND_FACTOR_ERROR';
  message: 'Endpoint Requires Second Factor';
}

InvalidUser

interface InvalidUser {
  code: 'INVALID_USER_ERROR';
  message: 'Invalid User';
}

UserRequiresSecondFactor

interface UserRequiresSecondFactor {
  code: 'USER_REQUIRES_SECOND_FACTOR_ERROR';
  message: 'User Requires Second Factor';
}

InvalidUsername

interface InvalidUsername {
  code: 'INVALID_USERNAME_ERROR';
  message: 'Invalid Username';
}

InvalidSecondFactor

interface InvalidSecondFactor {
  code: 'INVALID_SECOND_FACTOR_ERROR';
  message: 'Invalid Second Factor';
}

InvalidSecondFactorMethod

interface InvalidSecondFactorMethod {
  code: 'INVALID_SECOND_FACTOR_METHOD_ERROR';
  message: 'Invalid Second Factor Method';
}

InvalidSecondFactorResponse

interface InvalidSecondFactorResponse {
  code: 'INVALID_SECOND_FACTOR_RESPONSE_ERROR';
  message: 'Invalid Second Factor Response';
}

SecondFactorChallengeRequired

The specific structure for PublicKeyCredentialRequestOptionsJSON can be found here.

interface SecondFactorChallengeRequired {
  code: 'SECOND_FACTOR_CHALLENGE_REQUIRED_ERROR';
  message: 'Second Factor Challenge Required';
  token: string;
  exp: number;
  types: ('totp' | 'webauthn' | 'backup')[];
  challenge: PublicKeyCredentialRequestOptionsJSON; // Only present if one of the available types is 'webauthn'.
}

InvalidPassword

interface InvalidPassword {
  code: 'INVALID_PASSWORD_ERROR';
  message: 'Invalid Password';
}

PasswordsDoNotMatch

interface PasswordsDoNotMatch {
  code: 'PASSWORDS_DO_NOT_MATCH_ERROR';
  message: 'Passwords Do Not Match';
}

InvalidEmail

interface InvalidEmail {
  code: 'INVALID_EMAIL_ERROR';
  message: 'Invalid Email';
}

InvalidSession

interface InvalidSession {
  code: 'INVALID_SESSION_ERROR';
  message: 'Invalid Session';
}

InvalidDomain

interface InvalidDomain {
  code: 'INVALID_DOMAIN_ERROR';
  message: 'Invalid Domain';
}

SubdomainTooLong

interface SubdomainTooLong {
  code: 'SUBDOMAIN_TOO_LONG_ERROR';
  message: 'Subdomain Too Long';
}

InvalidFile

interface InvalidFile {
  code: 'INVALID_FILE_ERROR';
  message: 'Invalid File';
}

InvalidInstruction

interface InvalidInstruction {
  code: 'INVALID_INSTRUCTION_ERROR';
  message: 'Invalid Instruction';
}

SubdomainNotAllowed

interface SubdomainNotAllowed {
  code: 'SUBDOMAIN_NOT_ALLOWED_ERROR';
  message: 'Subdomain Not Allowed';
}

DomainExists

interface DomainExists {
  code: 'DOMAIN_EXISTS_ERROR';
  message: 'Domain Exists';
}

UserExists

interface UserExists {
  code: 'USER_EXISTS_ERROR';
  message: 'User Exists';
}

InstructionExists

interface InstructionExists {
  code: 'INSTRUCTION_EXISTS_ERROR';
  message: 'Instruction Exists';
}

MissingFields

interface MissingFields {
  code: 'MISSING_FIELDS_ERROR';
  message: 'Missing Fields';
  fields: string[];
}

Banned

interface Banned {
  code: 'BANNED_ERROR';
  message: 'Banned';
}

BodyTooLarge

interface BodyTooLarge {
  code: 'BODY_TOO_LARGE_ERROR';
  message: 'Body Too Large';
}

RateLimited

interface RateLimited {
  code: 'RATELIMITED_ERROR';
  message: 'You Have Been Ratelimited. Please Try Again Later.';
}

Internal

interface Internal {
  code: 'INTERNAL_SERVER_ERROR';
  message: 'Internal Server Error';
}

ServiceUnavailable

interface ServiceUnavailable {
  code: 'SERVICE_UNAVAILABLE_ERROR';
  message: 'Service Unavailable';
  feature: number;
}

NotImplemented

interface NotImplemented {
  code: 'NOT_IMPLEMENTED_ERROR';
  message: 'Not Implemented';
}