Get-VPASEPVUserDetailsSearch


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET EPV USER DETAILS VIA SEARCH QUERY


Description:

USE THIS FUNCTION TO GET EPV USER(s) DETAILS THROUGH A SEARCH QUERY


Syntax:

Get-VPASEPVUserDetailsSearch [-SearchQuery] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-SearchQuery <String>
Search string to find target resource via username, address, safe, platform, etc.
Comma separated for multiple fields, or to search all pass a blank value like so: " "

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

$EPVUserDetailsJSON = Get-VPASEPVUserDetailsSearch -SearchQuery {SEARCHQUERY VALUE}


Outputs:

If successful:
{
         "Users": [
                 ...
                 {
                         "id": 41,
                         "username": "vadim@vman.com",
                         "source": "CyberArk",
                         "userType": "EPVUser",
                         "componentUser": false,
                         "groupsMembership": " ",
                         "vaultAuthorization": "AddUpdateUsers AddSafes ManageServerFileCategories AuditUsers ResetUsersPasswords ActivateUsers",
                         "location": "\\",
                 "personalDetails": "@{firstName=Vadim; middleName=; lastName=Melamed; organization=; department=}",
                         "enableUser": true,
                         "suspended": false
                 },
                 {
                         "id": 56,
                         "username": "VadimAdmin@vman.com",
                         "source": "CyberArk",
                         "userType": "EPVUser",
                         "componentUser": false,
                         "groupsMembership": " ",
                         "vaultAuthorization": "AddUpdateUsers AddSafes ManageServerFileCategories AuditUsers ResetUsersPasswords ActivateUsers",
                         "location": "\\",
                 "personalDetails": "@{firstName=VadimAdmin; middleName=; lastName=; organization=; department=}",
                         "enableUser": true,
                         "suspended": false
                 },
                 {
                         "id": 188,
                         "username": "VpasModuleAppIDTest",
                         "source": "CyberArk",
                         "userType": "AIMAccount",
                         "componentUser": true,
                         "groupsMembership": "",
                         "vaultAuthorization": "",
                         "location": "\\",
                 "personalDetails": "@{firstName=vadim; middleName=; lastName=melamed; organization=; department=}",
                         "enableUser": true,
                         "suspended": false
                 },
                 ...
         ],
         "Total": 6
}

$false if failed