Skip to main content

Workspace Transitive Parent Group

View as Markdown

Represents a group that is a transitive parent of a principal.

TransitiveParentGroup object

Represents a group that is a transitive parent of a principal.

account_idstringBetaOutput only: The parent account ID for group in <Databricks>.

group_idstringBetaOutput only: Internal group ID of the group in <Databricks>.

external_idstringBetaOutput only: ExternalId of the group in the customer's IdP.

List Beta

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

Lists all transitive parent groups of a principal.

API scopes: identity

Parameters

principal_idint64Requiredpath: Required. Internal ID of the principal in <Databricks> whose transitive parent groups are being listed.

page_sizeint32query: The maximum number of parent groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.

page_tokenstringquery: A page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page.

Response

Returns a list of TransitiveParentGroup objects.

View as Markdown

Response

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