Skip to content
Release: Australia · Updated: 2026-06-01 · Official documentation · View source

Configure widget security in the GDS Service Portal by role

Configure widget security to verify that your GDS Service Portal widgets are being accessed only by the intended audience.

Before you begin

Role required: admin or sp_admin

About this task

There are several ways to configure widget security:

  • Restrict the widget to users with a login only (authenticated users)
  • Restrict the widget to users with certain roles only
  • Restrict which tables a public widget can access and return data from for guest (unauthenticated) users

When you configure widget security, configure the page security accordingly so that users can access the widget via the page on which it appears. For more information, see Configure page security.

Procedure

  1. Navigate to All > Service Portal > Widgets.

  2. Open the record of the widget to configure.

  3. On the form, configure the widget security.

OptionProcedure
Restrict the widget to authenticated usersUnselect the check box next to Public and leave the Roles field blank. This will display the widget to ALL users with a login.
Restrict the widget to certain roles
  1. Clear the Public check box.
  2. Next to Roles, select the edit icon (
    Image omitted: edit-icon.png
    Edit icon).</li>
  3. In the Roles related list, select a role by moving it from the Available list to the Selected list.
  4. Select Done.
  1. Select Update.

What to do next

For more information on configuring portal access by role, see Managing portal access.

Parent Topic:Manage role-based access to pages and widgets in GOV.UK Design System Service Portal

Previous topic:Configure page security in the GDS Service Portal by role

Next topic:Configure the Grants Management Portal