authentik 2025.2.0, Mar 24 25

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.StageEmail

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

Example Usage

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

const name = new authentik.StageEmail("name", {});

import pulumi
import pulumi_authentik as authentik

name = authentik.StageEmail("name")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authentik.NewStageEmail(ctx, "name", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var name = new Authentik.StageEmail("name");

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.StageEmail;
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 name = new StageEmail("name");

    }
}

resources:
  name:
    type: authentik:StageEmail

Create StageEmail Resource

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

Constructor syntax

new StageEmail(name: string, args?: StageEmailArgs, opts?: CustomResourceOptions);

@overload
def StageEmail(resource_name: str,
               args: Optional[StageEmailArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def StageEmail(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               activate_user_on_success: Optional[bool] = None,
               from_address: Optional[str] = None,
               host: Optional[str] = None,
               name: Optional[str] = None,
               password: Optional[str] = None,
               port: Optional[float] = None,
               stage_email_id: Optional[str] = None,
               subject: Optional[str] = None,
               template: Optional[str] = None,
               timeout: Optional[float] = None,
               token_expiry: Optional[float] = None,
               use_global_settings: Optional[bool] = None,
               use_ssl: Optional[bool] = None,
               use_tls: Optional[bool] = None,
               username: Optional[str] = None)

func NewStageEmail(ctx *Context, name string, args *StageEmailArgs, opts ...ResourceOption) (*StageEmail, error)

public StageEmail(string name, StageEmailArgs? args = null, CustomResourceOptions? opts = null)

public StageEmail(String name, StageEmailArgs args)
public StageEmail(String name, StageEmailArgs args, CustomResourceOptions options)

type: authentik:StageEmail
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 StageEmailArgs: 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 StageEmailArgs: 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 StageEmailArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StageEmailArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StageEmailArgs: 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 stageEmailResource = new Authentik.StageEmail("stageEmailResource", new()
{
    ActivateUserOnSuccess = false,
    FromAddress = "string",
    Host = "string",
    Name = "string",
    Password = "string",
    Port = 0,
    StageEmailId = "string",
    Subject = "string",
    Template = "string",
    Timeout = 0,
    TokenExpiry = 0,
    UseGlobalSettings = false,
    UseSsl = false,
    UseTls = false,
    Username = "string",
});

example, err := authentik.NewStageEmail(ctx, "stageEmailResource", &authentik.StageEmailArgs{
	ActivateUserOnSuccess: pulumi.Bool(false),
	FromAddress:           pulumi.String("string"),
	Host:                  pulumi.String("string"),
	Name:                  pulumi.String("string"),
	Password:              pulumi.String("string"),
	Port:                  pulumi.Float64(0),
	StageEmailId:          pulumi.String("string"),
	Subject:               pulumi.String("string"),
	Template:              pulumi.String("string"),
	Timeout:               pulumi.Float64(0),
	TokenExpiry:           pulumi.Float64(0),
	UseGlobalSettings:     pulumi.Bool(false),
	UseSsl:                pulumi.Bool(false),
	UseTls:                pulumi.Bool(false),
	Username:              pulumi.String("string"),
})

var stageEmailResource = new StageEmail("stageEmailResource", StageEmailArgs.builder()
    .activateUserOnSuccess(false)
    .fromAddress("string")
    .host("string")
    .name("string")
    .password("string")
    .port(0)
    .stageEmailId("string")
    .subject("string")
    .template("string")
    .timeout(0)
    .tokenExpiry(0)
    .useGlobalSettings(false)
    .useSsl(false)
    .useTls(false)
    .username("string")
    .build());

stage_email_resource = authentik.StageEmail("stageEmailResource",
    activate_user_on_success=False,
    from_address="string",
    host="string",
    name="string",
    password="string",
    port=0,
    stage_email_id="string",
    subject="string",
    template="string",
    timeout=0,
    token_expiry=0,
    use_global_settings=False,
    use_ssl=False,
    use_tls=False,
    username="string")

const stageEmailResource = new authentik.StageEmail("stageEmailResource", {
    activateUserOnSuccess: false,
    fromAddress: "string",
    host: "string",
    name: "string",
    password: "string",
    port: 0,
    stageEmailId: "string",
    subject: "string",
    template: "string",
    timeout: 0,
    tokenExpiry: 0,
    useGlobalSettings: false,
    useSsl: false,
    useTls: false,
    username: "string",
});

type: authentik:StageEmail
properties:
    activateUserOnSuccess: false
    fromAddress: string
    host: string
    name: string
    password: string
    port: 0
    stageEmailId: string
    subject: string
    template: string
    timeout: 0
    tokenExpiry: 0
    useGlobalSettings: false
    useSsl: false
    useTls: false
    username: string

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

ActivateUserOnSuccess bool: Defaults to false.
FromAddress string: Defaults to system@authentik.local.
Host string: Defaults to localhost.
Name string
Password string
Port double: Defaults to 25.
StageEmailId 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 double: Defaults to 30.
UseGlobalSettings bool: Defaults to true.
UseSsl bool
UseTls bool
Username string

ActivateUserOnSuccess bool: Defaults to false.
FromAddress string: Defaults to system@authentik.local.
Host string: Defaults to localhost.
Name string
Password string
Port float64: Defaults to 25.
StageEmailId 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 float64: Defaults to 30.
UseGlobalSettings bool: Defaults to true.
UseSsl bool
UseTls bool
Username string

activateUserOnSuccess Boolean: Defaults to false.
fromAddress String: Defaults to system@authentik.local.
host String: Defaults to localhost.
name String
password String
port Double: Defaults to 25.
stageEmailId 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 Double: Defaults to 30.
useGlobalSettings Boolean: Defaults to true.
useSsl Boolean
useTls Boolean
username String

activateUserOnSuccess boolean: Defaults to false.
fromAddress string: Defaults to system@authentik.local.
host string: Defaults to localhost.
name string
password string
port number: Defaults to 25.
stageEmailId 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 number: Defaults to 30.
useGlobalSettings boolean: Defaults to true.
useSsl boolean
useTls boolean
username string

activate_user_on_success bool: Defaults to false.
from_address str: Defaults to system@authentik.local.
host str: Defaults to localhost.
name str
password str
port float: Defaults to 25.
stage_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 float: Defaults to 30.
use_global_settings bool: Defaults to true.
use_ssl bool
use_tls bool
username str

activateUserOnSuccess Boolean: Defaults to false.
fromAddress String: Defaults to system@authentik.local.
host String: Defaults to localhost.
name String
password String
port Number: Defaults to 25.
stageEmailId 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 Number: Defaults to 30.
useGlobalSettings Boolean: Defaults to true.
useSsl Boolean
useTls Boolean
username String

Outputs

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

Get an existing StageEmail 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?: StageEmailState, opts?: CustomResourceOptions): StageEmail

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activate_user_on_success: Optional[bool] = None,
        from_address: Optional[str] = None,
        host: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[float] = None,
        stage_email_id: Optional[str] = None,
        subject: Optional[str] = None,
        template: Optional[str] = None,
        timeout: Optional[float] = None,
        token_expiry: Optional[float] = None,
        use_global_settings: Optional[bool] = None,
        use_ssl: Optional[bool] = None,
        use_tls: Optional[bool] = None,
        username: Optional[str] = None) -> StageEmail

