UPDATE SAFE

USE THIS FUNCTION TO UPDATE SAFE VALUES IN CYBERARK

Update-VPASSafe -safe <String> -field <String> -fieldval <String> [-token <Hashtable>] [<CommonParameters>]

Update-VPASSafe -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]

-safe <String>
Target unique safe name

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-field <String>
Specify which field will be updated
Possible values: SafeName, Description, OLACEnabled, ManagingCPM, NumberOfVersionsRetention, NumberOfDaysRetention

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-fieldval <String>
Target value to update the target field with

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

$UpdateSafeJSON = Update-VPASSafe -safe {SAFE VALUE} -field {FIELD VALUE} -fieldval {FIELDVAL VALUE}

$InputParameters = @{
        safe = "TargetSafeName"
        field = "SafeName"|"Description"|"ManagingCPM"|"NumberOfVersionsRetention"|"NumberOfDaysRetention"
        fieldval = "New description as an example"
}
$UpdateSafeJSON = Update-VPASSafe -InputParameters $InputParameters

If successful:
{
         "safeUrlId": "NewSafeVpas",
         "safeName": "NewSafeVpas",
         "safeNumber": 133,
         "description": "Updated description for documentation",
         "location": "\\",
         "creator": {
                 "id": "8c904dd3-b9f1-4e02-b4b0-1234",
                 "name": "vman@cyberark.cloud.1234"
         },
         "olacEnabled": false,
         "managingCPM": "ISPSSConnector",
         "numberOfVersionsRetention": null,
         "numberOfDaysRetention": 7,
         "autoPurgeEnabled": false,
         "creationTime": 1723779203,
         "lastModificationTime": 1723869537064880
}

$false if failed