Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. StageAuthenticatorEmail
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.StageAuthenticatorEmail

Explore with Pulumi AI

authentik logo
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

    Create StageAuthenticatorEmail Resource

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

    Constructor syntax

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

@overload
def StageAuthenticatorEmail(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            configure_flow: Optional[str] = None,
                            friendly_name: Optional[str] = None,
                            from_address: Optional[str] = None,
                            host: Optional[str] = None,
                            name: Optional[str] = None,
                            password: Optional[str] = None,
                            port: Optional[float] = None,
                            stage_authenticator_email_id: Optional[str] = None,
                            subject: Optional[str] = None,
                            template: Optional[str] = None,
                            timeout: Optional[float] = None,
                            token_expiry: Optional[str] = None,
                            use_global_settings: Optional[bool] = None,
                            use_ssl: Optional[bool] = None,
                            use_tls: Optional[bool] = None,
                            username: Optional[str] = None)
    func NewStageAuthenticatorEmail(ctx *Context, name string, args *StageAuthenticatorEmailArgs, opts ...ResourceOption) (*StageAuthenticatorEmail, error)
    public StageAuthenticatorEmail(string name, StageAuthenticatorEmailArgs? args = null, CustomResourceOptions? opts = null)
    public StageAuthenticatorEmail(String name, StageAuthenticatorEmailArgs args)
public StageAuthenticatorEmail(String name, StageAuthenticatorEmailArgs args, CustomResourceOptions options)

    type: authentik:StageAuthenticatorEmail
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 StageAuthenticatorEmailArgs
    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 StageAuthenticatorEmailArgs
    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 StageAuthenticatorEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StageAuthenticatorEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StageAuthenticatorEmailArgs
    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 stageAuthenticatorEmailResource = new Authentik.StageAuthenticatorEmail("stageAuthenticatorEmailResource", new()
{
    ConfigureFlow = "string",
    FriendlyName = "string",
    FromAddress = "string",
    Host = "string",
    Name = "string",
    Password = "string",
    Port = 0,
    StageAuthenticatorEmailId = "string",
    Subject = "string",
    Template = "string",
    Timeout = 0,
    TokenExpiry = "string",
    UseGlobalSettings = false,
    UseSsl = false,
    UseTls = false,
    Username = "string",
});

    example, err := authentik.NewStageAuthenticatorEmail(ctx, "stageAuthenticatorEmailResource", &authentik.StageAuthenticatorEmailArgs{
	ConfigureFlow:             pulumi.String("string"),
	FriendlyName:              pulumi.String("string"),
	FromAddress:               pulumi.String("string"),
	Host:                      pulumi.String("string"),
	Name:                      pulumi.String("string"),
	Password:                  pulumi.String("string"),
	Port:                      pulumi.Float64(0),
	StageAuthenticatorEmailId: pulumi.String("string"),
	Subject:                   pulumi.String("string"),
	Template:                  pulumi.String("string"),
	Timeout:                   pulumi.Float64(0),
	TokenExpiry:               pulumi.String("string"),
	UseGlobalSettings:         pulumi.Bool(false),
	UseSsl:                    pulumi.Bool(false),
	UseTls:                    pulumi.Bool(false),
	Username:                  pulumi.String("string"),
})

    var stageAuthenticatorEmailResource = new StageAuthenticatorEmail("stageAuthenticatorEmailResource", StageAuthenticatorEmailArgs.builder()
    .configureFlow("string")
    .friendlyName("string")
    .fromAddress("string")
    .host("string")
    .name("string")
    .password("string")
    .port(0)
    .stageAuthenticatorEmailId("string")
    .subject("string")
    .template("string")
    .timeout(0)
    .tokenExpiry("string")
    .useGlobalSettings(false)
    .useSsl(false)
    .useTls(false)
    .username("string")
    .build());

    stage_authenticator_email_resource = authentik.StageAuthenticatorEmail("stageAuthenticatorEmailResource",
    configure_flow="string",
    friendly_name="string",
    from_address="string",
    host="string",
    name="string",
    password="string",
    port=0,
    stage_authenticator_email_id="string",
    subject="string",
    template="string",
    timeout=0,
    token_expiry="string",
    use_global_settings=False,
    use_ssl=False,
    use_tls=False,
    username="string")

    const stageAuthenticatorEmailResource = new authentik.StageAuthenticatorEmail("stageAuthenticatorEmailResource", {
    configureFlow: "string",
    friendlyName: "string",
    fromAddress: "string",
    host: "string",
    name: "string",
    password: "string",
    port: 0,
    stageAuthenticatorEmailId: "string",
    subject: "string",
    template: "string",
    timeout: 0,
    tokenExpiry: "string",
    useGlobalSettings: false,
    useSsl: false,
    useTls: false,
    username: "string",
});

    type: authentik:StageAuthenticatorEmail
