Get-VPASIdentityUserDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RETRIEVE USER DETAILS IN IDENTITY


Description:

USE THIS FUNCTION TO RETRIEVE USER DETAILS IN IDENTITY


Syntax:

Get-VPASIdentityUserDetails -Username <String> [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASIdentityUserDetails -UserID <String> [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASIdentityUserDetails -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-Username <String>
Username that will be used to query for the target user in Identity if no UserID is passed

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

-UserID <String>
Unique UserID that maps to the target User in Identity
Supply the UserID to skip any querying for the target User

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

-ExportToCSV [<SwitchParameter>]
Output results to a CSV file found in AppData\Local\VPASModuleOutputs directory

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

-CSVDirectory <String>
Output directory where the exported CSV file will be saved to
Default value: C:\Users\{CurrentUser}\AppData\Local\VPASModuleOutputs\ExportedCSVs

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


Examples:

$GetUserDetails = Get-VPASIdentityUserDetails -Username {USERNAME VALUE}

$GetUserDetails = Get-VPASIdentityUserDetails -UserID {USERID VALUE}

$InputParameters = @{
        Username = "vadim.melamed@vman.com"
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$GetUserDetails = Get-VPASIdentityUserDetails -InputParameters $InputParameters

$InputParameters = @{
        UserID = "jkadhfkj84793-1234-abcd-9bc1-skldjfkls8974983"
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$GetUserDetails = Get-VPASIdentityUserDetails -InputParameters $InputParameters


Outputs:

If successful:
{
         "Uuid": "jkadhfkj84793-1234-abcd-9bc1-skldjfkls8974983",
         "State": "None",
         "LastModifiedDate": "10/16/2024 3:14:32 AM",
         "DisplayName": "Vadim Melamed",
         "Version": "1",
         "Mail": "vadim.melamed@vman.com",
         "Name": "vadim@vman.com",
         "ReportsTo": "Unassigned",
         "CreateDate": "12/27/2022 7:16:35 PM",
         "HomeNumber": "1234567890",
         "LockedByAdmin": false,
         "MobileNumber": "1234567890",
         "Alias": "vman.com",
         "OfficeNumber": "1234567890",
         "InEverybodyRole": true,
         "LastPasswordChangeDate": "8/1/2023 3:02:37 PM",
         "OauthClient": false,
         "PasswordNeverExpire": true
}

$false if failed