LogoLogo
  • Platform Overview
  • 🗺️Guides
    • Getting Started
    • Users
      • Integrate the User SDK
      • Registration
      • Authentication
      • SDK Releases
      • API Reference
    • Entitlements
      • Administrative API
        • Integrating the Administrative API
        • Entitlement Definitions
        • Managing Entitlements Sets
        • Managing Entitlements Sequences
        • Managing User Entitlements
        • API Schema
      • End-user API
        • Integrate the Entitlements SDK
        • Redeeming Entitlements
        • Retrieving Entitlements
        • SDK Releases
        • API Reference
    • Sudos
      • Integrate the Sudo Profiles SDK
      • Sudo Entitlements
      • Manage Sudos
      • SDK Releases
      • API Reference
    • Telephony
      • Integrate the Telephony SDK
      • Manage Phone Numbers
      • Text Messaging
      • Voice Calling
      • Telephony Simulator
      • SDK Releases
      • API Reference
    • Email
      • Integrate the Email SDK
      • Email Entitlements
      • Manage Email Addresses
      • Sending & Receiving Email
      • Manage Email Folders
      • Draft Email Messages
      • Manage Email Address Blocklists
      • Email Address Public Information
      • Pagination
      • Caching
      • Configuration Data
      • Email Notifications
      • SDK Releases
      • API Reference
    • Decentralized Identity
      • Edge Agent
        • Relay SDK
          • Integrate the Relay SDK
          • Relay Entitlements
          • Manage Relay Postboxes
          • Manage Relay Messages
          • Receiving Messages
          • SDK Releases
        • Edge Agent SDK
          • Integrate the Edge Agent SDK
          • Agent Management
          • Manage Wallets
          • Establishing Connections
          • Manage Connections
          • Messaging
          • Manage DIDs
          • Accepting New Credentials
          • Manage Credentials
          • Present Credentials for Verification
          • Utilize Alternative Cryptography Providers
          • SDK Releases
          • Standards and Protocols
      • Cloud Agent
        • Cloud Agent Admin API
          • Integrate the Cloud Agent Admin API
          • Aries Interop Profile (AIP)
            • Connection Exchanges
            • Credential Exchanges
            • Proof Exchanges
          • Connections
          • Basic Messages
          • Credentials
            • Anoncreds Credentials
              • Schemas
              • Credential Definitions
            • W3C Credentials
          • Audit Logs
          • API Schema
          • Error Codes
          • Standards and Protocols
    • Virtual Cards
      • Integrate the Virtual Cards SDK
      • Virtual Cards Entitlements
      • Virtual Cards Transaction Velocity Constraints
      • Key Management
      • Manage Funding Sources
      • Manage Virtual Cards
      • Manage Transactions
      • Configuration Data
      • Pagination
      • Caching
      • SDK Releases
      • API Reference
    • Virtual Cards Simulator
      • Integrate the Virtual Cards Simulator SDK
      • Simulate Authorizations
      • Simulate Debits
      • Simulate Refunds
      • Simulate Reversals
      • Merchants and Currencies
      • SDK Releases
      • API Reference
    • Virtual Private Network
      • Integrate the VPN SDK
      • VPN Entitlements
      • Manage Servers
      • Manage Connection
      • Observe VPN Related Events
      • SDK Releases
      • API Reference
      • Frequently Asked Questions
    • Secure ID Verification
      • Integrate the Secure ID Verification SDK
      • List Supported Countries
      • Verify an Identity
      • Check Secure ID Verification Status
      • Use the Secure ID Verification Simulator
      • SDK Releases
      • API Reference
    • Password Manager
      • Integrate the Password Manager SDK
      • Accessing the Password Manager
      • Managing Password Vaults
      • Managing Password Vault Items
      • Vault Import and Export
      • Password Utilities
      • Password Manager Entitlements
      • Password Vault Security
      • SDK Releases
      • API Reference
    • Ad/Tracker Blocker
      • Integrate the Ad/Tracker Blocker SDK
      • Manage Rulesets
      • Blocking Ads and Trackers
      • Manage Exceptions
      • SDK Releases
      • API Reference
    • Site Reputation
      • Integrate the Site Reputation SDK
      • Use the Site Reputation SDK
      • SDK Releases
      • API Reference
  • 💡Concepts
    • Sudo Digital Identities
  • 🧱Development
    • Versioning
  • 🏢Administration
    • Admin Console Roles
  • ❓Get Help
    • Request a Demo
    • Report an Issue
Powered by GitBook
On this page
  • Creating a Vault
  • Retrieving Vaults
  • Deleting a Vault
  1. Guides
  2. Password Manager

Managing Password Vaults

Provides the abilities to allow your users to create and manage their own password vaults.

PreviousAccessing the Password ManagerNextManaging Password Vault Items

Last updated 1 month ago

A Vault is a reference to vault data held internally by the Password Manager. To access the contents of a vault, the vault is passed to the Password Manager.

Creating a Vault

To effectively manage a user's contents, a vault needs to be created. All vaults that will be created must have an association with a Sudo. A Sudo can be created and retrieved using the . After either creating or retrieving a Sudo, the Sudo's id will be passed to the createVault method to asynchronously create a vault. If the Password Manager is successful a vault will be returned.

try {
    const sudoId = ""
    const vaultId = await client.createVault(sudoId)
    // `vaultId` contains the identifier of the newly created vault object.
} catch (error) {
    // handle errors or throw the error
    throw error
}
var client: PasswordManagerClient!

client.createVault(sudoId: "") { (result) in
    switch result {
    case .success(let vault):
        break
    case .failure(let error):
        break
    }
}
// val client: SudoPasswordManagerClient
// val sudoId: String

launch {
    try {
        val vault = withContext(Dispatchers.IO) {
            client.createVault(sudoId)
        }
    } catch (e: SudoPasswordManagerException) {
        // Handle/notify user of exception
    }
}

When creating vaults under a Sudo, be aware of .

Retrieving Vaults

Use the listVaults method to retrieve a list of all the vaults owned by the user. Use the list to filter for vaults owned by a Sudo or access the contents of the vault by using the id of one of the vaults returned from the method.

try {
    const vaults = await client.listVaults()
    // each vault in the array of vaults has an `id`
    // which can be used to access its items.
} catch {
    // Handle/notify user of errors
}
var client: PasswordManagerClient!

client.listVaults { (result) in
    switch result {
    case .success(let vaults):
        break
    case .failure(let error):
        break
    }
}

client.getVault(withId: "1") { (result) in
    switch result {
    case .success(let vault):
        break
    case .failure(let error):
        break
    }
}
// val client: SudoPasswordManagerClient

launch {
    try {
        val vaults = withContext(Dispatchers.IO) {
            client.listVaults()
            client.getVault("1")
        }
    } catch (e: SudoPasswordManagerException) {
        // Handle any errors related to fetching vaults
    }
}

Deleting a Vault

To delete a vault, call the deleteVault method and pass in the id of the vault you wish to delete.

try {
    const vaultId = "1"
    await client.deleteVault(vaultId)
} catch {
    // Handle/notify user of errors 
}
var client: PasswordManagerClient!

client.deleteVault(withId: "1") { (result) in
    switch result {
    case .success:
        break
    case .failure(let error):
        break
    }
}
// val client: SudoPasswordManagerClient

launch {
    try {
        withContext(Dispatchers.IO) {
            client.deleteVault("1")
        }
    } catch (e: SudoPasswordManagerException) {
        // Handle any errors related to vault deletion
    }
}

To learn more about key concepts surrounding Sudos, see .

🗺️
Sudo Profiles SDK
Password Entitlement limits
Sudo digital identities