Class User

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

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
public MyStack()
{
    var admin = new Auth0.Role("admin", new Auth0.RoleArgs
    {
        Description = "Administrator",
    });
    var user = new Auth0.User("user", new Auth0.UserArgs
    {
        ConnectionName = "Username-Password-Authentication",
        UserId = "12345",
        Username = "unique_username",
        GivenName = "Firstname",
        FamilyName = "Lastname",
        Nickname = "some.nickname",
        Email = "test@test.com",
        EmailVerified = true,
        Password = "passpass$12$12",
        Roles = 
        {
            admin.Id,
        },
    });
}

}
Inheritance
System.Object
Pulumi.Resource
Pulumi.CustomResource
User
Inherited Members
Pulumi.CustomResource.Id
Pulumi.Resource.GetResourceType()
Pulumi.Resource.GetResourceName()
Pulumi.Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Auth0
Assembly: Pulumi.Auth0.dll
Syntax
public class User : CustomResource

Constructors

View Source

User(String, UserArgs, CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

Declaration
public User(string name, UserArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
UserArgs args

The arguments used to populate this resource's properties
Pulumi.CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AppMetadata

String, JSON format. 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.

Declaration
public Output<string> AppMetadata { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Blocked

Declaration
public Output<bool?> Blocked { get; }
Property Value
Type Description
Pulumi.Output<System.Nullable<System.Boolean>>
View Source

ConnectionName

String. Name of the connection from which the user information was sourced.

Declaration
public Output<string> ConnectionName { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Email

String. Email address of the user.

Declaration
public Output<string> Email { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

EmailVerified

Boolean. Indicates whether or not the email address has been verified.

Declaration
public Output<bool?> EmailVerified { get; }
Property Value
Type Description
Pulumi.Output<System.Nullable<System.Boolean>>
View Source

FamilyName

Declaration
public Output<string> FamilyName { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

GivenName

Declaration
public Output<string> GivenName { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Name

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Nickname

String. Preferred nickname or alias of the user.

Declaration
public Output<string> Nickname { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Password

String, Case-sensitive. Initial password for this user. Used for non-SMS connections.

Declaration
public Output<string> Password { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

PhoneNumber

String. Phone number for the user; follows the E.164 recommendation. Used for SMS connections.

Declaration
public Output<string> PhoneNumber { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

PhoneVerified

Boolean. Indicates whether or not the phone number has been verified.

Declaration
public Output<bool?> PhoneVerified { get; }
Property Value
Type Description
Pulumi.Output<System.Nullable<System.Boolean>>
View Source

Picture

Declaration
public Output<string> Picture { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Roles

Set(String). Set of IDs of roles assigned to the user.

Declaration
public Output<ImmutableArray<string>> Roles { get; }
Property Value
Type Description
Pulumi.Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

UserId

String. ID of the user.

Declaration
public Output<string> UserId { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

UserMetadata

String, JSON format. 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.

Declaration
public Output<string> UserMetadata { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Username

String. Username of the user. Only valid if the connection requires a username.

Declaration
public Output<string> Username { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

VerifyEmail

Boolean. Indicates whether or not the user will receive a verification email after creation. Overrides behavior of email_verified parameter.

Declaration
public Output<bool?> VerifyEmail { get; }
Property Value
Type Description
Pulumi.Output<System.Nullable<System.Boolean>>

Methods

View Source

Get(String, Input<String>, UserState, CustomResourceOptions)

Get an existing User resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static User Get(string name, Input<string> id, UserState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Pulumi.Input<System.String> id

The unique provider ID of the resource to lookup.
UserState state

Any extra arguments used during the lookup.
Pulumi.CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
User