VpasModule

13.0.0

public/VCreateEPVGroup.ps1

<#
.Synopsis
   CREATE EPV GROUP
   CREATED BY: Vadim Melamed, EMAIL: vmelamed5@gmail.com
.DESCRIPTION
   USE THIS FUNCTION TO CREATE AN EPV GROUP IN CYBERARK
.EXAMPLE
   $VCreateEPVGroupJSON = VCreateEPVGroup -token {TOKEN VALUE} -GroupName {GROUPNAME VALUE} -Description {DESCRIPTION VALUE} -Location {LOCATION VALUE}
.OUTPUTS
   JSON Object (Group Details) if successful
   $false if failed
#>
function VCreateEPVGroup{
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true,Position=0)]
        [hashtable]$token,

        [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true,Position=1)]
        [String]$GroupName,

        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=2)]
        [String]$Description,

        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=3)]
        [String]$Location,

        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=4)]
        [Switch]$NoSSL
    
    )

    Write-Verbose "SUCCESSFULLY PARSED PVWA VALUE"
    Write-Verbose "SUCCESSFULLY PARSED TOKEN VALUE"
    Write-Verbose "SUCCESSFULLY PARSED GROUPNAME VALUE: $GroupName"

    try{
        $tokenval = $token.token
        $sessionval = $token.session
        $PVWA = $token.pvwa
        $Header = $token.HeaderType
        $ISPSS = $token.ISPSS

        $params = @{}
        $params+=@{ groupName = $GroupName }
        Write-Verbose "ADDED GROUPNAME: $GroupName TO API PARAMETERS"

        if([String]::IsNullOrEmpty($Description)){
            Write-Verbose "NO DESCRIPTION SUPPLIED, SKIPPING"
        }
        else{
            $params+=@{ description = $Description }
            Write-Verbose "ADDED DESCRIPTION: $Description TO API PARAMETERS"
        }

        if([String]::IsNullOrEmpty($Location)){
            $params+=@{ location = "\" }
            Write-Verbose "NO LOCATION SUPPLIED, PLACING GROUP IN ROOT"
        }
        else{
            $locationstr = "\" + $Location
            $params+=@{ location = $locationstr }
            Write-Verbose "ADDED LOCATION: $Location TO API PARAMETERES"
        }
        $params = $params | ConvertTo-Json
        Write-Verbose "FINISHED SETTING UP API PARAMETERS"

        if($NoSSL){
            Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS"
            $uri = "http://$PVWA/PasswordVault/api/UserGroups"
        }
        else{
            Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS"
            $uri = "https://$PVWA/PasswordVault/api/UserGroups"
        }
    
        Write-Verbose "MAKING API CALL TO CYBERARK"
        if($sessionval){
            $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json" -WebSession $sessionval
        }
        else{
            $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json"  
        }
        Write-Verbose "SUCCESSFULLY CREATED EPV GROUP: $GroupName"
        Write-Verbose "RETURNING GROUP DETAILS"
        return $response
    }catch{
        Write-Verbose "UNABLE TO CREATE EPV GROUP: $Groupname"
        Vout -str $_ -type E
        return $false
    }
}