Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthUser
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthUser

Explore with Pulumi AI

fusionauth logo
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

    # User Resource

    Users API

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";

const example = new fusionauth.FusionAuthUser("example", {
    userId: "4c4511df-0d0d-4029-8c2b-f6c01b9e138d",
    birthDate: "1976-05-30",
    data: JSON.stringify({
        displayName: "Johnny Boy",
        favoriteColors: [
            "Red",
            "Blue",
        ],
    }),
    email: "example@fusionauth.io",
    encryptionScheme: "salted-sha256",
    expiry: 1571786483322,
    firstName: "John",
    fullName: "John Doe",
    imageUrl: "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
    lastName: "Doe",
    middleName: "William",
    mobilePhone: "303-555-1234",
    passwordChangeRequired: false,
    preferredLanguages: [
        "en",
        "fr",
    ],
    timezone: "America/Denver",
    usernameStatus: "ACTIVE",
    username: "johnny123",
});

    import pulumi
import json
import theogravity_pulumi_fusionauth as fusionauth

example = fusionauth.FusionAuthUser("example",
    user_id="4c4511df-0d0d-4029-8c2b-f6c01b9e138d",
    birth_date="1976-05-30",
    data=json.dumps({
        "displayName": "Johnny Boy",
        "favoriteColors": [
            "Red",
            "Blue",
        ],
    }),
    email="example@fusionauth.io",
    encryption_scheme="salted-sha256",
    expiry=1571786483322,
    first_name="John",
    full_name="John Doe",
    image_url="http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
    last_name="Doe",
    middle_name="William",
    mobile_phone="303-555-1234",
    password_change_required=False,
    preferred_languages=[
        "en",
        "fr",
    ],
    timezone="America/Denver",
    username_status="ACTIVE",
    username="johnny123")

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"displayName": "Johnny Boy",
			"favoriteColors": []string{
				"Red",
				"Blue",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = fusionauth.NewFusionAuthUser(ctx, "example", &fusionauth.FusionAuthUserArgs{
			UserId:                 pulumi.String("4c4511df-0d0d-4029-8c2b-f6c01b9e138d"),
			BirthDate:              pulumi.String("1976-05-30"),
			Data:                   pulumi.String(json0),
			Email:                  pulumi.String("example@fusionauth.io"),
			EncryptionScheme:       pulumi.String("salted-sha256"),
			Expiry:                 pulumi.Int(1571786483322),
			FirstName:              pulumi.String("John"),
			FullName:               pulumi.String("John Doe"),
			ImageUrl:               pulumi.String("http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png"),
			LastName:               pulumi.String("Doe"),
			MiddleName:             pulumi.String("William"),
			MobilePhone:            pulumi.String("303-555-1234"),
			PasswordChangeRequired: pulumi.Bool(false),
			PreferredLanguages: pulumi.StringArray{
				pulumi.String("en"),
				pulumi.String("fr"),
			},
			Timezone:       pulumi.String("America/Denver"),
			UsernameStatus: pulumi.String("ACTIVE"),
			Username:       pulumi.String("johnny123"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var example = new Fusionauth.FusionAuthUser("example", new()
    {
        UserId = "4c4511df-0d0d-4029-8c2b-f6c01b9e138d",
        BirthDate = "1976-05-30",
        Data = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["displayName"] = "Johnny Boy",
            ["favoriteColors"] = new[]
            {
                "Red",
                "Blue",
            },
        }),
        Email = "example@fusionauth.io",
        EncryptionScheme = "salted-sha256",
        Expiry = 1571786483322,
        FirstName = "John",
        FullName = "John Doe",
        ImageUrl = "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
        LastName = "Doe",
        MiddleName = "William",
        MobilePhone = "303-555-1234",
        PasswordChangeRequired = false,
        PreferredLanguages = new[]
        {
            "en",
            "fr",
        },
        Timezone = "America/Denver",
        UsernameStatus = "ACTIVE",
        Username = "johnny123",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthUser;
import com.pulumi.fusionauth.FusionAuthUserArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 example = new FusionAuthUser("example", FusionAuthUserArgs.builder()
            .userId("4c4511df-0d0d-4029-8c2b-f6c01b9e138d")
            .birthDate("1976-05-30")
            .data(serializeJson(
                jsonObject(
                    jsonProperty("displayName", "Johnny Boy"),
                    jsonProperty("favoriteColors", jsonArray(
                        "Red", 
                        "Blue"
                    ))
                )))
            .email("example@fusionauth.io")
            .encryptionScheme("salted-sha256")
            .expiry(1571786483322)
            .firstName("John")
            .fullName("John Doe")
            .imageUrl("http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png")
            .lastName("Doe")
            .middleName("William")
            .mobilePhone("303-555-1234")
            .passwordChangeRequired(false)
            .preferredLanguages(            
                "en",
                "fr")
            .timezone("America/Denver")
            .usernameStatus("ACTIVE")
            .username("johnny123")
            .build());

    }
}

    resources:
  example:
    type: fusionauth:FusionAuthUser
    properties:
      userId: 4c4511df-0d0d-4029-8c2b-f6c01b9e138d
      birthDate: 1976-05-30
      data:
        fn::toJSON:
          displayName: Johnny Boy
          favoriteColors:
            - Red
            - Blue
      email: example@fusionauth.io
      encryptionScheme: salted-sha256
      expiry: 1.571786483322e+12
      firstName: John
      fullName: John Doe
      imageUrl: http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png
      lastName: Doe
      middleName: William
      mobilePhone: 303-555-1234
      passwordChangeRequired: false
      preferredLanguages:
        - en
        - fr
      timezone: America/Denver
      usernameStatus: ACTIVE
      username: johnny123

    Create FusionAuthUser Resource

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

    Constructor syntax

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

@overload
def FusionAuthUser(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   application_id: Optional[str] = None,
                   birth_date: Optional[str] = None,
                   data: Optional[str] = None,
                   disable_domain_block: Optional[bool] = None,
                   email: Optional[str] = None,
                   encryption_scheme: Optional[str] = None,
                   expiry: Optional[int] = None,
                   first_name: Optional[str] = None,
                   full_name: Optional[str] = None,
                   image_url: Optional[str] = None,
                   last_name: Optional[str] = None,
                   middle_name: Optional[str] = None,
                   mobile_phone: Optional[str] = None,
                   parent_email: Optional[str] = None,
                   password: Optional[str] = None,
                   password_change_required: Optional[bool] = None,
                   preferred_languages: Optional[Sequence[str]] = None,
                   send_set_password_email: Optional[bool] = None,
                   skip_verification: Optional[bool] = None,
                   tenant_id: Optional[str] = None,
                   timezone: Optional[str] = None,
                   two_factor_methods: Optional[Sequence[FusionAuthUserTwoFactorMethodArgs]] = None,
                   two_factor_recovery_codes: Optional[Sequence[str]] = None,
                   user_id: Optional[str] = None,
                   username: Optional[str] = None,
                   username_status: Optional[str] = None)
    func NewFusionAuthUser(ctx *Context, name string, args *FusionAuthUserArgs, opts ...ResourceOption) (*FusionAuthUser, error)
    public FusionAuthUser(string name, FusionAuthUserArgs? args = null, CustomResourceOptions? opts = null)
    public FusionAuthUser(String name, FusionAuthUserArgs args)
public FusionAuthUser(String name, FusionAuthUserArgs args, CustomResourceOptions options)

    type: fusionauth:FusionAuthUser
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 FusionAuthUserArgs
    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 FusionAuthUserArgs
    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 FusionAuthUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthUserArgs
    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 fusionAuthUserResource = new Fusionauth.FusionAuthUser("fusionAuthUserResource", new()
{
    ApplicationId = "string",
    BirthDate = "string",
    Data = "string",
    DisableDomainBlock = false,
    Email = "string",
    EncryptionScheme = "string",
    Expiry = 0,
    FirstName = "string",
    FullName = "string",
    ImageUrl = "string",
    LastName = "string",
    MiddleName = "string",
    MobilePhone = "string",
    ParentEmail = "string",
    Password = "string",
    PasswordChangeRequired = false,
    PreferredLanguages = new[]
    {
        "string",
    },
    SendSetPasswordEmail = false,
    SkipVerification = false,
    TenantId = "string",
    Timezone = "string",
    TwoFactorMethods = new[]
    {
        new Fusionauth.Inputs.FusionAuthUserTwoFactorMethodArgs
        {
            AuthenticatorAlgorithm = "string",
            AuthenticatorCodeLength = 0,
            AuthenticatorTimeStep = 0,
            Email = "string",
            Method = "string",
            MobilePhone = "string",
            Secret = "string",
            TwoFactorMethodId = "string",
        },
    },
    TwoFactorRecoveryCodes = new[]
    {
        "string",
    },
    UserId = "string",
    Username = "string",
    UsernameStatus = "string",
});

    example, err := fusionauth.NewFusionAuthUser(ctx, "fusionAuthUserResource", &fusionauth.FusionAuthUserArgs{
	ApplicationId:          pulumi.String("string"),
	BirthDate:              pulumi.String("string"),
	Data:                   pulumi.String("string"),
	DisableDomainBlock:     pulumi.Bool(false),
	Email:                  pulumi.String("string"),
	EncryptionScheme:       pulumi.String("string"),
	Expiry:                 pulumi.Int(0),
	FirstName:              pulumi.String("string"),
	FullName:               pulumi.String("string"),
	ImageUrl:               pulumi.String("string"),
	LastName:               pulumi.String("string"),
	MiddleName:             pulumi.String("string"),
	MobilePhone:            pulumi.String("string"),
	ParentEmail:            pulumi.String("string"),
	Password:               pulumi.String("string"),
	PasswordChangeRequired: pulumi.Bool(false),
	PreferredLanguages: pulumi.StringArray{
		pulumi.String("string"),
	},
	SendSetPasswordEmail: pulumi.Bool(false),
	SkipVerification:     pulumi.Bool(false),
	TenantId:             pulumi.String("string"),
	Timezone:             pulumi.String("string"),
	TwoFactorMethods: fusionauth.FusionAuthUserTwoFactorMethodArray{
		&fusionauth.FusionAuthUserTwoFactorMethodArgs{
			AuthenticatorAlgorithm:  pulumi.String("string"),
			AuthenticatorCodeLength: pulumi.Int(0),
			AuthenticatorTimeStep:   pulumi.Int(0),
			Email:                   pulumi.String("string"),
			Method:                  pulumi.String("string"),
			MobilePhone:             pulumi.String("string"),
			Secret:                  pulumi.String("string"),
			TwoFactorMethodId:       pulumi.String("string"),
		},
	},
	TwoFactorRecoveryCodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserId:         pulumi.String("string"),
	Username:       pulumi.String("string"),
	UsernameStatus: pulumi.String("string"),
})

    var fusionAuthUserResource = new FusionAuthUser("fusionAuthUserResource", FusionAuthUserArgs.builder()
    .applicationId("string")
    .birthDate("string")
    .data("string")
    .disableDomainBlock(false)
    .email("string")
    .encryptionScheme("string")
    .expiry(0)
    .firstName("string")
    .fullName("string")
    .imageUrl("string")
    .lastName("string")
    .middleName("string")
    .mobilePhone("string")
    .parentEmail("string")
    .password("string")
    .passwordChangeRequired(false)
    .preferredLanguages("string")
    .sendSetPasswordEmail(false)
    .skipVerification(false)
    .tenantId("string")
    .timezone("string")
    .twoFactorMethods(FusionAuthUserTwoFactorMethodArgs.builder()
        .authenticatorAlgorithm("string")
        .authenticatorCodeLength(0)
        .authenticatorTimeStep(0)
        .email("string")
        .method("string")
        .mobilePhone("string")
        .secret("string")
        .twoFactorMethodId("string")
        .build())
    .twoFactorRecoveryCodes("string")
    .userId("string")
    .username("string")
    .usernameStatus("string")
    .build());

    fusion_auth_user_resource = fusionauth.FusionAuthUser("fusionAuthUserResource",
    application_id="string",
    birth_date="string",
    data="string",
    disable_domain_block=False,
    email="string",
    encryption_scheme="string",
    expiry=0,
    first_name="string",
    full_name="string",
    image_url="string",
    last_name="string",
    middle_name="string",
    mobile_phone="string",
    parent_email="string",
    password="string",
    password_change_required=False,
    preferred_languages=["string"],
    send_set_password_email=False,
    skip_verification=False,
    tenant_id="string",
    timezone="string",
    two_factor_methods=[{
        "authenticator_algorithm": "string",
        "authenticator_code_length": 0,
        "authenticator_time_step": 0,
        "email": "string",
        "method": "string",
        "mobile_phone": "string",
        "secret": "string",
        "two_factor_method_id": "string",
    }],
    two_factor_recovery_codes=["string"],
    user_id="string",
    username="string",
    username_status="string")

    const fusionAuthUserResource = new fusionauth.FusionAuthUser("fusionAuthUserResource", {
    applicationId: "string",
    birthDate: "string",
    data: "string",
    disableDomainBlock: false,
    email: "string",
    encryptionScheme: "string",
    expiry: 0,
    firstName: "string",
    fullName: "string",
    imageUrl: "string",
    lastName: "string",
    middleName: "string",
    mobilePhone: "string",
    parentEmail: "string",
    password: "string",
    passwordChangeRequired: false,
    preferredLanguages: ["string"],
    sendSetPasswordEmail: false,
    skipVerification: false,
    tenantId: "string",
    timezone: "string",
    twoFactorMethods: [{
        authenticatorAlgorithm: "string",
        authenticatorCodeLength: 0,
        authenticatorTimeStep: 0,
        email: "string",
        method: "string",
        mobilePhone: "string",
        secret: "string",
        twoFactorMethodId: "string",
    }],
    twoFactorRecoveryCodes: ["string"],
    userId: "string",
    username: "string",
    usernameStatus: "string",
});

    type: fusionauth:FusionAuthUser
properties:
    applicationId: string
    birthDate: string
    data: string
    disableDomainBlock: false
    email: string
    encryptionScheme: string
    expiry: 0
    firstName: string
    fullName: string
    imageUrl: string
    lastName: string
    middleName: string
    mobilePhone: string
    parentEmail: string
    password: string
    passwordChangeRequired: false
    preferredLanguages:
        - string
    sendSetPasswordEmail: false
    skipVerification: false
    tenantId: string
    timezone: string
    twoFactorMethods:
        - authenticatorAlgorithm: string
          authenticatorCodeLength: 0
          authenticatorTimeStep: 0
          email: string
          method: string
          mobilePhone: string
          secret: string
          twoFactorMethodId: string
    twoFactorRecoveryCodes:
        - string
    userId: string
    username: string
    usernameStatus: string

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

    ApplicationId string
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    BirthDate string
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    Data string
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    DisableDomainBlock bool
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    Email string
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    EncryptionScheme string
    The method for encrypting the User’s password.
    Expiry int
    The expiration instant of the User’s account. An expired user is not permitted to login.
    FirstName string
    The first name of the User.
    FullName string
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    ImageUrl string
    The URL that points to an image file that is the User’s profile image.
    LastName string
    The User’s last name.
    MiddleName string
    The User’s middle name.
    MobilePhone string
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    ParentEmail string
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    Password string
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    PasswordChangeRequired bool
    Indicates that the User’s password needs to be changed during their next login attempt.
    PreferredLanguages List<string>
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    SendSetPasswordEmail bool
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    SkipVerification bool
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    TenantId string
    The unique Id of the tenant used to scope this API request.
    Timezone string
    The User’s preferred timezone. The string must be in an IANA time zone format.
    TwoFactorMethods List<theogravity.Fusionauth.Inputs.FusionAuthUserTwoFactorMethod>
    TwoFactorRecoveryCodes List<string>
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    UserId string
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    Username string
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    UsernameStatus string
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    ApplicationId string
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    BirthDate string
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    Data string
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    DisableDomainBlock bool
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    Email string
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    EncryptionScheme string
    The method for encrypting the User’s password.
    Expiry int
    The expiration instant of the User’s account. An expired user is not permitted to login.
    FirstName string
    The first name of the User.
    FullName string
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    ImageUrl string
    The URL that points to an image file that is the User’s profile image.
    LastName string
    The User’s last name.
    MiddleName string
    The User’s middle name.
    MobilePhone string
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    ParentEmail string
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    Password string
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    PasswordChangeRequired bool
    Indicates that the User’s password needs to be changed during their next login attempt.
    PreferredLanguages []string
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    SendSetPasswordEmail bool
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    SkipVerification bool
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    TenantId string
    The unique Id of the tenant used to scope this API request.
    Timezone string
    The User’s preferred timezone. The string must be in an IANA time zone format.
    TwoFactorMethods []FusionAuthUserTwoFactorMethodArgs
    TwoFactorRecoveryCodes []string
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    UserId string
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    Username string
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    UsernameStatus string
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    applicationId String
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birthDate String
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data String
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disableDomainBlock Boolean
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email String
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryptionScheme String
    The method for encrypting the User’s password.
    expiry Integer
    The expiration instant of the User’s account. An expired user is not permitted to login.
    firstName String
    The first name of the User.
    fullName String
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    imageUrl String
    The URL that points to an image file that is the User’s profile image.
    lastName String
    The User’s last name.
    middleName String
    The User’s middle name.
    mobilePhone String
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parentEmail String
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password String
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    passwordChangeRequired Boolean
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferredLanguages List<String>
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    sendSetPasswordEmail Boolean
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skipVerification Boolean
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenantId String
    The unique Id of the tenant used to scope this API request.
    timezone String
    The User’s preferred timezone. The string must be in an IANA time zone format.
    twoFactorMethods List<FusionAuthUserTwoFactorMethod>
    twoFactorRecoveryCodes List<String>
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    userId String
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username String
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    usernameStatus String
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    applicationId string
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birthDate string
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data string
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disableDomainBlock boolean
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email string
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryptionScheme string
    The method for encrypting the User’s password.
    expiry number
    The expiration instant of the User’s account. An expired user is not permitted to login.
    firstName string
    The first name of the User.
    fullName string
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    imageUrl string
    The URL that points to an image file that is the User’s profile image.
    lastName string
    The User’s last name.
    middleName string
    The User’s middle name.
    mobilePhone string
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parentEmail string
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password string
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    passwordChangeRequired boolean
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferredLanguages string[]
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    sendSetPasswordEmail boolean
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skipVerification boolean
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenantId string
    The unique Id of the tenant used to scope this API request.
    timezone string
    The User’s preferred timezone. The string must be in an IANA time zone format.
    twoFactorMethods FusionAuthUserTwoFactorMethod[]
    twoFactorRecoveryCodes string[]
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    userId string
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username string
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    usernameStatus string
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    application_id str
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birth_date str
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data str
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disable_domain_block bool
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email str
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryption_scheme str
    The method for encrypting the User’s password.
    expiry int
    The expiration instant of the User’s account. An expired user is not permitted to login.
    first_name str
    The first name of the User.
    full_name str
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    image_url str
    The URL that points to an image file that is the User’s profile image.
    last_name str
    The User’s last name.
    middle_name str
    The User’s middle name.
    mobile_phone str
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parent_email str
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password str
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    password_change_required bool
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferred_languages Sequence[str]
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    send_set_password_email bool
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skip_verification bool
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenant_id str
    The unique Id of the tenant used to scope this API request.
    timezone str
    The User’s preferred timezone. The string must be in an IANA time zone format.
    two_factor_methods Sequence[FusionAuthUserTwoFactorMethodArgs]
    two_factor_recovery_codes Sequence[str]
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    user_id str
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username str
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    username_status str
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    applicationId String
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birthDate String
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data String
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disableDomainBlock Boolean
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email String
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryptionScheme String
    The method for encrypting the User’s password.
    expiry Number
    The expiration instant of the User’s account. An expired user is not permitted to login.
    firstName String
    The first name of the User.
    fullName String
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    imageUrl String
    The URL that points to an image file that is the User’s profile image.
    lastName String
    The User’s last name.
    middleName String
    The User’s middle name.
    mobilePhone String
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parentEmail String
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password String
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    passwordChangeRequired Boolean
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferredLanguages List<String>
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    sendSetPasswordEmail Boolean
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skipVerification Boolean
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenantId String
    The unique Id of the tenant used to scope this API request.
    timezone String
    The User’s preferred timezone. The string must be in an IANA time zone format.
    twoFactorMethods List<Property Map>
    twoFactorRecoveryCodes List<String>
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    userId String
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username String
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    usernameStatus String
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FusionAuthUser Resource

    Get an existing FusionAuthUser 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?: FusionAuthUserState, opts?: CustomResourceOptions): FusionAuthUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_id: Optional[str] = None,
        birth_date: Optional[str] = None,
        data: Optional[str] = None,
        disable_domain_block: Optional[bool] = None,
        email: Optional[str] = None,
        encryption_scheme: Optional[str] = None,
        expiry: Optional[int] = None,
        first_name: Optional[str] = None,
        full_name: Optional[str] = None,
        image_url: Optional[str] = None,
        last_name: Optional[str] = None,
        middle_name: Optional[str] = None,
        mobile_phone: Optional[str] = None,
        parent_email: Optional[str] = None,
        password: Optional[str] = None,
        password_change_required: Optional[bool] = None,
        preferred_languages: Optional[Sequence[str]] = None,
        send_set_password_email: Optional[bool] = None,
        skip_verification: Optional[bool] = None,
        tenant_id: Optional[str] = None,
        timezone: Optional[str] = None,
        two_factor_methods: Optional[Sequence[FusionAuthUserTwoFactorMethodArgs]] = None,
        two_factor_recovery_codes: Optional[Sequence[str]] = None,
        user_id: Optional[str] = None,
        username: Optional[str] = None,
        username_status: Optional[str] = None) -> FusionAuthUser
    func GetFusionAuthUser(ctx *Context, name string, id IDInput, state *FusionAuthUserState, opts ...ResourceOption) (*FusionAuthUser, error)
    public static FusionAuthUser Get(string name, Input<string> id, FusionAuthUserState? state, CustomResourceOptions? opts = null)
    public static FusionAuthUser get(String name, Output<String> id, FusionAuthUserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ApplicationId string
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    BirthDate string
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    Data string
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    DisableDomainBlock bool
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    Email string
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    EncryptionScheme string
    The method for encrypting the User’s password.
    Expiry int
    The expiration instant of the User’s account. An expired user is not permitted to login.
    FirstName string
    The first name of the User.
    FullName string
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    ImageUrl string
    The URL that points to an image file that is the User’s profile image.
    LastName string
    The User’s last name.
    MiddleName string
    The User’s middle name.
    MobilePhone string
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    ParentEmail string
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    Password string
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    PasswordChangeRequired bool
    Indicates that the User’s password needs to be changed during their next login attempt.
    PreferredLanguages List<string>
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    SendSetPasswordEmail bool
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    SkipVerification bool
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    TenantId string
    The unique Id of the tenant used to scope this API request.
    Timezone string
    The User’s preferred timezone. The string must be in an IANA time zone format.
    TwoFactorMethods List<theogravity.Fusionauth.Inputs.FusionAuthUserTwoFactorMethod>
    TwoFactorRecoveryCodes List<string>
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    UserId string
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    Username string
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    UsernameStatus string
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    ApplicationId string
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    BirthDate string
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    Data string
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    DisableDomainBlock bool
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    Email string
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    EncryptionScheme string
    The method for encrypting the User’s password.
    Expiry int
    The expiration instant of the User’s account. An expired user is not permitted to login.
    FirstName string
    The first name of the User.
    FullName string
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    ImageUrl string
    The URL that points to an image file that is the User’s profile image.
    LastName string
    The User’s last name.
    MiddleName string
    The User’s middle name.
    MobilePhone string
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    ParentEmail string
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    Password string
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    PasswordChangeRequired bool
    Indicates that the User’s password needs to be changed during their next login attempt.
    PreferredLanguages []string
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    SendSetPasswordEmail bool
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    SkipVerification bool
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    TenantId string
    The unique Id of the tenant used to scope this API request.
    Timezone string
    The User’s preferred timezone. The string must be in an IANA time zone format.
    TwoFactorMethods []FusionAuthUserTwoFactorMethodArgs
    TwoFactorRecoveryCodes []string
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    UserId string
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    Username string
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    UsernameStatus string
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    applicationId String
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birthDate String
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data String
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disableDomainBlock Boolean
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email String
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryptionScheme String
    The method for encrypting the User’s password.
    expiry Integer
    The expiration instant of the User’s account. An expired user is not permitted to login.
    firstName String
    The first name of the User.
    fullName String
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    imageUrl String
    The URL that points to an image file that is the User’s profile image.
    lastName String
    The User’s last name.
    middleName String
    The User’s middle name.
    mobilePhone String
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parentEmail String
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password String
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    passwordChangeRequired Boolean
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferredLanguages List<String>
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    sendSetPasswordEmail Boolean
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skipVerification Boolean
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenantId String
    The unique Id of the tenant used to scope this API request.
    timezone String
    The User’s preferred timezone. The string must be in an IANA time zone format.
    twoFactorMethods List<FusionAuthUserTwoFactorMethod>
    twoFactorRecoveryCodes List<String>
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    userId String
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username String
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    usernameStatus String
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    applicationId string
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birthDate string
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data string
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disableDomainBlock boolean
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email string
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryptionScheme string
    The method for encrypting the User’s password.
    expiry number
    The expiration instant of the User’s account. An expired user is not permitted to login.
    firstName string
    The first name of the User.
    fullName string
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    imageUrl string
    The URL that points to an image file that is the User’s profile image.
    lastName string
    The User’s last name.
    middleName string
    The User’s middle name.
    mobilePhone string
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parentEmail string
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password string
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    passwordChangeRequired boolean
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferredLanguages string[]
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    sendSetPasswordEmail boolean
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skipVerification boolean
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenantId string
    The unique Id of the tenant used to scope this API request.
    timezone string
    The User’s preferred timezone. The string must be in an IANA time zone format.
    twoFactorMethods FusionAuthUserTwoFactorMethod[]
    twoFactorRecoveryCodes string[]
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    userId string
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username string
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    usernameStatus string
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    application_id str
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birth_date str
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data str
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disable_domain_block bool
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email str
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryption_scheme str
    The method for encrypting the User’s password.
    expiry int
    The expiration instant of the User’s account. An expired user is not permitted to login.
    first_name str
    The first name of the User.
    full_name str
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    image_url str
    The URL that points to an image file that is the User’s profile image.
    last_name str
    The User’s last name.
    middle_name str
    The User’s middle name.
    mobile_phone str
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parent_email str
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password str
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    password_change_required bool
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferred_languages Sequence[str]
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    send_set_password_email bool
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skip_verification bool
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenant_id str
    The unique Id of the tenant used to scope this API request.
    timezone str
    The User’s preferred timezone. The string must be in an IANA time zone format.
    two_factor_methods Sequence[FusionAuthUserTwoFactorMethodArgs]
    two_factor_recovery_codes Sequence[str]
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    user_id str
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username str
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    username_status str
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.
    applicationId String
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    birthDate String
    An ISO-8601 formatted date of the User’s birthdate such as YYYY-MM-DD.
    data String
    An object that can hold any information about a User that should be persisted. Must be a JSON serialised string.
    disableDomainBlock Boolean
    An optional Application Id. When this value is provided, it will be used to resolve an application specific email template if you have configured transactional emails such as setup password, email verification and others.
    email String
    The User’s email address. An email address is a unique in FusionAuth and stored in lower case.
    encryptionScheme String
    The method for encrypting the User’s password.
    expiry Number
    The expiration instant of the User’s account. An expired user is not permitted to login.
    firstName String
    The first name of the User.
    fullName String
    The User’s full name as a separate field that is not calculated from firstName and lastName.
    imageUrl String
    The URL that points to an image file that is the User’s profile image.
    lastName String
    The User’s last name.
    middleName String
    The User’s middle name.
    mobilePhone String
    The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.
    parentEmail String
    The email address of the user’s parent or guardian. This field is used to allow a child user to identify their parent so FusionAuth can make a request to the parent to confirm the parent relationship.
    password String
    The User’s plain texts password. This password will be hashed and the provided value will never be stored and cannot be retrieved.
    passwordChangeRequired Boolean
    Indicates that the User’s password needs to be changed during their next login attempt.
    preferredLanguages List<String>
    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text.
    sendSetPasswordEmail Boolean
    Indicates to FusionAuth to send the User an email asking them to set their password. The Email Template that is used is configured in the System Configuration setting for Set Password Email Template.
    skipVerification Boolean
    Indicates to FusionAuth that it should skip email verification even if it is enabled. This is useful for creating admin or internal User accounts.
    tenantId String
    The unique Id of the tenant used to scope this API request.
    timezone String
    The User’s preferred timezone. The string must be in an IANA time zone format.
    twoFactorMethods List<Property Map>
    twoFactorRecoveryCodes List<String>
    A list of recovery codes. These may be used in place of a code provided by an MFA factor. They are single use. If a recovery code is used in a disable request, all MFA methods are removed. If, after that, a Multi-Factor method is added, a new set of recovery codes will be generated.
    userId String
    The Id to use for the new User. If not specified a secure random UUID will be generated..
    username String
    The username of the User. The username is stored and returned as a case sensitive value, however a username is considered unique regardless of the case. bob is considered equal to BoB so either version of this username can be used whenever providing it as input to an API.
    usernameStatus String
    The current status of the username. This is used if you are moderating usernames via CleanSpeak.

    Supporting Types

    FusionAuthUserTwoFactorMethod, FusionAuthUserTwoFactorMethodArgs

    AuthenticatorAlgorithm string
    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
    AuthenticatorCodeLength int
    The length of code generated by the TOTP. With the current implementation, this will always be 6.
    AuthenticatorTimeStep int
    The time-step size in seconds. With the current implementation, this will always be 30.
    Email string
    The value of the email address for this method.
    Method string
    The type of this method. There will also be an object with the same value containing additional information about this method.
    MobilePhone string
    The value of the mobile phone for this method.
    Secret string
    A base64 encoded secret
    TwoFactorMethodId string
    The unique Id of the method.
    AuthenticatorAlgorithm string
    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
    AuthenticatorCodeLength int
    The length of code generated by the TOTP. With the current implementation, this will always be 6.
    AuthenticatorTimeStep int
    The time-step size in seconds. With the current implementation, this will always be 30.
    Email string
    The value of the email address for this method.
    Method string
    The type of this method. There will also be an object with the same value containing additional information about this method.
    MobilePhone string
    The value of the mobile phone for this method.
    Secret string
    A base64 encoded secret
    TwoFactorMethodId string
    The unique Id of the method.
    authenticatorAlgorithm String
    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
    authenticatorCodeLength Integer
    The length of code generated by the TOTP. With the current implementation, this will always be 6.
    authenticatorTimeStep Integer
    The time-step size in seconds. With the current implementation, this will always be 30.
    email String
    The value of the email address for this method.
    method String
    The type of this method. There will also be an object with the same value containing additional information about this method.
    mobilePhone String
    The value of the mobile phone for this method.
    secret String
    A base64 encoded secret
    twoFactorMethodId String
    The unique Id of the method.
    authenticatorAlgorithm string
    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
    authenticatorCodeLength number
    The length of code generated by the TOTP. With the current implementation, this will always be 6.
    authenticatorTimeStep number
    The time-step size in seconds. With the current implementation, this will always be 30.
    email string
    The value of the email address for this method.
    method string
    The type of this method. There will also be an object with the same value containing additional information about this method.
    mobilePhone string
    The value of the mobile phone for this method.
    secret string
    A base64 encoded secret
    twoFactorMethodId string
    The unique Id of the method.
    authenticator_algorithm str
    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
    authenticator_code_length int
    The length of code generated by the TOTP. With the current implementation, this will always be 6.
    authenticator_time_step int
    The time-step size in seconds. With the current implementation, this will always be 30.
    email str
    The value of the email address for this method.
    method str
    The type of this method. There will also be an object with the same value containing additional information about this method.
    mobile_phone str
    The value of the mobile phone for this method.
    secret str
    A base64 encoded secret
    two_factor_method_id str
    The unique Id of the method.
    authenticatorAlgorithm String
    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
    authenticatorCodeLength Number
    The length of code generated by the TOTP. With the current implementation, this will always be 6.
    authenticatorTimeStep Number
    The time-step size in seconds. With the current implementation, this will always be 30.
    email String
    The value of the email address for this method.
    method String
    The type of this method. There will also be an object with the same value containing additional information about this method.
    mobilePhone String
    The value of the mobile phone for this method.
    secret String
    A base64 encoded secret
    twoFactorMethodId String
    The unique Id of the method.

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
    theogravity/pulumi-fusionauth