Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,7 @@ no_list: true
superheading: "catalog_organization."
---



``get_declarative_notification_channels()``

Get all declarative notification channels in the current organization.

{{% parameters-block title="Parameters" None="yes" %}}
{{% /parameters-block %}}

{{% parameters-block title="Returns" %}}
{{< parameter p_type="list[CatalogDeclarativeNotificationChannel]" >}}
List of declarative notification channels.
{{< /parameter >}}
{{% /parameters-block %}}
{{< api-ref "sdk.CatalogOrganizationService.get_declarative_notification_channels" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,7 @@ no_list: true
superheading: "catalog_organization."
---



``put_declarative_notification_channels(notification_channels: list[CatalogDeclarativeNotificationChannel])``

Put declarative notification channels in the current organization.

{{% parameters-block title="Parameters"%}}
{{< parameter p_name="notification_channels" p_type="list[CatalogDeclarativeNotificationChannel]" >}}
List of declarative notification channels.
{{< /parameter >}}
{{% /parameters-block %}}

{{% parameters-block title="Returns" None="yes" %}}
{{% /parameters-block %}}
{{< api-ref "sdk.CatalogOrganizationService.put_declarative_notification_channels" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,4 @@ superheading: "catalog_organization."
weight: 100
---

``create_or_update_jwk( jwk: CatalogJwk ) -> None``

Create a new jwk or overwrite an existing jwk with the same id.

## Parameters

| name | type | description |
| -- | -- | -- |
| jwk | CatalogJwk | Catalog Jwk object to be created or updated. |

## Returns

_None_
{{< api-ref "sdk.CatalogOrganizationService.create_or_update_jwk" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,4 @@ superheading: "catalog_organization."
weight: 100
---

``delete_jwk( jwk_id: str ) -> None``

Delete a jwk.

## Parameters

| name | type | description |
| -- | -- |-----------------------------------------|
| jwk_id | str | Jwk identification string e.g. "demo" |

## Returns

_None_
{{< api-ref "sdk.CatalogOrganizationService.delete_jwk" >}}
17 changes: 1 addition & 16 deletions docs/content/en/latest/administration/organization/get_jwk.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,4 @@ superheading: "catalog_organization."
weight: 100
---

``get_jwk( jwk_id: str ) -> CatalogJwk``

Get an individual jwk.

## Parameters

|name | type| description |
| --- | --- | --- |
| jwk_id | str | Jwk identification string e.g. "demo"|


## Returns

| type | description |
| --- |-----------------------------------------------------|
| CatalogJwk | Catalog jwk object containing structure of the jwk. |
{{< api-ref "sdk.CatalogOrganizationService.get_jwk" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,4 @@ superheading: "catalog_organization."
weight: 100
---

``list_jwks( ) -> List[CatalogJwk]``

Returns a list of all jwks in the current organization.

## Parameters

_None_

## Returns

| type | description |
| -- | -- |
| List[CatalogJwk] | List of jwks in the current organization. |
{{< api-ref "sdk.CatalogOrganizationService.list_jwks" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,7 @@ no_list: true
superheading: "catalog_organization."
---



``update_name(name: str)``

Updates the name of the organization.

{{% parameters-block title="Parameters"%}}

{{< parameter p_name="name" p_type="string" >}}
New name of the organization
{{< /parameter >}}
{{% /parameters-block %}}

{{% parameters-block title="Returns" None="yes"%}}
{{% /parameters-block %}}
{{< api-ref "sdk.CatalogOrganizationService.update_name" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,7 @@ no_list: true
superheading: "catalog_organization."
---



``update_oidc_parameters(oauth_issuer_location: Optional[str] = None, oauth_client_id: Optional[str] = None, oauth_client_secret: Optional[str] = None)``

Updates the OIDC parameters for a given users.

{{% parameters-block title="Parameters"%}}

{{< parameter p_name="oauth_issuer_location" p_type="Optional[string]" >}}
Issuer location. Defaults to None.
{{< /parameter >}}
{{< parameter p_name="oauth_client_id" p_type="Optional[string]" >}}
Public client identifier. Defaults to None.
{{< /parameter >}}
{{< parameter p_name="oauth_client_secret" p_type="Optional[string]" >}}
Client secret. Defaults to None.
{{< /parameter >}}
{{% /parameters-block %}}

{{% parameters-block title="Returns" None="yes"%}}
{{% /parameters-block %}}

{{% parameters-block title="Raises"%}}
{{< parameter p_name="ValueError" >}}
Parameters were not strictly all none or all string.
{{< /parameter >}}
{{% /parameters-block %}}
{{< api-ref "sdk.CatalogOrganizationService.update_oidc_parameters" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,7 @@ 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 %}}
{{< api-ref "sdk.CatalogPermissionService.get_declarative_organization_permissions" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,7 @@ no_list: true
superheading: "catalog_permission."
---



``get_declarative_permissions(workspace_id: str)``

Gets the current set of permissions of the workspace in a declarative form.

{{% parameters-block title="Parameters"%}}
{{< parameter p_name="workspace_id" p_type="string" >}}
Workspace identification string. e.g. "demo"
{{< /parameter >}}
{{% /parameters-block %}}

{{% parameters-block title="Returns"%}}
{{< parameter p_type="CatalogDeclarativeWorkspacePermissions" >}}
Object Containing Workspace Permissions.
{{< /parameter >}}
{{% /parameters-block %}}
{{< api-ref "sdk.CatalogPermissionService.get_declarative_permissions" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,7 @@ 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 %}}
{{< api-ref "sdk.CatalogPermissionService.list_available_assignees" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,7 @@ 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 %}}
{{< api-ref "sdk.CatalogPermissionService.list_dashboard_permissions" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,7 @@ no_list: true
superheading: "catalog_permission."
---



``manage_dashboard_permissions(workspace_id: str, dashboard_id: str, permissions_for_assignee: List[Union[CatalogPermissionsForAssigneeIdentifier, 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[Union[CatalogPermissionsForAssigneeIdentifier, CatalogPermissionsForAssigneeRule]]" >}}
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 %}}
{{< api-ref "sdk.CatalogPermissionService.manage_dashboard_permissions" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,7 @@ 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 %}}
{{< api-ref "sdk.CatalogPermissionService.manage_organization_permissions" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,7 @@ no_list: true
superheading: "catalog_permission."
---



``put_declarative_organization_permissions(org_permissions: List[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 %}}
{{< api-ref "sdk.CatalogPermissionService.put_declarative_organization_permissions" >}}

## Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,7 @@ no_list: true
superheading: "catalog_permission."
---



``put_declarative_permissions(workspace_id: str, declarative_workspace_permissions: CatalogDeclarativeWorkspacePermissions)``

Sets the permissions for the workspace.

{{% parameters-block title="Parameters"%}}
{{< parameter p_name="workspace_id" p_type="string" >}}
Workspace identification string. e.g. "demo"
{{< /parameter >}}
{{< parameter p_name="declarative_workspace_permissions" p_type="CatalogDeclarativeWorkspacePermissions" >}}
Object Containing Workspace Permissions.
{{< /parameter >}}
{{% /parameters-block %}}

{{% parameters-block title="Returns" None="yes" %}}
{{% /parameters-block %}}
{{< api-ref "sdk.CatalogPermissionService.put_declarative_permissions" >}}

## Example

Expand Down
Loading
Loading