1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. WorkspaceIamWorkspaceIdentityDetailV2
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 the workspace-level activity status of a principal already assigned to the workspace. This is a singleton adopted with pulumi import (the principal is not created here); once imported, workspaceIdentityStatus can be toggled between ACTIVE and INACTIVE.

    Example Usage

    Example usage:

    This is a singleton resource: the identity detail already exists for a principal already assigned to the workspace, so principalId is read-only and the resource is adopted with pulumi import rather than created. Once imported, Pulumi manages workspaceIdentityStatus — the only updatable field. Edit it between ACTIVE and INACTIVE and re-apply to update in place.

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const _this = new databricks.WorkspaceIamWorkspaceIdentityDetailV2("this", {workspaceIdentityStatus: "ACTIVE"});
    
    import pulumi
    import pulumi_databricks as databricks
    
    this = databricks.WorkspaceIamWorkspaceIdentityDetailV2("this", workspace_identity_status="ACTIVE")
    
    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.NewWorkspaceIamWorkspaceIdentityDetailV2(ctx, "this", &databricks.WorkspaceIamWorkspaceIdentityDetailV2Args{
    			WorkspaceIdentityStatus: pulumi.String("ACTIVE"),
    		})
    		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.WorkspaceIamWorkspaceIdentityDetailV2("this", new()
        {
            WorkspaceIdentityStatus = "ACTIVE",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.databricks.WorkspaceIamWorkspaceIdentityDetailV2;
    import com.pulumi.databricks.WorkspaceIamWorkspaceIdentityDetailV2Args;
    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 WorkspaceIamWorkspaceIdentityDetailV2("this", WorkspaceIamWorkspaceIdentityDetailV2Args.builder()
                .workspaceIdentityStatus("ACTIVE")
                .build());
    
        }
    }
    
    resources:
      this:
        type: databricks:WorkspaceIamWorkspaceIdentityDetailV2
        properties:
          workspaceIdentityStatus: ACTIVE
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    resource "databricks_workspaceiamworkspaceidentitydetailv2" "this" {
      workspace_identity_status = "ACTIVE"
    }
    

    Import the resource by the principal’s internal Databricks ID:

    terraform import databricks_workspace_iam_workspace_identity_detail_v2.this <principal_id>
    

    Create WorkspaceIamWorkspaceIdentityDetailV2 Resource

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

    Constructor syntax

    new WorkspaceIamWorkspaceIdentityDetailV2(name: string, args?: WorkspaceIamWorkspaceIdentityDetailV2Args, opts?: CustomResourceOptions);
    @overload
    def WorkspaceIamWorkspaceIdentityDetailV2(resource_name: str,
                                              args: Optional[WorkspaceIamWorkspaceIdentityDetailV2Args] = None,
                                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkspaceIamWorkspaceIdentityDetailV2(resource_name: str,
                                              opts: Optional[ResourceOptions] = None,
                                              provider_config: Optional[WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs] = None,
                                              workspace_identity_status: Optional[str] = None)
    func NewWorkspaceIamWorkspaceIdentityDetailV2(ctx *Context, name string, args *WorkspaceIamWorkspaceIdentityDetailV2Args, opts ...ResourceOption) (*WorkspaceIamWorkspaceIdentityDetailV2, error)
    public WorkspaceIamWorkspaceIdentityDetailV2(string name, WorkspaceIamWorkspaceIdentityDetailV2Args? args = null, CustomResourceOptions? opts = null)
    public WorkspaceIamWorkspaceIdentityDetailV2(String name, WorkspaceIamWorkspaceIdentityDetailV2Args args)
    public WorkspaceIamWorkspaceIdentityDetailV2(String name, WorkspaceIamWorkspaceIdentityDetailV2Args args, CustomResourceOptions options)
    
    type: databricks:WorkspaceIamWorkspaceIdentityDetailV2
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "databricks_workspace_iam_workspace_identity_detail_v2" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceIamWorkspaceIdentityDetailV2Args
    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 WorkspaceIamWorkspaceIdentityDetailV2Args
    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 WorkspaceIamWorkspaceIdentityDetailV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceIamWorkspaceIdentityDetailV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceIamWorkspaceIdentityDetailV2Args
    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 workspaceIamWorkspaceIdentityDetailV2Resource = new Databricks.WorkspaceIamWorkspaceIdentityDetailV2("workspaceIamWorkspaceIdentityDetailV2Resource", new()
    {
        ProviderConfig = new Databricks.Inputs.WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs
        {
            WorkspaceId = "string",
        },
        WorkspaceIdentityStatus = "string",
    });
    
    example, err := databricks.NewWorkspaceIamWorkspaceIdentityDetailV2(ctx, "workspaceIamWorkspaceIdentityDetailV2Resource", &databricks.WorkspaceIamWorkspaceIdentityDetailV2Args{
    	ProviderConfig: &databricks.WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs{
    		WorkspaceId: pulumi.String("string"),
    	},
    	WorkspaceIdentityStatus: pulumi.String("string"),
    })
    
    resource "databricks_workspace_iam_workspace_identity_detail_v2" "workspaceIamWorkspaceIdentityDetailV2Resource" {
      lifecycle {
        create_before_destroy = true
      }
      provider_config = {
        workspace_id = "string"
      }
      workspace_identity_status = "string"
    }
    
    var workspaceIamWorkspaceIdentityDetailV2Resource = new WorkspaceIamWorkspaceIdentityDetailV2("workspaceIamWorkspaceIdentityDetailV2Resource", WorkspaceIamWorkspaceIdentityDetailV2Args.builder()
        .providerConfig(WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs.builder()
            .workspaceId("string")
            .build())
        .workspaceIdentityStatus("string")
        .build());
    
    workspace_iam_workspace_identity_detail_v2_resource = databricks.WorkspaceIamWorkspaceIdentityDetailV2("workspaceIamWorkspaceIdentityDetailV2Resource",
        provider_config={
            "workspace_id": "string",
        },
        workspace_identity_status="string")
    
    const workspaceIamWorkspaceIdentityDetailV2Resource = new databricks.WorkspaceIamWorkspaceIdentityDetailV2("workspaceIamWorkspaceIdentityDetailV2Resource", {
        providerConfig: {
            workspaceId: "string",
        },
        workspaceIdentityStatus: "string",
    });
    
    type: databricks:WorkspaceIamWorkspaceIdentityDetailV2
    properties:
        providerConfig:
            workspaceId: string
        workspaceIdentityStatus: string
    

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

    ProviderConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfig
    Configure the provider for management through account provider.
    WorkspaceIdentityStatus string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    ProviderConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs
    Configure the provider for management through account provider.
    WorkspaceIdentityStatus string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    provider_config object
    Configure the provider for management through account provider.
    workspace_identity_status string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    providerConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfig
    Configure the provider for management through account provider.
    workspaceIdentityStatus String
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    providerConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfig
    Configure the provider for management through account provider.
    workspaceIdentityStatus string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    provider_config WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs
    Configure the provider for management through account provider.
    workspace_identity_status str
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    providerConfig Property Map
    Configure the provider for management through account provider.
    workspaceIdentityStatus String
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE

    Outputs

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

    AssignmentType string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalId string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    PrincipalType string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    AssignmentType string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalId string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    PrincipalType string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    assignment_type string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    id string
    The provider-assigned unique ID for this managed resource.
    principal_id string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principal_type string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    assignmentType String
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    id String
    The provider-assigned unique ID for this managed resource.
    principalId String
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principalType String
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    assignmentType string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    id string
    The provider-assigned unique ID for this managed resource.
    principalId string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principalType string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    assignment_type str
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    id str
    The provider-assigned unique ID for this managed resource.
    principal_id str
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principal_type str
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    assignmentType String
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    id String
    The provider-assigned unique ID for this managed resource.
    principalId String
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principalType String
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER

    Look up Existing WorkspaceIamWorkspaceIdentityDetailV2 Resource

    Get an existing WorkspaceIamWorkspaceIdentityDetailV2 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?: WorkspaceIamWorkspaceIdentityDetailV2State, opts?: CustomResourceOptions): WorkspaceIamWorkspaceIdentityDetailV2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            assignment_type: Optional[str] = None,
            principal_id: Optional[str] = None,
            principal_type: Optional[str] = None,
            provider_config: Optional[WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs] = None,
            workspace_identity_status: Optional[str] = None) -> WorkspaceIamWorkspaceIdentityDetailV2
    func GetWorkspaceIamWorkspaceIdentityDetailV2(ctx *Context, name string, id IDInput, state *WorkspaceIamWorkspaceIdentityDetailV2State, opts ...ResourceOption) (*WorkspaceIamWorkspaceIdentityDetailV2, error)
    public static WorkspaceIamWorkspaceIdentityDetailV2 Get(string name, Input<string> id, WorkspaceIamWorkspaceIdentityDetailV2State? state, CustomResourceOptions? opts = null)
    public static WorkspaceIamWorkspaceIdentityDetailV2 get(String name, Output<String> id, WorkspaceIamWorkspaceIdentityDetailV2State state, CustomResourceOptions options)
    resources:  _:    type: databricks:WorkspaceIamWorkspaceIdentityDetailV2    get:      id: ${id}
    import {
      to = databricks_workspace_iam_workspace_identity_detail_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:
    AssignmentType string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    PrincipalId string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    PrincipalType string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    ProviderConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfig
    Configure the provider for management through account provider.
    WorkspaceIdentityStatus string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    AssignmentType string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    PrincipalId string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    PrincipalType string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    ProviderConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs
    Configure the provider for management through account provider.
    WorkspaceIdentityStatus string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    assignment_type string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    principal_id string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principal_type string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    provider_config object
    Configure the provider for management through account provider.
    workspace_identity_status string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    assignmentType String
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    principalId String
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principalType String
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    providerConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfig
    Configure the provider for management through account provider.
    workspaceIdentityStatus String
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    assignmentType string
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    principalId string
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principalType string
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    providerConfig WorkspaceIamWorkspaceIdentityDetailV2ProviderConfig
    Configure the provider for management through account provider.
    workspaceIdentityStatus string
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    assignment_type str
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    principal_id str
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principal_type str
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    provider_config WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs
    Configure the provider for management through account provider.
    workspace_identity_status str
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE
    assignmentType String
    (string) - The type of assignment the principal has to the workspace (direct or indirect). Possible values are: DIRECT, INDIRECT
    principalId String
    (integer) - The internal ID of the principal (user/sp/group) in Databricks
    principalType String
    (string) - The type of the principal (user/service principal/group). Possible values are: GROUP, SERVICE_PRINCIPAL, USER
    providerConfig Property Map
    Configure the provider for management through account provider.
    workspaceIdentityStatus String
    The activity status of an identity in a Databricks workspace. Possible values are: ACTIVE, INACTIVE

    Supporting Types

    WorkspaceIamWorkspaceIdentityDetailV2ProviderConfig, WorkspaceIamWorkspaceIdentityDetailV2ProviderConfigArgs

    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