Account Transitive Parent Group

View as Markdown

A group that a principal belongs to, either directly or through another group.

List all transitive parent groups of a principalGET /api/2.0/identity/{parent=accounts/*/principals/*}/transitive-parent-groups

TransitiveParentGroup object

A group that a principal belongs to, either directly or through another group.

namestringIDImmutable

The resource name of the parent group, in one of these formats:

• Account APIs: accounts/{account_id}/principals/{principal_id}/transitive-parent-groups/{group_id}
• Workspace APIs: principals/{principal_id}/transitive-parent-groups/{group_id}

account_idstringOutput only

The ID of the account that contains the group.

group_idstringOutput only

The Databricks ID of the group.

external_idstringOutput only

The ID of the group in your identity provider (IdP).

View as Markdown

The TransitiveParentGroup object

{
  "name": "string",
  "account_id": "string",
  "group_id": "string",
  "external_id": "string"
}

List all transitive parent groups of a principal GA

GET /api/2.0/identity/{parent=accounts/*/principals/*}/transitive-parent-groups

Lists every group that a user, service principal, or group belongs to, directly or through other groups, sorted by Databricks ID. If automatic identity management is on, the principal's group memberships are synced from your identity provider first.

API scopes: identity

Parameters

parentstringRequiredpath

The user, service principal, or group whose parent groups to list, in the format accounts/{account_id}/principals/{principal_id}.

page_sizeint32query

The maximum number of groups to return, up to 1000. The default is 1000. A page can contain fewer groups.

page_tokenstringquery

The next_page_token from a previous response, to get the next page.

Response

Returns a list of TransitiveParentGroup objects.

View as Markdown

Response

{
  "transitive_parent_groups": [
    {
      "name": "string",
      "account_id": "string",
      "group_id": "string",
      "external_id": "string"
    }
  ],
  "next_page_token": "string"
}