> For the complete documentation index, see llms.txt.
Skip to main content

Check out Port for yourself ➜ 

Page permissions

Page permissions are used to control access to catalog pages and dashboard pages in the software catalog.

These permissions help ensure the right people see the right operational surfaces. The same model that controls what developers can view also controls what agents can access.

Using these permissions, you can control which users, teams, and/or agents can view or edit a specific page.

Update page permissions​

Only users with the admin role can update the permissions of a page.

Admins can:

  • Define which users and/or teams can view the page.
  • Define which users and/or teams can edit the page.
  • Allow all users in the organization to view the page.

Update methods​

Use one of the following methods to update page permissions:

For organization pages, open the permissions modal using one of the following:

  • Click the permissions Permissions iconPermissions icon button in the top-right corner of the page.
  • Open the page menu and select Permissions.

For private pages, open the page menu and select Share page.

Select the users or teams you want to grant view or edit access to, then click Done.

To allow all users in the organization to view an organization page, use the toggle at the bottom of the permissions modal. This toggle is not available for private pages.

Examples​

Let's present a set of page permissions and then explore how different PATCH request bodies change the effective permissions of the page.

Given the following permissions for a page:

{
  "read": {
    "roles": ["Admin", "Member"],
    "users": [],
    "teams": []
  }
}

Add permissions to role​

Making an HTTP PATCH request with the following body will give the Services-Moderator role permissions to view the page (without removing the permissions of any existing role):

{
  "read": {
    "roles": ["Admin", "Member", "Services-Moderator"]
  }
}

Remove permissions from role​

Making an HTTP PATCH request with the following body will remove the Member role's permissions to view the page:

{
  "read": {
    "roles": ["Admin"]
  }
}

Add permissions to user​

Making an HTTP PATCH request with the following body will give the specified users permissions to view the page (without changing the permissions of existing roles):

{
  "read": {
    "users": ["exampleUser1@example.com", "exampleUser2@example.com"]
  }
}

Add permissions to team​

Making an HTTP PATCH request with the following body will give the specified teams permissions to view the page (without changing the permissions of existing roles):

{
  "read": {
    "teams": ["team1", "team2"]
  }
}
PATCH removes unspecified permissions

It is possible to update multiple permission keys (roles, teams, and/or users) in a single PATCH request. Keep in mind that any role, team, or user that is not specified and previously had permissions for the page will lose those permissions.

Lock pages​

Locking the page affects widgets that have Filter and/or Hide functionality.

See the section below for the different methods to lock a page:

Users who have permissions to update a page (usually users with the admin role) can lock the page's widgets.

  1. Save the page in the desired view by clicking the save page button.
  2. Open the page menu and click on lock page.

A locked page will have the Lock icon next to the page's title:

Page title with lock icon