Dfns TypeScript SDK - v0.8.35
    Preparing search index...

    Class RecoveryKeySigner

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Parameters

      • newCredentials: {
            firstFactorCredential:
                | {
                    credentialInfo: {
                        attestationData: string;
                        clientData: string;
                        credId: string;
                    };
                    credentialKind: "Fido2";
                    credentialName?: string;
                }
                | {
                    credentialInfo: {
                        attestationData: string;
                        clientData: string;
                        credId: string;
                    };
                    credentialKind: "Key";
                    credentialName?: string;
                }
                | {
                    credentialInfo: { password: string };
                    credentialKind: "Password";
                    credentialName?: string;
                }
                | {
                    credentialInfo: {
                        attestationData: string;
                        clientData: string;
                        credId: string;
                    };
                    credentialKind: "PasswordProtectedKey";
                    credentialName?: string;
                    encryptedPrivateKey: string;
                };
            recoveryCredential?: {
                credentialInfo: {
                    attestationData: string;
                    clientData: string;
                    credId: string;
                };
                credentialKind: "RecoveryKey";
                credentialName?: string;
                encryptedPrivateKey?: string;
            };
            secondFactorCredential?: | {
                credentialInfo: {
                    attestationData: string;
                    clientData: string;
                    credId: string;
                };
                credentialKind: "Fido2";
                credentialName?: string;
            }
            | {
                credentialInfo: {
                    attestationData: string;
                    clientData: string;
                    credId: string;
                };
                credentialKind: "Key";
                credentialName?: string;
            }
            | {
                credentialInfo: { otpCode: string };
                credentialKind: "Totp";
                credentialName?: string;
            }
            | {
                credentialInfo: {
                    attestationData: string;
                    clientData: string;
                    credId: string;
                };
                credentialKind: "PasswordProtectedKey";
                credentialName?: string;
                encryptedPrivateKey: string;
            };
        }
        • firstFactorCredential:
              | {
                  credentialInfo: {
                      attestationData: string;
                      clientData: string;
                      credId: string;
                  };
                  credentialKind: "Fido2";
                  credentialName?: string;
              }
              | {
                  credentialInfo: {
                      attestationData: string;
                      clientData: string;
                      credId: string;
                  };
                  credentialKind: "Key";
                  credentialName?: string;
              }
              | {
                  credentialInfo: { password: string };
                  credentialKind: "Password";
                  credentialName?: string;
              }
              | {
                  credentialInfo: {
                      attestationData: string;
                      clientData: string;
                      credId: string;
                  };
                  credentialKind: "PasswordProtectedKey";
                  credentialName?: string;
                  encryptedPrivateKey: string;
              }
        • OptionalrecoveryCredential?: {
              credentialInfo: {
                  attestationData: string;
                  clientData: string;
                  credId: string;
              };
              credentialKind: "RecoveryKey";
              credentialName?: string;
              encryptedPrivateKey?: string;
          }

          Register a recovery key. See Account Recovery for more details.

          • credentialInfo: { attestationData: string; clientData: string; credId: string }
            • attestationData: string

              Base64url-encoded public key.

            • clientData: string

              Base64url-encoded, stringified JSON client data object.

            • credId: string

              Base64url-encoded id of the recovery credential.

          • credentialKind: "RecoveryKey"
          • OptionalcredentialName?: string

            Human-readable name to assign to the credential.

          • OptionalencryptedPrivateKey?: string

            User-encrypted private key for the recovery credential.

        • OptionalsecondFactorCredential?:
              | {
                  credentialInfo: {
                      attestationData: string;
                      clientData: string;
                      credId: string;
                  };
                  credentialKind: "Fido2";
                  credentialName?: string;
              }
              | {
                  credentialInfo: {
                      attestationData: string;
                      clientData: string;
                      credId: string;
                  };
                  credentialKind: "Key";
                  credentialName?: string;
              }
              | {
                  credentialInfo: { otpCode: string };
                  credentialKind: "Totp";
                  credentialName?: string;
              }
              | {
                  credentialInfo: {
                      attestationData: string;
                      clientData: string;
                      credId: string;
                  };
                  credentialKind: "PasswordProtectedKey";
                  credentialName?: string;
                  encryptedPrivateKey: string;
              }
      • recoveryCode: string

      Returns Promise<
          {
              credentialAssertion: {
                  algorithm?: string;
                  clientData: string;
                  credId: string;
                  signature: string;
              };
              kind: "RecoveryKey";
          },
      >