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

chore: add user restrictions section #3043

Merged
merged 26 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
416ba63
add user restrictions section
nathansandi Dec 13, 2023
2239ee6
Update sidebars.js
nathansandi Dec 13, 2023
cda6f5f
Update user-restrictions.md
nathansandi Dec 13, 2023
a19b6d3
Update optimize_sidebars.js
nathansandi Dec 13, 2023
fa3ac3b
Merge branch 'add-identity-doc-user-restriction' of https://github.co…
nathansandi Dec 13, 2023
957c3c2
adjust sidebar
christinaausley Dec 13, 2023
6794bba
style(formatting): technical review
christinaausley Dec 13, 2023
d98e657
Update sidebars.js
nathansandi Dec 14, 2023
b3977ce
Update optimize_sidebars.js
nathansandi Dec 14, 2023
a6e00c6
Update docs/self-managed/tasklist-deployment/tasklist-authentication.md
nathansandi Dec 14, 2023
5cd60bc
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
7da9173
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
9f934d4
Update docs/self-managed/identity/deployment/configuration-variables.md
nathansandi Dec 14, 2023
13d7a01
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
19ba7d6
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
fac1fde
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
32695ad
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
0c1e98e
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
7a28e0b
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
1031845
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
003f856
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
e57dddb
Update docs/self-managed/concepts/access-control/user-restrictions.md
nathansandi Dec 14, 2023
ebc0657
Update docs/self-managed/tasklist-deployment/tasklist-authentication.md
nathansandi Dec 14, 2023
088d317
Add code review changes
nathansandi Dec 14, 2023
2a6ac16
Update user-task-access-restrictions.md
christinaausley Dec 15, 2023
34ff1c1
Merge branch 'main' into add-identity-doc-user-restriction
akeller Dec 15, 2023
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: user-task-access-restrictions
title: "User task access restrictions"
sidebar_label: "User task access restrictions"
description: "Control the level of access a user or group has to perform tasks in the system via user task access restrictions."
---

:::caution
User task access restrictions are enabled by default and can be disabled using environment variables. This feature is controlled in the required component, see [Identity feature flags](../../../../self-managed/identity/deployment/configuration-variables/#feature-flags).
:::

User task access restrictions allow you to control the level of access a [user](/self-managed/identity/user-guide/roles/add-assign-role.md) or
[group](self-managed/identity/user-guide/groups/create-group.md) has to perform BPMN user tasks where they are candidates.

### User task access restrictions

[User task access restrictions](self-managed/tasklist-deployment/tasklist-authentication.md/#user-restrictions) are used in Tasklist to control task access for a
user or [group](/self-managed/identity/user-guide/groups/create-group.md). The restrictions are
related to the candidate users or groups set up on user task definitions.

For example, if a task has a candidate group named `Team A` and a candidate user named `example`, only the
users that belong to `Team A` and the user `example` will have access to the task.
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ Identity uses feature flag environment variables to enable and disable features;
| ---------------------------- | --------------------------------------------- | ------------- |
| RESOURCE_PERMISSIONS_ENABLED | Controls the resource authorizations feature. | false |
| MULTITENANCY_ENABLED | Controls the multi tenancy feature. | false |
| USER_RESTRICTIONS_ENABLED | Controls the user task access restrictions feature in Tasklist. | true |

:::note
Setting either of the feature flags to `true` requires a database connection. To configure a database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,9 @@ Take the `access_token` value from the response object and store it as your toke
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>" -d '{"query": "{tasks(query:{}){id name}}"}' http://localhost:8080/graphql
```

### User restrictions
### User task access restrictions

When the **User Restrictions** feature is enabled, Tasklist applies additional security measures to filter tasks based on user identity and authorization. The tasks displayed are restricted based on the candidate groups, candidate users, and assignee associated with the logged-in user. The benefits of this resource are:
To use this resource, the **User Task Access Restrictions** feature must be [enabled on Identity](/self-managed/concepts/access-control/user-task-access-restrictions.md). When it is active, Tasklist applies additional security measures to filter tasks based on user identity and authorization. The tasks displayed are restricted based on the candidate groups, candidate users, and assignee associated with the logged-in user. The benefits of this resource are:

- Enhanced security: Users only see tasks for which they have the necessary permissions, improving security and preventing unauthorized access.
- Tasklist customization: The Tasklist interface is tailored to display only relevant tasks for each user, providing a personalized and streamlined experience.
Expand Down
4 changes: 4 additions & 0 deletions optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1885,6 +1885,10 @@ module.exports = {
"Resource authorizations",
"self-managed/concepts/access-control/resource-authorizations/"
),
docsLink(
"User restrictions",
"self-managed/concepts/access-control/user-task-access-restrictions/"
),
],
},
docsLink("Exporters", "self-managed/concepts/exporters/"),
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -887,6 +887,7 @@ module.exports = {
"Access control": [
"self-managed/concepts/access-control/applications",
"self-managed/concepts/access-control/resource-authorizations",
"self-managed/concepts/access-control/user-task-access-restrictions",
],
},
"self-managed/concepts/exporters",
Expand Down
Loading