Add allowed referrer

This method adds a web application URL to the allowed referrer list. This means access is allowed from the URL to the PVWA. Any user who is a member of the Vault admins group can run this web service.

URL

  
https://{PVWA_SERVER}/passwordvault/api/Configuration/AccessRestriction/AllowedReferrers

  • Make sure there are no spaces in the URL.

  • The following characters are not supported in URL values: + & %

  • If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

Resource information

HTTP method

 Content type

POST

application/json

Header parameter

Parameter

Description
Authorization

The token that identifies the session, encoded in BASE 64.

Type: string

Mandatory: yes

Default value: none

Body parameters

  
{

  "referrerURL": "https://CompanyA/portal/",

  "regularExpression": false

}

 

Parameter

Description

referrerURL

The URL from where users will be able to access PVWA. You can specify either of the following:

■ A portal URL that allows access from any page or sub-directory under the company’s portal URL. For example, https://CompanyA/portal/.
■ The exact name of a URL that only allows access from a specific page. For example, https://CompanyB/management/dashboard.

Type: string

Mandatory: yes

Default value: none

regularExpression

Defines whether or not the URL is a regular expression.

Type: bool

Mandatory: no

Default value: false

Result

  
{

  "referrerURL": "https://CompanyA/portal/",

  "regularExpression": false

}

Parameter

Description

referrerURL

The URL from where users will be able to access PVWA.

Type: string

regularExpression

Defines whether or not the URL is a regular expression.

Type: bool

Return codes

For a complete list of return codes, see Return Codes.