Get-VPASSafeMembers


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET ALL SAFE MEMBERS IN A SAFE


Description:

USE THIS FUNCTION TO RETRIEVE SAFE MEMBERS FROM A SPECIFIED SAFE AND SAFE PERMISSIONS


Syntax:

Get-VPASSafeMembers [-safe] <String> [[-IncludePredefinedMembers]] [[-LimitSearchTo] <String>] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-safe <String>
Target unique safe name

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

-IncludePredefinedMembers [<SwitchParameter>]
Specify to include predefined safe members in the output
Predefined safe members are the members that get added by default to every safe (Master, Batch, Backup, etc)

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

-LimitSearchTo <String>
Specify if the query should include only Users or Groups
Both Users and Groups are returned by default
Possible values: "UsersOnly", "GroupsOnly"

Required: false
Position: 3
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: 4
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)


Examples:

$SafeMembersJSON = Get-VPASSafeMembers -safe {SAFE VALUE}

$SafeMembersJSON = Get-VPASSafeMembers -safe {SAFE VALUE} -IncludePredefinedMembers


Outputs:

If successful:
{
         "value": [
                 {
                         "safeUrlId": "TestSafe",
                         "safeName": "TestSafe",
                         "safeNumber": 121,
                         "memberId": "1d7864kjhg7-827364-kjsdhfj-1bc2-ab34c5d67efg",
                         "memberName": "vadim@vman.com",
                         "memberType": "User",
                         "membershipExpirationDate": null,
                         "isExpiredMembershipEnable": false,
                         "isPredefinedUser": false,
                         "isReadOnly": true,
                 "permissions": "@{useAccounts=True; retrieveAccounts=True; listAccounts=True; addAccounts=True; updateAccountContent=True; updateAccountProperties=True; initiateCPMAccountManagementOperations=True; specifyNextAccountContent=True; renameAccounts=True;deleteAccounts=True; unlockAccounts=True; manageSafe=True; manageSafeMembers=True; backupSafe=True; viewAuditLog=True; viewSafeMembers=True; accessWithoutConfirmation=True; createFolders=True; deleteFolders=True; moveAccountsAndFolders=True; requestsAuthorizationLevel1=True; requestsAuthorizationLevel2=False}"
                 },
                 {
                         "safeUrlId": "TestSafe",
                         "safeName": "TestSafe",
                         "safeNumber": 121,
                         "memberId": "78",
                         "memberName": "SafeAccessgroup",
                         "memberType": "Group",
                         "membershipExpirationDate": null,
                         "isExpiredMembershipEnable": false,
                         "isPredefinedUser": false,
                         "isReadOnly": false,
                 "permissions": "@{useAccounts=False; retrieveAccounts=False; listAccounts=True; addAccounts=False; updateAccountContent=False; updateAccountProperties=False; initiateCPMAccountManagementOperations=False; specifyNextAccountContent=False; renameAccounts=False; deleteAccounts=False; unlockAccounts=True; manageSafe=False; manageSafeMembers=False; backupSafe=False; viewAuditLog=False; viewSafeMembers=False; accessWithoutConfirmation=False; createFolders=False; deleteFolders=False; moveAccountsAndFolders=False; requestsAuthorizationLevel1=False; requestsAuthorizationLevel2=False}"
                 }
         ],
         "count": 2
}

$false if failed