Add-VPASMemberEPVGroup


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

ADD MEMBER TO EPV GROUP


Description:

USE THIS FUNCTION TO ADD A MEMBER TO AN EPV GROUP


Syntax:

Add-VPASMemberEPVGroup -GroupName <String> -EPVUserName <String> -UserSearchIn <String> -DomainDNS <String> [-token <Hashtable>] [<CommonParameters>]

Add-VPASMemberEPVGroup -GroupID <String> -EPVUserName <String> -UserSearchIn <String> -DomainDNS <String> [-token <Hashtable>] [<CommonParameters>]

Add-VPASMemberEPVGroup -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-GroupName <String>
Target EPV group name that a user will be added to

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

-GroupID <String>
Target EPV group ID that a user will be added to

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

-EPVUserName <String>
Target EPVUserName that will be added to target EPVGroup

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

-UserSearchIn <String>
Specify where to find the target EPVUser
Possible values: Vault, Domain

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

-DomainDNS <String>
Specify the target directory mapping of the target EPVUser if the user is coming from a location of type Domain

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:

$AddMemberEPVGroupStatus = Add-VPASMemberEPVGroup -GroupName {GROUPNAME VALUE} -EPVUserName {USERNAME VALUE} -UserSearchIn domain -DomainDNS vman

$AddMemberEPVGroupStatus = Add-VPASMemberEPVGroup -GroupID {GROUPID VALUE} -EPVUserName {USERNAME VALUE} -UserSearchIn vault -DomainDNS vault

$InputParameters = @{
        GroupName = "TargetGroup1"
         EPVUserName = "TargetUser@vman.com
         UserSearchIn = "Vault"|"Domain"
         DomainDNS = "vman.com"|"Vault"
}
$AddMemberEPVGroupStatus = Add-VPASMemberEPVGroup -InputParameters $InputParameters

$InputParameters = @{
        GroupID = 22
         EPVUserName = "TargetUser@vman.com
         UserSearchIn = "Vault"|"Domain"
         DomainDNS = "vman.com"|"Vault"
}
$AddMemberEPVGroupStatus = Add-VPASMemberEPVGroup -InputParameters $InputParameters


Outputs:

$true if successful

$false if failed