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>] [[-UserID] <String>] [[-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: false
Position: 1
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: false
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:

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

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


Outputs:

If successful:
{
         "Uuid": "jkadhfkj84793-1234-abcd-9bc1-skldjfkls8974983",
         "State": "None",
         "LastModifiedDate": "\/Date(1723776119360)\/",
         "DisplayName": "Vadim Melamed",
         "Version": "1",
         "Mail": "vadim.melamed@vman.com",
         "Name": "vadim@vman.com",
         "ReportsTo": "Unassigned",
         "CreateDate": "\/Date(1672168595868)\/",
         "HomeNumber": "1234567890",
         "LockedByAdmin": false,
         "MobileNumber": "1234567890",
         "Alias": "vman.com",
         "OfficeNumber": "1234567890",
         "InEverybodyRole": true,
         "LastPasswordChangeDate": "\/Date(1690902157647)\/",
         "OauthClient": false,
         "PasswordNeverExpire": true
}

$false if failed