Skip to main content

Workspace Transitive Parent Group

View as Markdown

A group that a principal belongs to, either directly or through another group. To list a principal's parent groups, put the principal's resource name in the URL: GET /api/2.0/identity/accounts/{account_id}/principals/{principal_id}/transitive-parent-groups in account APIs, or GET /api/2.0/identity/principals/{principal_id}/transitive-parent-groups in workspace APIs.

TransitiveParentGroup object​

A group that a principal belongs to, either directly or through another group. To list a principal's parent groups, put the principal's resource name in the URL: GET /api/2.0/identity/accounts/{account_id}/principals/{principal_id}/transitive-parent-groups in account APIs, or GET /api/2.0/identity/principals/{principal_id}/transitive-parent-groups in workspace APIs.

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

List all transitive parent groups of a principal GA​

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

Lists every group that a user, service principal, or group belongs to, directly or through other groups, in the account that contains this workspace. Results are 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 principals/{principal_id}.

Example: principals/6412798305127934

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.