User Based API

The Passwordstate API is a HTTP Based Services interface, providing programmatic access to much of the data in the system. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses. This makes it easy to communicate with from a wide variety of environments, from command-line utilities to gadgets to the browser URL bar itself.

Overview

Overview
Authentication
Errors
Input Output Options
Password Hashes or Exclude Passwords
Two Factor Authentication
Providing a Reason Auditing Data

Reference

Category	API Method
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
Passwords	Retrieving a Password
	Checking in a Password
	Updating an Existing Password
	Adding a New Password
	Adding a New Password Reset Dependency
	Deleting a Password
	Deleting a Password Reset Dependency
	Retrieving Password History
	Retrieving All Passwords in a Password List
	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
	Search Privileged Account Credential Permissions
	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 Random Passwords
Password Generator Policies	Password Generator Policies
Password Strength Policies	Password Strength Policies
Reporting	Reporting
Password Reset Portal	Enroll User
	Perform Active Directory Synchronization