1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getWorkspaceIamUsersV2
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

    Lists the users visible to a workspace, using a workspace-scoped provider.

    Example Usage

    Example usage:

    List all users visible to the workspace, using a workspace-scoped provider.

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const _this = databricks.getWorkspaceIamUsersV2({});
    
    import pulumi
    import pulumi_databricks as databricks
    
    this = databricks.get_workspace_iam_users_v2()
    
    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.GetWorkspaceIamUsersV2(ctx, &databricks.GetWorkspaceIamUsersV2Args{}, 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 @this = Databricks.GetWorkspaceIamUsersV2.Invoke();
    
    });
    
    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.GetWorkspaceIamUsersV2Args;
    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 this = DatabricksFunctions.getWorkspaceIamUsersV2(GetWorkspaceIamUsersV2Args.builder()
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: databricks:getWorkspaceIamUsersV2
          arguments: {}
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    data "databricks_getworkspaceiamusersv2" "this" {
    }
    

    Using getWorkspaceIamUsersV2

    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 getWorkspaceIamUsersV2(args: GetWorkspaceIamUsersV2Args, opts?: InvokeOptions): Promise<GetWorkspaceIamUsersV2Result>
    function getWorkspaceIamUsersV2Output(args: GetWorkspaceIamUsersV2OutputArgs, opts?: InvokeOutputOptions): Output<GetWorkspaceIamUsersV2Result>
    def get_workspace_iam_users_v2(filter: Optional[str] = None,
                                   page_size: Optional[int] = None,
                                   provider_config: Optional[GetWorkspaceIamUsersV2ProviderConfig] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetWorkspaceIamUsersV2Result
    def get_workspace_iam_users_v2_output(filter: pulumi.Input[Optional[str]] = None,
                                   page_size: pulumi.Input[Optional[int]] = None,
                                   provider_config: pulumi.Input[Optional[GetWorkspaceIamUsersV2ProviderConfigArgs]] = None,
                                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetWorkspaceIamUsersV2Result]
    func GetWorkspaceIamUsersV2(ctx *Context, args *GetWorkspaceIamUsersV2Args, opts ...InvokeOption) (*GetWorkspaceIamUsersV2Result, error)
    func GetWorkspaceIamUsersV2Output(ctx *Context, args *GetWorkspaceIamUsersV2OutputArgs, opts ...InvokeOption) GetWorkspaceIamUsersV2ResultOutput

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

    public static class GetWorkspaceIamUsersV2 
    {
        public static Task<GetWorkspaceIamUsersV2Result> InvokeAsync(GetWorkspaceIamUsersV2Args args, InvokeOptions? opts = null)
        public static Output<GetWorkspaceIamUsersV2Result> Invoke(GetWorkspaceIamUsersV2InvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkspaceIamUsersV2Result> Invoke(GetWorkspaceIamUsersV2InvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetWorkspaceIamUsersV2Result> getWorkspaceIamUsersV2(GetWorkspaceIamUsersV2Args args, InvokeOptions options)
    public static Output<GetWorkspaceIamUsersV2Result> getWorkspaceIamUsersV2(GetWorkspaceIamUsersV2Args args, InvokeOptions options)
    public static Output<GetWorkspaceIamUsersV2Result> getWorkspaceIamUsersV2(GetWorkspaceIamUsersV2Args args, InvokeOutputOptions options)
    
    fn::invoke:
      function: databricks:index/getWorkspaceIamUsersV2:getWorkspaceIamUsersV2
      arguments:
        # arguments dictionary
    data "databricks_get_workspace_iam_users_v2" "name" {
        # arguments
    }

    The following arguments are supported:

    Filter string
    Optional. Allows filtering users by username or external id
    PageSize int
    The maximum number of users to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    ProviderConfig GetWorkspaceIamUsersV2ProviderConfig
    Configure the provider for management through account provider.
    Filter string
    Optional. Allows filtering users by username or external id
    PageSize int
    The maximum number of users to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    ProviderConfig GetWorkspaceIamUsersV2ProviderConfig
    Configure the provider for management through account provider.
    filter string
    Optional. Allows filtering users by username or external id
    page_size number
    The maximum number of users to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    provider_config object
    Configure the provider for management through account provider.
    filter String
    Optional. Allows filtering users by username or external id
    pageSize Integer
    The maximum number of users to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    providerConfig GetWorkspaceIamUsersV2ProviderConfig
    Configure the provider for management through account provider.
    filter string
    Optional. Allows filtering users by username or external id
    pageSize number
    The maximum number of users to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    providerConfig GetWorkspaceIamUsersV2ProviderConfig
    Configure the provider for management through account provider.
    filter str
    Optional. Allows filtering users by username or external id
    page_size int
    The maximum number of users to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    provider_config GetWorkspaceIamUsersV2ProviderConfig
    Configure the provider for management through account provider.
    filter String
    Optional. Allows filtering users by username or external id
    pageSize Number
    The maximum number of users to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    providerConfig Property Map
    Configure the provider for management through account provider.

    getWorkspaceIamUsersV2 Result

    The following output properties are available:

    Supporting Types

    GetWorkspaceIamUsersV2ProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetWorkspaceIamUsersV2User

    AccountId string
    (string) - The accountId parent of the user in Databricks
    AccountUserStatus string
    (string) - The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    ExternalId string
    (string) - ExternalId of the user in the customer's IdP
    FullName GetWorkspaceIamUsersV2UserFullName
    (UserFullName)
    UserId string
    (string) - Internal userId of the user in Databricks
    Username string
    (string) - Username/email of the user
    ProviderConfig GetWorkspaceIamUsersV2UserProviderConfig
    Configure the provider for management through account provider.
    AccountId string
    (string) - The accountId parent of the user in Databricks
    AccountUserStatus string
    (string) - The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    ExternalId string
    (string) - ExternalId of the user in the customer's IdP
    FullName GetWorkspaceIamUsersV2UserFullName
    (UserFullName)
    UserId string
    (string) - Internal userId of the user in Databricks
    Username string
    (string) - Username/email of the user
    ProviderConfig GetWorkspaceIamUsersV2UserProviderConfig
    Configure the provider for management through account provider.
    account_id string
    (string) - The accountId parent of the user in Databricks
    account_user_status string
    (string) - The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    external_id string
    (string) - ExternalId of the user in the customer's IdP
    full_name object
    (UserFullName)
    user_id string
    (string) - Internal userId of the user in Databricks
    username string
    (string) - Username/email of the user
    provider_config object
    Configure the provider for management through account provider.
    accountId String
    (string) - The accountId parent of the user in Databricks
    accountUserStatus String
    (string) - The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    externalId String
    (string) - ExternalId of the user in the customer's IdP
    fullName GetWorkspaceIamUsersV2UserFullName
    (UserFullName)
    userId String
    (string) - Internal userId of the user in Databricks
    username String
    (string) - Username/email of the user
    providerConfig GetWorkspaceIamUsersV2UserProviderConfig
    Configure the provider for management through account provider.
    accountId string
    (string) - The accountId parent of the user in Databricks
    accountUserStatus string
    (string) - The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    externalId string
    (string) - ExternalId of the user in the customer's IdP
    fullName GetWorkspaceIamUsersV2UserFullName
    (UserFullName)
    userId string
    (string) - Internal userId of the user in Databricks
    username string
    (string) - Username/email of the user
    providerConfig GetWorkspaceIamUsersV2UserProviderConfig
    Configure the provider for management through account provider.
    account_id str
    (string) - The accountId parent of the user in Databricks
    account_user_status str
    (string) - The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    external_id str
    (string) - ExternalId of the user in the customer's IdP
    full_name GetWorkspaceIamUsersV2UserFullName
    (UserFullName)
    user_id str
    (string) - Internal userId of the user in Databricks
    username str
    (string) - Username/email of the user
    provider_config GetWorkspaceIamUsersV2UserProviderConfig
    Configure the provider for management through account provider.
    accountId String
    (string) - The accountId parent of the user in Databricks
    accountUserStatus String
    (string) - The activity status of a user in a Databricks account. Possible values are: ACTIVE, INACTIVE
    externalId String
    (string) - ExternalId of the user in the customer's IdP
    fullName Property Map
    (UserFullName)
    userId String
    (string) - Internal userId of the user in Databricks
    username String
    (string) - Username/email of the user
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetWorkspaceIamUsersV2UserFullName

    FamilyName string
    (string)
    GivenName string
    (string)
    FamilyName string
    (string)
    GivenName string
    (string)
    family_name string
    (string)
    given_name string
    (string)
    familyName String
    (string)
    givenName String
    (string)
    familyName string
    (string)
    givenName string
    (string)
    family_name str
    (string)
    given_name str
    (string)
    familyName String
    (string)
    givenName String
    (string)

    GetWorkspaceIamUsersV2UserProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    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