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

ibm.AppidCloudDirectoryUser

Explore with Pulumi AI

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

    Create, update, or delete an IBM Cloud AppID Management Services Cloud Directory user resource. For more information, see managing users

    Note: depending on your AppID Cloud Directory settings, new user creation may trigger user verification email.

    Example Usage

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

const user = new ibm.AppidCloudDirectoryUser("user", {
    tenantId: _var.tenant_id,
    emails: [{
        value: "test_user@mail.com",
        primary: true,
    }],
    active: false,
    lockedUntil: 1631034316584,
    password: "P@ssw0rd",
    displayName: "Test TF User",
});

    import pulumi
import pulumi_ibm as ibm

user = ibm.AppidCloudDirectoryUser("user",
    tenant_id=var["tenant_id"],
    emails=[{
        "value": "test_user@mail.com",
        "primary": True,
    }],
    active=False,
    locked_until=1631034316584,
    password="P@ssw0rd",
    display_name="Test TF User")

    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.NewAppidCloudDirectoryUser(ctx, "user", &ibm.AppidCloudDirectoryUserArgs{
			TenantId: pulumi.Any(_var.Tenant_id),
			Emails: ibm.AppidCloudDirectoryUserEmailArray{
				&ibm.AppidCloudDirectoryUserEmailArgs{
					Value:   pulumi.String("test_user@mail.com"),
					Primary: pulumi.Bool(true),
				},
			},
			Active:      pulumi.Bool(false),
			LockedUntil: pulumi.Float64(1631034316584),
			Password:    pulumi.String("P@ssw0rd"),
			DisplayName: pulumi.String("Test TF User"),
		})
		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 user = new Ibm.AppidCloudDirectoryUser("user", new()
    {
        TenantId = @var.Tenant_id,
        Emails = new[]
        {
            new Ibm.Inputs.AppidCloudDirectoryUserEmailArgs
            {
                Value = "test_user@mail.com",
                Primary = true,
            },
        },
        Active = false,
        LockedUntil = 1631034316584,
        Password = "P@ssw0rd",
        DisplayName = "Test TF User",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.AppidCloudDirectoryUser;
import com.pulumi.ibm.AppidCloudDirectoryUserArgs;
import com.pulumi.ibm.inputs.AppidCloudDirectoryUserEmailArgs;
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 user = new AppidCloudDirectoryUser("user", AppidCloudDirectoryUserArgs.builder()
            .tenantId(var_.tenant_id())
            .emails(AppidCloudDirectoryUserEmailArgs.builder()
                .value("test_user@mail.com")
                .primary(true)
                .build())
            .active(false)
            .lockedUntil(1631034316584)
            .password("P@ssw0rd")
            .displayName("Test TF User")
            .build());

    }
}

    resources:
  user:
    type: ibm:AppidCloudDirectoryUser
    properties:
      tenantId: ${var.tenant_id}
      emails:
        - value: test_user@mail.com
          primary: true
      active: false
      lockedUntil: 1.631034316584e+12
      password: P@ssw0rd
      displayName: Test TF User

    Create AppidCloudDirectoryUser Resource

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

    Constructor syntax

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

@overload
def AppidCloudDirectoryUser(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            emails: Optional[Sequence[AppidCloudDirectoryUserEmailArgs]] = None,
                            password: Optional[str] = None,
                            tenant_id: Optional[str] = None,
                            active: Optional[bool] = None,
                            appid_cloud_directory_user_id: Optional[str] = None,
                            create_profile: Optional[bool] = None,
                            display_name: Optional[str] = None,
                            locked_until: Optional[float] = None,
                            status: Optional[str] = None,
                            user_name: Optional[str] = None)
    func NewAppidCloudDirectoryUser(ctx *Context, name string, args AppidCloudDirectoryUserArgs, opts ...ResourceOption) (*AppidCloudDirectoryUser, error)
    public AppidCloudDirectoryUser(string name, AppidCloudDirectoryUserArgs args, CustomResourceOptions? opts = null)
    public AppidCloudDirectoryUser(String name, AppidCloudDirectoryUserArgs args)
