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

DP-2707: Adding dashboard docu #405

Merged
1 commit merged into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
3 changes: 3 additions & 0 deletions docs/content/en/docs/administration/permissions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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")
```
Original file line number Diff line number Diff line change
@@ -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")
```
Original file line number Diff line number Diff line change
@@ -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]" >}}
Mara3l marked this conversation as resolved.
Show resolved Hide resolved
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"],
),
],
)
```
Loading