Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. AppidIdpCloudDirectory
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.AppidIdpCloudDirectory

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Update or reset an IBM Cloud AppID Management Services Cloud Directory IDP configuration. For more information, see configuring Cloud Directory

    Example Usage

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

const cd = new ibm.AppidIdpCloudDirectory("cd", {
    tenantId: _var.tenant_id,
    isActive: true,
    identityConfirmMethods: ["email"],
    identityField: "email",
    selfServiceEnabled: false,
    signupEnabled: false,
    welcomeEnabled: true,
    resetPasswordEnabled: false,
    resetPasswordNotificationEnabled: false,
});

    import pulumi
import pulumi_ibm as ibm

cd = ibm.AppidIdpCloudDirectory("cd",
    tenant_id=var["tenant_id"],
    is_active=True,
    identity_confirm_methods=["email"],
    identity_field="email",
    self_service_enabled=False,
    signup_enabled=False,
    welcome_enabled=True,
    reset_password_enabled=False,
    reset_password_notification_enabled=False)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewAppidIdpCloudDirectory(ctx, "cd", &ibm.AppidIdpCloudDirectoryArgs{
			TenantId: pulumi.Any(_var.Tenant_id),
			IsActive: pulumi.Bool(true),
			IdentityConfirmMethods: pulumi.StringArray{
				pulumi.String("email"),
			},
			IdentityField:                    pulumi.String("email"),
			SelfServiceEnabled:               pulumi.Bool(false),
			SignupEnabled:                    pulumi.Bool(false),
			WelcomeEnabled:                   pulumi.Bool(true),
			ResetPasswordEnabled:             pulumi.Bool(false),
			ResetPasswordNotificationEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var cd = new Ibm.AppidIdpCloudDirectory("cd", new()
    {
        TenantId = @var.Tenant_id,
        IsActive = true,
        IdentityConfirmMethods = new[]
        {
            "email",
        },
        IdentityField = "email",
        SelfServiceEnabled = false,
        SignupEnabled = false,
        WelcomeEnabled = true,
        ResetPasswordEnabled = false,
        ResetPasswordNotificationEnabled = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.AppidIdpCloudDirectory;
import com.pulumi.ibm.AppidIdpCloudDirectoryArgs;
import java.util.List;
import java.util.ArrayList;
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 cd = new AppidIdpCloudDirectory("cd", AppidIdpCloudDirectoryArgs.builder()
            .tenantId(var_.tenant_id())
            .isActive(true)
            .identityConfirmMethods("email")
            .identityField("email")
            .selfServiceEnabled(false)
            .signupEnabled(false)
            .welcomeEnabled(true)
            .resetPasswordEnabled(false)
            .resetPasswordNotificationEnabled(false)
            .build());

    }
}

    resources:
  cd:
    type: ibm:AppidIdpCloudDirectory
    properties:
      tenantId: ${var.tenant_id}
      isActive: true
      identityConfirmMethods:
        - email
      identityField: email
      selfServiceEnabled: false
      signupEnabled: false
      welcomeEnabled: true
      resetPasswordEnabled: false
      resetPasswordNotificationEnabled: false

    Create AppidIdpCloudDirectory Resource

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

    Constructor syntax

    new AppidIdpCloudDirectory(name: string, args: AppidIdpCloudDirectoryArgs, opts?: CustomResourceOptions);
    @overload
def AppidIdpCloudDirectory(resource_name: str,
                           args: AppidIdpCloudDirectoryArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def AppidIdpCloudDirectory(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           is_active: Optional[bool] = None,
                           tenant_id: Optional[str] = None,
                           appid_idp_cloud_directory_id: Optional[str] = None,
                           identity_confirm_access_mode: Optional[str] = None,
                           identity_confirm_methods: Optional[Sequence[str]] = None,
                           identity_field: Optional[str] = None,
                           reset_password_enabled: Optional[bool] = None,
                           reset_password_notification_enabled: Optional[bool] = None,
                           self_service_enabled: Optional[bool] = None,
                           signup_enabled: Optional[bool] = None,
                           welcome_enabled: Optional[bool] = None)
    func NewAppidIdpCloudDirectory(ctx *Context, name string, args AppidIdpCloudDirectoryArgs, opts ...ResourceOption) (*AppidIdpCloudDirectory, error)
    public AppidIdpCloudDirectory(string name, AppidIdpCloudDirectoryArgs args, CustomResourceOptions? opts = null)
    public AppidIdpCloudDirectory(String name, AppidIdpCloudDirectoryArgs args)
public AppidIdpCloudDirectory(String name, AppidIdpCloudDirectoryArgs args, CustomResourceOptions options)

    type: ibm:AppidIdpCloudDirectory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AppidIdpCloudDirectoryArgs
    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 AppidIdpCloudDirectoryArgs
    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 AppidIdpCloudDirectoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppidIdpCloudDirectoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppidIdpCloudDirectoryArgs
    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 appidIdpCloudDirectoryResource = new Ibm.AppidIdpCloudDirectory("appidIdpCloudDirectoryResource", new()
{
    IsActive = false,
    TenantId = "string",
    AppidIdpCloudDirectoryId = "string",
    IdentityConfirmAccessMode = "string",
    IdentityConfirmMethods = new[]
    {
        "string",
    },
    IdentityField = "string",
    ResetPasswordEnabled = false,
    ResetPasswordNotificationEnabled = false,
    SelfServiceEnabled = false,
    SignupEnabled = false,
    WelcomeEnabled = false,
});

    example, err := ibm.NewAppidIdpCloudDirectory(ctx, "appidIdpCloudDirectoryResource", &ibm.AppidIdpCloudDirectoryArgs{
	IsActive:                  pulumi.Bool(false),
	TenantId:                  pulumi.String("string"),
	AppidIdpCloudDirectoryId:  pulumi.String("string"),
	IdentityConfirmAccessMode: pulumi.String("string"),
	IdentityConfirmMethods: pulumi.StringArray{
		pulumi.String("string"),
	},
	IdentityField:                    pulumi.String("string"),
	ResetPasswordEnabled:             pulumi.Bool(false),
	ResetPasswordNotificationEnabled: pulumi.Bool(false),
	SelfServiceEnabled:               pulumi.Bool(false),
	SignupEnabled:                    pulumi.Bool(false),
	WelcomeEnabled:                   pulumi.Bool(false),
})

    var appidIdpCloudDirectoryResource = new AppidIdpCloudDirectory("appidIdpCloudDirectoryResource", AppidIdpCloudDirectoryArgs.builder()
    .isActive(false)
    .tenantId("string")
    .appidIdpCloudDirectoryId("string")
    .identityConfirmAccessMode("string")
    .identityConfirmMethods("string")
    .identityField("string")
    .resetPasswordEnabled(false)
    .resetPasswordNotificationEnabled(false)
    .selfServiceEnabled(false)
    .signupEnabled(false)
    .welcomeEnabled(false)
    .build());

    appid_idp_cloud_directory_resource = ibm.AppidIdpCloudDirectory("appidIdpCloudDirectoryResource",
    is_active=False,
    tenant_id="string",
    appid_idp_cloud_directory_id="string",
    identity_confirm_access_mode="string",
    identity_confirm_methods=["string"],
    identity_field="string",
    reset_password_enabled=False,
    reset_password_notification_enabled=False,
    self_service_enabled=False,
    signup_enabled=False,
    welcome_enabled=False)

    const appidIdpCloudDirectoryResource = new ibm.AppidIdpCloudDirectory("appidIdpCloudDirectoryResource", {
    isActive: false,
    tenantId: "string",
    appidIdpCloudDirectoryId: "string",
    identityConfirmAccessMode: "string",
    identityConfirmMethods: ["string"],
    identityField: "string",
    resetPasswordEnabled: false,
    resetPasswordNotificationEnabled: false,
    selfServiceEnabled: false,
    signupEnabled: false,
    welcomeEnabled: false,
});

    type: ibm:AppidIdpCloudDirectory
properties:
    appidIdpCloudDirectoryId: string
    identityConfirmAccessMode: string
    identityConfirmMethods:
        - string
    identityField: string
    isActive: false
    resetPasswordEnabled: false
    resetPasswordNotificationEnabled: false
    selfServiceEnabled: false
    signupEnabled: false
    tenantId: string
    welcomeEnabled: false

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

    IsActive bool
    Cloud Directory IDP activation
    TenantId string
    The AppID instance GUID
    AppidIdpCloudDirectoryId string
    IdentityConfirmAccessMode string
    Allowed values: FULL, RESTRICTIVE, OFF
    IdentityConfirmMethods List<string>
    Allowed value: email
    IdentityField string
    Allowed values: email, userName
    ResetPasswordEnabled bool
    Enable password resets
    ResetPasswordNotificationEnabled bool
    Enable password reset notification emails
    SelfServiceEnabled bool
    Let users change their password, edit user details
    SignupEnabled bool
    Allow users to sign-up
    WelcomeEnabled bool
    Send welcome email to new users
    IsActive bool
    Cloud Directory IDP activation
    TenantId string
    The AppID instance GUID
    AppidIdpCloudDirectoryId string
    IdentityConfirmAccessMode string
    Allowed values: FULL, RESTRICTIVE, OFF
    IdentityConfirmMethods []string
    Allowed value: email
    IdentityField string
    Allowed values: email, userName
    ResetPasswordEnabled bool
    Enable password resets
    ResetPasswordNotificationEnabled bool
    Enable password reset notification emails
    SelfServiceEnabled bool
    Let users change their password, edit user details
    SignupEnabled bool
    Allow users to sign-up
    WelcomeEnabled bool
    Send welcome email to new users
    isActive Boolean
    Cloud Directory IDP activation
    tenantId String
    The AppID instance GUID
    appidIdpCloudDirectoryId String
    identityConfirmAccessMode String
    Allowed values: FULL, RESTRICTIVE, OFF
    identityConfirmMethods List<String>
    Allowed value: email
    identityField String
    Allowed values: email, userName
    resetPasswordEnabled Boolean
    Enable password resets
    resetPasswordNotificationEnabled Boolean
    Enable password reset notification emails
    selfServiceEnabled Boolean
    Let users change their password, edit user details
    signupEnabled Boolean
    Allow users to sign-up
    welcomeEnabled Boolean
    Send welcome email to new users
    isActive boolean
    Cloud Directory IDP activation
    tenantId string
    The AppID instance GUID
    appidIdpCloudDirectoryId string
    identityConfirmAccessMode string
    Allowed values: FULL, RESTRICTIVE, OFF
    identityConfirmMethods string[]
    Allowed value: email
    identityField string
    Allowed values: email, userName
    resetPasswordEnabled boolean
    Enable password resets
    resetPasswordNotificationEnabled boolean
    Enable password reset notification emails
    selfServiceEnabled boolean
    Let users change their password, edit user details
    signupEnabled boolean
    Allow users to sign-up
    welcomeEnabled boolean
    Send welcome email to new users
    is_active bool
    Cloud Directory IDP activation
    tenant_id str
    The AppID instance GUID
    appid_idp_cloud_directory_id str
    identity_confirm_access_mode str
    Allowed values: FULL, RESTRICTIVE, OFF
    identity_confirm_methods Sequence[str]
    Allowed value: email
    identity_field str
    Allowed values: email, userName
    reset_password_enabled bool
    Enable password resets
    reset_password_notification_enabled bool
    Enable password reset notification emails
    self_service_enabled bool
    Let users change their password, edit user details
    signup_enabled bool
    Allow users to sign-up
    welcome_enabled bool
    Send welcome email to new users
    isActive Boolean
    Cloud Directory IDP activation
    tenantId String
    The AppID instance GUID
    appidIdpCloudDirectoryId String
    identityConfirmAccessMode String
    Allowed values: FULL, RESTRICTIVE, OFF
    identityConfirmMethods List<String>
    Allowed value: email
    identityField String
    Allowed values: email, userName
    resetPasswordEnabled Boolean
    Enable password resets
    resetPasswordNotificationEnabled Boolean
    Enable password reset notification emails
    selfServiceEnabled Boolean
    Let users change their password, edit user details
    signupEnabled Boolean
    Allow users to sign-up
    welcomeEnabled Boolean
    Send welcome email to new users

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AppidIdpCloudDirectory Resource

    Get an existing AppidIdpCloudDirectory 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?: AppidIdpCloudDirectoryState, opts?: CustomResourceOptions): AppidIdpCloudDirectory
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        appid_idp_cloud_directory_id: Optional[str] = None,
        identity_confirm_access_mode: Optional[str] = None,
        identity_confirm_methods: Optional[Sequence[str]] = None,
        identity_field: Optional[str] = None,
        is_active: Optional[bool] = None,
        reset_password_enabled: Optional[bool] = None,
        reset_password_notification_enabled: Optional[bool] = None,
        self_service_enabled: Optional[bool] = None,
        signup_enabled: Optional[bool] = None,
        tenant_id: Optional[str] = None,
        welcome_enabled: Optional[bool] = None) -> AppidIdpCloudDirectory
    func GetAppidIdpCloudDirectory(ctx *Context, name string, id IDInput, state *AppidIdpCloudDirectoryState, opts ...ResourceOption) (*AppidIdpCloudDirectory, error)
    public static AppidIdpCloudDirectory Get(string name, Input<string> id, AppidIdpCloudDirectoryState? state, CustomResourceOptions? opts = null)
    public static AppidIdpCloudDirectory get(String name, Output<String> id, AppidIdpCloudDirectoryState state, CustomResourceOptions options)
    resources:  _:    type: ibm:AppidIdpCloudDirectory    get:      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:
    AppidIdpCloudDirectoryId string
    IdentityConfirmAccessMode string
    Allowed values: FULL, RESTRICTIVE, OFF
    IdentityConfirmMethods List<string>
    Allowed value: email
    IdentityField string
    Allowed values: email, userName
    IsActive bool
    Cloud Directory IDP activation
    ResetPasswordEnabled bool
    Enable password resets
    ResetPasswordNotificationEnabled bool
    Enable password reset notification emails
    SelfServiceEnabled bool
    Let users change their password, edit user details
    SignupEnabled bool
    Allow users to sign-up
    TenantId string
    The AppID instance GUID
    WelcomeEnabled bool
    Send welcome email to new users
    AppidIdpCloudDirectoryId string
    IdentityConfirmAccessMode string
    Allowed values: FULL, RESTRICTIVE, OFF
    IdentityConfirmMethods []string
    Allowed value: email
    IdentityField string
    Allowed values: email, userName
    IsActive bool
    Cloud Directory IDP activation
    ResetPasswordEnabled bool
    Enable password resets
    ResetPasswordNotificationEnabled bool
    Enable password reset notification emails
    SelfServiceEnabled bool
    Let users change their password, edit user details
    SignupEnabled bool
    Allow users to sign-up
    TenantId string
    The AppID instance GUID
    WelcomeEnabled bool
    Send welcome email to new users
    appidIdpCloudDirectoryId String
    identityConfirmAccessMode String
    Allowed values: FULL, RESTRICTIVE, OFF
    identityConfirmMethods List<String>
    Allowed value: email
    identityField String
    Allowed values: email, userName
    isActive Boolean
    Cloud Directory IDP activation
    resetPasswordEnabled Boolean
    Enable password resets
    resetPasswordNotificationEnabled Boolean
    Enable password reset notification emails
    selfServiceEnabled Boolean
    Let users change their password, edit user details
    signupEnabled Boolean
    Allow users to sign-up
    tenantId String
    The AppID instance GUID
    welcomeEnabled Boolean
    Send welcome email to new users
    appidIdpCloudDirectoryId string
    identityConfirmAccessMode string
    Allowed values: FULL, RESTRICTIVE, OFF
    identityConfirmMethods string[]
    Allowed value: email
    identityField string
    Allowed values: email, userName
    isActive boolean
    Cloud Directory IDP activation
    resetPasswordEnabled boolean
    Enable password resets
    resetPasswordNotificationEnabled boolean
    Enable password reset notification emails
    selfServiceEnabled boolean
    Let users change their password, edit user details
    signupEnabled boolean
    Allow users to sign-up
    tenantId string
    The AppID instance GUID
    welcomeEnabled boolean
    Send welcome email to new users
    appid_idp_cloud_directory_id str
    identity_confirm_access_mode str
    Allowed values: FULL, RESTRICTIVE, OFF
    identity_confirm_methods Sequence[str]
    Allowed value: email
    identity_field str
    Allowed values: email, userName
    is_active bool
    Cloud Directory IDP activation
    reset_password_enabled bool
    Enable password resets
    reset_password_notification_enabled bool
    Enable password reset notification emails
    self_service_enabled bool
    Let users change their password, edit user details
    signup_enabled bool
    Allow users to sign-up
    tenant_id str
    The AppID instance GUID
    welcome_enabled bool
    Send welcome email to new users
    appidIdpCloudDirectoryId String
    identityConfirmAccessMode String
    Allowed values: FULL, RESTRICTIVE, OFF
    identityConfirmMethods List<String>
    Allowed value: email
    identityField String
    Allowed values: email, userName
    isActive Boolean
    Cloud Directory IDP activation
    resetPasswordEnabled Boolean
    Enable password resets
    resetPasswordNotificationEnabled Boolean
    Enable password reset notification emails
    selfServiceEnabled Boolean
    Let users change their password, edit user details
    signupEnabled Boolean
    Allow users to sign-up
    tenantId String
    The AppID instance GUID
    welcomeEnabled Boolean
    Send welcome email to new users

    Import

    The ibm_appid_idp_cloud_directory resource can be imported by using the AppID tenant ID.

    Syntax

    bash

    $ pulumi import ibm:index/appidIdpCloudDirectory:AppidIdpCloudDirectory cd <tenant_id>

    Example

    bash

    $ pulumi import ibm:index/appidIdpCloudDirectory:AppidIdpCloudDirectory cd 5fa344a8-d361-4bc2-9051-58ca253f4b2b

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm