Space SDK Package

Space SDK Package

  • Users
  • Storage
  • Space Docs

›User API

User API

  • Users.authenticate() method
  • Users.withStorage() method
  • Users.createIdentity() method
  • Users.recoverKeysByPassphrase() method
  • Users.backupKeysByPassphrase() method
  • Users.list() method
  • Users.remove() method

Space User API

  • SpaceUser.storageAuth property
  • SpaceUser.token property

Types

  • Identity interface

@spacehq/sdk > Users > recoverKeysByPassphrase

Users.recoverKeysByPassphrase() method

Recovers users identity key information using the passphrase provided.

If successfully recovered, the users information is stored in the IdentityStorage (if provided) when initializing the users class.

Signature:

recoverKeysByPassphrase(uuid: string, passphrase: string, backupType: VaultBackupType): Promise<SpaceUser>;

Parameters

ParameterTypeDescription
uuidstringusers unique vault id
passphrasestringusers passphrase used to recover keys
backupTypeVaultBackupTypeType of vault backup the passphrase originates from

Returns:

Promise<SpaceUser>

← Users.createIdentity() methodUsers.backupKeysByPassphrase() method →
  • Users.recoverKeysByPassphrase() method
  • Parameters
Space SDK Package
Docs
Getting StartedUsersStorage
Resources
All DocumentationProject SlackBlog
More
GitHubStar
Follow @spacestorage