Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start on Security Overview beta release docs #8770

Open
wants to merge 19 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/en/docs/refguide/modeling/security/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,7 @@ Mendix applications that are deployed to SAP BTP can have SSO with SAP's IdP. Me
## Building an App as a Team {#team}

If you want to invite your colleagues to build your app, you can manage the **Team** in [Apps](https://sprintr.home.mendix.com/). Only team members who are invited to your app can access it (as a project to collaborate on). You can assign app roles to them. These team member roles define what they can access and change in the app in the backend while developing the app and are different from end-user roles which define what users can access in a running app. For more information, see [Team](/developerportal/general/team/) in the documentation of **Apps**.

## The Security Overview (Beta)

The Security Overview (Beta) provides you with a clear and unified overview of your application's security. Go to **App** > **Show Security Overview (Beta)** to access this overview. The Security Overview was introduced as a Beta feature in Mendix 10.18.
41 changes: 41 additions & 0 deletions content/en/docs/refguide/modeling/security/security-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "Security Overview (Beta)"
url: /refguide/security-overview/
weight: 20
---

{{% alert color="info" %}}
The Security Overview is currently a Beta feature introduced in Studio Pro 10.18.0. For more information on experimental features, see [Beta and Experimental Releases](/releasenotes/beta-features/).
{{% /alert %}}

## Introduction

The Security Overview provides you with a clear and unified overview of your application's security. This overview can be used to review the security of your application. The overview can be accessed via **App** > **Show Security Overview (Beta)**.

## The Security Overview layout: User roles and Modules

The security Overview summarizes the application's security for a selected user role. This user role can be selected in the dropdown at the top of the overview with the "Show access for user role:" label.

In the sidebar of the overview, the current module can be selected. This selection filters the content in the Entity access, Page access, Microflow access, and Nanoflow access tab. The list of modules does not show the System module or any protected modules.

## The tabs within the Security Overview

The Security Overview is split into four tabs: "Entity access", "Page access", "Microflow access" and "Nanoflow access". As of Mendix 10.18.0, only the "Entity access" tab is available. The other tabs will display a "Coming soon!" message.

{{< figure src="/attachments/refguide/modeling/security/app-security/user-roles/security-overview.png" class="no-border" >}}

## Entity access

The Entity Access tab shows a summarized view of the permissions that will be applied during runtime for all entities in the selected module for each user role. This helps developers and reviewers easily understand what an end user can or cannot access within the application.

The `Combined access rules` column aggregates all access rules applicable to the selected user role, reflecting the runtime behaviour. This means that if any access rule grants access to that user, the user will have access. For example, if one access rule grants Read and Create access and another access rule grants ReadWrite access, the combined access is ReadWrite and Create access.
Multiple columns will be shown for entities with XPath constraints. Access rules with the same XPath constraint are also combined here, so each XPath in this list is unique.

When the selected user role has no access to an attribute or an association, it will not be shown in the table. If the selected user role has no access to an entity at all, the entity will not be shown in the Security Overview.

* See [User Roles](/refguide/user-roles/) for more information on how user and module roles work in Mendix.
* See [Access Rule"s](/refguide/access-rules/) for more information on how access rules work in Mendix.

## Page, Microflow, and Nanoflow access

These tabs display tab a "Coming soon!" message.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.