harness.User
Explore with Pulumi AI
Resource for creating a Harness user
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as harness from "@pulumi/harness";
const johnDoe = new harness.User("john_doe", {
    name: "John Doe",
    email: "john.doe@example.com",
});
import pulumi
import pulumi_harness as harness
john_doe = harness.User("john_doe",
    name="John Doe",
    email="john.doe@example.com")
package main
import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := harness.NewUser(ctx, "john_doe", &harness.UserArgs{
			Name:  pulumi.String("John Doe"),
			Email: pulumi.String("john.doe@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;
return await Deployment.RunAsync(() => 
{
    var johnDoe = new Harness.User("john_doe", new()
    {
        Name = "John Doe",
        Email = "john.doe@example.com",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.User;
import com.pulumi.harness.UserArgs;
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 johnDoe = new User("johnDoe", UserArgs.builder()
            .name("John Doe")
            .email("john.doe@example.com")
            .build());
    }
}
resources:
  johnDoe:
    type: harness:User
    name: john_doe
    properties:
      name: John Doe
      email: john.doe@example.com
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,
         group_ids: Optional[Sequence[str]] = None,
         name: Optional[str] = None)func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)public User(string name, UserArgs args, CustomResourceOptions? opts = null)type: harness: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 Harness.User("userResource", new()
{
    Email = "string",
    GroupIds = new[]
    {
        "string",
    },
    Name = "string",
});
example, err := harness.NewUser(ctx, "userResource", &harness.UserArgs{
	Email: pulumi.String("string"),
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
var userResource = new User("userResource", UserArgs.builder()
    .email("string")
    .groupIds("string")
    .name("string")
    .build());
user_resource = harness.User("userResource",
    email="string",
    group_ids=["string"],
    name="string")
const userResource = new harness.User("userResource", {
    email: "string",
    groupIds: ["string"],
    name: "string",
});
type: harness:User
properties:
    email: string
    groupIds:
        - string
    name: 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
- The email of the user.
- GroupIds List<string>
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- Name string
- The name of the user.
- Email string
- The email of the user.
- GroupIds []string
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- Name string
- The name of the user.
- email String
- The email of the user.
- groupIds List<String>
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- name String
- The name of the user.
- email string
- The email of the user.
- groupIds string[]
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- name string
- The name of the user.
- email str
- The email of the user.
- group_ids Sequence[str]
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- name str
- The name of the user.
- email String
- The email of the user.
- groupIds List<String>
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- name String
- The name of the user.
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.
- IsEmail boolVerified 
- Flag indicating whether or not the users email has been verified.
- IsImported boolFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- IsPassword boolExpired 
- Flag indicating whether or not the users password has expired.
- IsTwo boolFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- IsUser boolLocked 
- Flag indicating whether or not the user is locked out.
- Id string
- The provider-assigned unique ID for this managed resource.
- IsEmail boolVerified 
- Flag indicating whether or not the users email has been verified.
- IsImported boolFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- IsPassword boolExpired 
- Flag indicating whether or not the users password has expired.
- IsTwo boolFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- IsUser boolLocked 
- Flag indicating whether or not the user is locked out.
- id String
- The provider-assigned unique ID for this managed resource.
- isEmail BooleanVerified 
- Flag indicating whether or not the users email has been verified.
- isImported BooleanFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- isPassword BooleanExpired 
- Flag indicating whether or not the users password has expired.
- isTwo BooleanFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- isUser BooleanLocked 
- Flag indicating whether or not the user is locked out.
- id string
- The provider-assigned unique ID for this managed resource.
- isEmail booleanVerified 
- Flag indicating whether or not the users email has been verified.
- isImported booleanFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- isPassword booleanExpired 
- Flag indicating whether or not the users password has expired.
- isTwo booleanFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- isUser booleanLocked 
- Flag indicating whether or not the user is locked out.
- id str
- The provider-assigned unique ID for this managed resource.
- is_email_ boolverified 
- Flag indicating whether or not the users email has been verified.
- is_imported_ boolfrom_ identity_ provider 
- Flag indicating whether or not the user was imported from an identity provider.
- is_password_ boolexpired 
- Flag indicating whether or not the users password has expired.
- is_two_ boolfactor_ auth_ enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- is_user_ boollocked 
- Flag indicating whether or not the user is locked out.
- id String
- The provider-assigned unique ID for this managed resource.
- isEmail BooleanVerified 
- Flag indicating whether or not the users email has been verified.
- isImported BooleanFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- isPassword BooleanExpired 
- Flag indicating whether or not the users password has expired.
- isTwo BooleanFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- isUser BooleanLocked 
- Flag indicating whether or not the user is locked out.
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,
        email: Optional[str] = None,
        group_ids: Optional[Sequence[str]] = None,
        is_email_verified: Optional[bool] = None,
        is_imported_from_identity_provider: Optional[bool] = None,
        is_password_expired: Optional[bool] = None,
        is_two_factor_auth_enabled: Optional[bool] = None,
        is_user_locked: Optional[bool] = None,
        name: Optional[str] = None) -> Userfunc 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: harness: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.
- Email string
- The email of the user.
- GroupIds List<string>
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- IsEmail boolVerified 
- Flag indicating whether or not the users email has been verified.
- IsImported boolFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- IsPassword boolExpired 
- Flag indicating whether or not the users password has expired.
- IsTwo boolFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- IsUser boolLocked 
- Flag indicating whether or not the user is locked out.
- Name string
- The name of the user.
- Email string
- The email of the user.
- GroupIds []string
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- IsEmail boolVerified 
- Flag indicating whether or not the users email has been verified.
- IsImported boolFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- IsPassword boolExpired 
- Flag indicating whether or not the users password has expired.
- IsTwo boolFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- IsUser boolLocked 
- Flag indicating whether or not the user is locked out.
- Name string
- The name of the user.
- email String
- The email of the user.
- groupIds List<String>
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- isEmail BooleanVerified 
- Flag indicating whether or not the users email has been verified.
- isImported BooleanFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- isPassword BooleanExpired 
- Flag indicating whether or not the users password has expired.
- isTwo BooleanFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- isUser BooleanLocked 
- Flag indicating whether or not the user is locked out.
- name String
- The name of the user.
- email string
- The email of the user.
- groupIds string[]
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- isEmail booleanVerified 
- Flag indicating whether or not the users email has been verified.
- isImported booleanFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- isPassword booleanExpired 
- Flag indicating whether or not the users password has expired.
- isTwo booleanFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- isUser booleanLocked 
- Flag indicating whether or not the user is locked out.
- name string
- The name of the user.
- email str
- The email of the user.
- group_ids Sequence[str]
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- is_email_ boolverified 
- Flag indicating whether or not the users email has been verified.
- is_imported_ boolfrom_ identity_ provider 
- Flag indicating whether or not the user was imported from an identity provider.
- is_password_ boolexpired 
- Flag indicating whether or not the users password has expired.
- is_two_ boolfactor_ auth_ enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- is_user_ boollocked 
- Flag indicating whether or not the user is locked out.
- name str
- The name of the user.
- email String
- The email of the user.
- groupIds List<String>
- The groups the user belongs to. This is only used during the creation of the user. The groups are not updated after the user is created. When using this option you should also set lifecycle = { ignore_changes = ["group_ids"] }.
- isEmail BooleanVerified 
- Flag indicating whether or not the users email has been verified.
- isImported BooleanFrom Identity Provider 
- Flag indicating whether or not the user was imported from an identity provider.
- isPassword BooleanExpired 
- Flag indicating whether or not the users password has expired.
- isTwo BooleanFactor Auth Enabled 
- Flag indicating whether or not two-factor authentication is enabled for the user.
- isUser BooleanLocked 
- Flag indicating whether or not the user is locked out.
- name String
- The name of the user.
Import
Import using the email address of the user
$ pulumi import harness:index/user:User john_doe john.doe@example.com
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- harness pulumi/pulumi-harness
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the harnessTerraform Provider.
