GET SAFE DETAILS

USE THIS FUNCTION TO GET SAFE DETAILS FOR A SPECIFIED SAFE

Get-VPASSafeDetails -safe <String> [-IncludeAccounts] [-token <Hashtable>] [<CommonParameters>]

Get-VPASSafeDetails -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

-IncludeAccounts [<SwitchParameter>]
Switch if to include accounts in the return value or not

Required: false
Position: named
Default value: False
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)

$SafeDetailsJSON = Get-VPASSafeDetails -safe {SAFE VALUE}

$InputParameters = @{
        safe = "TargetSafeName"
        IncludeAccounts = $true|$false
}
$SafeDetailsJSON = Get-VPASSafeDetails -InputParameters $InputParameters

If successful:
{
         "safeUrlId": "TestSafe",
         "safeName": "TestSafe",
         "safeNumber": 121,
         "description": "",
         "location": "\\",
         "creator": {
                 "id": "876kjsf-4554364-lkfjg-9bc1-skjdhf876345",
                 "name": "vadim@vman.com"
         },
         "olacEnabled": false,
         "managingCPM": "",
         "numberOfVersionsRetention": null,
         "numberOfDaysRetention": 7,
         "autoPurgeEnabled": false,
         "creationTime": 1715299864,
         "lastModificationTime": 1724029250038895,
         "accounts": [
                 {
                         "id": "121_4",
                         "name": "Operating System-WinDomain-vman.com-testdomainuser01"
                 },
                 {
                         "id": "121_5",
                         "name": "Operating System-WinDomain-vman.com-testdomainuser02"
                 }
         ],
         "isExpiredMember": false
}

$false if failed