Skip to content

UpdatePermissionGroupRequest

Source code in docs_src/capo_finspace_data/types/update_permission_group_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class UpdatePermissionGroupRequest(TypedDict, closed=True):
    permission_group_id: (
        "capo_finspace_data.types.permission_group_id.PermissionGroupId"
    )
    """<p>The unique identifier for the permission group to update.</p>"""
    name: NotRequired[
        "capo_finspace_data.types.permission_group_name.PermissionGroupName"
    ]
    """<p>The name of the permission group.</p>"""
    description: NotRequired[
        "capo_finspace_data.types.permission_group_description.PermissionGroupDescription"
    ]
    """<p>A brief description for the permission group.</p>"""
    application_permissions: NotRequired[
        "capo_finspace_data.types.application_permission_list.ApplicationPermissionList"
    ]
    """<p>The permissions that are granted to a specific group for accessing the FinSpace application.</p> <important> <p>When assigning application permissions, be aware that the permission <code>ManageUsersAndGroups</code> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</p> </important> <ul> <li> <p> <code>CreateDataset</code> – Group members can create new datasets.</p> </li> <li> <p> <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p> </li> <li> <p> <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.</p> </li> <li> <p> <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p> </li> <li> <p> <code>ViewAuditData</code> – Group members can view audit data.</p> </li> <li> <p> <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p> </li> <li> <p> <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p> </li> </ul>"""
    client_token: NotRequired["capo_finspace_data.types.client_token.ClientToken"]
    """<p>A token that ensures idempotency. This token expires in 10 minutes.</p>"""

application_permissions instance-attribute 

application_permissions: NotRequired[ApplicationPermissionList]

The permissions that are granted to a specific group for accessing the FinSpace application.

When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

  • CreateDataset – Group members can create new datasets.

  • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.

  • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

  • ManageAttributeSets – Group members can manage attribute sets.

  • ViewAuditData – Group members can view audit data.

  • AccessNotebooks – Group members will have access to FinSpace notebooks.

  • GetTemporaryCredentials – Group members can get temporary API credentials.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

A token that ensures idempotency. This token expires in 10 minutes.

description instance-attribute 

description: NotRequired[PermissionGroupDescription]

A brief description for the permission group.

name instance-attribute 

name: NotRequired[PermissionGroupName]

The name of the permission group.

permission_group_id instance-attribute 

permission_group_id: PermissionGroupId

The unique identifier for the permission group to update.