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

ibm.ComputeUser

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, and delete an IBM ID accounts or Softlayer account. For more information, about managing user accounts, see assigning access to account management services.

    Example Usage

    The following example shows how to use this resource with SoftLayer accounts:

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

const joe = new ibm.ComputeUser("joe", {
    address1: "12345 Any Street",
    address2: "Suite #99",
    city: "Atlanta",
    companyName: "Comp Inc",
    country: "US",
    email: "joe@doe.com",
    firstName: "Joe",
    hasApiKey: false,
    lastName: "Doe",
    password: "Change3Me!",
    permissions: [
        "ACCESS_ALL_GUEST",
        "ACCESS_ALL_HARDWARE",
        "SERVER_ADD",
        "SERVER_CANCEL",
        "RESET_PORTAL_PASSWORD",
    ],
    state: "GA",
    timezone: "EST",
    username: "testuser",
});

    import pulumi
import pulumi_ibm as ibm

joe = ibm.ComputeUser("joe",
    address1="12345 Any Street",
    address2="Suite #99",
    city="Atlanta",
    company_name="Comp Inc",
    country="US",
    email="joe@doe.com",
    first_name="Joe",
    has_api_key=False,
    last_name="Doe",
    password="Change3Me!",
    permissions=[
        "ACCESS_ALL_GUEST",
        "ACCESS_ALL_HARDWARE",
        "SERVER_ADD",
        "SERVER_CANCEL",
        "RESET_PORTAL_PASSWORD",
    ],
    state="GA",
    timezone="EST",
    username="testuser")

    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.NewComputeUser(ctx, "joe", &ibm.ComputeUserArgs{
			Address1:    pulumi.String("12345 Any Street"),
			Address2:    pulumi.String("Suite #99"),
			City:        pulumi.String("Atlanta"),
			CompanyName: pulumi.String("Comp Inc"),
			Country:     pulumi.String("US"),
			Email:       pulumi.String("joe@doe.com"),
			FirstName:   pulumi.String("Joe"),
			HasApiKey:   pulumi.Bool(false),
			LastName:    pulumi.String("Doe"),
			Password:    pulumi.String("Change3Me!"),
			Permissions: pulumi.StringArray{
				pulumi.String("ACCESS_ALL_GUEST"),
				pulumi.String("ACCESS_ALL_HARDWARE"),
				pulumi.String("SERVER_ADD"),
				pulumi.String("SERVER_CANCEL"),
				pulumi.String("RESET_PORTAL_PASSWORD"),
			},
			State:    pulumi.String("GA"),
			Timezone: pulumi.String("EST"),
			Username: pulumi.String("testuser"),
		})
		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 joe = new Ibm.ComputeUser("joe", new()
    {
        Address1 = "12345 Any Street",
        Address2 = "Suite #99",
        City = "Atlanta",
        CompanyName = "Comp Inc",
        Country = "US",
        Email = "joe@doe.com",
        FirstName = "Joe",
        HasApiKey = false,
        LastName = "Doe",
        Password = "Change3Me!",
        Permissions = new[]
        {
            "ACCESS_ALL_GUEST",
            "ACCESS_ALL_HARDWARE",
            "SERVER_ADD",
            "SERVER_CANCEL",
            "RESET_PORTAL_PASSWORD",
        },
        State = "GA",
        Timezone = "EST",
        Username = "testuser",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ComputeUser;
import com.pulumi.ibm.ComputeUserArgs;
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 joe = new ComputeUser("joe", ComputeUserArgs.builder()
            .address1("12345 Any Street")
            .address2("Suite #99")
            .city("Atlanta")
            .companyName("Comp Inc")
            .country("US")
            .email("joe@doe.com")
            .firstName("Joe")
            .hasApiKey(false)
            .lastName("Doe")
            .password("Change3Me!")
            .permissions(            
                "ACCESS_ALL_GUEST",
                "ACCESS_ALL_HARDWARE",
                "SERVER_ADD",
                "SERVER_CANCEL",
                "RESET_PORTAL_PASSWORD")
            .state("GA")
            .timezone("EST")
            .username("testuser")
            .build());

    }
}

    resources:
  joe:
    type: ibm:ComputeUser
    properties:
      address1: 12345 Any Street
      address2: 'Suite #99'
      city: Atlanta
      companyName: Comp Inc
      country: US
      email: joe@doe.com
      firstName: Joe
      hasApiKey: false
      lastName: Doe
      password: Change3Me!
      permissions:
        - ACCESS_ALL_GUEST
        - ACCESS_ALL_HARDWARE
        - SERVER_ADD
        - SERVER_CANCEL
        - RESET_PORTAL_PASSWORD
      state: GA
      timezone: EST
      username: testuser

    IBMID account

    You can use an IBMID instead of your SoftLayer credentials. An IBMID is used as a consistent way to access IBM products. You can create an IBMID in advance.

    If you use this resource for an IBMID account, the resource should not contain username and password arguments. The user name is generated by SoftLayer by combining the IBMID account number and the IBMID email address. The password is not used in an IBMID account.

    To access the SoftLayer portal, the user can log in with the IBMID.

    To access the SoftLayer API, the user can log in with the username generated by SoftLayer and the API key. An api_key is generated by SoftLayer when the has_api_key flag is true.

    If the IBM Cloud API getBlueIdAuthenticationRequiredFlag returns true, the account is an IBMID.

    The following example shows how to use this resource with IBMID accounts:

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

