direct_group_members

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

Overview

Name	direct_group_members
Type	Resource
Id	databricks_workspace.iamv2.direct_group_members

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
external_id	string	The external ID of the principal in Databricks.
principal_id	integer	Internal ID of the principal in Databricks.
display_name	string	Display name of the principal.
membership_source	string	The source of group membership (internal or from identity provider). (IDENTITY_PROVIDER, INTERNAL)
principal_type	string	The type of the principal (user/service principal/group). (GROUP, SERVICE_PRINCIPAL, USER)

list

Name	Datatype	Description
external_id	string	The external ID of the principal in Databricks.
principal_id	integer	Internal ID of the principal in Databricks.
display_name	string	Display name of the principal.
membership_source	string	The source of group membership (internal or from identity provider). (IDENTITY_PROVIDER, INTERNAL)
principal_type	string	The type of the principal (user/service principal/group). (GROUP, SERVICE_PRINCIPAL, USER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group_id, principal_id, deployment_name		Gets a provisioned direct member of a group.
list	select	group_id, deployment_name	page_size, page_token	Lists provisioned direct members of a group with their membership source (internal or from identity
create	insert	group_id, deployment_name, direct_group_member		Creates a group membership (assigns a principal to a group).
delete	delete	group_id, principal_id, deployment_name		Deletes a group membership (unassigns a principal from a group).

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
group_id	integer	Required. Internal ID of the group in Databricks.
principal_id	integer	Required. Internal ID of the principal to be unassigned from the group.
page_size	integer	The maximum number of members to return. The service may return fewer than this value. If not provided, defaults to 1000 (also the maximum allowed).
page_token	string	A page token, received from a previous ListDirectGroupMembersProxy call. Provide this to retrieve the subsequent page.

SELECT examples

get

Gets a provisioned direct member of a group.

SELECT
external_id,
principal_id,
display_name,
membership_source,
principal_type
FROM databricks_workspace.iamv2.direct_group_members
WHERE group_id = '{{ group_id }}' -- required
AND principal_id = '{{ principal_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Lists provisioned direct members of a group with their membership source (internal or from identity

SELECT
external_id,
principal_id,
display_name,
membership_source,
principal_type
FROM databricks_workspace.iamv2.direct_group_members
WHERE group_id = '{{ group_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a group membership (assigns a principal to a group).

INSERT INTO databricks_workspace.iamv2.direct_group_members (
direct_group_member,
group_id,
deployment_name
)
SELECT 
'{{ direct_group_member }}' /* required */,
'{{ group_id }}',
'{{ deployment_name }}'
RETURNING
external_id,
principal_id,
display_name,
membership_source,
principal_type
;

Manifest

# Description fields are for documentation purposes
- name: direct_group_members
props:
  - name: group_id
    value: {{ group_id }}
    description: Required parameter for the direct_group_members resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the direct_group_members resource.
  - name: direct_group_member
    description: |
      Required. The group membership to create.
    value:
      principal_id: {{ principal_id }}
      display_name: "{{ display_name }}"
      external_id: "{{ external_id }}"
      membership_source: "{{ membership_source }}"
      principal_type: "{{ principal_type }}"

DELETE examples

delete

Deletes a group membership (unassigns a principal from a group).

DELETE FROM databricks_workspace.iamv2.direct_group_members
WHERE group_id = '{{ group_id }}' --required
AND principal_id = '{{ principal_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;