Get-VPASIdentityAllRoles


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RETRIEVE ALL ROLES IN IDENTITY


Description:

USE THIS FUNCTION TO RETRIEVE ALL ROLES IN IDENTITY


Syntax:

Get-VPASIdentityAllRoles [[-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:

$AllRolesArray = Get-VPASIdentityAllRoles


Outputs:

If successful:
{
         "value": [
                 ...
                 {
                         "_TableName": "roles",
                         "Name": "NewRoleVpas",
                         "ID": "wdsefg456_3456_6789_dfgh_dfgh7654",
                         "OrgPath": null,
                         "Description": "New role for documentation purposes",
                         "IsHidden": null,
                         "RoleType": "PrincipalList",
                         "OrgId": null,
                         "ReadOnly": false,
                         "DirectoryServiceUuid": "7982479482-3298ABCD-ABCDE-4232-37869385"
                 },
                 {
                         "_TableName": "roles",
                         "Name": "NewVmanRole",
                         "ID": "wd34534_erty_yuio_6545_8975hkjsl",
                         "OrgPath": null,
                         "Description": "New test role",
                         "IsHidden": null,
                         "RoleType": "PrincipalList",
                         "OrgId": null,
                         "ReadOnly": false,
                         "DirectoryServiceUuid": "3298ABCD-4232-465F-ABCDE-467834698213"
                 },
                 ...
         ]
}

$false if failed