const joe = new ibm.ComputeUser("joe", {
    address1: "12345 Any Street",
    address2: "Suite #99",
    city: "Atlanta",
    companyName: "Comp Inc",
    country: "US",
    email: "joe@doe.com",
    firstName: "Joe",
    hasApiKey: false,
    lastName: "Doe",
    permissions: [
        "ACCESS_ALL_GUEST",
        "ACCESS_ALL_HARDWARE",
        "SERVER_ADD",
        "SERVER_CANCEL",
        "RESET_PORTAL_PASSWORD",
    ],
    state: "GA",
    timezone: "EST",
});

    import pulumi
import pulumi_ibm as ibm

joe = ibm.ComputeUser("joe",
    address1="12345 Any Street",
    address2="Suite #99",
    city="Atlanta",
    company_name="Comp Inc",
    country="US",
    email="joe@doe.com",
    first_name="Joe",
    has_api_key=False,
    last_name="Doe",
    permissions=[
        "ACCESS_ALL_GUEST",
        "ACCESS_ALL_HARDWARE",
        "SERVER_ADD",
        "SERVER_CANCEL",
        "RESET_PORTAL_PASSWORD",
    ],
    state="GA",
    timezone="EST")

    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.NewComputeUser(ctx, "joe", &ibm.ComputeUserArgs{
			Address1:    pulumi.String("12345 Any Street"),
			Address2:    pulumi.String("Suite #99"),
			City:        pulumi.String("Atlanta"),
			CompanyName: pulumi.String("Comp Inc"),
			Country:     pulumi.String("US"),
			Email:       pulumi.String("joe@doe.com"),
			FirstName:   pulumi.String("Joe"),
			HasApiKey:   pulumi.Bool(false),
			LastName:    pulumi.String("Doe"),
			Permissions: pulumi.StringArray{
				pulumi.String("ACCESS_ALL_GUEST"),
				pulumi.String("ACCESS_ALL_HARDWARE"),
				pulumi.String("SERVER_ADD"),
				pulumi.String("SERVER_CANCEL"),
				pulumi.String("RESET_PORTAL_PASSWORD"),
			},
			State:    pulumi.String("GA"),
			Timezone: pulumi.String("EST"),
		})
		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 joe = new Ibm.ComputeUser("joe", new()
    {
        Address1 = "12345 Any Street",
        Address2 = "Suite #99",
        City = "Atlanta",
        CompanyName = "Comp Inc",
        Country = "US",
        Email = "joe@doe.com",
        FirstName = "Joe",
        HasApiKey = false,
        LastName = "Doe",
        Permissions = new[]
        {
            "ACCESS_ALL_GUEST",
            "ACCESS_ALL_HARDWARE",
            "SERVER_ADD",
            "SERVER_CANCEL",
            "RESET_PORTAL_PASSWORD",
        },
        State = "GA",
        Timezone = "EST",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ComputeUser;
import com.pulumi.ibm.ComputeUserArgs;
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 joe = new ComputeUser("joe", ComputeUserArgs.builder()
            .address1("12345 Any Street")
            .address2("Suite #99")
            .city("Atlanta")
            .companyName("Comp Inc")
            .country("US")
            .email("joe@doe.com")
            .firstName("Joe")
            .hasApiKey(false)
            .lastName("Doe")
            .permissions(            
                "ACCESS_ALL_GUEST",
                "ACCESS_ALL_HARDWARE",
                "SERVER_ADD",
                "SERVER_CANCEL",
                "RESET_PORTAL_PASSWORD")
            .state("GA")
            .timezone("EST")
            .build());

    }
}

    resources:
  joe:
    type: ibm:ComputeUser
    properties:
      address1: 12345 Any Street
      address2: 'Suite #99'
      city: Atlanta
      companyName: Comp Inc
      country: US
      email: joe@doe.com
      firstName: Joe
      hasApiKey: false
      lastName: Doe
      permissions:
        - ACCESS_ALL_GUEST
        - ACCESS_ALL_HARDWARE
        - SERVER_ADD
        - SERVER_CANCEL
        - RESET_PORTAL_PASSWORD
      state: GA
      timezone: EST

    Note

    An IBMID is used as a consistent way to access IBM products. You can create an IBMID in advance.

    For more information, see the SoftLayer API documentation.

    Create ComputeUser Resource

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

    Constructor syntax

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

