vco:PageAccessControl Component

The vco:PageAccessControl component allows or denies users access to the Web view page that contains this component. The vco:PageAccessControl component checks the membership of the Web view user to an LDAP group.

If the user is a member of at least one group that the deny attribute defines, the Web view denies the user access to the page. If the user is not a member of a group in the deny attribute, the component checks the allow attribute.

If the user is a member of at least one group that the allow attribute defines, the user can access the page. Otherwise, the Web view does not display the page.

You set the LDAP groups of users who can view the page as Web view attributes in the Orchestrator client.

Properties

The vco:PageAccessControl component defines the following properties.

Name	Type	Description
`deny`	String	A Web view attribute of the type LdapGroup, or an array of LdapGroup objects.
`allow`	String	A Web view attribute of the type LdapGroup, or an array of LdapGroup objects.
`redirectUrl`	String	A URL to which to redirect the user if they are not authorized to view the page. If `redirectUrl` is not set, the Web view returns a 403 error.
`message`	String	If `redirectUrl` is set and `message` is set, the URL of the page to which the Web view redirects the user contains a `msg`query parameter and the contents of the `message` property. For example `error_page.html`?msg=`message_content`.

Example: vco:PageAccessControl Component

The following example code line allows access to a page to users who are members of the group that the adminGroup Web view attribute defines.

<span jwcid="@vco:PageAccessControl" allow="adminGroup"/>

The following example code line denies access to a page to users who are members of the group that the partnerGroup Web view attribute defines.

<span jwcid="@vco:PageAccessControl" deny="partnerGroup"/>

The following example code line redirects users who are members of the partnerGroup LDAP group to an error page. The error401.html file is at the root of the Web view file structure.

<span jwcid="@vco:PageAccessControl" deny="partnerGroup" redirectUrl="error401.html"/>