subcategory |
---|
Security |
This resource is used to manage users, that could be added to databricks_group within the workspace. Upon user creation the user will receive a password reset email. You can also get information about caller identity using databricks_current_user data source.
Creating regular user:
resource "databricks_user" "me" {
user_name = "me@example.com"
}
Creating user with administrative permissions - referencing special admins
databricks_group in databricks_group_member resource:
data "databricks_group" "admins" {
display_name = "admins"
}
resource "databricks_user" "me" {
user_name = "me@example.com"
}
resource "databricks_group_member" "i-am-admin" {
group_id = data.databricks_group.admins.id
member_id = databricks_user.me.id
}
Creating user with cluster create permissions:
resource "databricks_user" "me" {
user_name = "me@example.com"
display_name = "Example user"
allow_cluster_create = true
}
The following arguments are available:
user_name
- (Required) This is the username of the given user and will be their form of access and identity.display_name
- (Optional) This is an alias for the username that can be the full name of the user.external_id
- (Optional) ID of the user in an external identity provider.allow_cluster_create
- (Optional) Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks_permissions andcluster_id
argument. Everyone withoutallow_cluster_create
argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.allow_instance_pool_create
- (Optional) Allow the user to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks_permissions and instance_pool_id argument.databricks_sql_access
- (Optional) This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.active
- (Optional) Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.force
- (Optional) Ignorecannot create user: User with username X already exists
errors and implicitly import the specific user into Terraform state, enforcing entitlements defined in the instance of resource. This functionality is experimental and is designed to simplify corner cases, like Azure Active Directory synchronisation.
In addition to all arguments above, the following attributes are exported:
id
- Canonical unique identifier for the user.
The resource scim user can be imported using id:
$ terraform import databricks_user.me <user-id>
The following resources are often used in the same context:
- End to end workspace management guide.
- databricks_group to manage groups in Databricks Workspace or Account Console (for AWS deployments).
- databricks_group data to retrieve information about databricks_group members, entitlements and instance profiles.
- databricks_group_instance_profile to attach databricks_instance_profile (AWS) to databricks_group.
- databricks_group_member to attach users and groups as group members.
- databricks_instance_profile to manage AWS EC2 instance profiles that users can launch databricks_cluster and access data, like databricks_mount.
- databricks_user data to retrieves information about databricks_user.