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
  • Prerequisites
  • Get Started
  • Integrate the JS SDK
  • Integrate the iOS SDK
  • Integrate the Android SDK
  1. Guides
  2. Password Manager

Integrate the Password Manager SDK

Integrate the Password Manager SDK into your application

PreviousPassword ManagerNextAccessing the Password Manager

Last updated 28 days ago

Prerequisites

Get Started

Integrate the JS SDK

To gain access to the JS SDK and sample app providing a reference for integrating the SDK, please .

To use the Password Manager SDK in a Web or Node.js project, you must add @sudoplatform/sudo-password-manager as a dependency to your project.

yarn add '@sudoplatform/sudo-password-manager'
# or
npm install --save '@sudoplatform/sudo-password-manager'

In addition, the Password Manager SDK depends on the Sudo Secure Vault SDK. You can provide these dependencies when instantiating the PasswordManagerClient.

To instantiate and initialize a client in your application, add the following:

import {
    PasswordManagerClient,
    BrowserKeyDerivingKeyStore
} from '@sudoplatform/sudo-password-manager'
import { DefaultConfigurationManager } from '@sudoplatform/sudo-common'
import { DefaultSudoUserClient } from '@sudoplatform/sudo-user'
import { DefaultSudoProfilesClient } from '@sudoplatform/sudo-profiles'
import { DefaultSudoEntitlementsClient } from '@sudoplatform/sudo-entitlements'
import { DefaultSudoSecureVaultClient } from '@sudoplatform/sudo-secure-vault'

const sdkConfigJSON = /* ... refer to Users documentation ... */
DefaultConfigurationManager.getInstance().setConfig(sdkConfigJSON)

const secretCodeStore = new BrowserKeyDerivingKeyStore()
const userClient = new DefaultSudoUserClient(/* refer to Users documentation */)
const profilesClient = new DefaultSudoProfilesClient(/* refer to Sudos documentation */)
const entitlementsClient = new DefaultSudoEntitlementsClient(/* refer to Entitlements documentation */)
const secureVaultConfig = undefined // undefined to use the config from DefaultConfigurationManager

const client = new PasswordManagerClient(
    secretCodeStore,
    userClient,
    profilesClient,
    entitlementsClient,
    secureVaultConfig,
    { logBackgroundReconciliationError: console.warn }
)

Integrate the iOS SDK

pod 'SudoPasswordManager'

Install pod dependencies by running the following command in your project directory:

pod install --repo-update

This will update the local CocoaPods repository and install the latest version of the Password Manager SDK.

To instantiate a client in your application, add the following:

import SudoEntitlements
import SudoPasswordManager
import SudoProfiles
import SudoUser

let userClient = // ... see "Users" docs
let profilesClient = // ... see "Sudos" docs
let entitlementsClient = // ... see "Entitlements" docs

let passwordManagerClient = try DefaultPasswordManagerClient(
    userClient: userClient, 
    profilesClient: profilesClient, 
    entitlementsClient: entitlementsClient
)

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

Integrate the Android SDK

The Android SDK is open source and compatible with Android 6 (API level 23) and above.

Add this line to the dependencies section of the app module build.gradle and synchronize your project with Android Studio.

dependencies {
    implementation 'com.sudoplatform:sudopasswordmanager:$latest_version'
}

To instantiate a client in your application, add the following:

val logger = // ... use your implemenation of logger
val userClient = // ... see "Users" docs
val profilesClient = // ... see "Sudos" docs

val sudoPasswordManager = SudoPasswordManagerClient.builder()
            .setContext(appContext)
            .setSudoUserClient(userClient)
            .setSudoProfilesClient(profilesClient)
            .setLogger(logger)
            .build()

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

In order to instantiate a Password Manager client, make sure you have followed instructions for , , and (see above).

To gain access to the iOS SDK and iOS sample app providing a reference for integrating the SDK, please .

Add this line to your :

In order to instantiate a Password Manager client, make sure you have followed instructions for , , and (see above).

See it in action. Be sure to take a look at the on GitHub that our team published as a reference for integrating the Password Manager SDK into your app as quickly and seamlessly as possible.

To gain access to the Android SDK and Android sample app providing a reference for integrating the SDK, please .

The latest version of the SDK can be found at .

In order to instantiate a Password Manager client, make sure you have followed instructions for , , and (see above).

See it in action. Be sure to take a look at the on GitHub that our team published as a reference for integrating the Password Manager SDK into your app as quickly and seamlessly as possible.

🗺️
contact us
open-source iOS sample app
contact us
SDK Releases
open source Android sample app
Complete the Getting Started Guide
Integrate the User SDK
Integrate the Sudo Profiles SDK
Integrate the Entitlements SDK
contact us
Integrate the JS SDK
Integrate the iOS SDK
Integrate the Android SDK
Getting Started
User SDK
Sudo Profiles SDK
Entitlements SDK
Prerequisites
Getting Started
User SDK
Sudo Profiles SDK
Entitlements SDK
Prerequisites
Getting Started
User SDK
Sudo Profiles SDK
Entitlements SDK
Prerequisites
Podfile