account_groups

Creates, updates, deletes, gets or lists an account_groups resource.

Overview

Name	account_groups
Type	Resource
Id	databricks_account.iam.account_groups

Fields

The following fields are returned by SELECT queries:

account_groups_v2_get

Name	Datatype	Description
id	string	Databricks group ID
account_id	string
displayName	string	String that represents a human-readable group name
externalId	string	external_id should be unique for identifying groups
▶members	array
▶meta	object	Container for the group identifier. Workspace local versus account.
▶roles	array	Indicates if the group has the admin role.

account_groups_v2_list

Name	Datatype	Description
id	string	Databricks group ID
account_id	string
displayName	string	String that represents a human-readable group name
externalId	string	external_id should be unique for identifying groups
▶members	array
▶meta	object	Container for the group identifier. Workspace local versus account.
▶roles	array	Indicates if the group has the admin role.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
account_groups_v2_get	select	account_id, id		Gets the information for a specific group in the Databricks account.
account_groups_v2_list	select	account_id	attributes, count, excluded_attributes, filter, sort_by, sort_order, start_index	Gets all details of the groups associated with the Databricks account. As of 08/22/2025, this endpoint
account_groups_v2_create	insert	account_id		Creates a group in the Databricks account with a unique name, using the supplied group details.
account_groups_v2_patch	update	account_id, id		Partially updates the details of a group.
account_groups_v2_update	replace	account_id, id		Updates the details of a group by replacing the entire group entity.
account_groups_v2_delete	delete	account_id, id		Deletes a group from the Databricks account.

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.

Name	Datatype	Description
account_id	string
id	string	Unique ID for a group in the Databricks account.
attributes	string	Comma-separated list of attributes to return in response.
count	integer	Desired number of results per page. Default is 10000.
excluded_attributes	string	Comma-separated list of attributes to exclude in response.
filter	string	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	string	Attribute to sort the results.
sort_order	string	The order to sort the results.
start_index	integer	Specifies the index of the first result. First item is number 1.

SELECT examples

account_groups_v2_get

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

SELECT
id,
account_id,
displayName,
externalId,
members,
meta,
roles
FROM databricks_account.iam.account_groups
WHERE account_id = '{{ account_id }}' -- required
AND id = '{{ id }}' -- required
;

account_groups_v2_list

Gets all details of the groups associated with the Databricks account. As of 08/22/2025, this endpoint

SELECT
id,
account_id,
displayName,
externalId,
members,
meta,
roles
FROM databricks_account.iam.account_groups
WHERE account_id = '{{ account_id }}' -- required
AND attributes = '{{ attributes }}'
AND count = '{{ count }}'
AND excluded_attributes = '{{ excluded_attributes }}'
AND filter = '{{ filter }}'
AND sort_by = '{{ sort_by }}'
AND sort_order = '{{ sort_order }}'
AND start_index = '{{ start_index }}'
;

INSERT examples

account_groups_v2_create

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

INSERT INTO databricks_account.iam.account_groups (
displayName,
externalId,
id,
members,
meta,
roles,
account_id
)
SELECT 
'{{ displayName }}',
'{{ externalId }}',
'{{ id }}',
'{{ members }}',
'{{ meta }}',
'{{ roles }}',
'{{ account_id }}'
RETURNING
id,
account_id,
displayName,
externalId,
members,
meta,
roles
;

Manifest

# Description fields are for documentation purposes
- name: account_groups
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the account_groups resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      String that represents a human-readable group name
  - name: externalId
    value: "{{ externalId }}"
  - name: id
    value: "{{ id }}"
    description: |
      Databricks group ID
  - name: members
    value:
      - display: "{{ display }}"
        primary: {{ primary }}
        $ref: "{{ $ref }}"
        type: "{{ type }}"
        value: "{{ value }}"
  - name: meta
    description: |
      Container for the group identifier. Workspace local versus account.
    value:
      resourceType: "{{ resourceType }}"
  - name: roles
    description: |
      Indicates if the group has the admin role.
    value:
      - display: "{{ display }}"
        primary: {{ primary }}
        $ref: "{{ $ref }}"
        type: "{{ type }}"
        value: "{{ value }}"

UPDATE examples

account_groups_v2_patch

Partially updates the details of a group.

UPDATE databricks_account.iam.account_groups
SET 
Operations = '{{ Operations }}',
schemas = '{{ schemas }}'
WHERE 
account_id = '{{ account_id }}' --required
AND id = '{{ id }}' --required;

REPLACE examples

account_groups_v2_update

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

REPLACE databricks_account.iam.account_groups
SET 
displayName = '{{ displayName }}',
externalId = '{{ externalId }}',
members = '{{ members }}',
meta = '{{ meta }}',
roles = '{{ roles }}'
WHERE 
account_id = '{{ account_id }}' --required
AND id = '{{ id }}' --required;

DELETE examples

account_groups_v2_delete

Deletes a group from the Databricks account.

DELETE FROM databricks_account.iam.account_groups
WHERE account_id = '{{ account_id }}' --required
AND id = '{{ id }}' --required
;