1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getUser
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    The following resources are used in the same context:

    • End to end workspace management guide
    • databricks.getCurrentUser data to retrieve information about databricks.User or databricks_service_principal, that is calling Databricks REST API.
    • 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.Permissions to manage access control in Databricks workspace.
    • databricks.User to manage users, that could be added to databricks.Group within the workspace.
    • databricks.UserInstanceProfile to attach databricks.InstanceProfile (AWS) to databricks_user.

    Using getUser

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
    function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
    def get_user(user_id: Optional[str] = None,
                 user_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetUserResult
    def get_user_output(user_id: Optional[pulumi.Input[str]] = None,
                 user_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
    func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

    > Note: This function is named LookupUser in the Go SDK.

    public static class GetUser 
    {
        public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
        public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
    public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getUser:getUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

    UserId string
    ID of the user.
    UserName string
    User name of the user. The user must exist before this resource can be planned.
    UserId string
    ID of the user.
    UserName string
    User name of the user. The user must exist before this resource can be planned.
    userId String
    ID of the user.
    userName String
    User name of the user. The user must exist before this resource can be planned.
    userId string
    ID of the user.
    userName string
    User name of the user. The user must exist before this resource can be planned.
    user_id str
    ID of the user.
    user_name str
    User name of the user. The user must exist before this resource can be planned.
    userId String
    ID of the user.
    userName String
    User name of the user. The user must exist before this resource can be planned.

    getUser Result

    The following output properties are available:

    Alphanumeric string
    Alphanumeric representation of user local name. e.g. mr_foo.
    DisplayName string
    Display name of the user, e.g. Mr Foo.
    ExternalId string
    ID of the user in an external identity provider.
    Home string
    Home folder of the user, e.g. /Users/mr.foo@example.com.
    Id string
    The provider-assigned unique ID for this managed resource.
    Repos string
    Personal Repos location of the user, e.g. /Repos/mr.foo@example.com.
    UserId string
    UserName string
    Name of the user, e.g. mr.foo@example.com.
    Alphanumeric string
    Alphanumeric representation of user local name. e.g. mr_foo.
    DisplayName string
    Display name of the user, e.g. Mr Foo.
    ExternalId string
    ID of the user in an external identity provider.
    Home string
    Home folder of the user, e.g. /Users/mr.foo@example.com.
    Id string
    The provider-assigned unique ID for this managed resource.
    Repos string
    Personal Repos location of the user, e.g. /Repos/mr.foo@example.com.
    UserId string
    UserName string
    Name of the user, e.g. mr.foo@example.com.
    alphanumeric String
    Alphanumeric representation of user local name. e.g. mr_foo.
    displayName String
    Display name of the user, e.g. Mr Foo.
    externalId String
    ID of the user in an external identity provider.
    home String
    Home folder of the user, e.g. /Users/mr.foo@example.com.
    id String
    The provider-assigned unique ID for this managed resource.
    repos String
    Personal Repos location of the user, e.g. /Repos/mr.foo@example.com.
    userId String
    userName String
    Name of the user, e.g. mr.foo@example.com.
    alphanumeric string
    Alphanumeric representation of user local name. e.g. mr_foo.
    displayName string
    Display name of the user, e.g. Mr Foo.
    externalId string
    ID of the user in an external identity provider.
    home string
    Home folder of the user, e.g. /Users/mr.foo@example.com.
    id string
    The provider-assigned unique ID for this managed resource.
    repos string
    Personal Repos location of the user, e.g. /Repos/mr.foo@example.com.
    userId string
    userName string
    Name of the user, e.g. mr.foo@example.com.
    alphanumeric str
    Alphanumeric representation of user local name. e.g. mr_foo.
    display_name str
    Display name of the user, e.g. Mr Foo.
    external_id str
    ID of the user in an external identity provider.
    home str
    Home folder of the user, e.g. /Users/mr.foo@example.com.
    id str
    The provider-assigned unique ID for this managed resource.
    repos str
    Personal Repos location of the user, e.g. /Repos/mr.foo@example.com.
    user_id str
    user_name str
    Name of the user, e.g. mr.foo@example.com.
    alphanumeric String
    Alphanumeric representation of user local name. e.g. mr_foo.
    displayName String
    Display name of the user, e.g. Mr Foo.
    externalId String
    ID of the user in an external identity provider.
    home String
    Home folder of the user, e.g. /Users/mr.foo@example.com.
    id String
    The provider-assigned unique ID for this managed resource.
    repos String
    Personal Repos location of the user, e.g. /Repos/mr.foo@example.com.
    userId String
    userName String
    Name of the user, e.g. mr.foo@example.com.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.