Passwordstate Documentation

Update Password List Permissions ​

PUT /api/passwordlistpermissions

To update permissions on a Password List, the same conditions apply as when you are adding permissions, and adding checks are made to ensure permissions exist already for the User or Security Group.

Updating permissions can be achieved as per the example below, using the following parameter descriptions:

Powershell
#JSON data for the object
$Body = @{
PasswordListID                          = $PasswordListID
Permission                              = "M"
ApplyPermissionsForSecurityGroupName    = "Core Admins"
}

$jsonData = $Body | ConvertTo-Json

$PasswordstateURL = 'https://passwordstate/api'
$result = Invoke-Restmethod -Method Put -Uri $PasswordstateURL'/passwordlistpermissions' -ContentType "application/json" -Body $jsonData -Header @{ "APIKey" = "<apikey>" }
Write-Output $result
HeadingData TypeDescription
PasswordListIDIntegerUnique identifier for the Password List
Read-only: The time at which the Password List was created.
PermissionString (1)A for Administrator, M for Modify or V for View permissions
ApplyPermissionsForUserIDString (100)The UserID you wish to apply permissions for
ApplyPermissionsForSecurityGroupIDIntegerThe SecurityGroupID you wish to apply permissions for. You can only specify SecurityGroupID or SecurityGroupName, not both in the same call.
ApplyPermissionsForSecurityGroupNameString (NA)The Security Group Name you wish to apply permissions for You can only specify SecurityGroupID or SecurityGroupName, not both in the same call.
APIKeyString (NA)Password List or System Wide API Key
Json
# Response
HTTP/1.1 200          
[
{
    "PasswordListID":"2180",
    "Permission":"M",
    "ApplyPermissionsForUserID":"",
    "ApplyPermissionsForSecurityGroupID":"312",
    "ApplyPermissionsForSecurityGroupName":"Core Admins",
    "APIKey":"Redacted"
}
]