databricks.User (v0) | Pulumi Registry

Databricks v0.4.0 (0.x), Mar 9 26

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

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.GroupInstanceProfile to attach databricks.InstanceProfile (AWS) to databricks_group.
databricks_group_member to attach users and groups as group members.
databricks.InstanceProfile 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.

Create User Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);

@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         user_name: Optional[str] = None,
         active: Optional[bool] = None,
         allow_cluster_create: Optional[bool] = None,
         allow_instance_pool_create: Optional[bool] = None,
         databricks_sql_access: Optional[bool] = None,
         display_name: Optional[str] = None,
         external_id: Optional[str] = None,
         force: Optional[bool] = None,
         workspace_access: Optional[bool] = None)

func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)

public User(string name, UserArgs args, CustomResourceOptions? opts = null)

public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: databricks:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var userResource = new Databricks.User("userResource", new()
{
    UserName = "string",
    Active = false,
    AllowClusterCreate = false,
    AllowInstancePoolCreate = false,
    DatabricksSqlAccess = false,
    DisplayName = "string",
    ExternalId = "string",
    Force = false,
    WorkspaceAccess = false,
});

example, err := databricks.NewUser(ctx, "userResource", &databricks.UserArgs{
	UserName:                pulumi.String("string"),
	Active:                  pulumi.Bool(false),
	AllowClusterCreate:      pulumi.Bool(false),
	AllowInstancePoolCreate: pulumi.Bool(false),
	DatabricksSqlAccess:     pulumi.Bool(false),
	DisplayName:             pulumi.String("string"),
	ExternalId:              pulumi.String("string"),
	Force:                   pulumi.Bool(false),
	WorkspaceAccess:         pulumi.Bool(false),
})

var userResource = new User("userResource", UserArgs.builder()
    .userName("string")
    .active(false)
    .allowClusterCreate(false)
    .allowInstancePoolCreate(false)
    .databricksSqlAccess(false)
    .displayName("string")
    .externalId("string")
    .force(false)
    .workspaceAccess(false)
    .build());

user_resource = databricks.User("userResource",
    user_name="string",
    active=False,
    allow_cluster_create=False,
    allow_instance_pool_create=False,
    databricks_sql_access=False,
    display_name="string",
    external_id="string",
    force=False,
    workspace_access=False)

const userResource = new databricks.User("userResource", {
    userName: "string",
    active: false,
    allowClusterCreate: false,
    allowInstancePoolCreate: false,
    databricksSqlAccess: false,
    displayName: "string",
    externalId: "string",
    force: false,
    workspaceAccess: false,
});

type: databricks:User
properties:
    active: false
    allowClusterCreate: false
    allowInstancePoolCreate: false
    databricksSqlAccess: false
    displayName: string
    externalId: string
    force: false
    userName: string
    workspaceAccess: false

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The User resource accepts the following input properties:

UserName string: This is the username of the given user and will be their form of access and identity.
Active bool: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
AllowClusterCreate bool: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
AllowInstancePoolCreate bool: 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.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
DisplayName string: This is an alias for the username that can be the full name of the user.
ExternalId string: ID of the user in an external identity provider.
Force bool
WorkspaceAccess bool

UserName string: This is the username of the given user and will be their form of access and identity.
Active bool: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
AllowClusterCreate bool: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
AllowInstancePoolCreate bool: 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.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
DisplayName string: This is an alias for the username that can be the full name of the user.
ExternalId string: ID of the user in an external identity provider.
Force bool
WorkspaceAccess bool

userName String: This is the username of the given user and will be their form of access and identity.
active Boolean: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allowClusterCreate Boolean: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
allowInstancePoolCreate Boolean: 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.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
displayName String: This is an alias for the username that can be the full name of the user.
externalId String: ID of the user in an external identity provider.
force Boolean
workspaceAccess Boolean