@overload
def ComputeUser(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                first_name: Optional[str] = None,
                state: Optional[str] = None,
                timezone: Optional[str] = None,
                city: Optional[str] = None,
                company_name: Optional[str] = None,
                address1: Optional[str] = None,
                country: Optional[str] = None,
                email: Optional[str] = None,
                last_name: Optional[str] = None,
                address2: Optional[str] = None,
                has_api_key: Optional[bool] = None,
                password: Optional[str] = None,
                permissions: Optional[Sequence[str]] = None,
                compute_user_id: Optional[str] = None,
                tags: Optional[Sequence[str]] = None,
                api_key: Optional[str] = None,
                user_status: Optional[str] = None,
                username: Optional[str] = None)
    func NewComputeUser(ctx *Context, name string, args ComputeUserArgs, opts ...ResourceOption) (*ComputeUser, error)
    public ComputeUser(string name, ComputeUserArgs args, CustomResourceOptions? opts = null)
    public ComputeUser(String name, ComputeUserArgs args)
public ComputeUser(String name, ComputeUserArgs args, CustomResourceOptions options)

    type: ibm:ComputeUser
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 ComputeUserArgs
    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 ComputeUserArgs
    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 ComputeUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ComputeUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ComputeUserArgs
    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 computeUserResource = new Ibm.ComputeUser("computeUserResource", new()
{
    FirstName = "string",
    State = "string",
    Timezone = "string",
    City = "string",
    CompanyName = "string",
    Address1 = "string",
    Country = "string",
    Email = "string",
    LastName = "string",
    Address2 = "string",
    HasApiKey = false,
    Password = "string",
    Permissions = new[]
    {
        "string",
    },
    ComputeUserId = "string",
    Tags = new[]
    {
        "string",
    },
    ApiKey = "string",
    UserStatus = "string",
    Username = "string",
});

    example, err := ibm.NewComputeUser(ctx, "computeUserResource", &ibm.ComputeUserArgs{
	FirstName:   pulumi.String("string"),
	State:       pulumi.String("string"),
	Timezone:    pulumi.String("string"),
	City:        pulumi.String("string"),
	CompanyName: pulumi.String("string"),
	Address1:    pulumi.String("string"),
	Country:     pulumi.String("string"),
	Email:       pulumi.String("string"),
	LastName:    pulumi.String("string"),
	Address2:    pulumi.String("string"),
	HasApiKey:   pulumi.Bool(false),
	Password:    pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	ComputeUserId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiKey:     pulumi.String("string"),
	UserStatus: pulumi.String("string"),
	Username:   pulumi.String("string"),
})

    var computeUserResource = new ComputeUser("computeUserResource", ComputeUserArgs.builder()
    .firstName("string")
    .state("string")
    .timezone("string")
    .city("string")
    .companyName("string")
    .address1("string")
    .country("string")
    .email("string")
    .lastName("string")
    .address2("string")
    .hasApiKey(false)
    .password("string")
    .permissions("string")
    .computeUserId("string")
    .tags("string")
    .apiKey("string")
    .userStatus("string")
    .username("string")
    .build());

    compute_user_resource = ibm.ComputeUser("computeUserResource",
    first_name="string",
    state="string",
    timezone="string",
    city="string",
    company_name="string",
    address1="string",
    country="string",
    email="string",
    last_name="string",
    address2="string",
    has_api_key=False,
    password="string",
    permissions=["string"],
    compute_user_id="string",
    tags=["string"],
    api_key="string",
    user_status="string",
    username="string")

    const computeUserResource = new ibm.ComputeUser("computeUserResource", {
    firstName: "string",
    state: "string",
    timezone: "string",
    city: "string",
    companyName: "string",
    address1: "string",
    country: "string",
    email: "string",
    lastName: "string",
    address2: "string",
    hasApiKey: false,
    password: "string",
    permissions: ["string"],
    computeUserId: "string",
    tags: ["string"],
    apiKey: "string",
    userStatus: "string",
    username: "string",
});

    type: ibm:ComputeUser
