Get-VPASIdentityRoles


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RETRIEVE ROLE DETAILS IN IDENTITY


Description:

USE THIS FUNCTION TO RETRIEVE ROLE DETAILS BASED ON A SEARCH QUERY IN IDENTITY


Syntax:

Get-VPASIdentityRoles [-SearchQuery] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-SearchQuery <String>
Search string to find target resource via username, address, safe, platform, etc.
Comma separated for multiple fields, or to search all pass a blank value like so: " "

Required: true
Position: 1
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: 2
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:

$RoleDetailsArray = Get-VPASIdentityRoles -SearchQuery {SEARCHQUERY VALUE}


Outputs:

If successful:
{
         "_TableName": "roles",
         "Name": "NewRoleVpas",
         "ID": "jkahfkjdf_2345_87564_sdf7_jkahsd824756",
         "OrgPath": null,
         "Description": "New role for documentation purposes",
         "IsHidden": null,
         "RoleType": "PrincipalList",
         "OrgId": null,
         "ReadOnly": false,
         "DirectoryServiceUuid": "0234234-1234-654F-ABBA-123456ABCD"
}

$false if failed