ping-identity
    Preparing search index...

    Class OathError

    Error payload returned when OATH operations fail.

    Matches the shared native/JS error contract defined in @ping-identity/rn-types.

    When code is 'OATH_POLICY_VIOLATION', the violatedPolicy field identifies which policy blocked the operation, enabling callers to react programmatically without a second round-trip or message string parsing.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    violatedPolicy?

    Methods

    from

    Constructors

    • Parameters

      • message: string
      • code: string
      • type: string
      • Optionalstatus: number
      • OptionalviolatedPolicy: string

      Returns OathError

    Properties

    violatedPolicy?: string & {} | "biometricAvailable" | "deviceTampering"

    The name of the policy that caused a OATH_POLICY_VIOLATION error.

    Typed as OathMfaPolicy['kind'] | (string & {}) to accept well-known values ('biometricAvailable', 'deviceTampering') while remaining open to future policy kinds added by the native SDK.

    undefined for all other error codes.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods