import * as pulumi from "@pulumi/pulumi"; /** * With this resource, you can manage user identities, including resetting passwords, and creating, provisioning, blocking, and deleting users. * * ## Example Usage * * ```typescript * 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", * }); * // Create a user with custom_domain_header * const auth0UserWithCustomDomain = new auth0.User("auth0_user_with_custom_domain", { * connectionName: "Username-Password-Authentication", * username: "your_new_user_", * email: "change.username@acceptance.test.com", * emailVerified: true, * password: "MyPass123$", * customDomainHeader: "my-custom.domain.org", * }); * ``` * * ## Import * * This resource can be imported using the user ID. * * Example: * * ```sh * $ pulumi import auth0:index/user:User user "auth0|111111111111111111111111" * ``` */ export declare class User extends pulumi.CustomResource { /** * Get an existing User resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: UserState, opts?: pulumi.CustomResourceOptions): User; /** * Returns true if the given object is an instance of User. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is User; /** * 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. */ readonly appMetadata: pulumi.Output; /** * Indicates whether the user is blocked or not. */ readonly blocked: pulumi.Output; /** * Name of the connection from which the user information was sourced. */ readonly connectionName: pulumi.Output; /** * Sets the `Auth0-Custom-Domain` header on all requests for this resource. Global setting of provider takes precedence over resource specific param, if both are set. */ readonly customDomainHeader: pulumi.Output; /** * Email address of the user. */ readonly email: pulumi.Output; /** * Indicates whether the email address has been verified. */ readonly emailVerified: pulumi.Output; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ readonly familyName: pulumi.Output; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ readonly givenName: pulumi.Output; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ readonly name: pulumi.Output; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ readonly nickname: pulumi.Output; /** * Initial password for this user. Required for non-passwordless connections (SMS and email). */ readonly password: pulumi.Output; /** * Phone number for the user; follows the E.164 recommendation. Used for SMS connections. */ readonly phoneNumber: pulumi.Output; /** * Indicates whether the phone number has been verified. */ readonly phoneVerified: pulumi.Output; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ readonly picture: pulumi.Output; /** * ID of the user. */ readonly userId: pulumi.Output; /** * 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. */ readonly userMetadata: pulumi.Output; /** * Username of the user. Only valid if the connection requires a username. */ readonly username: pulumi.Output; /** * Indicates whether the user will receive a verification email after creation. Overrides behavior of `emailVerified` parameter. */ readonly verifyEmail: pulumi.Output; /** * Create a User resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering User resources. */ export interface UserState { /** * 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. */ appMetadata?: pulumi.Input; /** * Indicates whether the user is blocked or not. */ blocked?: pulumi.Input; /** * Name of the connection from which the user information was sourced. */ connectionName?: pulumi.Input; /** * Sets the `Auth0-Custom-Domain` header on all requests for this resource. Global setting of provider takes precedence over resource specific param, if both are set. */ customDomainHeader?: pulumi.Input; /** * Email address of the user. */ email?: pulumi.Input; /** * Indicates whether the email address has been verified. */ emailVerified?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ familyName?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ givenName?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ name?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ nickname?: pulumi.Input; /** * Initial password for this user. Required for non-passwordless connections (SMS and email). */ password?: pulumi.Input; /** * Phone number for the user; follows the E.164 recommendation. Used for SMS connections. */ phoneNumber?: pulumi.Input; /** * Indicates whether the phone number has been verified. */ phoneVerified?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ picture?: pulumi.Input; /** * ID of the user. */ userId?: pulumi.Input; /** * 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. */ userMetadata?: pulumi.Input; /** * Username of the user. Only valid if the connection requires a username. */ username?: pulumi.Input; /** * Indicates whether the user will receive a verification email after creation. Overrides behavior of `emailVerified` parameter. */ verifyEmail?: pulumi.Input; } /** * The set of arguments for constructing a User resource. */ export interface UserArgs { /** * 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. */ appMetadata?: pulumi.Input; /** * Indicates whether the user is blocked or not. */ blocked?: pulumi.Input; /** * Name of the connection from which the user information was sourced. */ connectionName: pulumi.Input; /** * Sets the `Auth0-Custom-Domain` header on all requests for this resource. Global setting of provider takes precedence over resource specific param, if both are set. */ customDomainHeader?: pulumi.Input; /** * Email address of the user. */ email?: pulumi.Input; /** * Indicates whether the email address has been verified. */ emailVerified?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ familyName?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ givenName?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ name?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ nickname?: pulumi.Input; /** * Initial password for this user. Required for non-passwordless connections (SMS and email). */ password?: pulumi.Input; /** * Phone number for the user; follows the E.164 recommendation. Used for SMS connections. */ phoneNumber?: pulumi.Input; /** * Indicates whether the phone number has been verified. */ phoneVerified?: pulumi.Input; /** * 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](https://auth0.com/docs/manage-users/user-accounts/user-profiles/configure-connection-sync-with-auth0). */ picture?: pulumi.Input; /** * ID of the user. */ userId?: pulumi.Input; /** * 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. */ userMetadata?: pulumi.Input; /** * Username of the user. Only valid if the connection requires a username. */ username?: pulumi.Input; /** * Indicates whether the user will receive a verification email after creation. Overrides behavior of `emailVerified` parameter. */ verifyEmail?: pulumi.Input; }