Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getAccountIamExternalUserV2
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getAccountIamExternalUserV2

databricks logo databricks logo
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    API Documentation

    Retrieves an external user — a user that can be synced from your identity provider (IdP) — with the given external ID from the customer’s IdP. If the user does not exist in the account, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this returns an error.

    The name uses the format accounts/{account_id}/external-users/{external_user_id}, where externalUserId is the user’s object ID in the IdP (for example, a Microsoft Entra ID object ID).

    Note Reading this data source has a side effect: it resolves the user against the IdP and provisions the user in the account if it does not already exist.

    Note This data source can only be used with an account-level provider.

    Example Usage

    Referring to an external user by its resource name:

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const example = databricks.getAccountIamExternalUserV2({
    name: "accounts/00000000-0000-0000-0000-000000000000/external-users/11111111-2222-3333-4444-555555555555",
});

    import pulumi
import pulumi_databricks as databricks

example = databricks.get_account_iam_external_user_v2(name="accounts/00000000-0000-0000-0000-000000000000/external-users/11111111-2222-3333-4444-555555555555")

    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.GetAccountIamExternalUserV2(ctx, &databricks.GetAccountIamExternalUserV2Args{
			Name: "accounts/00000000-0000-0000-0000-000000000000/external-users/11111111-2222-3333-4444-555555555555",
		}, nil)
		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 example = Databricks.GetAccountIamExternalUserV2.Invoke(new()
    {
        Name = "accounts/00000000-0000-0000-0000-000000000000/external-users/11111111-2222-3333-4444-555555555555",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetAccountIamExternalUserV2Args;
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) {
        final var example = DatabricksFunctions.getAccountIamExternalUserV2(GetAccountIamExternalUserV2Args.builder()
            .name("accounts/00000000-0000-0000-0000-000000000000/external-users/11111111-2222-3333-4444-555555555555")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: databricks:getAccountIamExternalUserV2
      arguments:
        name: accounts/00000000-0000-0000-0000-000000000000/external-users/11111111-2222-3333-4444-555555555555

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

data "databricks_getaccountiamexternaluserv2" "example" {
  name = "accounts/00000000-0000-0000-0000-000000000000/external-users/11111111-2222-3333-4444-555555555555"
}

    Using getAccountIamExternalUserV2

    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 getAccountIamExternalUserV2(args: GetAccountIamExternalUserV2Args, opts?: InvokeOptions): Promise<GetAccountIamExternalUserV2Result>
function getAccountIamExternalUserV2Output(args: GetAccountIamExternalUserV2OutputArgs, opts?: InvokeOutputOptions): Output<GetAccountIamExternalUserV2Result>
    def get_account_iam_external_user_v2(name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetAccountIamExternalUserV2Result
def get_account_iam_external_user_v2_output(name: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetAccountIamExternalUserV2Result]
    func GetAccountIamExternalUserV2(ctx *Context, args *GetAccountIamExternalUserV2Args, opts ...InvokeOption) (*GetAccountIamExternalUserV2Result, error)
func GetAccountIamExternalUserV2Output(ctx *Context, args *GetAccountIamExternalUserV2OutputArgs, opts ...InvokeOption) GetAccountIamExternalUserV2ResultOutput

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

    public static class GetAccountIamExternalUserV2 
{
    public static Task<GetAccountIamExternalUserV2Result> InvokeAsync(GetAccountIamExternalUserV2Args args, InvokeOptions? opts = null)
    public static Output<GetAccountIamExternalUserV2Result> Invoke(GetAccountIamExternalUserV2InvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetAccountIamExternalUserV2Result> Invoke(GetAccountIamExternalUserV2InvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetAccountIamExternalUserV2Result> getAccountIamExternalUserV2(GetAccountIamExternalUserV2Args args, InvokeOptions options)
public static Output<GetAccountIamExternalUserV2Result> getAccountIamExternalUserV2(GetAccountIamExternalUserV2Args args, InvokeOptions options)
public static Output<GetAccountIamExternalUserV2Result> getAccountIamExternalUserV2(GetAccountIamExternalUserV2Args args, InvokeOutputOptions options)

    fn::invoke:
  function: databricks:index/getAccountIamExternalUserV2:getAccountIamExternalUserV2
  arguments:
    # arguments dictionary
    data "databricks_get_account_iam_external_user_v2" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    Name string
    The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    name string
    The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    name String
    The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    name string
    The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    name str
    The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    name String
    The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}

    getAccountIamExternalUserV2 Result

    The following output properties are available:

    AccountId string
    (string) - The parent account ID, from Databricks
    AccountUserStatus string
    (string) - The activity status of the user in the Databricks account. Possible values are: ACTIVE, INACTIVE
    DisplayName string
    (string) - Display name of the user from the customer's IdP
    ExternalUserId string
    (string) - The external ID of the user in the customer's IdP
    FullName GetAccountIamExternalUserV2FullName
    (FullName) - The full name of the user, from the customer's IdP
    InternalId string
    (string) - Internal userId of the user in Databricks
    Name string
    (string) - The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    Username string
    (string) - Username/email of the user, from Databricks
    AccountId string
    (string) - The parent account ID, from Databricks
    AccountUserStatus string
    (string) - The activity status of the user in the Databricks account. Possible values are: ACTIVE, INACTIVE
    DisplayName string
    (string) - Display name of the user from the customer's IdP
    ExternalUserId string
    (string) - The external ID of the user in the customer's IdP
    FullName GetAccountIamExternalUserV2FullName
    (FullName) - The full name of the user, from the customer's IdP
    InternalId string
    (string) - Internal userId of the user in Databricks
    Name string
    (string) - The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    Username string
    (string) - Username/email of the user, from Databricks
    account_id string
    (string) - The parent account ID, from Databricks
    account_user_status string
    (string) - The activity status of the user in the Databricks account. Possible values are: ACTIVE, INACTIVE
    display_name string
    (string) - Display name of the user from the customer's IdP
    external_user_id string
    (string) - The external ID of the user in the customer's IdP
    full_name object
    (FullName) - The full name of the user, from the customer's IdP
    internal_id string
    (string) - Internal userId of the user in Databricks
    name string
    (string) - The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    username string
    (string) - Username/email of the user, from Databricks
    accountId String
    (string) - The parent account ID, from Databricks
    accountUserStatus String
    (string) - The activity status of the user in the Databricks account. Possible values are: ACTIVE, INACTIVE
    displayName String
    (string) - Display name of the user from the customer's IdP
    externalUserId String
    (string) - The external ID of the user in the customer's IdP
    fullName GetAccountIamExternalUserV2FullName
    (FullName) - The full name of the user, from the customer's IdP
    internalId String
    (string) - Internal userId of the user in Databricks
    name String
    (string) - The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    username String
    (string) - Username/email of the user, from Databricks
    accountId string
    (string) - The parent account ID, from Databricks
    accountUserStatus string
    (string) - The activity status of the user in the Databricks account. Possible values are: ACTIVE, INACTIVE
    displayName string
    (string) - Display name of the user from the customer's IdP
    externalUserId string
    (string) - The external ID of the user in the customer's IdP
    fullName GetAccountIamExternalUserV2FullName
    (FullName) - The full name of the user, from the customer's IdP
    internalId string
    (string) - Internal userId of the user in Databricks
    name string
    (string) - The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    username string
    (string) - Username/email of the user, from Databricks
    account_id str
    (string) - The parent account ID, from Databricks
    account_user_status str
    (string) - The activity status of the user in the Databricks account. Possible values are: ACTIVE, INACTIVE
    display_name str
    (string) - Display name of the user from the customer's IdP
    external_user_id str
    (string) - The external ID of the user in the customer's IdP
    full_name GetAccountIamExternalUserV2FullName
    (FullName) - The full name of the user, from the customer's IdP
    internal_id str
    (string) - Internal userId of the user in Databricks
    name str
    (string) - The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    username str
    (string) - Username/email of the user, from Databricks
    accountId String
    (string) - The parent account ID, from Databricks
    accountUserStatus String
    (string) - The activity status of the user in the Databricks account. Possible values are: ACTIVE, INACTIVE
    displayName String
    (string) - Display name of the user from the customer's IdP
    externalUserId String
    (string) - The external ID of the user in the customer's IdP
    fullName Property Map
    (FullName) - The full name of the user, from the customer's IdP
    internalId String
    (string) - Internal userId of the user in Databricks
    name String
    (string) - The resource name of the external user. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-users/{external_user_id}
    • Workspace-scoped: external-users/{external_user_id}
    username String
    (string) - Username/email of the user, from Databricks

    Supporting Types

    GetAccountIamExternalUserV2FullName

    FamilyName string
    (string) - The family (last) name of the user, from the customer's IdP
    GivenName string
    (string) - The given (first) name of the user, from the customer's IdP
    FamilyName string
    (string) - The family (last) name of the user, from the customer's IdP
    GivenName string
    (string) - The given (first) name of the user, from the customer's IdP
    family_name string
    (string) - The family (last) name of the user, from the customer's IdP
    given_name string
    (string) - The given (first) name of the user, from the customer's IdP
    familyName String
    (string) - The family (last) name of the user, from the customer's IdP
    givenName String
    (string) - The given (first) name of the user, from the customer's IdP
    familyName string
    (string) - The family (last) name of the user, from the customer's IdP
    givenName string
    (string) - The given (first) name of the user, from the customer's IdP
    family_name str
    (string) - The family (last) name of the user, from the customer's IdP
    given_name str
    (string) - The given (first) name of the user, from the customer's IdP
    familyName String
    (string) - The family (last) name of the user, from the customer's IdP
    givenName String
    (string) - The given (first) name of the user, from the customer's IdP

    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
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial