Remove-VPASIdentityRole


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

DELETE ROLE IN IDENTITY


Description:

USE THIS FUNCTION TO DELETE AN EXISTING ROLE IN IDENTITY


Syntax:

Remove-VPASIdentityRole -RoleName <String> [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASIdentityRole -RoleID <String> [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASIdentityRole -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

-WhatIf [<SwitchParameter>]
Run code simulation to see what is affected by running the command as well as any possible implications
This is a code simulation flag, meaning the command will NOT actually run

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

-HideWhatIfOutput [<SwitchParameter>]
Suppress any code simulation output from the console

Required: false
Position: named
Default value: False
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:

$WhatIfSimulation = Remove-VPASIdentityRole -Name {NAME VALUE} -WhatIf

$DeleteIdentityRole = Remove-VPASIdentityRole -Name {NAME VALUE}

$DeleteIdentityRole = Remove-VPASIdentityRole -RoleID {ROLEID VALUE}

$InputParameters = @{
        RoleName = "targetRolename"
         WhatIf = $true|$false
         HideWhatIfOutput = $true|$false
}
$DeleteIdentityRole = Remove-VPASIdentityRole -InputParameters $InputParameters

$InputParameters = @{
        RoleID = "1234-abcde-5678-lmnop-0987hjkj98"
         WhatIf = $true|$false
         HideWhatIfOutput = $true|$false
}
$DeleteIdentityRole = Remove-VPASIdentityRole -InputParameters $InputParameters


Outputs:

$true if successful

$false if failed