a.groups_v2: Account Groups

class databricks.sdk.service.iam.AccountGroupsV2API

Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects.

It is best practice to assign access to workspaces and access-control policies in Unity Catalog to groups, instead of to users individually. All Databricks account identities can be assigned as members of groups, and members inherit permissions that are assigned to their group.

create([, display_name: Optional[str], external_id: Optional[str], id: Optional[str], members: Optional[List[ComplexValue]], meta: Optional[ResourceMeta], roles: Optional[List[ComplexValue]]]) → AccountGroup

Creates a group in the Databricks account with a unique name, using the supplied group details.

Parameters:

  • display_name – str (optional) String that represents a human-readable group name

  • external_id – str (optional)

  • id – str (optional) Databricks group ID

  • members – List[ComplexValue] (optional)

  • meta – ResourceMeta (optional) Container for the group identifier. Workspace local versus account.

  • roles – List[ComplexValue] (optional) Indicates if the group has the admin role.

Returns:

AccountGroup

delete(id: str)

Deletes a group from the Databricks account.

Parameters:

id – str Unique ID for a group in the Databricks account.

get(id: str) → AccountGroup

Gets the information for a specific group in the Databricks account.

Parameters:

id – str Unique ID for a group in the Databricks account.

Returns:

AccountGroup

list([, attributes: Optional[str], count: Optional[int], excluded_attributes: Optional[str], filter: Optional[str], sort_by: Optional[str], sort_order: Optional[ListSortOrder], start_index: Optional[int]]) → Iterator[AccountGroup]

Gets all details of the groups associated with the Databricks account. As of 08/22/2025, this endpoint will no longer return members. Instead, members should be retrieved by iterating through Get group details. Existing accounts that rely on this attribute will not be impacted and will continue receiving member data as before.

Parameters:

  • attributes – str (optional) Comma-separated list of attributes to return in response.

  • count – int (optional) Desired number of results per page. Default is 10000.

  • excluded_attributes – str (optional) Comma-separated list of attributes to exclude in response.

  • filter –

    str (optional) Query by which the results have to be filtered. Supported operators are equals(eq), contains(co), starts with(sw) and not equals(ne). Additionally, simple expressions can be formed using logical operators - and and or. The [SCIM RFC] has more details but we currently only support simple expressions.

    [SCIM RFC]: https://tools.ietf.org/html/rfc7644#section-3.4.2.2

  • sort_by – str (optional) Attribute to sort the results.

  • sort_order – ListSortOrder (optional) The order to sort the results.

  • start_index – int (optional) Specifies the index of the first result. First item is number 1.

Returns:

Iterator over AccountGroup

patch(id: str [, operations: Optional[List[Patch]], schemas: Optional[List[PatchSchema]]])

Partially updates the details of a group.

Parameters:
update(id: str [, display_name: Optional[str], external_id: Optional[str], members: Optional[List[ComplexValue]], meta: Optional[ResourceMeta], roles: Optional[List[ComplexValue]]])

Updates the details of a group by replacing the entire group entity.

Parameters:

  • id – str Databricks group ID

  • display_name – str (optional) String that represents a human-readable group name

  • external_id – str (optional)

  • members – List[ComplexValue] (optional)

  • meta – ResourceMeta (optional) Container for the group identifier. Workspace local versus account.

  • roles – List[ComplexValue] (optional) Indicates if the group has the admin role.