Get-VPASEPVUserDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET EPV USER DETAILS


Description:

USE THIS FUNCTION TO GET EPV USER(s) DETAILS


Syntax:

Get-VPASEPVUserDetails [-LookupBy] <String> [-LookupVal] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-LookupBy <String>
Which method will be used to query for the target EPVUser, via Username or UserID
Possible values: Username, UserID

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

-LookupVal <String>
Target searchquery string

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:

$EPVUserDetailsJSON = Get-VPASEPVUserDetails -LookupBy Username -LookupVal {USERNAME VALUE}

$EPVUserDetailsJSON = Get-VPASEPVUserDetails -LookupBy UserID -LookupVal {USERID VALUE}


Outputs:

If successful:
{
         "enableUser": true,
         "changePassOnNextLogon": false,
         "expiryDate": null,
         "suspended": false,
         "lastSuccessfulLoginDate": 1723868229,
         "unAuthorizedInterfaces": [
                
         ],
         "authenticationMethod": [
                
         ],
         "passwordNeverExpires": false,
         "distinguishedName": "",
         "description": "",
         "businessAddress": {
                 "workStreet": "",
                 "workCity": "",
                 "workState": "",
                 "workZip": "",
                 "workCountry": ""
         },
         "internet": {
                 "homePage": "",
                 "homeEmail": "",
                 "businessEmail": "vadim.melamed@vman.com",
                 "otherEmail": ""
         },
         "phones": {
                 "homeNumber": "",
                 "businessNumber": "1234567890",
                 "cellularNumber": "",
                 "faxNumber": "",
                 "pagerNumber": ""
         },
         "personalDetails": {
                 "street": "",
                 "city": "",
                 "state": "",
                 "zip": "",
                 "country": "",
                 "title": "",
                 "organization": "",
                 "department": "",
                 "profession": "",
                 "firstName": "Vadim",
                 "middleName": "",
                 "lastName": "Melamed"
         },
         "id": 41,
         "username": "vadim@vman.com",
         "source": "CyberArk",
         "userType": "EPVUser",
         "componentUser": false,
         "groupsMembership": [
                 {
                         "groupID": 28,
                         "groupName": "Everybody",
                         "groupType": "Vault"
                 },
                 {
                         "groupID": 40,
                         "groupName": "Privilege Cloud Administrators",
                         "groupType": "Vault"
                 },
                 {
                         "groupID": 82,
                         "groupName": "TestingNewAuth",
                         "groupType": "Vault"
                 }
         ],
         "vaultAuthorization": [
                 "AddUpdateUsers",
                 "AddSafes",
                 "ManageServerFileCategories",
                 "AuditUsers",
                 "ResetUsersPasswords",
                 "ActivateUsers"
         ],
         "location": "\\"
}

$false if failed