public AppidCloudDirectoryUser(String name, AppidCloudDirectoryUserArgs args, CustomResourceOptions options)

    type: ibm:AppidCloudDirectoryUser
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 AppidCloudDirectoryUserArgs
    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 AppidCloudDirectoryUserArgs
    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 AppidCloudDirectoryUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppidCloudDirectoryUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppidCloudDirectoryUserArgs
    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 appidCloudDirectoryUserResource = new Ibm.AppidCloudDirectoryUser("appidCloudDirectoryUserResource", new()
{
    Emails = new[]
    {
        new Ibm.Inputs.AppidCloudDirectoryUserEmailArgs
        {
            Value = "string",
            Primary = false,
        },
    },
    Password = "string",
    TenantId = "string",
    Active = false,
    AppidCloudDirectoryUserId = "string",
    CreateProfile = false,
    DisplayName = "string",
    LockedUntil = 0,
    Status = "string",
    UserName = "string",
});

    example, err := ibm.NewAppidCloudDirectoryUser(ctx, "appidCloudDirectoryUserResource", &ibm.AppidCloudDirectoryUserArgs{
	Emails: ibm.AppidCloudDirectoryUserEmailArray{
		&ibm.AppidCloudDirectoryUserEmailArgs{
			Value:   pulumi.String("string"),
			Primary: pulumi.Bool(false),
		},
	},
	Password:                  pulumi.String("string"),
	TenantId:                  pulumi.String("string"),
	Active:                    pulumi.Bool(false),
	AppidCloudDirectoryUserId: pulumi.String("string"),
	CreateProfile:             pulumi.Bool(false),
	DisplayName:               pulumi.String("string"),
	LockedUntil:               pulumi.Float64(0),
	Status:                    pulumi.String("string"),
	UserName:                  pulumi.String("string"),
})

    var appidCloudDirectoryUserResource = new AppidCloudDirectoryUser("appidCloudDirectoryUserResource", AppidCloudDirectoryUserArgs.builder()
    .emails(AppidCloudDirectoryUserEmailArgs.builder()
        .value("string")
        .primary(false)
        .build())
    .password("string")
    .tenantId("string")
    .active(false)
    .appidCloudDirectoryUserId("string")
    .createProfile(false)
    .displayName("string")
    .lockedUntil(0)
    .status("string")
    .userName("string")
    .build());

    appid_cloud_directory_user_resource = ibm.AppidCloudDirectoryUser("appidCloudDirectoryUserResource",
    emails=[{
        "value": "string",
        "primary": False,
    }],
    password="string",
    tenant_id="string",
    active=False,
    appid_cloud_directory_user_id="string",
    create_profile=False,
    display_name="string",
    locked_until=0,
    status="string",
    user_name="string")

    const appidCloudDirectoryUserResource = new ibm.AppidCloudDirectoryUser("appidCloudDirectoryUserResource", {
    emails: [{
        value: "string",
        primary: false,
    }],
    password: "string",
    tenantId: "string",
    active: false,
    appidCloudDirectoryUserId: "string",
    createProfile: false,
    displayName: "string",
    lockedUntil: 0,
    status: "string",
    userName: "string",
});

    type: ibm:AppidCloudDirectoryUser
