Functions/UserMangement/Get-PVGroup.ps1

Function Get-PVGroup {

    <#
    .SYNOPSIS
    Returns details of a CyberArk group.

    .DESCRIPTION
    Exposes the PACLI Function: "GROUPDETAILS"

    .PARAMETER vault
    The defined Vault name

    .PARAMETER user
    The Username of the authenticated User.

    .PARAMETER group
    The name of the group

    .PARAMETER sessionID
    The ID number of the session. Use this parameter when working
    with multiple scripts simultaneously. The default is ‘0’.

    .EXAMPLE
    Get-PVGroup -vault Lab -user administrator -group cybr_admins -sessionID 0

    Lists details for cybr_admins group

    .NOTES
    AUTHOR: Pete Maan

    #>


    [CmdLetBinding()]
    param(

        [Parameter(
            Mandatory = $True,
            ValueFromPipelineByPropertyName = $True)]
        [string]$vault,

        [Parameter(
            Mandatory = $True,
            ValueFromPipelineByPropertyName = $True)]
        [string]$user,

        [Parameter(
            Mandatory = $True,
            ValueFromPipelineByPropertyName = $True)]
        [Alias("Groupname")]
        [string]$group,

        [Parameter(
            Mandatory = $False,
            ValueFromPipelineByPropertyName = $True)]
        [int]$sessionID
    )

    PROCESS {

        $Return = Invoke-PACLICommand $Script:PV.ClientPath GROUPDETAILS "$($PSBoundParameters.getEnumerator() |
                ConvertTo-ParameterString) OUTPUT (ALL,ENCLOSE)"


        if($Return.ExitCode -eq 0) {

            #if result(s) returned
            if($Return.StdOut) {

                #Convert Output to array
                $Results = (($Return.StdOut | Select-String -Pattern "\S") | ConvertFrom-PacliOutput)

                #loop through results
                For($i = 0 ; $i -lt $Results.length ; $i += 6) {

                    #Get Range from array
                    $values = $Results[$i..($i + 6)]

                    #Output Object
                    [PSCustomObject] @{

                        #assign values to properties
                        "Groupname"     = $group
                        "Description"   = $values[0]
                        "LDAPFullDN"    = $values[1]
                        "LDAPDirectory" = $values[2]
                        "MapID"         = $values[3]
                        "MapName"       = $values[4]
                        "ExternalGroup" = $values[5]

                    } | Add-ObjectDetail -TypeName pacli.PoShPACLI.Group -PropertyToAdd @{
                        "vault"     = $vault
                        "user"      = $user
                        "sessionID" = $sessionID
                    }

                }

            }

        }

    }

}