Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ionoscloud Provider
  3. API Docs
  4. User
ionoscloud 6.7.7 published on Tuesday, May 20, 2025 by ionos-cloud
ionos-cloud/terraform-provider-ionoscloud

ionoscloud.User

Explore with Pulumi AI

ionoscloud logo
ionoscloud 6.7.7 published on Tuesday, May 20, 2025 by ionos-cloud
ionos-cloud/terraform-provider-ionoscloud

    Import

    Resource User can be imported using the resource id, e.g.

    $ pulumi import ionoscloud:index/user:User myuser user uuid

    Create User Resource

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

    Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         email: Optional[str] = None,
         first_name: Optional[str] = None,
         last_name: Optional[str] = None,
         active: Optional[bool] = None,
         administrator: Optional[bool] = None,
         force_sec_auth: Optional[bool] = None,
         group_ids: Optional[Sequence[str]] = None,
         password: Optional[str] = None,
         password_wo: Optional[str] = None,
         password_wo_version: Optional[float] = None,
         timeouts: Optional[UserTimeoutsArgs] = None,
         user_id: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: ionoscloud:User
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 UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 userResource = new Ionoscloud.User("userResource", new()
{
    Email = "string",
    FirstName = "string",
    LastName = "string",
    Active = false,
    Administrator = false,
    ForceSecAuth = false,
    GroupIds = new[]
    {
        "string",
    },
    Password = "string",
    PasswordWo = "string",
    PasswordWoVersion = 0,
    Timeouts = new Ionoscloud.Inputs.UserTimeoutsArgs
    {
        Create = "string",
        Default = "string",
        Delete = "string",
        Update = "string",
    },
    UserId = "string",
});

    example, err := ionoscloud.NewUser(ctx, "userResource", &ionoscloud.UserArgs{
	Email:         pulumi.String("string"),
	FirstName:     pulumi.String("string"),
	LastName:      pulumi.String("string"),
	Active:        pulumi.Bool(false),
	Administrator: pulumi.Bool(false),
	ForceSecAuth:  pulumi.Bool(false),
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Password:          pulumi.String("string"),
	PasswordWo:        pulumi.String("string"),
	PasswordWoVersion: pulumi.Float64(0),
	Timeouts: &ionoscloud.UserTimeoutsArgs{
		Create:  pulumi.String("string"),
		Default: pulumi.String("string"),
		Delete:  pulumi.String("string"),
		Update:  pulumi.String("string"),
	},
	UserId: pulumi.String("string"),
})

    var userResource = new User("userResource", UserArgs.builder()
    .email("string")
    .firstName("string")
    .lastName("string")
    .active(false)
    .administrator(false)
    .forceSecAuth(false)
    .groupIds("string")
    .password("string")
    .passwordWo("string")
    .passwordWoVersion(0.0)
    .timeouts(UserTimeoutsArgs.builder()
        .create("string")
        .default_("string")
        .delete("string")
        .update("string")
        .build())
    .userId("string")
    .build());

    user_resource = ionoscloud.User("userResource",
    email="string",
    first_name="string",
    last_name="string",
    active=False,
    administrator=False,
    force_sec_auth=False,
    group_ids=["string"],
    password="string",
    password_wo="string",
    password_wo_version=0,
    timeouts={
        "create": "string",
        "default": "string",
        "delete": "string",
        "update": "string",
    },
    user_id="string")

    const userResource = new ionoscloud.User("userResource", {
    email: "string",
    firstName: "string",
    lastName: "string",
    active: false,
    administrator: false,
    forceSecAuth: false,
    groupIds: ["string"],
    password: "string",
    passwordWo: "string",
    passwordWoVersion: 0,
    timeouts: {
        create: "string",
        "default": "string",
        "delete": "string",
        update: "string",
    },
    userId: "string",
});

    type: ionoscloud:User