properties:
    active: false
    appidCloudDirectoryUserId: string
    createProfile: false
    displayName: string
    emails:
        - primary: false
          value: string
    lockedUntil: 0
    password: string
    status: string
    tenantId: string
    userName: string

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

    Emails List<AppidCloudDirectoryUserEmail>

    A set of user emails

    Nested scheme for email:

    Password string
    Password
    TenantId string
    The AppID instance GUID
    Active bool
    Determines if the user account is active or not (Default: true)
    AppidCloudDirectoryUserId string
    CreateProfile bool
    A boolean indication if a profile should be created for the Cloud Directory user
    DisplayName string
    Optional user's display name, defaults to user's email
    LockedUntil double
    Epoch time in milliseconds, determines till when the user account will be locked
    Status string
    PENDING or CONFIRMED (Default: PENDING)
    UserName string
    Username
    Emails []AppidCloudDirectoryUserEmailArgs

    A set of user emails

    Nested scheme for email:

    Password string
    Password
    TenantId string
    The AppID instance GUID
    Active bool
    Determines if the user account is active or not (Default: true)
    AppidCloudDirectoryUserId string
    CreateProfile bool
    A boolean indication if a profile should be created for the Cloud Directory user
    DisplayName string
    Optional user's display name, defaults to user's email
    LockedUntil float64
    Epoch time in milliseconds, determines till when the user account will be locked
    Status string
    PENDING or CONFIRMED (Default: PENDING)
    UserName string
    Username
    emails List<AppidCloudDirectoryUserEmail>

    A set of user emails

    Nested scheme for email:

    password String
    Password
    tenantId String
    The AppID instance GUID
    active Boolean
    Determines if the user account is active or not (Default: true)
    appidCloudDirectoryUserId String
    createProfile Boolean
    A boolean indication if a profile should be created for the Cloud Directory user
    displayName String
    Optional user's display name, defaults to user's email
    lockedUntil Double
    Epoch time in milliseconds, determines till when the user account will be locked
    status String
    PENDING or CONFIRMED (Default: PENDING)
    userName String
    Username
    emails AppidCloudDirectoryUserEmail[]

    A set of user emails

    Nested scheme for email:

    password string
    Password
    tenantId string
    The AppID instance GUID
    active boolean
    Determines if the user account is active or not (Default: true)
    appidCloudDirectoryUserId string
    createProfile boolean
    A boolean indication if a profile should be created for the Cloud Directory user
    displayName string
    Optional user's display name, defaults to user's email
    lockedUntil number
    Epoch time in milliseconds, determines till when the user account will be locked
    status string
    PENDING or CONFIRMED (Default: PENDING)
    userName string
    Username
    emails Sequence[AppidCloudDirectoryUserEmailArgs]

    A set of user emails

    Nested scheme for email:

    password str
    Password
    tenant_id str
    The AppID instance GUID
    active bool
    Determines if the user account is active or not (Default: true)
    appid_cloud_directory_user_id str
    create_profile bool
    A boolean indication if a profile should be created for the Cloud Directory user
    display_name str
    Optional user's display name, defaults to user's email
    locked_until float
    Epoch time in milliseconds, determines till when the user account will be locked
    status str
    PENDING or CONFIRMED (Default: PENDING)
    user_name str
    Username
    emails List<Property Map>

    A set of user emails

    Nested scheme for email:

    password String
    Password
    tenantId String
    The AppID instance GUID
    active Boolean
    Determines if the user account is active or not (Default: true)
    appidCloudDirectoryUserId String
    createProfile Boolean
    A boolean indication if a profile should be created for the Cloud Directory user
    displayName String
    Optional user's display name, defaults to user's email
    lockedUntil Number
    Epoch time in milliseconds, determines till when the user account will be locked
    status String
    PENDING or CONFIRMED (Default: PENDING)
    userName String
    Username

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Metas List<AppidCloudDirectoryUserMeta>
    (List of Object) User metadata
    Subject string
    (String) The user's identifier ('subject' in identity token)
    UserId string
    (String) User identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Metas []AppidCloudDirectoryUserMeta
    (List of Object) User metadata
    Subject string
    (String) The user's identifier ('subject' in identity token)
    UserId string
    (String) User identifier
    id String
    The provider-assigned unique ID for this managed resource.
    metas List<AppidCloudDirectoryUserMeta>
    (List of Object) User metadata
    subject String
    (String) The user's identifier ('subject' in identity token)
    userId String
    (String) User identifier
    id string
    The provider-assigned unique ID for this managed resource.
    metas AppidCloudDirectoryUserMeta[]
    (List of Object) User metadata
    subject string
    (String) The user's identifier ('subject' in identity token)
    userId string
    (String) User identifier
    id str
    The provider-assigned unique ID for this managed resource.
    metas Sequence[AppidCloudDirectoryUserMeta]
    (List of Object) User metadata
    subject str
    (String) The user's identifier ('subject' in identity token)
    user_id str
    (String) User identifier
    id String
    The provider-assigned unique ID for this managed resource.
    metas List<Property Map>
    (List of Object) User metadata
    subject String
    (String) The user's identifier ('subject' in identity token)
    userId String
    (String) User identifier

    Look up Existing AppidCloudDirectoryUser Resource

    Get an existing AppidCloudDirectoryUser 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?: AppidCloudDirectoryUserState, opts?: CustomResourceOptions): AppidCloudDirectoryUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        appid_cloud_directory_user_id: Optional[str] = None,
        create_profile: Optional[bool] = None,
        display_name: Optional[str] = None,
        emails: Optional[Sequence[AppidCloudDirectoryUserEmailArgs]] = None,
        locked_until: Optional[float] = None,
        metas: Optional[Sequence[AppidCloudDirectoryUserMetaArgs]] = None,
        password: Optional[str] = None,
        status: Optional[str] = None,
        subject: Optional[str] = None,
        tenant_id: Optional[str] = None,
        user_id: Optional[str] = None,
        user_name: Optional[str] = None) -> AppidCloudDirectoryUser
    func GetAppidCloudDirectoryUser(ctx *Context, name string, id IDInput, state *AppidCloudDirectoryUserState, opts ...ResourceOption) (*AppidCloudDirectoryUser, error)
    public static AppidCloudDirectoryUser Get(string name, Input<string> id, AppidCloudDirectoryUserState? state, CustomResourceOptions? opts = null)
    public static AppidCloudDirectoryUser get(String name, Output<String> id, AppidCloudDirectoryUserState state, CustomResourceOptions options)
    resources:  _:    type: ibm:AppidCloudDirectoryUser    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:
    Active bool
    Determines if the user account is active or not (Default: true)
    AppidCloudDirectoryUserId string
    CreateProfile bool
    A boolean indication if a profile should be created for the Cloud Directory user
    DisplayName string
    Optional user's display name, defaults to user's email
    Emails List<AppidCloudDirectoryUserEmail>

    A set of user emails

    Nested scheme for email:

    LockedUntil double
    Epoch time in milliseconds, determines till when the user account will be locked
    Metas List<AppidCloudDirectoryUserMeta>
    (List of Object) User metadata
    Password string
    Password
    Status string
    PENDING or CONFIRMED (Default: PENDING)
    Subject string
    (String) The user's identifier ('subject' in identity token)
    TenantId string
    The AppID instance GUID
    UserId string
    (String) User identifier
    UserName string
    Username
    Active bool
    Determines if the user account is active or not (Default: true)
    AppidCloudDirectoryUserId string
    CreateProfile bool
    A boolean indication if a profile should be created for the Cloud Directory user
    DisplayName string
    Optional user's display name, defaults to user's email
    Emails []AppidCloudDirectoryUserEmailArgs

    A set of user emails

    Nested scheme for email:

    LockedUntil float64
    Epoch time in milliseconds, determines till when the user account will be locked
    Metas []AppidCloudDirectoryUserMetaArgs
    (List of Object) User metadata
    Password string
    Password
    Status string
    PENDING or CONFIRMED (Default: PENDING)
    Subject string
    (String) The user's identifier ('subject' in identity token)
    TenantId string
    The AppID instance GUID
    UserId string
    (String) User identifier
    UserName string
    Username
    active Boolean
    Determines if the user account is active or not (Default: true)
    appidCloudDirectoryUserId String
    createProfile Boolean
    A boolean indication if a profile should be created for the Cloud Directory user
    displayName String
    Optional user's display name, defaults to user's email
    emails List<AppidCloudDirectoryUserEmail>

    A set of user emails

    Nested scheme for email:

    lockedUntil Double
    Epoch time in milliseconds, determines till when the user account will be locked
    metas List<AppidCloudDirectoryUserMeta>
    (List of Object) User metadata
    password String
    Password
    status String
    PENDING or CONFIRMED (Default: PENDING)
    subject String
    (String) The user's identifier ('subject' in identity token)
    tenantId String
    The AppID instance GUID
    userId String
    (String) User identifier
    userName String
    Username
    active boolean
    Determines if the user account is active or not (Default: true)
    appidCloudDirectoryUserId string
    createProfile boolean
    A boolean indication if a profile should be created for the Cloud Directory user
    displayName string
    Optional user's display name, defaults to user's email
    emails AppidCloudDirectoryUserEmail[]

    A set of user emails

    Nested scheme for email:

    lockedUntil number
    Epoch time in milliseconds, determines till when the user account will be locked
    metas AppidCloudDirectoryUserMeta[]
    (List of Object) User metadata
    password string
    Password
    status string
    PENDING or CONFIRMED (Default: PENDING)
    subject string
    (String) The user's identifier ('subject' in identity token)
    tenantId string
    The AppID instance GUID
    userId string
    (String) User identifier
    userName string
    Username
    active bool
    Determines if the user account is active or not (Default: true)
    appid_cloud_directory_user_id str
    create_profile bool
    A boolean indication if a profile should be created for the Cloud Directory user
    display_name str
    Optional user's display name, defaults to user's email
    emails Sequence[AppidCloudDirectoryUserEmailArgs]

    A set of user emails

    Nested scheme for email:

    locked_until float
    Epoch time in milliseconds, determines till when the user account will be locked
    metas Sequence[AppidCloudDirectoryUserMetaArgs]
    (List of Object) User metadata
    password str
    Password
    status str
    PENDING or CONFIRMED (Default: PENDING)
    subject str
    (String) The user's identifier ('subject' in identity token)
    tenant_id str
    The AppID instance GUID
    user_id str
    (String) User identifier
    user_name str
    Username
    active Boolean
    Determines if the user account is active or not (Default: true)
    appidCloudDirectoryUserId String
    createProfile Boolean
    A boolean indication if a profile should be created for the Cloud Directory user
    displayName String
    Optional user's display name, defaults to user's email
    emails List<Property Map>

    A set of user emails

    Nested scheme for email:

    lockedUntil Number
    Epoch time in milliseconds, determines till when the user account will be locked
    metas List<Property Map>
    (List of Object) User metadata
    password String
    Password
    status String
    PENDING or CONFIRMED (Default: PENDING)
    subject String
    (String) The user's identifier ('subject' in identity token)
    tenantId String
    The AppID instance GUID
    userId String
    (String) User identifier
    userName String
    Username

    Supporting Types

    AppidCloudDirectoryUserEmail, AppidCloudDirectoryUserEmailArgs

    Value string
    An email string
    Primary bool
    true if this is primary email
    Value string
    An email string
    Primary bool
    true if this is primary email
    value String
    An email string
    primary Boolean
    true if this is primary email
    value string
    An email string
    primary boolean
    true if this is primary email
    value str
    An email string
    primary bool
    true if this is primary email
    value String
    An email string
    primary Boolean
    true if this is primary email

    AppidCloudDirectoryUserMeta, AppidCloudDirectoryUserMetaArgs

    Created string
    (String) User creation date
    LastModified string
    (String) Last modification date
    Created string
    (String) User creation date
    LastModified string
    (String) Last modification date
    created String
    (String) User creation date
    lastModified String
    (String) Last modification date
    created string
    (String) User creation date
    lastModified string
    (String) Last modification date
    created str
    (String) User creation date
    last_modified str
    (String) Last modification date
    created String
    (String) User creation date
    lastModified String
    (String) Last modification date

    Import

    The ibm_appid_cloud_directory_user resource can be imported by using the AppID tenant ID and user ID.

    Syntax

    bash

    $ pulumi import ibm:index/appidCloudDirectoryUser:AppidCloudDirectoryUser user <tenant_id>/<user_id>

    Example

    bash

    $ pulumi import ibm:index/appidCloudDirectoryUser:AppidCloudDirectoryUser user 5fa344a8-d361-4bc2-9051-58ca253f4b2b/03dde38a-b35a-43f2-a58a-c2d3fe26aaea

    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