psPAS

5.5.110

Functions/LDAPDirectories/Set-PASDirectoryMapping.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
 # .ExternalHelp psPAS-help.xml
function Set-PASDirectoryMapping {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$DirectoryName,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateLength(1, 28)]
        [string]$MappingID,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$MappingName,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$LDAPBranch,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string[]]$DomainGroups,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string[]]$VaultGroups,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$Location,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$LDAPQuery,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [Authorizations]$MappingAuthorizations,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateRange(1, 3650)]
        [int]$UserActivityLogPeriod

    )

    BEGIN {

        #10.7 functionality
        Assert-VersionRequirement -RequiredVersion 10.7

    }#begin

    PROCESS {

        #Get request parameters
        $boundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove DirectoryName, MappingID, MappingAuthorizations

        #Ensure minimum required version is being used.
        switch ($PSBoundParameters.Keys) {

            'MappingAuthorizations' {

                #Transform MappingAuthorizations
                $boundParameters.Add('MappingAuthorizations', [array][int]$MappingAuthorizations)
                Continue

            }

            'UserActivityLogPeriod' {

                #v10.10
                Assert-VersionRequirement -RequiredVersion 10.10
                Continue

            }

        }

        #Create URL for request
        $URI = "$Script:BaseURI/api/Configuration/LDAP/Directories/$DirectoryName/Mappings/$MappingID/"

        $body = $boundParameters | ConvertTo-Json

        if ($PSCmdlet.ShouldProcess($MappingID, 'Update Directory Mapping')) {

            #send request to web service
            $result = Invoke-PASRestMethod -Uri $URI -Method PUT -Body $Body -WebSession $Script:WebSession

            If ($null -ne $result) {

                #Return Results
                $result | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Directory.Mapping

            }

        }

    }#process

    END { }#end

}