Functions/Accounts/New-PASAccountPassword.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
# .ExternalHelp psPAS-help.xml
function New-PASAccountPassword {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [Alias('id')]
        [string]$AccountID
    )

    BEGIN {

        #check minimum version
        Assert-VersionRequirement -RequiredVersion 12.0

    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/Accounts/$AccountID/Secret/Generate"

        if ($PSCmdlet.ShouldProcess($AccountID, 'Generate New Password')) {

            #Send request to webservice
            $result = Invoke-PASRestMethod -Uri $URI -Method POST -WebSession $Script:WebSession

            if ($null -ne $result) {

                #Unescape returned string.
                $result = [System.Text.RegularExpressions.Regex]::Unescape($result.password)

                [PSCustomObject] @{'Password' = $result } | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Credential

            }

        }

    }#process

    END { }#end

}