With the introduction of Passwordstate Version 10, we’ve made some changes to our APIs. That’s great you say, but what’s an API?
An API, or Application Programming Interface, is a set of defined rules and protocols that allow a software application to communicate and exchange data with other applications. Think of it as a “middleman” where developers can use it to automate tasks including the retrieval of data, using existing functionality, without having to rebuild the applications from scratch.
An analogy is the drive-through take-away. Where you the Customer (Client Application), queues in a drive-through lane specifically used for interacting with the Take-Away Venue (Server Application).

You place your food order from a menu of specific items (rules and protocols) with the Drive-Through Attendant (API). The Drive-Through Attendant engages the Take-Away Venue on your behalf, ensures the interaction conforms with the required rules and protocols for the interaction, and presents your completed food order to you.
Three Types of API
Passwordstate has 3 different APIs, providing a choice of authentication models for accessing and performing actions on the information stored within Passwordstate.
Standard API
Sometimes referred to as a General API, this uses preset API keys, typically a long-lived string used to authenticate the calling code/script, rather than an account. This is used at the Password List, Folder or Passwordstate System Wide level. The benefit is it requires no human-based interaction and never expires (unless you force it to).
- Example Use Case: An internal script runs nightly, pulling information from HR systems relating to new employees, and populates entries in an organizations’ Identity Management System and Passwordstate. In Passwordstate it ensures the new user has access to credentials required for their role by synchronizing Active Directory Groups, ensuring they have been assigned to any specific Security Groups, creating a personal folder and private password list for them, and enrolling the user for the Password Reset Portal.
Windows Integrated API
Also known as a User’s Authenticated Windows Session. This leverages the user’s existing authenticated system login (Active Directory) rather than actual API keys. It enables API calls to operate under the same security context as they would have if the user performed the activities manually via the User Interface. In Passwordstate it means a user doesn’t have to generate, copy, or paste keys. Security permissions instantly match corporate IT policies (because the permissions are based on their account permissions). When an employee is terminated or changes roles as defined in Active Directory, their “API” access vanishes or changes automatically.
- Example Use Case: An employee has a custom script, that retrieves a username, password, one-time Password, and change management template for a custom change management system. It then passes the credentials to the change management system, and opens the change management template with Microsoft Word. The employee edits the word document based on the template as saves it to the change management system. The employee’s security context, established when they logged in via Active Directory, authenticates all the transactions against Passwordstate.
User Based API
Sometimes referred to as Scoped User Tokens, this approach provides a unique API key generated from within a specific user’s account, inheriting that particular user’s access rights and scope as defined within Passwordstate. It again operates the same as if the user was logged in via the User Interface.
- Example Use Case: An employee, such as a System Administrator, creates an API key that is unique to their access within Passwordstate. He uses this to authenticate his API calls within a custom script, that reads an “assets” file and adds new Hosts that have been commissioned and deletes Hosts that have been retired.
Is there Documentation Available?
Click Studios provide comprehensive documentation on the 3 types of APIs here,

Each of the API Manuals includes specifics for the API type, including Authentication, Errors, and examples of the API methods that can be invoked.
Automatic Rotation of API Keys
Introduced with Passwordstate Version 10 is the new Job Scheduling Engine. This allows organizations to centrally manage, execute and audit PowerShell scripts, discovery jobs and operational automation tasks.
Rather than maintaining scripts across separate servers, desktops or scheduling platforms, administrators can manage jobs from within Passwordstate and control who can create, modify, execute and review them.
One of the big wins with the Job Scheduling Engine is the ability to securely access the required API key during execution, without needing to embed the key within the PowerShell script. The API key can then be automatically rotated after job execution, reducing the exposure and reuse of API credentials.
The rotation of API keys is limited to the Standard API and User Based API only. It is not available with the Windows Integrated API, as this uses the User’s Authenticated Windows Session instead of an API key.






























