properties:
    address1: string
    address2: string
    apiKey: string
    city: string
    companyName: string
    computeUserId: string
    country: string
    email: string
    firstName: string
    hasApiKey: false
    lastName: string
    password: string
    permissions:
        - string
    state: string
    tags:
        - string
    timezone: string
    userStatus: string
    username: string

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

    Address1 string
    The first line of the user's street address.
    City string
    The user's city.
    CompanyName string
    The user's company.
    Country string
    The user's country.
    Email string
    The email address associated with the account.
    FirstName string
    The user's given name.
    LastName string
    The user's last name.
    State string
    The state of a user's street address.
    Timezone string
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    Address2 string
    The second line of the user's street address.
    ApiKey string
    (String) The SoftLayer API key that is created for the user.
    ComputeUserId string
    (String) The unique SoftLayer identifier that is created for the user.
    HasApiKey bool
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    Password string
    password for the user
    Permissions List<string>
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    Tags List<string>
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    UserStatus string
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    Username string
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    Address1 string
    The first line of the user's street address.
    City string
    The user's city.
    CompanyName string
    The user's company.
    Country string
    The user's country.
    Email string
    The email address associated with the account.
    FirstName string
    The user's given name.
    LastName string
    The user's last name.
    State string
    The state of a user's street address.
    Timezone string
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    Address2 string
    The second line of the user's street address.
    ApiKey string
    (String) The SoftLayer API key that is created for the user.
    ComputeUserId string
    (String) The unique SoftLayer identifier that is created for the user.
    HasApiKey bool
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    Password string
    password for the user
    Permissions []string
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    Tags []string
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    UserStatus string
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    Username string
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 String
    The first line of the user's street address.
    city String
    The user's city.
    companyName String
    The user's company.
    country String
    The user's country.
    email String
    The email address associated with the account.
    firstName String
    The user's given name.
    lastName String
    The user's last name.
    state String
    The state of a user's street address.
    timezone String
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    address2 String
    The second line of the user's street address.
    apiKey String
    (String) The SoftLayer API key that is created for the user.
    computeUserId String
    (String) The unique SoftLayer identifier that is created for the user.
    hasApiKey Boolean
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    password String
    password for the user
    permissions List<String>
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    tags List<String>
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    userStatus String
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username String
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 string
    The first line of the user's street address.
    city string
    The user's city.
    companyName string
    The user's company.
    country string
    The user's country.
    email string
    The email address associated with the account.
    firstName string
    The user's given name.
    lastName string
    The user's last name.
    state string
    The state of a user's street address.
    timezone string
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    address2 string
    The second line of the user's street address.
    apiKey string
    (String) The SoftLayer API key that is created for the user.
    computeUserId string
    (String) The unique SoftLayer identifier that is created for the user.
    hasApiKey boolean
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    password string
    password for the user
    permissions string[]
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    tags string[]
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    userStatus string
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username string
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 str
    The first line of the user's street address.
    city str
    The user's city.
    company_name str
    The user's company.
    country str
    The user's country.
    email str
    The email address associated with the account.
    first_name str
    The user's given name.
    last_name str
    The user's last name.
    state str
    The state of a user's street address.
    timezone str
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    address2 str
    The second line of the user's street address.
    api_key str
    (String) The SoftLayer API key that is created for the user.
    compute_user_id str
    (String) The unique SoftLayer identifier that is created for the user.
    has_api_key bool
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    password str
    password for the user
    permissions Sequence[str]
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    tags Sequence[str]
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    user_status str
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username str
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 String
    The first line of the user's street address.
    city String
    The user's city.
    companyName String
    The user's company.
    country String
    The user's country.
    email String
    The email address associated with the account.
    firstName String
    The user's given name.
    lastName String
    The user's last name.
    state String
    The state of a user's street address.
    timezone String
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    address2 String
    The second line of the user's street address.
    apiKey String
    (String) The SoftLayer API key that is created for the user.
    computeUserId String
    (String) The unique SoftLayer identifier that is created for the user.
    hasApiKey Boolean
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    password String
    password for the user
    permissions List<String>
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    tags List<String>
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    userStatus String
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username String
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.

    Outputs

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

    IbmId string
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    Id string
    The provider-assigned unique ID for this managed resource.
    IbmId string
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ibmId String
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    id String
    The provider-assigned unique ID for this managed resource.
    ibmId string
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    id string
    The provider-assigned unique ID for this managed resource.
    ibm_id str
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    id str
    The provider-assigned unique ID for this managed resource.
    ibmId String
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ComputeUser Resource

    Get an existing ComputeUser 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?: ComputeUserState, opts?: CustomResourceOptions): ComputeUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address1: Optional[str] = None,
        address2: Optional[str] = None,
        api_key: Optional[str] = None,
        city: Optional[str] = None,
        company_name: Optional[str] = None,
        compute_user_id: Optional[str] = None,
        country: Optional[str] = None,
        email: Optional[str] = None,
        first_name: Optional[str] = None,
        has_api_key: Optional[bool] = None,
        ibm_id: Optional[str] = None,
        last_name: Optional[str] = None,
        password: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None,
        state: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timezone: Optional[str] = None,
        user_status: Optional[str] = None,
        username: Optional[str] = None) -> ComputeUser
    func GetComputeUser(ctx *Context, name string, id IDInput, state *ComputeUserState, opts ...ResourceOption) (*ComputeUser, error)
    public static ComputeUser Get(string name, Input<string> id, ComputeUserState? state, CustomResourceOptions? opts = null)
    public static ComputeUser get(String name, Output<String> id, ComputeUserState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ComputeUser    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:
    Address1 string
    The first line of the user's street address.
    Address2 string
    The second line of the user's street address.
    ApiKey string
    (String) The SoftLayer API key that is created for the user.
    City string
    The user's city.
    CompanyName string
    The user's company.
    ComputeUserId string
    (String) The unique SoftLayer identifier that is created for the user.
    Country string
    The user's country.
    Email string
    The email address associated with the account.
    FirstName string
    The user's given name.
    HasApiKey bool
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    IbmId string
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    LastName string
    The user's last name.
    Password string
    password for the user
    Permissions List<string>
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    State string
    The state of a user's street address.
    Tags List<string>
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timezone string
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    UserStatus string
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    Username string
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    Address1 string
    The first line of the user's street address.
    Address2 string
    The second line of the user's street address.
    ApiKey string
    (String) The SoftLayer API key that is created for the user.
    City string
    The user's city.
    CompanyName string
    The user's company.
    ComputeUserId string
    (String) The unique SoftLayer identifier that is created for the user.
    Country string
    The user's country.
    Email string
    The email address associated with the account.
    FirstName string
    The user's given name.
    HasApiKey bool
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    IbmId string
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    LastName string
    The user's last name.
    Password string
    password for the user
    Permissions []string
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    State string
    The state of a user's street address.
    Tags []string
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    Timezone string
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    UserStatus string
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    Username string
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 String
    The first line of the user's street address.
    address2 String
    The second line of the user's street address.
    apiKey String
    (String) The SoftLayer API key that is created for the user.
    city String
    The user's city.
    companyName String
    The user's company.
    computeUserId String
    (String) The unique SoftLayer identifier that is created for the user.
    country String
    The user's country.
    email String
    The email address associated with the account.
    firstName String
    The user's given name.
    hasApiKey Boolean
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    ibmId String
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    lastName String
    The user's last name.
    password String
    password for the user
    permissions List<String>
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    state String
    The state of a user's street address.
    tags List<String>
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timezone String
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    userStatus String
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username String
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 string
    The first line of the user's street address.
    address2 string
    The second line of the user's street address.
    apiKey string
    (String) The SoftLayer API key that is created for the user.
    city string
    The user's city.
    companyName string
    The user's company.
    computeUserId string
    (String) The unique SoftLayer identifier that is created for the user.
    country string
    The user's country.
    email string
    The email address associated with the account.
    firstName string
    The user's given name.
    hasApiKey boolean
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    ibmId string
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    lastName string
    The user's last name.
    password string
    password for the user
    permissions string[]
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    state string
    The state of a user's street address.
    tags string[]
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timezone string
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    userStatus string
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username string
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 str
    The first line of the user's street address.
    address2 str
    The second line of the user's street address.
    api_key str
    (String) The SoftLayer API key that is created for the user.
    city str
    The user's city.
    company_name str
    The user's company.
    compute_user_id str
    (String) The unique SoftLayer identifier that is created for the user.
    country str
    The user's country.
    email str
    The email address associated with the account.
    first_name str
    The user's given name.
    has_api_key bool
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    ibm_id str
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    last_name str
    The user's last name.
    password str
    password for the user
    permissions Sequence[str]
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    state str
    The state of a user's street address.
    tags Sequence[str]
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timezone str
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    user_status str
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username str
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.
    address1 String
    The first line of the user's street address.
    address2 String
    The second line of the user's street address.
    apiKey String
    (String) The SoftLayer API key that is created for the user.
    city String
    The user's city.
    companyName String
    The user's company.
    computeUserId String
    (String) The unique SoftLayer identifier that is created for the user.
    country String
    The user's country.
    email String
    The email address associated with the account.
    firstName String
    The user's given name.
    hasApiKey Boolean
    When the value is true, a SoftLayer API key is created for the user. The key is returned in the api_key attribute. When the value is false, any existing SoftLayer API keys for the user are deleted. The default value is false.
    ibmId String
    (String) The username for IBMID accounts. This attribute is generated by SoftLayer when the IBMID is activated.
    lastName String
    The user's last name.
    password String
    password for the user
    permissions List<String>
    Permissions assigned to this user. This is a set of zero or more string values. See the IBM Cloud API Documentation for user permissions.
    state String
    The state of a user's street address.
    tags List<String>
    Tags associated with the user account instance. Note Tags are managed locally and not stored on the IBM Cloud Service Endpoint at this moment.
    timezone String
    The user's time zone as a short name value (e.g., "EST"). For accepted values, see the IBM Cloud API Documentation for time zones.
    userStatus String
    The user's log in status. You can find accepted values in the IBM Cloud API Documentation for user status. The default value is ACTIVE.
    username String
    A unique name to identify a user globally across all SoftLayer login. The username is also the user login. Once a username is created, it cannot be changed. You must define a username when the account is a SoftLayer account. The user name is generated by SoftLayer when the account is an IBMID account. For example, if an IBMID had an account number of 1234567 and an email address (IBMID) of test@example.com, then SoftLayer would generate 1234567_test@example.com as the username. This argument is optional for an IBMID account.

    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