users

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

Overview

Name	users
Type	Resource
Id	databricks_account.iam.users

Fields

The following fields are returned by SELECT queries:

get

User information was returned successfully.

Name	Datatype	Description
id	string
name	object
active	boolean
displayName	string
emails	array
externalId	string
roles	array
userName	string

list

List users operation was succesful.

Name	Datatype	Description
id	string
name	object
active	boolean
displayName	string
emails	array
externalId	string
roles	array
userName	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets information for a specific user in Databricks account.
list	select			Gets details for all the users associated with a Databricks account.
create	insert			Creates a new user in the Databricks account. This new user will also be added to the Databricks account.
patch	update			Partially updates a user resource by applying the supplied operations on specific user attributes.
update	replace			Replaces a user's information with the data supplied in request.
delete	delete			Deletes a user. Deleting a user from a Databricks account also removes objects associated with the user.

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

SELECT examples

get

Gets information for a specific user in Databricks account.

SELECT
id,
name,
active,
displayName,
emails,
externalId,
roles,
userName
FROM databricks_account.iam.users;

list

Gets details for all the users associated with a Databricks account.

SELECT
id,
name,
active,
displayName,
emails,
externalId,
roles,
userName
FROM databricks_account.iam.users;

INSERT examples

create

Creates a new user in the Databricks account. This new user will also be added to the Databricks account.

INSERT INTO databricks_account.iam.users (
data__id,
data__userName,
data__displayName,
data__externalId,
data__active,
data__emails,
data__name,
data__roles
)
SELECT 
{{ id }},
'{{ userName }}',
'{{ displayName }}',
'{{ externalId }}',
{{ active }},
'{{ emails }}',
'{{ name }}',
'{{ roles }}'
;

Manifest

# Description fields are for documentation purposes
- name: users
  props:
    - name: id
      value: integer
    - name: userName
      value: email
    - name: displayName
      value: string
    - name: externalId
      value: string
    - name: active
      value: boolean
    - name: emails
      value: Array of object
    - name: name
      value: object
    - name: roles
      value: Array of object

UPDATE examples

patch

Partially updates a user resource by applying the supplied operations on specific user attributes.

UPDATE databricks_account.iam.users
SET 
data__schemas = '{{ schemas }}',
data__Operations = '{{ Operations }}'
WHERE 
;

REPLACE examples

update

Replaces a user's information with the data supplied in request.

REPLACE databricks_account.iam.users
SET 
data__id = {{ id }},
data__userName = '{{ userName }}',
data__displayName = '{{ displayName }}',
data__externalId = '{{ externalId }}',
data__active = {{ active }},
data__emails = '{{ emails }}',
data__name = '{{ name }}',
data__roles = '{{ roles }}'
WHERE 
;

DELETE examples

delete

Deletes a user. Deleting a user from a Databricks account also removes objects associated with the user.

DELETE FROM databricks_account.iam.users;