Functions/User/Get-PASGroup.ps1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# .ExternalHelp psPAS-help.xml function Get-PASGroup { [CmdletBinding(DefaultParameterSetName = 'groupType')] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'byID' )] [int]$id, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'groupType' )] [ValidateSet('Directory', 'Vault')] [string]$groupType, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'groupType' )] [string]$groupName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'groupType' )] [string[]]$sort, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'groupType' )] [string]$search, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'byID' )] [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true, ParameterSetName = 'groupType' )] [boolean]$includeMembers ) BEGIN { Assert-VersionRequirement -RequiredVersion 10.5 #Parameter to include in request $Parameters = [Collections.Generic.List[Object]]::New(@('groupType', 'groupName', 'id')) }#begin PROCESS { #Create URL for request $URI = "$Script:BaseURI/API/UserGroups" #Get Parameters to include in request $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove $Parameters switch ($PSCmdlet.ParameterSetName) { 'ByID' { #id parameter require 12.6 Assert-VersionRequirement -RequiredVersion 12.6 #Create URL for request $URI = "$URI/$id/" break } default { switch ($PSBoundParameters.Keys) { { $_ -match 'includeMembers' } { #includeMembers parameter require 12.0 Assert-VersionRequirement -RequiredVersion 12.0 continue } { $_ -match 'sort|groupName' } { #Sort parameter require 12.2 Assert-VersionRequirement -RequiredVersion 12.2 } } #Parse parameters to include as filter value in url $null = $Parameters.Remove('id') $filterProperties = $PSBoundParameters | Get-PASParameter -ParametersToKeep $Parameters $FilterString = $filterProperties | ConvertTo-FilterString If ($null -ne $FilterString) { $boundParameters = $boundParameters + $FilterString } } } #Create Query String, escaped for inclusion in request URL $queryString = $boundParameters | ConvertTo-QueryString if ($null -ne $queryString) { #Build URL from base URL $URI = "$URI`?$queryString" } #send request to web service $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession If ($null -ne $result) { switch ($PSCmdlet.ParameterSetName) { 'groupType' { $result = $result.value Continue } } $result | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Group } }#process END { }#end } |