All access to the API Methods is through the use of API Keys which are generated within Passwordstate. API Keys can be associated with individual Password Lists, or there are various system wide API Key can be used, depending on API methods being used. Each Password List can also specify which types of calls are allowed to be made to the records stored within the list i.e. retrieve, update and add data.

There are two types of API's available:

1. Standard API - One in which requires the use of API Keys, and is not 'user account' aware
2. Windows Integrated API - One which is integrated with Active Directory and is 'user account' aware

Optional Two-Factor Authentication can also be enabled for both version of the API(s).

Below are the list of currently available API Calls, and full documentation can be found under the Help menu in your Passwordstate installation.

Folders

  • Adding a New Folder
  • Search for Folders
  • Add Folder Permissions
  • Update Folder Permissions
  • Delete Folder Permissions

Password Lists

  • Adding a New Password List
  • Retrieving a Password List
  • Retrieving all Shared Password Lists
  • Search for Password Lists
  • Add Password List Permissions
  • Update Password List Permissions
  • Delete Password List Permissions

Password

  • Retrieving a Password
  • Updating an Existing Password
  • Adding a New Password
  • Adding a New Password Reset Dependency
  • Deleting a Password
  • Retrieving Password History
  • Retrieving All Passwords in a Password List
  • Retrieving All Passwords in all Password Lists
  • Retrieving a One Time Password
  • Moving a Password
  • Copying/Linking a Password
  • Searching for Passwords
  • Add Password Permissions
  • Update Password Permissions
  • Delete Password Permissions

Privileged Account Credentials

  • Search Privileged Account Credential
  • Add Privileged Account Credential
  • Update Privileged Account Credential
  • Delete Privileged Account Credential
  • Add Privileged Account Credential Permission
  • Delete Privileged Account Credential Permission

Active Directory Domains

  • Search Active Directory Domains
  • Add Active Directory Domains
  • Update Active Directory Domains
  • Delete Active Directory Domains

Remote Site Locations

  • Search Remote Site Locations
  • Add Remote Site Location
  • Update Remote Site Location
  • Delete Remote Site Location
  • Export Installer Instructions

Address Book

  • Search Address Book
  • Add a New Address Book Contact
  • Update an Address Book Contact
  • Delete an Address Book Contact

Self Destruct Messages

  • Send Self Destruct Message

Security Groups (Active Directory)

  • Add Active Directory Security Group
  • Perform Active Directory Synchronization
  • Retrieving Security Groups

Security Groups (Local)

  • Add Local Security Group
  • Retrieving Security Groups
  • Add User to Local Security Group
  • Remove User from Local Security Group

User Accounts

  • Add User Account

Hosts

  • Searching for Hosts
  • Add a New Host
  • Delete a Host

Documents

  • Add a Password Document
  • Add a Password List Document
  • Add a Folder Document
  • Retrieve a Password Document
  • Retrieve a Password List Document
  • Retrieve a Folder Document

Generate Random Passwords

  • Generate based on a policy you specify
  • Generate based on specific criteria you specify

Password Generator Policies

  • Password Generator Policies

Password Strength Policies

  • Password Strength Policies

Reporting

  • User Reports (12 in total)
  • Password Reports (13 in total)
  • Permission Reports (10 on total)
  • Activity Reports (6 in total)
  • Document Reports (6 in total)
  • Miscellaneous Reports (2 in total)

Password Reset Portal

  • Enroll User)
  • Perform Active Directory Synchronization