Get-VPASIdentityRoleDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RETRIEVE SPECIFIC ROLE DETAILS IN IDENTITY


Description:

USE THIS FUNCTION TO RETRIEVE SPECIFIC ROLE DETAILS IN IDENTITY


Syntax:

Get-VPASIdentityRoleDetails -RoleName <String> [-token <Hashtable>] [<CommonParameters>]

Get-VPASIdentityRoleDetails -RoleID <String> [-token <Hashtable>] [<CommonParameters>]

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


Parameters:

-RoleName <String>
Unique RoleName in Identity to query for target RoleID

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

-RoleID <String>
Target RoleID that maps the target Role in Identity
Supply the RoleID to skip querying for the target Role

Required: true
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:

$RoleDetailsArray = Get-VPASIdentityRoleDetails -Rolename {ROLENAME VALUE}

$RoleDetailsArray = Get-VPASIdentityRoleDetails -RoleID {ROLEID VALUE}

$InputParameters = @{
        RoleName = "VPASModuleTestingRole"
}
$RoleDetailsArray = Get-VPASIdentityRoleDetails -InputParameters $InputParameters

$InputParameters = @{
        RoleID = "jkahd786_sdfg_ghjf_4567_jdhfkj289743"
}
$RoleDetailsArray = Get-VPASIdentityRoleDetails -InputParameters $InputParameters


Outputs:

If successful:
{
         "_TableName": "roles",
         "Name": "NewRoleVpas",
         "ID": "jkahd786_sdfg_ghjf_4567_jdhfkj289743",
         "OrgPath": null,
         "Description": "New role for documentation purposes",
         "IsHidden": null,
         "RoleType": "PrincipalList",
         "OrgId": null,
         "ReadOnly": false,
         "DirectoryServiceUuid": "2798457982-ABCD-ABCDE-2345-895743ABCDE"
}

$false if failed