From 7a215d980865c6b9831aae1a5c396617a5922202 Mon Sep 17 00:00:00 2001 From: JKlucka Date: Wed, 1 Nov 2023 09:18:19 +0100 Subject: [PATCH] DP-2706 Adding enforcing api token related APIs to documentation --- .../docs/administration/permissions/_index.md | 3 ++ ...et_declarative_organization_permissions.md | 29 +++++++++++++++++++ .../manage_organization_permissions.md | 29 +++++++++++++++++++ ...ut_declarative_organization_permissions.md | 29 +++++++++++++++++++ 4 files changed, 90 insertions(+) create mode 100644 docs/content/en/docs/administration/permissions/get_declarative_organization_permissions.md create mode 100644 docs/content/en/docs/administration/permissions/manage_organization_permissions.md create mode 100644 docs/content/en/docs/administration/permissions/put_declarative_organization_permissions.md diff --git a/docs/content/en/docs/administration/permissions/_index.md b/docs/content/en/docs/administration/permissions/_index.md index c6a096f15..56ac34097 100644 --- a/docs/content/en/docs/administration/permissions/_index.md +++ b/docs/content/en/docs/administration/permissions/_index.md @@ -13,6 +13,9 @@ See [Manage Permissions](https://www.gooddata.com/developers/cloud-native/doc/cl * [get_declarative_permissions](./get_declarative_permissions/) * [put_declarative_permissions](./put_declarative_permissions/) +* [get_declarative_organization_permissions](./get_declarative_organization_permissions/) +* [put_declarative_permissions](./put_declarative_organization_permissions/) +* [manage_organization_permissions](./manage_organization_permissions/) ## Example diff --git a/docs/content/en/docs/administration/permissions/get_declarative_organization_permissions.md b/docs/content/en/docs/administration/permissions/get_declarative_organization_permissions.md new file mode 100644 index 000000000..9ebc43666 --- /dev/null +++ b/docs/content/en/docs/administration/permissions/get_declarative_organization_permissions.md @@ -0,0 +1,29 @@ +--- +title: "get_declarative_organization_permissions" +linkTitle: "get_declarative_organization_permissions" +weight: 10 +no_list: true +superheading: "catalog_permission." +--- + + + +``get_declarative_organization_permissions()`` + +Gets the current set of permissions of the workspace in a declarative form. + +{{% parameters-block title="Parameters" None="yes" %}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns"%}} +{{< parameter p_type="List[CatalogDeclarativeOrganizationPermission]" >}} +List of Objects Containing Organization Permissions. +{{< /parameter >}} +{{% /parameters-block %}} + +## Example + +```python +# Get organization permissions in declarative from +declarative_permissions = sdk.catalog_permission.get_declarative_organization_permissions() +``` diff --git a/docs/content/en/docs/administration/permissions/manage_organization_permissions.md b/docs/content/en/docs/administration/permissions/manage_organization_permissions.md new file mode 100644 index 000000000..96676fbf9 --- /dev/null +++ b/docs/content/en/docs/administration/permissions/manage_organization_permissions.md @@ -0,0 +1,29 @@ +--- +title: "manage_organization_permissions" +linkTitle: "manage_organization_permissions" +weight: 20 +no_list: true +superheading: "catalog_permission." +--- + + + +``manage_organization_permissions(organization_permission_assignments: List[CatalogOrganizationPermissionAssignment])`` + +Manage the permissions of the whole organization. + +{{% parameters-block title="Parameters"%}} +{{< parameter p_name="organization_permission_assignments" p_type="List[CatalogOrganizationPermissionAssignment]" >}} +List of Organization Permission Assignments. +{{< /parameter >}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns" None="yes" %}} +{{% /parameters-block %}} + +## Example + +```python +# Update permissions on the server with your changes +sdk.catalog_permission.manage_organization_permissions(organization_permission_assignments=org_permissions_assignments) +``` diff --git a/docs/content/en/docs/administration/permissions/put_declarative_organization_permissions.md b/docs/content/en/docs/administration/permissions/put_declarative_organization_permissions.md new file mode 100644 index 000000000..8675c1572 --- /dev/null +++ b/docs/content/en/docs/administration/permissions/put_declarative_organization_permissions.md @@ -0,0 +1,29 @@ +--- +title: "put_declarative_organization_permissions" +linkTitle: "put_declarative_organization_permissions" +weight: 20 +no_list: true +superheading: "catalog_permission." +--- + + + +``put_declarative_organization_permissions(org_permissions: CatalogDeclarativeOrganizationPermission)`` + +Sets the permissions for the whole organization. + +{{% parameters-block title="Parameters"%}} +{{< parameter p_name="org_permissions" p_type="List[CatalogDeclarativeOrganizationPermission]" >}} +List of Organization Permissions. +{{< /parameter >}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns" None="yes" %}} +{{% /parameters-block %}} + +## Example + +```python +# Update permissions on the server with your changes +sdk.catalog_permission.put_declarative_organization_permissions(org_permissions=List[declarative_org_permissions]) +```