func GetStageEmail(ctx *Context, name string, id IDInput, state *StageEmailState, opts ...ResourceOption) (*StageEmail, error)

public static StageEmail Get(string name, Input<string> id, StageEmailState? state, CustomResourceOptions? opts = null)

public static StageEmail get(String name, Output<String> id, StageEmailState state, CustomResourceOptions options)

resources:  _:    type: authentik:StageEmail    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:

ActivateUserOnSuccess bool: Defaults to false.
FromAddress string: Defaults to system@authentik.local.
Host string: Defaults to localhost.
Name string
Password string
Port double: Defaults to 25.
StageEmailId 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 double: Defaults to 30.
UseGlobalSettings bool: Defaults to true.
UseSsl bool
UseTls bool
Username string

ActivateUserOnSuccess bool: Defaults to false.
FromAddress string: Defaults to system@authentik.local.
Host string: Defaults to localhost.
Name string
Password string
Port float64: Defaults to 25.
StageEmailId 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 float64: Defaults to 30.
UseGlobalSettings bool: Defaults to true.
UseSsl bool
UseTls bool
Username string

activateUserOnSuccess Boolean: Defaults to false.
fromAddress String: Defaults to system@authentik.local.
host String: Defaults to localhost.
name String
password String
port Double: Defaults to 25.
stageEmailId 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 Double: Defaults to 30.
useGlobalSettings Boolean: Defaults to true.
useSsl Boolean
useTls Boolean
username String

activateUserOnSuccess boolean: Defaults to false.
fromAddress string: Defaults to system@authentik.local.
host string: Defaults to localhost.
name string
password string
port number: Defaults to 25.
stageEmailId 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 number: Defaults to 30.
useGlobalSettings boolean: Defaults to true.
useSsl boolean
useTls boolean
username string

activate_user_on_success bool: Defaults to false.
from_address str: Defaults to system@authentik.local.
host str: Defaults to localhost.
name str
password str
port float: Defaults to 25.
stage_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 float: Defaults to 30.
use_global_settings bool: Defaults to true.
use_ssl bool
use_tls bool
username str

activateUserOnSuccess Boolean: Defaults to false.
fromAddress String: Defaults to system@authentik.local.
host String: Defaults to localhost.
name String
password String
port Number: Defaults to 25.
stageEmailId 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 Number: Defaults to 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 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

goauthentik/terraform-provider-authentik

authentik.StageEmail

On this page

On this page

Example Usage

Create StageEmail Resource

Constructor syntax

Parameters

Constructor example

StageEmail Resource Properties

Inputs

Outputs

Look up Existing StageEmail Resource

Package Details

On this page

On this page