Functions/General/Add-PASAllowedReferrer.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
Function Add-PASAllowedReferrer {
    <#
.SYNOPSIS
Adds an entry to the allowed refferer list.

.DESCRIPTION
Adds a new web application URL to the allowed referrer list.
Vault admins group membership required.

.PARAMETER referrerURL
A URL from where access to PVWA will be allowed:

.PARAMETER regularExpression
Whether or not the URL is a regular expression.

.EXAMPLE
Add-PASAllowedReferrer -referrerURL "https://CompanyA/portal/"

Adds portal URL which permits access from any page or sub-directory

.EXAMPLE
Add-PASAllowedReferrer -referrerURL "https://CompanyB/management/dashboard"

Adds URL that only allows access from a specific page
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$referrerURL,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [boolean]$regularExpression
    )

    BEGIN {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion 11.5

    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/Configuration/AccessRestriction/AllowedReferrers"

        #Create request body
        $body = $PSBoundParameters | Get-PASParameter | ConvertTo-Json

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

        if ($result) {

            $result

        }

    }#process

    END { }#end

}