node-totp
    Preparing search index...

    Interface GenerateUriOptions

    Options for generating an otpauth URI and secret.

    interface GenerateUriOptions {
        account: string;
        algorithm?: TotpAlgorithm;
        byteLength?: number;
        digits?: UriDigits;
        issuer: string;
        period?: number;
        secret?: string;
    }
    Index

    Properties

    account algorithm? byteLength? digits? issuer period? secret?

    Properties

    account: string

    User identifier, typically an email address or username.

    algorithm?: TotpAlgorithm

    Hash algorithm used by the authenticator.

    'SHA1'

    byteLength?: number

    Secret length in bytes when generating a new secret (minimum 16). Defaults to an algorithm-appropriate size.

    digits?: UriDigits

    Number of digits in the setup URI (6 or 8).

    6

    issuer: string

    Service or application name displayed by authenticator apps.

    period?: number

    Time step in seconds.

    30

    secret?: string

    Canonical unpadded Base32 secret of at least 16 bytes to embed in the URI. If omitted, a new secret is generated.

    Settings

    Member Visibility

    On This Page

    Properties