1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. AccountIamUserV2
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
databricks logo databricks logo
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi

    Public Beta

    API Documentation

    Manages an account-level user. Creating the resource provisions the user; deleting it removes the user. username is immutable — changing it replaces the resource.

    When Automatic Identity Management (AIM) is enabled for the account, this resource manages local users only: a user cannot be created with externalId set. Users that already have an externalId can still be read through this resource, but only their externalId may be updated — their other fields are sourced from the identity provider.

    Example Usage

    Example usage:

    Creates an account-level user. When AIM is enabled, the user cannot be created with externalId set.

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const _this = new databricks.AccountIamUserV2("this", {
        username: "jane.doe@example.com",
        accountUserStatus: "ACTIVE",
        fullName: {
            givenName: "Jane",
            familyName: "Doe",
        },
    });
    
    import pulumi
    import pulumi_databricks as databricks
    
    this = databricks.AccountIamUserV2("this",
        username="jane.doe@example.com",
        account_user_status="ACTIVE",
        full_name={
            "given_name": "Jane",
            "family_name": "Doe",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := databricks.NewAccountIamUserV2(ctx, "this", &databricks.AccountIamUserV2Args{
    			Username:          pulumi.String("jane.doe@example.com"),
    			AccountUserStatus: pulumi.String("ACTIVE"),
    			FullName: &databricks.AccountIamUserV2FullNameArgs{
    				GivenName:  pulumi.String("Jane"),
    				FamilyName: pulumi.String("Doe"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = new Databricks.AccountIamUserV2("this", new()
        {
            Username = "jane.doe@example.com",
            AccountUserStatus = "ACTIVE",
            FullName = new Databricks.Inputs.AccountIamUserV2FullNameArgs
            {
                GivenName = "Jane",
                FamilyName = "Doe",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.databricks.AccountIamUserV2;
    import com.pulumi.databricks.AccountIamUserV2Args;
    import com.pulumi.databricks.inputs.AccountIamUserV2FullNameArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var this_ = new AccountIamUserV2("this", AccountIamUserV2Args.builder()
                .username("jane.doe@example.com")
                .accountUserStatus("ACTIVE")
                .fullName(AccountIamUserV2FullNameArgs.builder()
                    .givenName("Jane")
                    .familyName("Doe")
                    .build())
                .build());
    
        }
    }
    
    resources:
      this:
        type: databricks:AccountIamUserV2
        properties:
          username: jane.doe@example.com
          accountUserStatus: ACTIVE
          fullName:
            givenName: Jane
            familyName: Doe
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    resource "databricks_accountiamuserv2" "this" {
      username            = "jane.doe@example.com"
      account_user_status = "ACTIVE"
      full_name = {
        given_name  = "Jane"
        family_name = "Doe"
      }
    }
    

    Create AccountIamUserV2 Resource

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

    Constructor syntax

    new AccountIamUserV2(name: string, args: AccountIamUserV2Args, opts?: CustomResourceOptions);
    @overload
    def AccountIamUserV2(resource_name: str,
                         args: AccountIamUserV2Args,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccountIamUserV2(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         account_user_status: Optional[str] = None,
                         full_name: Optional[AccountIamUserV2FullNameArgs] = None,
                         username: Optional[str] = None,
                         external_id: Optional[str] = None)
    func NewAccountIamUserV2(ctx *Context, name string, args AccountIamUserV2Args, opts ...ResourceOption) (*AccountIamUserV2, error)
    public AccountIamUserV2(string name, AccountIamUserV2Args args, CustomResourceOptions? opts = null)
    public AccountIamUserV2(String name, AccountIamUserV2Args args)
    public AccountIamUserV2(String name, AccountIamUserV2Args args, CustomResourceOptions options)
    
    type: databricks:AccountIamUserV2
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "databricks_account_iam_user_v2" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AccountIamUserV2Args
    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 AccountIamUserV2Args
    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 AccountIamUserV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountIamUserV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountIamUserV2Args
    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 accountIamUserV2Resource = new Databricks.AccountIamUserV2("accountIamUserV2Resource", new()
    {
        AccountUserStatus = "string",
        FullName = new Databricks.Inputs.AccountIamUserV2FullNameArgs
        {
            FamilyName = "string",
            GivenName = "string",
        },
        Username = "string",
        ExternalId = "string",
    });
    
    example, err := databricks.NewAccountIamUserV2(ctx, "accountIamUserV2Resource", &databricks.AccountIamUserV2Args{
    	AccountUserStatus: pulumi.String("string"),
    	FullName: &databricks.AccountIamUserV2FullNameArgs{
    		FamilyName: pulumi.String("string"),
    		GivenName:  pulumi.String("string"),
    	},
    	Username:   pulumi.String("string"),
    	ExternalId: pulumi.String("string"),
    })
    
    resource "databricks_account_iam_user_v2" "accountIamUserV2Resource" {
      lifecycle {
        create_before_destroy = true
      }
      account_user_status = "string"
      full_name = {
        family_name = "string"
        given_name  = "string"
      }
      username    = "string"
      external_id = "string"
    }
    
    var accountIamUserV2Resource = new AccountIamUserV2("accountIamUserV2Resource", AccountIamUserV2Args.builder()
        .accountUserStatus("string")
        .fullName(AccountIamUserV2FullNameArgs.builder()
            .familyName("string")
            .givenName("string")
            .build())
        .username("string")
        .externalId("string")
        .build());
    
    account_iam_user_v2_resource = databricks.AccountIamUserV2("accountIamUserV2Resource",
        account_user_status="string",
        full_name={
            "family_name": "string",
            "given_name": "string",
        },
        username="string",
        external_id="string")
    
    const accountIamUserV2Resource = new databricks.AccountIamUserV2("accountIamUserV2Resource", {
        accountUserStatus: "string",
        fullName: {
            familyName: "string",
            givenName: "string",
        },
        username: "string",
        externalId: "string",
    });
    
    type: databricks:AccountIamUserV2
    properties:
        accountUserStatus: string
        externalId: string
        fullName:
            familyName: string
            givenName: string
        username: string
    

    AccountIamUserV2 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 AccountIamUserV2 resource accepts the following input properties:

    AccountUserStatus string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    FullName AccountIamUserV2FullName
    Username string
    Username/email of the user
    ExternalId string
    ExternalId of the user in the customer's IdP
    AccountUserStatus string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    FullName AccountIamUserV2FullNameArgs
    Username string
    Username/email of the user
    ExternalId string
    ExternalId of the user in the customer's IdP
    account_user_status string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    full_name object
    username string
    Username/email of the user
    external_id string
    ExternalId of the user in the customer's IdP
    accountUserStatus String
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    fullName AccountIamUserV2FullName
    username String
    Username/email of the user
    externalId String
    ExternalId of the user in the customer's IdP
    accountUserStatus string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    fullName AccountIamUserV2FullName
    username string
    Username/email of the user
    externalId string
    ExternalId of the user in the customer's IdP
    account_user_status str
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    full_name AccountIamUserV2FullNameArgs
    username str
    Username/email of the user
    external_id str
    ExternalId of the user in the customer's IdP
    accountUserStatus String
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    fullName Property Map
    username String
    Username/email of the user
    externalId String
    ExternalId of the user in the customer's IdP

    Outputs

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

    AccountId string
    (string) - The accountId parent of the user in Databricks
    Id string
    The provider-assigned unique ID for this managed resource.
    UserId string
    (string) - Internal userId of the user in Databricks
    AccountId string
    (string) - The accountId parent of the user in Databricks
    Id string
    The provider-assigned unique ID for this managed resource.
    UserId string
    (string) - Internal userId of the user in Databricks
    account_id string
    (string) - The accountId parent of the user in Databricks
    id string
    The provider-assigned unique ID for this managed resource.
    user_id string
    (string) - Internal userId of the user in Databricks
    accountId String
    (string) - The accountId parent of the user in Databricks
    id String
    The provider-assigned unique ID for this managed resource.
    userId String
    (string) - Internal userId of the user in Databricks
    accountId string
    (string) - The accountId parent of the user in Databricks
    id string
    The provider-assigned unique ID for this managed resource.
    userId string
    (string) - Internal userId of the user in Databricks
    account_id str
    (string) - The accountId parent of the user in Databricks
    id str
    The provider-assigned unique ID for this managed resource.
    user_id str
    (string) - Internal userId of the user in Databricks
    accountId String
    (string) - The accountId parent of the user in Databricks
    id String
    The provider-assigned unique ID for this managed resource.
    userId String
    (string) - Internal userId of the user in Databricks

    Look up Existing AccountIamUserV2 Resource

    Get an existing AccountIamUserV2 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?: AccountIamUserV2State, opts?: CustomResourceOptions): AccountIamUserV2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            account_user_status: Optional[str] = None,
            external_id: Optional[str] = None,
            full_name: Optional[AccountIamUserV2FullNameArgs] = None,
            user_id: Optional[str] = None,
            username: Optional[str] = None) -> AccountIamUserV2
    func GetAccountIamUserV2(ctx *Context, name string, id IDInput, state *AccountIamUserV2State, opts ...ResourceOption) (*AccountIamUserV2, error)
    public static AccountIamUserV2 Get(string name, Input<string> id, AccountIamUserV2State? state, CustomResourceOptions? opts = null)
    public static AccountIamUserV2 get(String name, Output<String> id, AccountIamUserV2State state, CustomResourceOptions options)
    resources:  _:    type: databricks:AccountIamUserV2    get:      id: ${id}
    import {
      to = databricks_account_iam_user_v2.example
      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:
    AccountId string
    (string) - The accountId parent of the user in Databricks
    AccountUserStatus string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    ExternalId string
    ExternalId of the user in the customer's IdP
    FullName AccountIamUserV2FullName
    UserId string
    (string) - Internal userId of the user in Databricks
    Username string
    Username/email of the user
    AccountId string
    (string) - The accountId parent of the user in Databricks
    AccountUserStatus string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    ExternalId string
    ExternalId of the user in the customer's IdP
    FullName AccountIamUserV2FullNameArgs
    UserId string
    (string) - Internal userId of the user in Databricks
    Username string
    Username/email of the user
    account_id string
    (string) - The accountId parent of the user in Databricks
    account_user_status string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    external_id string
    ExternalId of the user in the customer's IdP
    full_name object
    user_id string
    (string) - Internal userId of the user in Databricks
    username string
    Username/email of the user
    accountId String
    (string) - The accountId parent of the user in Databricks
    accountUserStatus String
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    externalId String
    ExternalId of the user in the customer's IdP
    fullName AccountIamUserV2FullName
    userId String
    (string) - Internal userId of the user in Databricks
    username String
    Username/email of the user
    accountId string
    (string) - The accountId parent of the user in Databricks
    accountUserStatus string
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    externalId string
    ExternalId of the user in the customer's IdP
    fullName AccountIamUserV2FullName
    userId string
    (string) - Internal userId of the user in Databricks
    username string
    Username/email of the user
    account_id str
    (string) - The accountId parent of the user in Databricks
    account_user_status str
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    external_id str
    ExternalId of the user in the customer's IdP
    full_name AccountIamUserV2FullNameArgs
    user_id str
    (string) - Internal userId of the user in Databricks
    username str
    Username/email of the user
    accountId String
    (string) - The accountId parent of the user in Databricks
    accountUserStatus String
    The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    externalId String
    ExternalId of the user in the customer's IdP
    fullName Property Map
    userId String
    (string) - Internal userId of the user in Databricks
    username String
    Username/email of the user

    Supporting Types

    AccountIamUserV2FullName, AccountIamUserV2FullNameArgs

    FamilyName string
    GivenName string
    FamilyName string
    GivenName string
    family_name string
    given_name string
    familyName String
    givenName String
    familyName string
    givenName string
    familyName String
    givenName String

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo databricks logo
    Viewing docs for Databricks v1.109.0
    published on Tuesday, Sep 8, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial