Passwordstate Documentation

Checking in a Password ​

GET /userapi/passwords

If a Password record is configured for Exclusive Check-In / Check-Out, you can check it back in using a simple GET request. Please note the following for records which are configured this way:

  1. Only the person who has checked out a record, can check it back in

  2. Appropriate 403 Forbidden status will be returned if the incorrect user tries to check in a record, or the records not configured for check out, or the record is already checked out, etc

  3. Only the 'Retrieving a Password' method above can be used to check out a record - and it will be checked out automatically when you retrieve it

  4. Other methods below for retrieving all records from a Password List, or searching for records, will mask the value of the password saying that either the record must be checked out, or that it's already checked out to a user

  5. If the record is configured to perform password resets, and the option to change the password on check in is selected, then the appropriate reset record will be added to the queue upon check in.

Powershell
# PowerShell Request
$PasswordstateUrl = 'https://passwordstate/userapi/passwords/<PasswordID>?CheckIn'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "UserID" = "<UserID>" ; "APIKey" = "<APIKey>" }
Json
# Response
HTTP/1.1 200