userName string: This is the username of the given user and will be their form of access and identity.
active boolean: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allowClusterCreate boolean: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
allowInstancePoolCreate boolean: 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.
databricksSqlAccess boolean: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
displayName string: This is an alias for the username that can be the full name of the user.
externalId string: ID of the user in an external identity provider.
force boolean
workspaceAccess boolean

user_name str: This is the username of the given user and will be their form of access and identity.
active bool: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allow_cluster_create bool: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_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 bool: 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 bool: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
display_name str: This is an alias for the username that can be the full name of the user.
external_id str: ID of the user in an external identity provider.
force bool
workspace_access bool

userName String: This is the username of the given user and will be their form of access and identity.
active Boolean: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allowClusterCreate Boolean: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
allowInstancePoolCreate Boolean: 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.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
displayName String: This is an alias for the username that can be the full name of the user.
externalId String: ID of the user in an external identity provider.
force Boolean
workspaceAccess Boolean

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        allow_cluster_create: Optional[bool] = None,
        allow_instance_pool_create: Optional[bool] = None,
        databricks_sql_access: Optional[bool] = None,
        display_name: Optional[str] = None,
        external_id: Optional[str] = None,
        force: Optional[bool] = None,
        user_name: Optional[str] = None,
        workspace_access: Optional[bool] = None) -> User

func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)

public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)

public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)

resources:  _:    type: databricks:User    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Active bool: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
AllowClusterCreate bool: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
AllowInstancePoolCreate bool: 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.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
DisplayName string: This is an alias for the username that can be the full name of the user.
ExternalId string: ID of the user in an external identity provider.
Force bool
UserName string: This is the username of the given user and will be their form of access and identity.
WorkspaceAccess bool

Active bool: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
AllowClusterCreate bool: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
AllowInstancePoolCreate bool: 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.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
DisplayName string: This is an alias for the username that can be the full name of the user.
ExternalId string: ID of the user in an external identity provider.
Force bool
UserName string: This is the username of the given user and will be their form of access and identity.
WorkspaceAccess bool

active Boolean: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allowClusterCreate Boolean: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
allowInstancePoolCreate Boolean: 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.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
displayName String: This is an alias for the username that can be the full name of the user.
externalId String: ID of the user in an external identity provider.
force Boolean
userName String: This is the username of the given user and will be their form of access and identity.
workspaceAccess Boolean

active boolean: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allowClusterCreate boolean: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
allowInstancePoolCreate boolean: 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.
databricksSqlAccess boolean: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
displayName string: This is an alias for the username that can be the full name of the user.
externalId string: ID of the user in an external identity provider.
force boolean
userName string: This is the username of the given user and will be their form of access and identity.
workspaceAccess boolean

active bool: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allow_cluster_create bool: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_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 bool: 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 bool: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
display_name str: This is an alias for the username that can be the full name of the user.
external_id str: ID of the user in an external identity provider.
force bool
user_name str: This is the username of the given user and will be their form of access and identity.
workspace_access bool

active Boolean: Either user is active or not. True by default, but can be set to false in case of user deactivation with preserving user assets.
allowClusterCreate Boolean: Allow the user to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
allowInstancePoolCreate Boolean: 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.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
displayName String: This is an alias for the username that can be the full name of the user.
externalId String: ID of the user in an external identity provider.
force Boolean
userName String: This is the username of the given user and will be their form of access and identity.
workspaceAccess Boolean

Import

The resource scim user can be imported using idbash

 $ pulumi import databricks:index/user:User me <user-id>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

databricks.User

On this page

On this page

Create User Resource

Constructor syntax

Parameters

Constructor example

User Resource Properties

Inputs

Outputs

Look up Existing User Resource

Import

Package Details

On this page

On this page

databricks.User

On this page

On this page

Related Resources

Create User Resource

Constructor syntax

Parameters

Constructor example

User Resource Properties

Inputs

Outputs

Look up Existing User Resource

Import

Package Details

On this page

On this page