Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hsdp Provider
  3. API Docs
  4. IamUser
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

hsdp.IamUser

Explore with Pulumi AI

hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

Provides a resource for managing a HSDP IAM user. When a new user is created an invitation email is triggered with a validity of 72 hours. In case the user hasn’t activated their account within this 72-hour period you can use the hsdp.IamActivationEmail resource to resend the email. Identifying unactivated users can be done using the hsdp.getIamUsers data source.

Example Usage

The following example creates a user.

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

const developer = new hsdp.IamUser("developer", {
    login: "developer",
    email: "developer@1e100.io",
    firstName: "Devel",
    lastName: "Oper",
    organizationId: hsdp_iam_org.testdev.id,
});
Copy
import pulumi
import pulumi_hsdp as hsdp

developer = hsdp.IamUser("developer",
    login="developer",
    email="developer@1e100.io",
    first_name="Devel",
    last_name="Oper",
    organization_id=hsdp_iam_org["testdev"]["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hsdp.NewIamUser(ctx, "developer", &hsdp.IamUserArgs{
			Login:          pulumi.String("developer"),
			Email:          pulumi.String("developer@1e100.io"),
			FirstName:      pulumi.String("Devel"),
			LastName:       pulumi.String("Oper"),
			OrganizationId: pulumi.Any(hsdp_iam_org.Testdev.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Hsdp = Pulumi.Hsdp;

return await Deployment.RunAsync(() => 
{
    var developer = new Hsdp.IamUser("developer", new()
    {
        Login = "developer",
        Email = "developer@1e100.io",
        FirstName = "Devel",
        LastName = "Oper",
        OrganizationId = hsdp_iam_org.Testdev.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hsdp.IamUser;
import com.pulumi.hsdp.IamUserArgs;
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 developer = new IamUser("developer", IamUserArgs.builder()
            .login("developer")
            .email("developer@1e100.io")
            .firstName("Devel")
            .lastName("Oper")
            .organizationId(hsdp_iam_org.testdev().id())
            .build());

    }
}
Copy
resources:
  developer:
    type: hsdp:IamUser
    properties:
      login: developer
      email: developer@1e100.io
      firstName: Devel
      lastName: Oper
      organizationId: ${hsdp_iam_org.testdev.id}
Copy

Create IamUser Resource

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

Constructor syntax

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

@overload
def IamUser(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            email: Optional[str] = None,
            first_name: Optional[str] = None,
            last_name: Optional[str] = None,
            login: Optional[str] = None,
            organization_id: Optional[str] = None,
            iam_user_id: Optional[str] = None,
            mobile: Optional[str] = None,
            password: Optional[str] = None,
            preferred_communication_channel: Optional[str] = None,
            preferred_language: Optional[str] = None,
            username: Optional[str] = None)
func NewIamUser(ctx *Context, name string, args IamUserArgs, opts ...ResourceOption) (*IamUser, error)
public IamUser(string name, IamUserArgs args, CustomResourceOptions? opts = null)
public IamUser(String name, IamUserArgs args)
public IamUser(String name, IamUserArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IamUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IamUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IamUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IamUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IamUserArgs
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 iamUserResource = new Hsdp.IamUser("iamUserResource", new()
{
    Email = "string",
    FirstName = "string",
    LastName = "string",
    Login = "string",
    OrganizationId = "string",
    IamUserId = "string",
    Mobile = "string",
    Password = "string",
    PreferredCommunicationChannel = "string",
    PreferredLanguage = "string",
});
Copy
example, err := hsdp.NewIamUser(ctx, "iamUserResource", &hsdp.IamUserArgs{
Email: pulumi.String("string"),
FirstName: pulumi.String("string"),
LastName: pulumi.String("string"),
Login: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
IamUserId: pulumi.String("string"),
Mobile: pulumi.String("string"),
Password: pulumi.String("string"),
PreferredCommunicationChannel: pulumi.String("string"),
PreferredLanguage: pulumi.String("string"),
})
Copy
var iamUserResource = new IamUser("iamUserResource", IamUserArgs.builder()
    .email("string")
    .firstName("string")
    .lastName("string")
    .login("string")
    .organizationId("string")
    .iamUserId("string")
    .mobile("string")
    .password("string")
    .preferredCommunicationChannel("string")
    .preferredLanguage("string")
    .build());
Copy
iam_user_resource = hsdp.IamUser("iamUserResource",
    email="string",
    first_name="string",
    last_name="string",
    login="string",
    organization_id="string",
    iam_user_id="string",
    mobile="string",
    password="string",
    preferred_communication_channel="string",
    preferred_language="string")
Copy
const iamUserResource = new hsdp.IamUser("iamUserResource", {
    email: "string",
    firstName: "string",
    lastName: "string",
    login: "string",
    organizationId: "string",
    iamUserId: "string",
    mobile: "string",
    password: "string",
    preferredCommunicationChannel: "string",
    preferredLanguage: "string",
});
Copy
type: hsdp:IamUser
properties:
    email: string
    firstName: string
    iamUserId: string
    lastName: string
    login: string
    mobile: string
    organizationId: string
    password: string
    preferredCommunicationChannel: string
    preferredLanguage: string
Copy

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

Email This property is required. string
The email address of the user
FirstName This property is required. string
First name of the user
LastName This property is required. string
Last name of the user
Login This property is required. string
The login ID of the user (NEW since v0.4.0)
OrganizationId This property is required. string
The managing organization of the user
IamUserId string
The GUID of the user
Mobile string
Mobile number of the user. E.164 format
Password string
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
PreferredCommunicationChannel string
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
PreferredLanguage string
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
Username string

Deprecated: Deprecated

Email This property is required. string
The email address of the user
FirstName This property is required. string
First name of the user
LastName This property is required. string
Last name of the user
Login This property is required. string
The login ID of the user (NEW since v0.4.0)
OrganizationId This property is required. string
The managing organization of the user
IamUserId string
The GUID of the user
Mobile string
Mobile number of the user. E.164 format
Password string
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
PreferredCommunicationChannel string
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
PreferredLanguage string
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
Username string

Deprecated: Deprecated

email This property is required. String
The email address of the user
firstName This property is required. String
First name of the user
lastName This property is required. String
Last name of the user
login This property is required. String
The login ID of the user (NEW since v0.4.0)
organizationId This property is required. String
The managing organization of the user
iamUserId String
The GUID of the user
mobile String
Mobile number of the user. E.164 format
password String
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferredCommunicationChannel String
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferredLanguage String
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username String

Deprecated: Deprecated

email This property is required. string
The email address of the user
firstName This property is required. string
First name of the user
lastName This property is required. string
Last name of the user
login This property is required. string
The login ID of the user (NEW since v0.4.0)
organizationId This property is required. string
The managing organization of the user
iamUserId string
The GUID of the user
mobile string
Mobile number of the user. E.164 format
password string
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferredCommunicationChannel string
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferredLanguage string
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username string

Deprecated: Deprecated

email This property is required. str
The email address of the user
first_name This property is required. str
First name of the user
last_name This property is required. str
Last name of the user
login This property is required. str
The login ID of the user (NEW since v0.4.0)
organization_id This property is required. str
The managing organization of the user
iam_user_id str
The GUID of the user
mobile str
Mobile number of the user. E.164 format
password str
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferred_communication_channel str
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferred_language str
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username str

Deprecated: Deprecated

email This property is required. String
The email address of the user
firstName This property is required. String
First name of the user
lastName This property is required. String
Last name of the user
login This property is required. String
The login ID of the user (NEW since v0.4.0)
organizationId This property is required. String
The managing organization of the user
iamUserId String
The GUID of the user
mobile String
Mobile number of the user. E.164 format
password String
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferredCommunicationChannel String
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferredLanguage String
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username String

Deprecated: Deprecated

Outputs

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

AccessStatus string
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
Id string
The provider-assigned unique ID for this managed resource.
AccessStatus string
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
Id string
The provider-assigned unique ID for this managed resource.
accessStatus String
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
id String
The provider-assigned unique ID for this managed resource.
accessStatus string
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
id string
The provider-assigned unique ID for this managed resource.
access_status str
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
id str
The provider-assigned unique ID for this managed resource.
accessStatus String
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
id String
The provider-assigned unique ID for this managed resource.

Look up Existing IamUser Resource

Get an existing IamUser 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?: IamUserState, opts?: CustomResourceOptions): IamUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_status: Optional[str] = None,
        email: Optional[str] = None,
        first_name: Optional[str] = None,
        iam_user_id: Optional[str] = None,
        last_name: Optional[str] = None,
        login: Optional[str] = None,
        mobile: Optional[str] = None,
        organization_id: Optional[str] = None,
        password: Optional[str] = None,
        preferred_communication_channel: Optional[str] = None,
        preferred_language: Optional[str] = None,
        username: Optional[str] = None) -> IamUser
func GetIamUser(ctx *Context, name string, id IDInput, state *IamUserState, opts ...ResourceOption) (*IamUser, error)
public static IamUser Get(string name, Input<string> id, IamUserState? state, CustomResourceOptions? opts = null)
public static IamUser get(String name, Output<String> id, IamUserState state, CustomResourceOptions options)
resources:  _:    type: hsdp:IamUser    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccessStatus string
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
Email string
The email address of the user
FirstName string
First name of the user
IamUserId string
The GUID of the user
LastName string
Last name of the user
Login string
The login ID of the user (NEW since v0.4.0)
Mobile string
Mobile number of the user. E.164 format
OrganizationId string
The managing organization of the user
Password string
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
PreferredCommunicationChannel string
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
PreferredLanguage string
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
Username string

Deprecated: Deprecated

AccessStatus string
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
Email string
The email address of the user
FirstName string
First name of the user
IamUserId string
The GUID of the user
LastName string
Last name of the user
Login string
The login ID of the user (NEW since v0.4.0)
Mobile string
Mobile number of the user. E.164 format
OrganizationId string
The managing organization of the user
Password string
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
PreferredCommunicationChannel string
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
PreferredLanguage string
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
Username string

Deprecated: Deprecated

accessStatus String
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
email String
The email address of the user
firstName String
First name of the user
iamUserId String
The GUID of the user
lastName String
Last name of the user
login String
The login ID of the user (NEW since v0.4.0)
mobile String
Mobile number of the user. E.164 format
organizationId String
The managing organization of the user
password String
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferredCommunicationChannel String
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferredLanguage String
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username String

Deprecated: Deprecated

accessStatus string
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
email string
The email address of the user
firstName string
First name of the user
iamUserId string
The GUID of the user
lastName string
Last name of the user
login string
The login ID of the user (NEW since v0.4.0)
mobile string
Mobile number of the user. E.164 format
organizationId string
The managing organization of the user
password string
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferredCommunicationChannel string
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferredLanguage string
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username string

Deprecated: Deprecated

access_status str
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
email str
The email address of the user
first_name str
First name of the user
iam_user_id str
The GUID of the user
last_name str
Last name of the user
login str
The login ID of the user (NEW since v0.4.0)
mobile str
Mobile number of the user. E.164 format
organization_id str
The managing organization of the user
password str
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferred_communication_channel str
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferred_language str
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username str

Deprecated: Deprecated

accessStatus String
Reflects the access we have to the (existing) user. Possible values are none, id_only, full
email String
The email address of the user
firstName String
First name of the user
iamUserId String
The GUID of the user
lastName String
Last name of the user
login String
The login ID of the user (NEW since v0.4.0)
mobile String
Mobile number of the user. E.164 format
organizationId String
The managing organization of the user
password String
When specified this will skip the email activation flow and immediately activate the IAM account. Very Important: you are responsible for sharing this password with the new IAM user through some channel of communication. No email will be triggered by the system. If unsure, do not set a password so the normal email activation flow is followed. Finally, any password value changes after user creation will have no effect on the users' actual password.
preferredCommunicationChannel String
Preferred communication channel. Email and SMS are supported channels. Email is the default channel if e-mail address is provided. Values supported: [ email | sms ].
preferredLanguage String
Language preference for all communications. Value can be a two letter language code as defined by ISO 639-1 (en, de) or it can be a combination of language code and country code (en-gb, en-us). The country code is as per ISO 3166 two letter code (alpha-2)
username String

Deprecated: Deprecated

Import

$ pulumi import hsdp:index/iamUser:IamUser An existing user can be imported using `hsdp_iam_user`, e.g.
Copy
$ pulumi import hsdp:index/iamUser:IamUser > hsdp_iam_user.developer a-guid
Copy

Alternatively, users can be imported based on their existing IAM Login ID using login/ prefix, e.g.

$ pulumi import hsdp:index/iamUser:IamUser > hsdp_iam_user.developer login/developer
Copy

Where developer would be the IAM login ID of the user.

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

Package Details

Repository
hsdp philips-software/terraform-provider-hsdp
License
Notes
This Pulumi package is based on the hsdp Terraform Provider.
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp