-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #402 from JKlucka/jklu/DP-2706
DP-2706 Adding enforcing api token related APIs to documentation Reviewed-by: https://github.com/Mara3l
- Loading branch information
Showing
4 changed files
with
90 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
.../en/docs/administration/permissions/get_declarative_organization_permissions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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() | ||
``` |
29 changes: 29 additions & 0 deletions
29
docs/content/en/docs/administration/permissions/manage_organization_permissions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
``` |
29 changes: 29 additions & 0 deletions
29
.../en/docs/administration/permissions/put_declarative_organization_permissions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]) | ||
``` |