Get-VPASSafeMemberSearch


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET SPECIFIC SAFE MEMBER IN A SAFE


Description:

USE THIS FUNCTION TO RETRIEVE A SPECIFIC SAFE MEMBER FROM A SPECIFIED SAFE


Syntax:

Get-VPASSafeMemberSearch [-safe] <String> [-member] <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

-member <String>
Target unique safe member

Required: true
Position: 2
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: 3
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:

$SafeMemberJSON = Get-VPASSafeMemberSearch -safe {SAFE VALUE} -member {MEMBER VALUE}


Outputs:

If successful:
{
         "safeUrlId": "TestSafe",
         "safeName": "TestSafe",
         "safeNumber": 121,
         "memberId": "1dfc3edf-ksjdf-876243-jh675-lkjahdkj78687",
         "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
         }
}

$false if failed