propelauth.BasicAuthConfiguration
Explore with Pulumi AI
Basic Auth Configuration. This is for configuring basic authentication, signup, and user-account-management settings in PropelAuth.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as propelauth from "@pulumi/propelauth";
// Configure basic authentication settings for your PropelAuth project.
const example = new propelauth.BasicAuthConfiguration("example", {
    hasPasswordLogin: true,
    hasPasswordlessLogin: true,
});
import pulumi
import pulumi_propelauth as propelauth
# Configure basic authentication settings for your PropelAuth project.
example = propelauth.BasicAuthConfiguration("example",
    has_password_login=True,
    has_passwordless_login=True)
package main
import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/propelauth/propelauth"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Configure basic authentication settings for your PropelAuth project.
		_, err := propelauth.NewBasicAuthConfiguration(ctx, "example", &propelauth.BasicAuthConfigurationArgs{
			HasPasswordLogin:     pulumi.Bool(true),
			HasPasswordlessLogin: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Propelauth = Pulumi.Propelauth;
return await Deployment.RunAsync(() => 
{
    // Configure basic authentication settings for your PropelAuth project.
    var example = new Propelauth.BasicAuthConfiguration("example", new()
    {
        HasPasswordLogin = true,
        HasPasswordlessLogin = true,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.BasicAuthConfiguration;
import com.pulumi.propelauth.BasicAuthConfigurationArgs;
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) {
        // Configure basic authentication settings for your PropelAuth project.
        var example = new BasicAuthConfiguration("example", BasicAuthConfigurationArgs.builder()
            .hasPasswordLogin(true)
            .hasPasswordlessLogin(true)
            .build());
    }
}
resources:
  # Configure basic authentication settings for your PropelAuth project.
  example:
    type: propelauth:BasicAuthConfiguration
    properties:
      hasPasswordLogin: true
      hasPasswordlessLogin: true
Create BasicAuthConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BasicAuthConfiguration(name: string, args?: BasicAuthConfigurationArgs, opts?: CustomResourceOptions);@overload
def BasicAuthConfiguration(resource_name: str,
                           args: Optional[BasicAuthConfigurationArgs] = None,
                           opts: Optional[ResourceOptions] = None)
@overload
def BasicAuthConfiguration(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           allow_users_to_signup_with_personal_email: Optional[bool] = None,
                           has_password_login: Optional[bool] = None,
                           has_passwordless_login: Optional[bool] = None,
                           include_login_method: Optional[bool] = None,
                           signup_domain_allowlists: Optional[Sequence[str]] = None,
                           signup_domain_blocklists: Optional[Sequence[str]] = None,
                           user_autologout_seconds: Optional[float] = None,
                           user_autologout_type: Optional[str] = None,
                           users_can_change_email: Optional[bool] = None,
                           users_can_delete_own_account: Optional[bool] = None,
                           waitlist_users_enabled: Optional[bool] = None)func NewBasicAuthConfiguration(ctx *Context, name string, args *BasicAuthConfigurationArgs, opts ...ResourceOption) (*BasicAuthConfiguration, error)public BasicAuthConfiguration(string name, BasicAuthConfigurationArgs? args = null, CustomResourceOptions? opts = null)
public BasicAuthConfiguration(String name, BasicAuthConfigurationArgs args)
public BasicAuthConfiguration(String name, BasicAuthConfigurationArgs args, CustomResourceOptions options)
type: propelauth:BasicAuthConfiguration
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 BasicAuthConfigurationArgs
- 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 BasicAuthConfigurationArgs
- 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 BasicAuthConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BasicAuthConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BasicAuthConfigurationArgs
- 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 basicAuthConfigurationResource = new Propelauth.BasicAuthConfiguration("basicAuthConfigurationResource", new()
{
    AllowUsersToSignupWithPersonalEmail = false,
    HasPasswordLogin = false,
    HasPasswordlessLogin = false,
    IncludeLoginMethod = false,
    SignupDomainAllowlists = new[]
    {
        "string",
    },
    SignupDomainBlocklists = new[]
    {
        "string",
    },
    UserAutologoutSeconds = 0,
    UserAutologoutType = "string",
    UsersCanChangeEmail = false,
    UsersCanDeleteOwnAccount = false,
    WaitlistUsersEnabled = false,
});
example, err := propelauth.NewBasicAuthConfiguration(ctx, "basicAuthConfigurationResource", &propelauth.BasicAuthConfigurationArgs{
	AllowUsersToSignupWithPersonalEmail: pulumi.Bool(false),
	HasPasswordLogin:                    pulumi.Bool(false),
	HasPasswordlessLogin:                pulumi.Bool(false),
	IncludeLoginMethod:                  pulumi.Bool(false),
	SignupDomainAllowlists: pulumi.StringArray{
		pulumi.String("string"),
	},
	SignupDomainBlocklists: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserAutologoutSeconds:    pulumi.Float64(0),
	UserAutologoutType:       pulumi.String("string"),
	UsersCanChangeEmail:      pulumi.Bool(false),
	UsersCanDeleteOwnAccount: pulumi.Bool(false),
	WaitlistUsersEnabled:     pulumi.Bool(false),
})
var basicAuthConfigurationResource = new BasicAuthConfiguration("basicAuthConfigurationResource", BasicAuthConfigurationArgs.builder()
    .allowUsersToSignupWithPersonalEmail(false)
    .hasPasswordLogin(false)
    .hasPasswordlessLogin(false)
    .includeLoginMethod(false)
    .signupDomainAllowlists("string")
    .signupDomainBlocklists("string")
    .userAutologoutSeconds(0.0)
    .userAutologoutType("string")
    .usersCanChangeEmail(false)
    .usersCanDeleteOwnAccount(false)
    .waitlistUsersEnabled(false)
    .build());
basic_auth_configuration_resource = propelauth.BasicAuthConfiguration("basicAuthConfigurationResource",
    allow_users_to_signup_with_personal_email=False,
    has_password_login=False,
    has_passwordless_login=False,
    include_login_method=False,
    signup_domain_allowlists=["string"],
    signup_domain_blocklists=["string"],
    user_autologout_seconds=0,
    user_autologout_type="string",
    users_can_change_email=False,
    users_can_delete_own_account=False,
    waitlist_users_enabled=False)
const basicAuthConfigurationResource = new propelauth.BasicAuthConfiguration("basicAuthConfigurationResource", {
    allowUsersToSignupWithPersonalEmail: false,
    hasPasswordLogin: false,
    hasPasswordlessLogin: false,
    includeLoginMethod: false,
    signupDomainAllowlists: ["string"],
    signupDomainBlocklists: ["string"],
    userAutologoutSeconds: 0,
    userAutologoutType: "string",
    usersCanChangeEmail: false,
    usersCanDeleteOwnAccount: false,
    waitlistUsersEnabled: false,
});
type: propelauth:BasicAuthConfiguration
properties:
    allowUsersToSignupWithPersonalEmail: false
    hasPasswordLogin: false
    hasPasswordlessLogin: false
    includeLoginMethod: false
    signupDomainAllowlists:
        - string
    signupDomainBlocklists:
        - string
    userAutologoutSeconds: 0
    userAutologoutType: string
    usersCanChangeEmail: false
    usersCanDeleteOwnAccount: false
    waitlistUsersEnabled: false
BasicAuthConfiguration 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 BasicAuthConfiguration resource accepts the following input properties:
- AllowUsers boolTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- HasPassword boolLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- HasPasswordless boolLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- IncludeLogin boolMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- SignupDomain List<string>Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- SignupDomain List<string>Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- UserAutologout doubleSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- UserAutologout stringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- UsersCan boolChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- UsersCan boolDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- WaitlistUsers boolEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- AllowUsers boolTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- HasPassword boolLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- HasPasswordless boolLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- IncludeLogin boolMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- SignupDomain []stringAllowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- SignupDomain []stringBlocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- UserAutologout float64Seconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- UserAutologout stringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- UsersCan boolChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- UsersCan boolDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- WaitlistUsers boolEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allowUsers BooleanTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- hasPassword BooleanLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- hasPasswordless BooleanLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- includeLogin BooleanMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signupDomain List<String>Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signupDomain List<String>Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- userAutologout DoubleSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- userAutologout StringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- usersCan BooleanChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- usersCan BooleanDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlistUsers BooleanEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allowUsers booleanTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- hasPassword booleanLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- hasPasswordless booleanLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- includeLogin booleanMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signupDomain string[]Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signupDomain string[]Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- userAutologout numberSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- userAutologout stringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- usersCan booleanChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- usersCan booleanDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlistUsers booleanEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allow_users_ boolto_ signup_ with_ personal_ email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- has_password_ boollogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- has_passwordless_ boollogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- include_login_ boolmethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signup_domain_ Sequence[str]allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signup_domain_ Sequence[str]blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- user_autologout_ floatseconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- user_autologout_ strtype 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- users_can_ boolchange_ email 
- If true, your users will be able to change their email address. The default setting is true.
- users_can_ booldelete_ own_ account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlist_users_ boolenabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allowUsers BooleanTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- hasPassword BooleanLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- hasPasswordless BooleanLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- includeLogin BooleanMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signupDomain List<String>Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signupDomain List<String>Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- userAutologout NumberSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- userAutologout StringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- usersCan BooleanChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- usersCan BooleanDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlistUsers BooleanEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
Outputs
All input properties are implicitly available as output properties. Additionally, the BasicAuthConfiguration 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 BasicAuthConfiguration Resource
Get an existing BasicAuthConfiguration 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?: BasicAuthConfigurationState, opts?: CustomResourceOptions): BasicAuthConfiguration@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_users_to_signup_with_personal_email: Optional[bool] = None,
        has_password_login: Optional[bool] = None,
        has_passwordless_login: Optional[bool] = None,
        include_login_method: Optional[bool] = None,
        signup_domain_allowlists: Optional[Sequence[str]] = None,
        signup_domain_blocklists: Optional[Sequence[str]] = None,
        user_autologout_seconds: Optional[float] = None,
        user_autologout_type: Optional[str] = None,
        users_can_change_email: Optional[bool] = None,
        users_can_delete_own_account: Optional[bool] = None,
        waitlist_users_enabled: Optional[bool] = None) -> BasicAuthConfigurationfunc GetBasicAuthConfiguration(ctx *Context, name string, id IDInput, state *BasicAuthConfigurationState, opts ...ResourceOption) (*BasicAuthConfiguration, error)public static BasicAuthConfiguration Get(string name, Input<string> id, BasicAuthConfigurationState? state, CustomResourceOptions? opts = null)public static BasicAuthConfiguration get(String name, Output<String> id, BasicAuthConfigurationState state, CustomResourceOptions options)resources:  _:    type: propelauth:BasicAuthConfiguration    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AllowUsers boolTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- HasPassword boolLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- HasPasswordless boolLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- IncludeLogin boolMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- SignupDomain List<string>Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- SignupDomain List<string>Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- UserAutologout doubleSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- UserAutologout stringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- UsersCan boolChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- UsersCan boolDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- WaitlistUsers boolEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- AllowUsers boolTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- HasPassword boolLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- HasPasswordless boolLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- IncludeLogin boolMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- SignupDomain []stringAllowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- SignupDomain []stringBlocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- UserAutologout float64Seconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- UserAutologout stringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- UsersCan boolChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- UsersCan boolDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- WaitlistUsers boolEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allowUsers BooleanTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- hasPassword BooleanLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- hasPasswordless BooleanLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- includeLogin BooleanMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signupDomain List<String>Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signupDomain List<String>Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- userAutologout DoubleSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- userAutologout StringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- usersCan BooleanChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- usersCan BooleanDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlistUsers BooleanEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allowUsers booleanTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- hasPassword booleanLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- hasPasswordless booleanLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- includeLogin booleanMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signupDomain string[]Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signupDomain string[]Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- userAutologout numberSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- userAutologout stringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- usersCan booleanChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- usersCan booleanDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlistUsers booleanEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allow_users_ boolto_ signup_ with_ personal_ email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- has_password_ boollogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- has_passwordless_ boollogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- include_login_ boolmethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signup_domain_ Sequence[str]allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signup_domain_ Sequence[str]blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- user_autologout_ floatseconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- user_autologout_ strtype 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- users_can_ boolchange_ email 
- If true, your users will be able to change their email address. The default setting is true.
- users_can_ booldelete_ own_ account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlist_users_ boolenabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
- allowUsers BooleanTo Signup With Personal Email 
- If true, your users will be able to sign up using personal email domains (@gmail.com, @yahoo.com, etc.).The default setting is true. This is only enabled if signup_domain_allowlistis empty.
- hasPassword BooleanLogin 
- If true, your users will be able to log in using their email and password. The default setting is true.
- hasPasswordless BooleanLogin 
- If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- includeLogin BooleanMethod 
- If true, the login method will be included in the access token. The default setting is false.See https://docs.propelauth.com/overview/user-management/user-properties#login-method-propertyfor more information.
- signupDomain List<String>Allowlists 
- A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- signupDomain List<String>Blocklists 
- A list of email domains that are blocked from signing up. This is only used if signup_domain_allowlistis empty.Note: This feature is only available on some pricing plans.
- userAutologout NumberSeconds 
- The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "userautologouttype" for more information.
- userAutologout StringType 
- This sets the behavior for when the counting for "userautologoutseconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- usersCan BooleanChange Email 
- If true, your users will be able to change their email address. The default setting is true.
- usersCan BooleanDelete Own Account 
- If true, your users will be able to delete their own account. The default setting is false.
- waitlistUsers BooleanEnabled 
- If true, you will be able to use the APIs to collect emails before launching. The default setting is false.
Import
As there is only one basic_auth_configuration per project there’s no need to specify the id,
$ pulumi import propelauth:index/basicAuthConfiguration:BasicAuthConfiguration but requires an id to be specified, so we can use an arbitrary string here.
$ pulumi import propelauth:index/basicAuthConfiguration:BasicAuthConfiguration example arbitrary_string_here
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- propelauth propelauth/terraform-provider-propelauth
- License
- Notes
- This Pulumi package is based on the propelauthTerraform Provider.