Add-VPASIdentityRole


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

ADD ROLE IN IDENTITY


Description:

USE THIS FUNCTION TO ADD A NEW ROLE INTO IDENTITY


Syntax:

Add-VPASIdentityRole [-RoleName] <String> [[-Description] <String>] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-RoleName <String>
Unique RoleName that will be applied to the new role being created in Identity

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

-Description <String>
An explanation/details of the target resource
Best practice states to leave informative descriptions to help identify the resource purpose

Required: false
Position: 2
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: 3
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:

$AddNewIdentityRole = Add-VPASIdentityRole -Name {NAME VALUE} -Description {DESCRIPTION VALUE}


Outputs:

If successful:
$AddNewIdentityRole = "152d9c38_38ba_4d94_9ff7_52342c77e709"

$false if failed