From 5189622f733ba39d6c98fffae3a97e3598216f56 Mon Sep 17 00:00:00 2001
From: Mara3l <Mara3l@proton.me>
Date: Wed, 1 Nov 2023 15:06:42 +0100
Subject: [PATCH] DP-2707: Adding dashboard docu

---
 .../docs/administration/permissions/_index.md |  3 ++
 .../permissions/list_available_assignees.md   | 37 +++++++++++++++
 .../permissions/list_dashboard_permissions.md | 37 +++++++++++++++
 .../manage_dashboard_permissions.md           | 47 +++++++++++++++++++
 4 files changed, 124 insertions(+)
 create mode 100644 docs/content/en/docs/administration/permissions/list_available_assignees.md
 create mode 100644 docs/content/en/docs/administration/permissions/list_dashboard_permissions.md
 create mode 100644 docs/content/en/docs/administration/permissions/manage_dashboard_permissions.md

diff --git a/docs/content/en/docs/administration/permissions/_index.md b/docs/content/en/docs/administration/permissions/_index.md
index 56ac34097..8eda13160 100644
--- a/docs/content/en/docs/administration/permissions/_index.md
+++ b/docs/content/en/docs/administration/permissions/_index.md
@@ -16,6 +16,9 @@ See [Manage Permissions](https://www.gooddata.com/developers/cloud-native/doc/cl
 * [get_declarative_organization_permissions](./get_declarative_organization_permissions/)
 * [put_declarative_permissions](./put_declarative_organization_permissions/)
 * [manage_organization_permissions](./manage_organization_permissions/)
+* [list_available_assignees](./list_available_assignees/)
+* [list_dashboard_permissions](./list_dashboard_permissions/)
+* [manage_dashboard_permissions](./manage_dashboard_permissions/)
 
 ## Example
 
diff --git a/docs/content/en/docs/administration/permissions/list_available_assignees.md b/docs/content/en/docs/administration/permissions/list_available_assignees.md
new file mode 100644
index 000000000..70200410a
--- /dev/null
+++ b/docs/content/en/docs/administration/permissions/list_available_assignees.md
@@ -0,0 +1,37 @@
+---
+title: "list_available_assignees"
+linkTitle: "list_available_assignees"
+weight: 17
+no_list: true
+superheading: "catalog_permission."
+---
+
+
+
+``list_available_assignees(workspace_id: str, dashboard_id: str) -> CatalogAvailableAssignees``
+
+Provide list of users and groups available to assign some dashboard permission
+
+{{% parameters-block  title="Parameters"%}}
+{{< parameter p_name="workspace_id" p_type="str" >}}
+Workspace identification string. e.g. "demo"
+{{< /parameter >}}
+{{< parameter p_name="dashboard_id" p_type="str" >}}
+Dashboard identification string. e.g. "campaign"
+{{< /parameter >}}
+{{% /parameters-block %}}
+
+{{% parameters-block title="Returns" %}}
+
+{{< parameter p_type="CatalogAvailableAssignees" >}}
+Object containing users and user groups
+{{< /parameter >}}
+
+{{% /parameters-block %}}
+
+## Example
+
+```python
+# list all assignees
+possible_assignees = list_available_assignees(workspace_id="demo",dashboard_id="sales")
+```
diff --git a/docs/content/en/docs/administration/permissions/list_dashboard_permissions.md b/docs/content/en/docs/administration/permissions/list_dashboard_permissions.md
new file mode 100644
index 000000000..b1ecf3415
--- /dev/null
+++ b/docs/content/en/docs/administration/permissions/list_dashboard_permissions.md
@@ -0,0 +1,37 @@
+---
+title: "list_dashboard_permissions"
+linkTitle: "list_dashboard_permissions"
+weight: 16
+no_list: true
+superheading: "catalog_permission."
+---
+
+
+
+``list_dashboard_permissions(workspace_id: str, dashboard_id: str) -> CatalogDashboardPermissions``
+
+Provide list of users and user groups with granted dashboard permissions for particular dashboard
+
+{{% parameters-block  title="Parameters"%}}
+{{< parameter p_name="workspace_id" p_type="str" >}}
+Workspace identification string. e.g. "demo"
+{{< /parameter >}}
+{{< parameter p_name="dashboard_id" p_type="str" >}}
+Dashboard identification string. e.g. "campaign"
+{{< /parameter >}}
+{{% /parameters-block %}}
+
+{{% parameters-block title="Returns" %}}
+
+{{< parameter p_type="CatalogDashboardPermissions" >}}
+Object containing users and user groups and granted dashboard permissions and any permission rules in effect.
+{{< /parameter >}}
+
+{{% /parameters-block %}}
+
+## Example
+
+```python
+# list all dashboard permissions
+permissions = list_dashboard_permissions(workspace_id="demo",dashboard_id="sales")
+```
diff --git a/docs/content/en/docs/administration/permissions/manage_dashboard_permissions.md b/docs/content/en/docs/administration/permissions/manage_dashboard_permissions.md
new file mode 100644
index 000000000..3fe340c6c
--- /dev/null
+++ b/docs/content/en/docs/administration/permissions/manage_dashboard_permissions.md
@@ -0,0 +1,47 @@
+---
+title: "manage_dashboard_permissions"
+linkTitle: "manage_dashboard_permissions"
+weight: 15
+no_list: true
+superheading: "catalog_permission."
+---
+
+
+
+``manage_dashboard_permissions(workspace_id: str, dashboard_id: str, permissions_for_assignee: List[Union[CatalogPermissionsForAssignee, CatalogPermissionsForAssigneeRule]] ) -> None``
+
+Provide managing dashboard permissions for user and user groups.
+
+{{% parameters-block  title="Parameters"%}}
+{{< parameter p_name="workspace_id" p_type="str" >}}
+Workspace identification string. e.g. "demo"
+{{< /parameter >}}
+{{< parameter p_name="dashboard_id" p_type="str" >}}
+Dashboard identification string. e.g. "campaign"
+{{< /parameter >}}
+{{< parameter p_name="permissions_for_assignee" p_type="List[CatalogPermissionsForAssignee]" >}}
+Object containing list of users, user groups, or rules and desired dashboard permissions. Set empty list permissions for user/user group means remove dashboard permissions.
+{{< /parameter >}}
+{{% /parameters-block %}}
+
+{{% parameters-block title="Returns" None="yes" %}}
+{{% /parameters-block %}}
+
+## Example
+
+```python
+manage_dashboard_permissions(
+    workspace_id="demo",
+    dashboard_id="sales",
+    permissions_for_assignee=[
+        CatalogPermissionsForAssignee(
+            assignee_identifier=CatalogAssigneeIdentifier(id="demoGroup", type="userGroup"),
+            permissions=["EDIT"],
+        ),
+        CatalogPermissionsForAssigneeRule(
+            assignee_rule=CatalogAssigneeRule(type="allWorkspaceUsers"),
+            permissions=["VIEW"],
+        ),
+    ],
+)
+```