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-2706 Adding enforcing api token related APIs to documentation #402

Merged
1 commit merged into from
Nov 1, 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 @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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()
```
Original file line number Diff line number Diff line change
@@ -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)
```
Original file line number Diff line number Diff line change
@@ -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])
```
Loading