Skip to main content

transitive_parent_groups

Creates, updates, deletes, gets or lists a transitive_parent_groups resource.

Overview​

Nametransitive_parent_groups
TypeResource
Iddatabricks_account.iamv2.transitive_parent_groups

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
account_idstringThe parent account ID for group in Databricks.
external_idstringExternalId of the group in the customer's IdP.
group_idstringInternal group ID of the group in Databricks.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectaccount_id, principal_id, account_hostpage_size, page_tokenLists all transitive parent groups of a principal.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
account_hoststringThe Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}})
account_idstring
principal_idintegerRequired. Internal ID of the principal in Databricks whose transitive parent groups are being listed.
page_sizeintegerThe 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_tokenstringA page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page.

SELECT examples​

Lists all transitive parent groups of a principal.

SELECT
account_id,
external_id,
group_id
FROM databricks_account.iamv2.transitive_parent_groups
WHERE account_id = '{{ account_id }}' -- required
AND principal_id = '{{ principal_id }}' -- required
AND account_host = '{{ account_host }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;