psPAS

5.5.110

Functions/User/Disable-PASUser.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

                                # .ExternalHelp psPAS-help.xml

function Disable-PASUser {

    [CmdletBinding(SupportsShouldProcess)]

    param(

        [parameter(

            Mandatory = $true,

            ValueFromPipelinebyPropertyName = $true

        )]

        [int]$id

    )

    BEGIN {

        Assert-VersionRequirement -RequiredVersion 12.6

    }#begin

    PROCESS {

        $URI = "$Script:BaseURI/API/Users/$id/disable/"

        if ($PSCmdlet.ShouldProcess($id, 'Disable User')) {

            #send request to web service

            Invoke-PASRestMethod -Uri $URI -Method POST -WebSession $Script:WebSession

        }

    }#process

    END { }#end

}