properties:
    active: false
    administrator: false
    email: string
    firstName: string
    forceSecAuth: false
    groupIds:
        - string
    lastName: string
    password: string
    passwordWo: string
    passwordWoVersion: 0
    timeouts:
        create: string
        default: string
        delete: string
        update: string
    userId: string

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

    Email string
    [string] An e-mail address for the user.
    FirstName string
    [string] A first name for the user.
    LastName string
    [string] A last name for the user.
    Active bool
    [Boolean] Indicates if the user is active
    Administrator bool
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    ForceSecAuth bool
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    GroupIds List<string>
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    Password string
    PasswordWo string
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    PasswordWoVersion double
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    Timeouts UserTimeouts
    UserId string
    Email string
    [string] An e-mail address for the user.
    FirstName string
    [string] A first name for the user.
    LastName string
    [string] A last name for the user.
    Active bool
    [Boolean] Indicates if the user is active
    Administrator bool
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    ForceSecAuth bool
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    GroupIds []string
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    Password string
    PasswordWo string
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    PasswordWoVersion float64
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    Timeouts UserTimeoutsArgs
    UserId string
    email String
    [string] An e-mail address for the user.
    firstName String
    [string] A first name for the user.
    lastName String
    [string] A last name for the user.
    active Boolean
    [Boolean] Indicates if the user is active
    administrator Boolean
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    forceSecAuth Boolean
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    groupIds List<String>
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    password String
    passwordWo String
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    passwordWoVersion Double
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    timeouts UserTimeouts
    userId String
    email string
    [string] An e-mail address for the user.
    firstName string
    [string] A first name for the user.
    lastName string
    [string] A last name for the user.
    active boolean
    [Boolean] Indicates if the user is active
    administrator boolean
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    forceSecAuth boolean
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    groupIds string[]
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    password string
    passwordWo string
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    passwordWoVersion number
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    timeouts UserTimeouts
    userId string
    email str
    [string] An e-mail address for the user.
    first_name str
    [string] A first name for the user.
    last_name str
    [string] A last name for the user.
    active bool
    [Boolean] Indicates if the user is active
    administrator bool
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    force_sec_auth bool
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    group_ids Sequence[str]
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    password str
    password_wo str
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    password_wo_version float
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    timeouts UserTimeoutsArgs
    user_id str
    email String
    [string] An e-mail address for the user.
    firstName String
    [string] A first name for the user.
    lastName String
    [string] A last name for the user.
    active Boolean
    [Boolean] Indicates if the user is active
    administrator Boolean
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    forceSecAuth Boolean
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    groupIds List<String>
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    password String
    passwordWo String
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    passwordWoVersion Number
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    timeouts Property Map
    userId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    S3CanonicalUserId string
    Canonical (IONOS Object Storage) id of the user for a given identity
    SecAuthActive bool
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    Id string
    The provider-assigned unique ID for this managed resource.
    S3CanonicalUserId string
    Canonical (IONOS Object Storage) id of the user for a given identity
    SecAuthActive bool
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    id String
    The provider-assigned unique ID for this managed resource.
    s3CanonicalUserId String
    Canonical (IONOS Object Storage) id of the user for a given identity
    secAuthActive Boolean
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    id string
    The provider-assigned unique ID for this managed resource.
    s3CanonicalUserId string
    Canonical (IONOS Object Storage) id of the user for a given identity
    secAuthActive boolean
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    id str
    The provider-assigned unique ID for this managed resource.
    s3_canonical_user_id str
    Canonical (IONOS Object Storage) id of the user for a given identity
    sec_auth_active bool
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    id String
    The provider-assigned unique ID for this managed resource.
    s3CanonicalUserId String
    Canonical (IONOS Object Storage) id of the user for a given identity
    secAuthActive Boolean
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update

    Look up Existing User Resource

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        administrator: Optional[bool] = None,
        email: Optional[str] = None,
        first_name: Optional[str] = None,
        force_sec_auth: Optional[bool] = None,
        group_ids: Optional[Sequence[str]] = None,
        last_name: Optional[str] = None,
        password: Optional[str] = None,
        password_wo: Optional[str] = None,
        password_wo_version: Optional[float] = None,
        s3_canonical_user_id: Optional[str] = None,
        sec_auth_active: Optional[bool] = None,
        timeouts: Optional[UserTimeoutsArgs] = None,
        user_id: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: ionoscloud:User    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
    [Boolean] Indicates if the user is active
    Administrator bool
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    Email string
    [string] An e-mail address for the user.
    FirstName string
    [string] A first name for the user.
    ForceSecAuth bool
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    GroupIds List<string>
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    LastName string
    [string] A last name for the user.
    Password string
    PasswordWo string
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    PasswordWoVersion double
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    S3CanonicalUserId string
    Canonical (IONOS Object Storage) id of the user for a given identity
    SecAuthActive bool
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    Timeouts UserTimeouts
    UserId string
    Active bool
    [Boolean] Indicates if the user is active
    Administrator bool
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    Email string
    [string] An e-mail address for the user.
    FirstName string
    [string] A first name for the user.
    ForceSecAuth bool
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    GroupIds []string
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    LastName string
    [string] A last name for the user.
    Password string
    PasswordWo string
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    PasswordWoVersion float64
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    S3CanonicalUserId string
    Canonical (IONOS Object Storage) id of the user for a given identity
    SecAuthActive bool
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    Timeouts UserTimeoutsArgs
    UserId string
    active Boolean
    [Boolean] Indicates if the user is active
    administrator Boolean
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    email String
    [string] An e-mail address for the user.
    firstName String
    [string] A first name for the user.
    forceSecAuth Boolean
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    groupIds List<String>
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    lastName String
    [string] A last name for the user.
    password String
    passwordWo String
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    passwordWoVersion Double
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    s3CanonicalUserId String
    Canonical (IONOS Object Storage) id of the user for a given identity
    secAuthActive Boolean
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    timeouts UserTimeouts
    userId String
    active boolean
    [Boolean] Indicates if the user is active
    administrator boolean
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    email string
    [string] An e-mail address for the user.
    firstName string
    [string] A first name for the user.
    forceSecAuth boolean
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    groupIds string[]
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    lastName string
    [string] A last name for the user.
    password string
    passwordWo string
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    passwordWoVersion number
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    s3CanonicalUserId string
    Canonical (IONOS Object Storage) id of the user for a given identity
    secAuthActive boolean
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    timeouts UserTimeouts
    userId string
    active bool
    [Boolean] Indicates if the user is active
    administrator bool
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    email str
    [string] An e-mail address for the user.
    first_name str
    [string] A first name for the user.
    force_sec_auth bool
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    group_ids Sequence[str]
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    last_name str
    [string] A last name for the user.
    password str
    password_wo str
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    password_wo_version float
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    s3_canonical_user_id str
    Canonical (IONOS Object Storage) id of the user for a given identity
    sec_auth_active bool
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    timeouts UserTimeoutsArgs
    user_id str
    active Boolean
    [Boolean] Indicates if the user is active
    administrator Boolean
    [Boolean] Indicates if the user has administrative rights. Administrators do not need to be managed in groups, as they automatically have access to all resources associated with the contract.
    email String
    [string] An e-mail address for the user.
    firstName String
    [string] A first name for the user.
    forceSecAuth Boolean
    [Boolean] Indicates if secure (two-factor) authentication should be forced for the user (true) or not (false).
    groupIds List<String>
    [Set] The groups that this user will be a member of NOTE: Group_ids field cannot be used at the same time with user_ids field in group resource. Trying to add the same user to the same group in both ways in the same plan will result in a cyclic dependency error. NOTE: password_wo requires Teraform 1.11 or higher.
    lastName String
    [string] A last name for the user.
    password String
    passwordWo String
    Write-only attribute. Password for the user. To modify, must change the password_wo_version attribute.
    passwordWoVersion Number
    Used together with password_wo to trigger an update. Increment this value when an update to the password_wo is required.
    s3CanonicalUserId String
    Canonical (IONOS Object Storage) id of the user for a given identity
    secAuthActive Boolean
    [Boolean] Indicates if secure authentication is active for the user or not. it can not be used in create requests - can be used in update
    timeouts Property Map
    userId String

    Supporting Types

    UserTimeouts, UserTimeoutsArgs

    Create string
    Default string
    Delete string
    Update string
    Create string
    Default string
    Delete string
    Update string
    create String
    default_ String
    delete String
    update String
    create string
    default string
    delete string
    update string
    create String
    default String
    delete String
    update String

    Package Details

    Repository
    ionoscloud ionos-cloud/terraform-provider-ionoscloud
    License
    Notes
    This Pulumi package is based on the ionoscloud Terraform Provider.
    ionoscloud logo
    ionoscloud 6.7.7 published on Tuesday, May 20, 2025 by ionos-cloud
    ionos-cloud/terraform-provider-ionoscloud