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..ba0dbba8c --- /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 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 >}} +{{% /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..86f88bf5c --- /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 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 >}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns" %}} + +{{< parameter p_type="CatalogDashboardPermissions" >}} +Object containing users and user groups and granted dashboard permissions +{{< /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..56527d94d --- /dev/null +++ b/docs/content/en/docs/administration/permissions/manage_dashboard_permissions.md @@ -0,0 +1,34 @@ +--- +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 and user group 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 + +```