Passwordstate Documentation

Add Folder Permissions ​

POST/api/folderpermissions

To add permissions to a Folder, you must either use the Folder's API Key, or the System Wide API Key, and it must be configured to have its permissions managed manually.

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

Powershell
#JSON data for the object
$Body = @{
FolderID                                = "2180"
Permission		                        = "A"
ApplyPermissionsForSecurityGroupName	= "Core Admins"
}

$jsonData = $Body | ConvertTo-Json

$PasswordstateURL = 'https://passwordstate/api'
$result = Invoke-Restmethod -Method Post -Uri $PasswordstateURL'/folderpermissions' -ContentType "application/json" -Body $jsonData -Header @{ "APIKey" = "<apikey>" }
Write-Output $result
HeadingData TypeDescription
FolderIDIntegerUnique identifier for the Folder Read-only: The time at which the Folder 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)Folder or System Wide API Key
Json
# Response
    HTTP/1.1 200          
    [
        {
            "FolderID":"2180",
            "Permission":"A",
            "ApplyPermissionsForUserID":"",
            "ApplyPermissionsForSecurityGroupID":"312",
            "ApplyPermissionsForSecurityGroupName":"Core Admins",
            "APIKey":"Redacted"
        }
    ]