Skip to content

PermissionGroup

Source code in docs_src/capo_finspace_data/types/permission_group.py
class PermissionGroup(TypedDict, closed=True):
    permission_group_id: NotRequired[
        "capo_finspace_data.types.permission_group_id.PermissionGroupId"
    ]
    """<p> The unique identifier for the permission group.</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>Indicates 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>"""
    create_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds. </p>"""
    last_modified_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds. </p>"""
    membership_status: NotRequired[
        "capo_finspace_data.types.permission_group_membership_status.PermissionGroupMembershipStatus"
    ]
    """<p>Indicates the status of the user within a permission group.</p> <ul> <li> <p> <code>ADDITION_IN_PROGRESS</code> – The user is currently being added to the permission group.</p> </li> <li> <p> <code>ADDITION_SUCCESS</code> – The user is successfully added to the permission group.</p> </li> <li> <p> <code>REMOVAL_IN_PROGRESS</code> – The user is currently being removed from the permission group.</p> </li> </ul>"""

application_permissions instance-attribute

application_permissions: NotRequired[ApplicationPermissionList]

Indicates 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.

create_time instance-attribute

create_time: TimestampEpoch

The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

description instance-attribute

description: NotRequired[PermissionGroupDescription]

A brief description for the permission group.

last_modified_time instance-attribute

last_modified_time: TimestampEpoch

Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

membership_status instance-attribute

membership_status: NotRequired[PermissionGroupMembershipStatus]

Indicates the status of the user within a permission group.

  • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

  • ADDITION_SUCCESS – The user is successfully added to the permission group.

  • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

name instance-attribute

name: NotRequired[PermissionGroupName]

The name of the permission group.

permission_group_id instance-attribute

permission_group_id: NotRequired[PermissionGroupId]

The unique identifier for the permission group.