Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. User
Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0

auth0.User

Explore with Pulumi AI

Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0

With this resource, you can manage user identities, including resetting passwords, and creating, provisioning, blocking, and deleting users.

Example Usage

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

const user = new auth0.User("user", {
    connectionName: "Username-Password-Authentication",
    userId: "12345",
    username: "unique_username",
    name: "Firstname Lastname",
    nickname: "some.nickname",
    email: "test@test.com",
    emailVerified: true,
    password: "passpass$12$12",
    picture: "https://www.example.com/a-valid-picture-url.jpg",
});
Copy
import pulumi
import pulumi_auth0 as auth0

user = auth0.User("user",
    connection_name="Username-Password-Authentication",
    user_id="12345",
    username="unique_username",
    name="Firstname Lastname",
    nickname="some.nickname",
    email="test@test.com",
    email_verified=True,
    password="passpass$12$12",
    picture="https://www.example.com/a-valid-picture-url.jpg")
Copy
package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewUser(ctx, "user", &auth0.UserArgs{
			ConnectionName: pulumi.String("Username-Password-Authentication"),
			UserId:         pulumi.String("12345"),
			Username:       pulumi.String("unique_username"),
			Name:           pulumi.String("Firstname Lastname"),
			Nickname:       pulumi.String("some.nickname"),
			Email:          pulumi.String("test@test.com"),
			EmailVerified:  pulumi.Bool(true),
			Password:       pulumi.String("passpass$12$12"),
			Picture:        pulumi.String("https://www.example.com/a-valid-picture-url.jpg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var user = new Auth0.User("user", new()
    {
        ConnectionName = "Username-Password-Authentication",
        UserId = "12345",
        Username = "unique_username",
        Name = "Firstname Lastname",
        Nickname = "some.nickname",
        Email = "test@test.com",
        EmailVerified = true,
        Password = "passpass$12$12",
        Picture = "https://www.example.com/a-valid-picture-url.jpg",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.User;
import com.pulumi.auth0.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 user = new User("user", UserArgs.builder()
            .connectionName("Username-Password-Authentication")
            .userId("12345")
            .username("unique_username")
            .name("Firstname Lastname")
            .nickname("some.nickname")
            .email("test@test.com")
            .emailVerified(true)
            .password("passpass$12$12")
            .picture("https://www.example.com/a-valid-picture-url.jpg")
            .build());

    }
}
Copy
resources:
  user:
    type: auth0:User
    properties:
      connectionName: Username-Password-Authentication
      userId: '12345'
      username: unique_username
      name: Firstname Lastname
      nickname: some.nickname
      email: test@test.com
      emailVerified: true
      password: passpass$12$12
      picture: https://www.example.com/a-valid-picture-url.jpg
Copy

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,
         connection_name: Optional[str] = None,
         nickname: Optional[str] = None,
         phone_number: Optional[str] = None,
         email: Optional[str] = None,
         email_verified: Optional[bool] = None,
         family_name: Optional[str] = None,
         given_name: Optional[str] = None,
         blocked: Optional[bool] = None,
         name: Optional[str] = None,
         password: Optional[str] = None,
         app_metadata: Optional[str] = None,
         phone_verified: Optional[bool] = None,
         picture: Optional[str] = None,
         user_id: Optional[str] = None,
         user_metadata: Optional[str] = None,
         username: Optional[str] = None,
         verify_email: Optional[bool] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 Auth0.User("userResource", new()
{
    ConnectionName = "string",
    Nickname = "string",
    PhoneNumber = "string",
    Email = "string",
    EmailVerified = false,
    FamilyName = "string",
    GivenName = "string",
    Blocked = false,
    Name = "string",
    Password = "string",
    AppMetadata = "string",
    PhoneVerified = false,
    Picture = "string",
    UserId = "string",
    UserMetadata = "string",
    Username = "string",
    VerifyEmail = false,
});
Copy
example, err := auth0.NewUser(ctx, "userResource", &auth0.UserArgs{
	ConnectionName: pulumi.String("string"),
	Nickname:       pulumi.String("string"),
	PhoneNumber:    pulumi.String("string"),
	Email:          pulumi.String("string"),
	EmailVerified:  pulumi.Bool(false),
	FamilyName:     pulumi.String("string"),
	GivenName:      pulumi.String("string"),
	Blocked:        pulumi.Bool(false),
	Name:           pulumi.String("string"),
	Password:       pulumi.String("string"),
	AppMetadata:    pulumi.String("string"),
	PhoneVerified:  pulumi.Bool(false),
	Picture:        pulumi.String("string"),
	UserId:         pulumi.String("string"),
	UserMetadata:   pulumi.String("string"),
	Username:       pulumi.String("string"),
	VerifyEmail:    pulumi.Bool(false),
})
Copy
var userResource = new User("userResource", UserArgs.builder()
    .connectionName("string")
    .nickname("string")
    .phoneNumber("string")
    .email("string")
    .emailVerified(false)
    .familyName("string")
    .givenName("string")
    .blocked(false)
    .name("string")
    .password("string")
    .appMetadata("string")
    .phoneVerified(false)
    .picture("string")
    .userId("string")
    .userMetadata("string")
    .username("string")
    .verifyEmail(false)
    .build());
Copy
user_resource = auth0.User("userResource",
    connection_name="string",
    nickname="string",
    phone_number="string",
    email="string",
    email_verified=False,
    family_name="string",
    given_name="string",
    blocked=False,
    name="string",
    password="string",
    app_metadata="string",
    phone_verified=False,
    picture="string",
    user_id="string",
    user_metadata="string",
    username="string",
    verify_email=False)
Copy
const userResource = new auth0.User("userResource", {
    connectionName: "string",
    nickname: "string",
    phoneNumber: "string",
    email: "string",
    emailVerified: false,
    familyName: "string",
    givenName: "string",
    blocked: false,
    name: "string",
    password: "string",
    appMetadata: "string",
    phoneVerified: false,
    picture: "string",
    userId: "string",
    userMetadata: "string",
    username: "string",
    verifyEmail: false,
});
Copy
type: auth0:User
properties:
    appMetadata: string
    blocked: false
    connectionName: string
    email: string
    emailVerified: false
    familyName: string
    givenName: string
    name: string
    nickname: string
    password: string
    phoneNumber: string
    phoneVerified: false
    picture: string
    userId: string
    userMetadata: string
    username: string
    verifyEmail: false
Copy

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:

ConnectionName This property is required. string
Name of the connection from which the user information was sourced.
AppMetadata string
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
Blocked bool
Indicates whether the user is blocked or not.
Email string
Email address of the user.
EmailVerified bool
Indicates whether the email address has been verified.
FamilyName string
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
GivenName string
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Name string
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Nickname string
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Password string
Initial password for this user. Required for non-passwordless connections (SMS and email).
PhoneNumber string
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
PhoneVerified bool
Indicates whether the phone number has been verified.
Picture string
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
UserId string
ID of the user.
UserMetadata string
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
Username string
Username of the user. Only valid if the connection requires a username.
VerifyEmail bool
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
ConnectionName This property is required. string
Name of the connection from which the user information was sourced.
AppMetadata string
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
Blocked bool
Indicates whether the user is blocked or not.
Email string
Email address of the user.
EmailVerified bool
Indicates whether the email address has been verified.
FamilyName string
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
GivenName string
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Name string
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Nickname string
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Password string
Initial password for this user. Required for non-passwordless connections (SMS and email).
PhoneNumber string
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
PhoneVerified bool
Indicates whether the phone number has been verified.
Picture string
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
UserId string
ID of the user.
UserMetadata string
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
Username string
Username of the user. Only valid if the connection requires a username.
VerifyEmail bool
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
connectionName This property is required. String
Name of the connection from which the user information was sourced.
appMetadata String
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked Boolean
Indicates whether the user is blocked or not.
email String
Email address of the user.
emailVerified Boolean
Indicates whether the email address has been verified.
familyName String
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
givenName String
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name String
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname String
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password String
Initial password for this user. Required for non-passwordless connections (SMS and email).
phoneNumber String
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phoneVerified Boolean
Indicates whether the phone number has been verified.
picture String
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
userId String
ID of the user.
userMetadata String
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username String
Username of the user. Only valid if the connection requires a username.
verifyEmail Boolean
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
connectionName This property is required. string
Name of the connection from which the user information was sourced.
appMetadata string
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked boolean
Indicates whether the user is blocked or not.
email string
Email address of the user.
emailVerified boolean
Indicates whether the email address has been verified.
familyName string
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
givenName string
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name string
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname string
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password string
Initial password for this user. Required for non-passwordless connections (SMS and email).
phoneNumber string
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phoneVerified boolean
Indicates whether the phone number has been verified.
picture string
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
userId string
ID of the user.
userMetadata string
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username string
Username of the user. Only valid if the connection requires a username.
verifyEmail boolean
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
connection_name This property is required. str
Name of the connection from which the user information was sourced.
app_metadata str
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked bool
Indicates whether the user is blocked or not.
email str
Email address of the user.
email_verified bool
Indicates whether the email address has been verified.
family_name str
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
given_name str
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name str
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname str
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password str
Initial password for this user. Required for non-passwordless connections (SMS and email).
phone_number str
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phone_verified bool
Indicates whether the phone number has been verified.
picture str
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
user_id str
ID of the user.
user_metadata str
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username str
Username of the user. Only valid if the connection requires a username.
verify_email bool
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
connectionName This property is required. String
Name of the connection from which the user information was sourced.
appMetadata String
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked Boolean
Indicates whether the user is blocked or not.
email String
Email address of the user.
emailVerified Boolean
Indicates whether the email address has been verified.
familyName String
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
givenName String
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name String
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname String
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password String
Initial password for this user. Required for non-passwordless connections (SMS and email).
phoneNumber String
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phoneVerified Boolean
Indicates whether the phone number has been verified.
picture String
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
userId String
ID of the user.
userMetadata String
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username String
Username of the user. Only valid if the connection requires a username.
verifyEmail Boolean
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.

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.
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 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,
        app_metadata: Optional[str] = None,
        blocked: Optional[bool] = None,
        connection_name: Optional[str] = None,
        email: Optional[str] = None,
        email_verified: Optional[bool] = None,
        family_name: Optional[str] = None,
        given_name: Optional[str] = None,
        name: Optional[str] = None,
        nickname: Optional[str] = None,
        password: Optional[str] = None,
        phone_number: Optional[str] = None,
        phone_verified: Optional[bool] = None,
        picture: Optional[str] = None,
        user_id: Optional[str] = None,
        user_metadata: Optional[str] = None,
        username: Optional[str] = None,
        verify_email: Optional[bool] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
resources:  _:    type: auth0:User    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AppMetadata string
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
Blocked bool
Indicates whether the user is blocked or not.
ConnectionName string
Name of the connection from which the user information was sourced.
Email string
Email address of the user.
EmailVerified bool
Indicates whether the email address has been verified.
FamilyName string
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
GivenName string
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Name string
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Nickname string
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Password string
Initial password for this user. Required for non-passwordless connections (SMS and email).
PhoneNumber string
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
PhoneVerified bool
Indicates whether the phone number has been verified.
Picture string
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
UserId string
ID of the user.
UserMetadata string
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
Username string
Username of the user. Only valid if the connection requires a username.
VerifyEmail bool
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
AppMetadata string
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
Blocked bool
Indicates whether the user is blocked or not.
ConnectionName string
Name of the connection from which the user information was sourced.
Email string
Email address of the user.
EmailVerified bool
Indicates whether the email address has been verified.
FamilyName string
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
GivenName string
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Name string
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Nickname string
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
Password string
Initial password for this user. Required for non-passwordless connections (SMS and email).
PhoneNumber string
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
PhoneVerified bool
Indicates whether the phone number has been verified.
Picture string
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
UserId string
ID of the user.
UserMetadata string
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
Username string
Username of the user. Only valid if the connection requires a username.
VerifyEmail bool
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
appMetadata String
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked Boolean
Indicates whether the user is blocked or not.
connectionName String
Name of the connection from which the user information was sourced.
email String
Email address of the user.
emailVerified Boolean
Indicates whether the email address has been verified.
familyName String
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
givenName String
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name String
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname String
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password String
Initial password for this user. Required for non-passwordless connections (SMS and email).
phoneNumber String
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phoneVerified Boolean
Indicates whether the phone number has been verified.
picture String
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
userId String
ID of the user.
userMetadata String
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username String
Username of the user. Only valid if the connection requires a username.
verifyEmail Boolean
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
appMetadata string
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked boolean
Indicates whether the user is blocked or not.
connectionName string
Name of the connection from which the user information was sourced.
email string
Email address of the user.
emailVerified boolean
Indicates whether the email address has been verified.
familyName string
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
givenName string
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name string
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname string
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password string
Initial password for this user. Required for non-passwordless connections (SMS and email).
phoneNumber string
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phoneVerified boolean
Indicates whether the phone number has been verified.
picture string
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
userId string
ID of the user.
userMetadata string
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username string
Username of the user. Only valid if the connection requires a username.
verifyEmail boolean
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
app_metadata str
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked bool
Indicates whether the user is blocked or not.
connection_name str
Name of the connection from which the user information was sourced.
email str
Email address of the user.
email_verified bool
Indicates whether the email address has been verified.
family_name str
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
given_name str
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name str
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname str
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password str
Initial password for this user. Required for non-passwordless connections (SMS and email).
phone_number str
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phone_verified bool
Indicates whether the phone number has been verified.
picture str
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
user_id str
ID of the user.
user_metadata str
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username str
Username of the user. Only valid if the connection requires a username.
verify_email bool
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.
appMetadata String
Custom fields that store info about the user that impact the user's core functionality, such as how an application functions or what the user can access. Examples include support plans and IDs for external accounts.
blocked Boolean
Indicates whether the user is blocked or not.
connectionName String
Name of the connection from which the user information was sourced.
email String
Email address of the user.
emailVerified Boolean
Indicates whether the email address has been verified.
familyName String
Family name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
givenName String
Given name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
name String
Name of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
nickname String
Preferred nickname or alias of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
password String
Initial password for this user. Required for non-passwordless connections (SMS and email).
phoneNumber String
Phone number for the user; follows the E.164 recommendation. Used for SMS connections.
phoneVerified Boolean
Indicates whether the phone number has been verified.
picture String
Picture of the user. This value can only be updated if the connection is a database connection (using the Auth0 store), a passwordless connection (email or sms) or has disabled 'Sync user profile attributes at each login'. For more information, see: Configure Identity Provider Connection for User Profile Updates.
userId String
ID of the user.
userMetadata String
Custom fields that store info about the user that does not impact a user's core functionality. Examples include work address, home address, and user preferences.
username String
Username of the user. Only valid if the connection requires a username.
verifyEmail Boolean
Indicates whether the user will receive a verification email after creation. Overrides behavior of email_verified parameter.

Import

This resource can be imported using the user ID.

Example:

$ pulumi import auth0:index/user:User user "auth0|111111111111111111111111"
Copy

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

Package Details

Repository
Auth0 pulumi/pulumi-auth0
License
Apache-2.0
Notes
This Pulumi package is based on the auth0 Terraform Provider.
Auth0 v3.17.1 published on Tuesday, Apr 15, 2025 by Pulumi
pulumi/pulumi-auth0