Get-VPASIdentityAllUsers


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RETRIEVE ALL USERS IN IDENTITY


Description:

USE THIS FUNCTION TO RETRIEVE ALL USERS IN IDENTITY


Syntax:

Get-VPASIdentityAllUsers [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-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: 1
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:

$AllIdentityUsers = Get-VPASIdentityAllUsers


Outputs:

If successful:
{
         "IsAggregate": false,
         "Count": 40,
         "Columns": [
                 {
                         "Name": "Uuid",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "Uuid",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "DisplayName",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "DisplayName",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "Description",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "Description",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "Mail",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "Mail",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "Name",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "Name",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "OfficeNumber",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "OfficeNumber",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "MobileNumber",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "MobileNumber",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "HomeNumber",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "HomeNumber",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "StartDate",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "StartDate",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 0,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "EndDate",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "EndDate",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 0,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "ReportsTo",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "ReportsTo",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 12,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "PictureUri",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "PictureUri",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 0,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 },
                 {
                         "Name": "PreferredCulture",
                         "IsHidden": false,
                         "DDName": null,
                         "Title": "PreferredCulture",
                         "DDTitle": null,
                         "Description": null,
                         "Type": 0,
                         "Format": null,
                         "Width": 0,
                         "TableKey": null,
                         "ForeignKey": null,
                         "TableName": null
                 }
         ],
         "FullCount": 40,
         "Results": [
                 ...
                 {
                         "Entities": "",
                 "Row": "@{Uuid=jkdfh2389742-werw-sdff-3456-345897sdfkjh; DisplayName=VmanAPI; Mail=; Name=VmanAPI@vman.com; ReportsTo=Unassigned; PreferredCulture=; HomeNumber=; StartDate=; MobileNumber=; EndDate=; PictureUri=; Description=; OfficeNumber=}"
                 },
                 {
                         "Entities": "",
                 "Row": "@{Uuid=lsdflks43890-sdff-5344-1221-slkdjf489579; DisplayName=Vadim Melamed; Mail=vadim.melamed@vman.com; Name=vadim@vman.com; ReportsTo=Unassigned; PreferredCulture=; HomeNumber=1234567890; StartDate=; MobileNumber=1234567890; EndDate=; PictureUri=; Description=; OfficeNumber=1234567890}"
                 },
                 ...
         ],
         "ReturnID": ""
}

$false if failed