Passwork REST API
Passwork includes a REST API, designed to manage vaults, folders, and passwords. The API is based on the HTTPS protocol and provides responses in JSON format. Working with the API consists of three main stages:
- Authorization using the user's API key and getting tokens for the API session
- Performing operations
- Session terminationA
Access rights to the API correspond to the user's rights, whose API key is used. All actions are logged on behalf of this user. The REST API interacts with Passwork mobile apps and browser extensions. The API can also be used to integrate Passwork into your infrastructure. To support the “zero knowledge” mode (client-side encryption), the client-side must be able to decrypt the API-returned data and encrypt data before sending it to the API. These data preparation processes are technically complex and require data encoding in specific formats, deriving keys from passwords, calculating hash functions, and using RSA and AES encryption. To facilitate the use of the API, we have developed special connectors that encapsulate all necessary actions and provide simple interfaces for developers. At the moment, connectors and samples are available for:
The REST API allows you to: Perform CRUD actions with passwords, folders, and vaults Search passwords by phrases and URLs
- CRUD passwords, folders, vaults
- search password by phrase and url
Each user has its own API Key. Enable the API and copy the key.
By specifying an API key, you are acting on behalf of the user who owns the API key. As soon as you reset the key, disable the API or block the user, API access is immediately closed.
For example, you can create scripts that will perform routine actions on your behalf (user). Or create a service user, giving him the necessary rights and access.
Detailed examples can be found in the connectors' repositories.
Getting a password by ID
💡 What is the master password? The master password is an additional password which is used for a client side encryption. If you don't have the master password or don't know where to get it, then just pass this parameter