properties:
    configureFlow: string
    friendlyName: string
    fromAddress: string
    host: string
    name: string
    password: string
    port: 0
    stageAuthenticatorEmailId: string
    subject: string
    template: string
    timeout: 0
    tokenExpiry: string
    useGlobalSettings: false
    useSsl: false
    useTls: false
    username: string

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

    ConfigureFlow string
    FriendlyName string
    FromAddress string
    Defaults to system@authentik.local.
    Host string
    Defaults to localhost.
    Name string
    Password string
    Port double
    Defaults to 25.
    StageAuthenticatorEmailId string
    The ID of this resource.
    Subject string
    Defaults to authentik.
    Template string
    Defaults to email/password_reset.html.
    Timeout double
    Defaults to 30.
    TokenExpiry string
    Defaults to minutes=30.
    UseGlobalSettings bool
    Defaults to true.
    UseSsl bool
    UseTls bool
    Username string
    ConfigureFlow string
    FriendlyName string
    FromAddress string
    Defaults to system@authentik.local.
    Host string
    Defaults to localhost.
    Name string
    Password string
    Port float64
    Defaults to 25.
    StageAuthenticatorEmailId string
    The ID of this resource.
    Subject string
    Defaults to authentik.
    Template string
    Defaults to email/password_reset.html.
    Timeout float64
    Defaults to 30.
    TokenExpiry string
    Defaults to minutes=30.
    UseGlobalSettings bool
    Defaults to true.
    UseSsl bool
    UseTls bool
    Username string
    configureFlow String
    friendlyName String
    fromAddress String
    Defaults to system@authentik.local.
    host String
    Defaults to localhost.
    name String
    password String
    port Double
    Defaults to 25.
    stageAuthenticatorEmailId String
    The ID of this resource.
    subject String
    Defaults to authentik.
    template String
    Defaults to email/password_reset.html.
    timeout Double
    Defaults to 30.
    tokenExpiry String
    Defaults to minutes=30.
    useGlobalSettings Boolean
    Defaults to true.
    useSsl Boolean
    useTls Boolean
    username String
    configureFlow string
    friendlyName string
    fromAddress string
    Defaults to system@authentik.local.
    host string
    Defaults to localhost.
    name string
    password string
    port number
    Defaults to 25.
    stageAuthenticatorEmailId string
    The ID of this resource.
    subject string
    Defaults to authentik.
    template string
    Defaults to email/password_reset.html.
    timeout number
    Defaults to 30.
    tokenExpiry string
    Defaults to minutes=30.
    useGlobalSettings boolean
    Defaults to true.
    useSsl boolean
    useTls boolean
    username string
    configure_flow str
    friendly_name str
    from_address str
    Defaults to system@authentik.local.
    host str
    Defaults to localhost.
    name str
    password str
    port float
    Defaults to 25.
    stage_authenticator_email_id str
    The ID of this resource.
    subject str
    Defaults to authentik.
    template str
    Defaults to email/password_reset.html.
    timeout float
    Defaults to 30.
    token_expiry str
    Defaults to minutes=30.
    use_global_settings bool
    Defaults to true.
    use_ssl bool
    use_tls bool
    username str
    configureFlow String
    friendlyName String
    fromAddress String
    Defaults to system@authentik.local.
    host String
    Defaults to localhost.
    name String
    password String
    port Number
    Defaults to 25.
    stageAuthenticatorEmailId String
    The ID of this resource.
    subject String
    Defaults to authentik.
    template String
    Defaults to email/password_reset.html.
    timeout Number
    Defaults to 30.
    tokenExpiry String
    Defaults to minutes=30.
    useGlobalSettings Boolean
    Defaults to true.
    useSsl Boolean
    useTls Boolean
    username String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StageAuthenticatorEmail 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 StageAuthenticatorEmail Resource

    Get an existing StageAuthenticatorEmail 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?: StageAuthenticatorEmailState, opts?: CustomResourceOptions): StageAuthenticatorEmail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configure_flow: Optional[str] = None,
        friendly_name: Optional[str] = None,
        from_address: Optional[str] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[float] = None,
        stage_authenticator_email_id: Optional[str] = None,
        subject: Optional[str] = None,
        template: Optional[str] = None,
        timeout: Optional[float] = None,
        token_expiry: Optional[str] = None,
        use_global_settings: Optional[bool] = None,
        use_ssl: Optional[bool] = None,
        use_tls: Optional[bool] = None,
        username: Optional[str] = None) -> StageAuthenticatorEmail
    func GetStageAuthenticatorEmail(ctx *Context, name string, id IDInput, state *StageAuthenticatorEmailState, opts ...ResourceOption) (*StageAuthenticatorEmail, error)
    public static StageAuthenticatorEmail Get(string name, Input<string> id, StageAuthenticatorEmailState? state, CustomResourceOptions? opts = null)
    public static StageAuthenticatorEmail get(String name, Output<String> id, StageAuthenticatorEmailState state, CustomResourceOptions options)
    resources:  _:    type: authentik:StageAuthenticatorEmail    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.
    The following state arguments are supported:
    ConfigureFlow string
    FriendlyName string
    FromAddress string
    Defaults to system@authentik.local.
    Host string
    Defaults to localhost.
    Name string
    Password string
    Port double
    Defaults to 25.
    StageAuthenticatorEmailId string
    The ID of this resource.
    Subject string
    Defaults to authentik.
    Template string
    Defaults to email/password_reset.html.
    Timeout double
    Defaults to 30.
    TokenExpiry string
    Defaults to minutes=30.
    UseGlobalSettings bool
    Defaults to true.
    UseSsl bool
    UseTls bool
    Username string
    ConfigureFlow string
    FriendlyName string
    FromAddress string
    Defaults to system@authentik.local.
    Host string
    Defaults to localhost.
    Name string
    Password string
    Port float64
    Defaults to 25.
    StageAuthenticatorEmailId string
    The ID of this resource.
    Subject string
    Defaults to authentik.
    Template string
    Defaults to email/password_reset.html.
    Timeout float64
    Defaults to 30.
    TokenExpiry string
    Defaults to minutes=30.
    UseGlobalSettings bool
    Defaults to true.
    UseSsl bool
    UseTls bool
    Username string
    configureFlow String
    friendlyName String
    fromAddress String
    Defaults to system@authentik.local.
    host String
    Defaults to localhost.
    name String
    password String
    port Double
    Defaults to 25.
    stageAuthenticatorEmailId String
    The ID of this resource.
    subject String
    Defaults to authentik.
    template String
    Defaults to email/password_reset.html.
    timeout Double
    Defaults to 30.
    tokenExpiry String
    Defaults to minutes=30.
    useGlobalSettings Boolean
    Defaults to true.
    useSsl Boolean
    useTls Boolean
    username String
    configureFlow string
    friendlyName string
    fromAddress string
    Defaults to system@authentik.local.
    host string
    Defaults to localhost.
    name string
    password string
    port number
    Defaults to 25.
    stageAuthenticatorEmailId string
    The ID of this resource.
    subject string
    Defaults to authentik.
    template string
    Defaults to email/password_reset.html.
    timeout number
    Defaults to 30.
    tokenExpiry string
    Defaults to minutes=30.
    useGlobalSettings boolean
    Defaults to true.
    useSsl boolean
    useTls boolean
    username string
    configure_flow str
    friendly_name str
    from_address str
    Defaults to system@authentik.local.
    host str
    Defaults to localhost.
    name str
    password str
    port float
    Defaults to 25.
    stage_authenticator_email_id str
    The ID of this resource.
    subject str
    Defaults to authentik.
    template str
    Defaults to email/password_reset.html.
    timeout float
    Defaults to 30.
    token_expiry str
    Defaults to minutes=30.
    use_global_settings bool
    Defaults to true.
    use_ssl bool
    use_tls bool
    username str
    configureFlow String
    friendlyName String
    fromAddress String
    Defaults to system@authentik.local.
    host String
    Defaults to localhost.
    name String
    password String
    port Number
    Defaults to 25.
    stageAuthenticatorEmailId String
    The ID of this resource.
    subject String
    Defaults to authentik.
    template String
    Defaults to email/password_reset.html.
    timeout Number
    Defaults to 30.
    tokenExpiry String
    Defaults to minutes=30.
    useGlobalSettings Boolean
    Defaults to true.
    useSsl Boolean
    useTls Boolean
    username String

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    authentik logo
    authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
    goauthentik/terraform-provider-authentik