Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthUserAction
FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthUserAction

Explore with Pulumi AI

FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth

# User Action Resource

User Actions API

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";

const example = new fusionauth.FusionAuthUserAction("example", {
    preventLogin: true,
    temporal: true,
});
Copy
import pulumi
import theogravity_pulumi_fusionauth as fusionauth

example = fusionauth.FusionAuthUserAction("example",
    prevent_login=True,
    temporal=True)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.NewFusionAuthUserAction(ctx, "example", &fusionauth.FusionAuthUserActionArgs{
			PreventLogin: pulumi.Bool(true),
			Temporal:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var example = new Fusionauth.FusionAuthUserAction("example", new()
    {
        PreventLogin = true,
        Temporal = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthUserAction;
import com.pulumi.fusionauth.FusionAuthUserActionArgs;
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 example = new FusionAuthUserAction("example", FusionAuthUserActionArgs.builder()
            .preventLogin(true)
            .temporal(true)
            .build());

    }
}
Copy
resources:
  example:
    type: fusionauth:FusionAuthUserAction
    properties:
      preventLogin: true
      temporal: true
Copy

Create FusionAuthUserAction Resource

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

Constructor syntax

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

@overload
def FusionAuthUserAction(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         cancel_email_template_id: Optional[str] = None,
                         end_email_template_id: Optional[str] = None,
                         include_email_in_event_json: Optional[bool] = None,
                         localized_names: Optional[Mapping[str, str]] = None,
                         modify_email_template_id: Optional[str] = None,
                         name: Optional[str] = None,
                         options: Optional[Sequence[FusionAuthUserActionOptionArgs]] = None,
                         prevent_login: Optional[bool] = None,
                         send_end_event: Optional[bool] = None,
                         start_email_template_id: Optional[str] = None,
                         temporal: Optional[bool] = None,
                         user_action_id: Optional[str] = None,
                         user_emailing_enabled: Optional[bool] = None,
                         user_notifications_enabled: Optional[bool] = None)
func NewFusionAuthUserAction(ctx *Context, name string, args *FusionAuthUserActionArgs, opts ...ResourceOption) (*FusionAuthUserAction, error)
public FusionAuthUserAction(string name, FusionAuthUserActionArgs? args = null, CustomResourceOptions? opts = null)
public FusionAuthUserAction(String name, FusionAuthUserActionArgs args)
public FusionAuthUserAction(String name, FusionAuthUserActionArgs args, CustomResourceOptions options)

type: fusionauth:FusionAuthUserAction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args FusionAuthUserActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args FusionAuthUserActionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args FusionAuthUserActionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args FusionAuthUserActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FusionAuthUserActionArgs
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 fusionAuthUserActionResource = new Fusionauth.FusionAuthUserAction("fusionAuthUserActionResource", new()
{
    CancelEmailTemplateId = "string",
    EndEmailTemplateId = "string",
    IncludeEmailInEventJson = false,
    LocalizedNames = 
    {
        { "string", "string" },
    },
    ModifyEmailTemplateId = "string",
    Name = "string",
    Options = new[]
    {
        new Fusionauth.Inputs.FusionAuthUserActionOptionArgs
        {
            Name = "string",
            LocalizedNames = 
            {
                { "string", "string" },
            },
        },
    },
    PreventLogin = false,
    SendEndEvent = false,
    StartEmailTemplateId = "string",
    Temporal = false,
    UserActionId = "string",
    UserEmailingEnabled = false,
    UserNotificationsEnabled = false,
});
Copy
example, err := fusionauth.NewFusionAuthUserAction(ctx, "fusionAuthUserActionResource", &fusionauth.FusionAuthUserActionArgs{
	CancelEmailTemplateId:   pulumi.String("string"),
	EndEmailTemplateId:      pulumi.String("string"),
	IncludeEmailInEventJson: pulumi.Bool(false),
	LocalizedNames: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ModifyEmailTemplateId: pulumi.String("string"),
	Name:                  pulumi.String("string"),
	Options: fusionauth.FusionAuthUserActionOptionArray{
		&fusionauth.FusionAuthUserActionOptionArgs{
			Name: pulumi.String("string"),
			LocalizedNames: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	PreventLogin:             pulumi.Bool(false),
	SendEndEvent:             pulumi.Bool(false),
	StartEmailTemplateId:     pulumi.String("string"),
	Temporal:                 pulumi.Bool(false),
	UserActionId:             pulumi.String("string"),
	UserEmailingEnabled:      pulumi.Bool(false),
	UserNotificationsEnabled: pulumi.Bool(false),
})
Copy
var fusionAuthUserActionResource = new FusionAuthUserAction("fusionAuthUserActionResource", FusionAuthUserActionArgs.builder()
    .cancelEmailTemplateId("string")
    .endEmailTemplateId("string")
    .includeEmailInEventJson(false)
    .localizedNames(Map.of("string", "string"))
    .modifyEmailTemplateId("string")
    .name("string")
    .options(FusionAuthUserActionOptionArgs.builder()
        .name("string")
        .localizedNames(Map.of("string", "string"))
        .build())
    .preventLogin(false)
    .sendEndEvent(false)
    .startEmailTemplateId("string")
    .temporal(false)
    .userActionId("string")
    .userEmailingEnabled(false)
    .userNotificationsEnabled(false)
    .build());
Copy
fusion_auth_user_action_resource = fusionauth.FusionAuthUserAction("fusionAuthUserActionResource",
    cancel_email_template_id="string",
    end_email_template_id="string",
    include_email_in_event_json=False,
    localized_names={
        "string": "string",
    },
    modify_email_template_id="string",
    name="string",
    options=[{
        "name": "string",
        "localized_names": {
            "string": "string",
        },
    }],
    prevent_login=False,
    send_end_event=False,
    start_email_template_id="string",
    temporal=False,
    user_action_id="string",
    user_emailing_enabled=False,
    user_notifications_enabled=False)
Copy
const fusionAuthUserActionResource = new fusionauth.FusionAuthUserAction("fusionAuthUserActionResource", {
    cancelEmailTemplateId: "string",
    endEmailTemplateId: "string",
    includeEmailInEventJson: false,
    localizedNames: {
        string: "string",
    },
    modifyEmailTemplateId: "string",
    name: "string",
    options: [{
        name: "string",
        localizedNames: {
            string: "string",
        },
    }],
    preventLogin: false,
    sendEndEvent: false,
    startEmailTemplateId: "string",
    temporal: false,
    userActionId: "string",
    userEmailingEnabled: false,
    userNotificationsEnabled: false,
});
Copy
type: fusionauth:FusionAuthUserAction
properties:
    cancelEmailTemplateId: string
    endEmailTemplateId: string
    includeEmailInEventJson: false
    localizedNames:
        string: string
    modifyEmailTemplateId: string
    name: string
    options:
        - localizedNames:
            string: string
          name: string
    preventLogin: false
    sendEndEvent: false
    startEmailTemplateId: string
    temporal: false
    userActionId: string
    userEmailingEnabled: false
    userNotificationsEnabled: false
Copy

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

CancelEmailTemplateId string
The Id of the Email Template that is used when User Actions are canceled.
EndEmailTemplateId string
The Id of the Email Template that is used when User Actions expired automatically (end).
IncludeEmailInEventJson bool
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
LocalizedNames Dictionary<string, string>
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
ModifyEmailTemplateId string
The Id of the Email Template that is used when User Actions are modified.
Name string
The name of this User Action.
Options List<theogravity.Fusionauth.Inputs.FusionAuthUserActionOption>
The list of User Action Options.
PreventLogin bool
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
SendEndEvent bool
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
StartEmailTemplateId string
The Id of the Email Template that is used when User Actions are started (created).
Temporal bool
Whether or not this User Action is time-based (temporal).
UserActionId string
The id of this User Action.
UserEmailingEnabled bool
Whether or not email is enabled for this User Action.
UserNotificationsEnabled bool
Whether or not user notifications are enabled for this User Action.
CancelEmailTemplateId string
The Id of the Email Template that is used when User Actions are canceled.
EndEmailTemplateId string
The Id of the Email Template that is used when User Actions expired automatically (end).
IncludeEmailInEventJson bool
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
LocalizedNames map[string]string
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
ModifyEmailTemplateId string
The Id of the Email Template that is used when User Actions are modified.
Name string
The name of this User Action.
Options []FusionAuthUserActionOptionArgs
The list of User Action Options.
PreventLogin bool
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
SendEndEvent bool
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
StartEmailTemplateId string
The Id of the Email Template that is used when User Actions are started (created).
Temporal bool
Whether or not this User Action is time-based (temporal).
UserActionId string
The id of this User Action.
UserEmailingEnabled bool
Whether or not email is enabled for this User Action.
UserNotificationsEnabled bool
Whether or not user notifications are enabled for this User Action.
cancelEmailTemplateId String
The Id of the Email Template that is used when User Actions are canceled.
endEmailTemplateId String
The Id of the Email Template that is used when User Actions expired automatically (end).
includeEmailInEventJson Boolean
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localizedNames Map<String,String>
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modifyEmailTemplateId String
The Id of the Email Template that is used when User Actions are modified.
name String
The name of this User Action.
options List<FusionAuthUserActionOption>
The list of User Action Options.
preventLogin Boolean
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
sendEndEvent Boolean
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
startEmailTemplateId String
The Id of the Email Template that is used when User Actions are started (created).
temporal Boolean
Whether or not this User Action is time-based (temporal).
userActionId String
The id of this User Action.
userEmailingEnabled Boolean
Whether or not email is enabled for this User Action.
userNotificationsEnabled Boolean
Whether or not user notifications are enabled for this User Action.
cancelEmailTemplateId string
The Id of the Email Template that is used when User Actions are canceled.
endEmailTemplateId string
The Id of the Email Template that is used when User Actions expired automatically (end).
includeEmailInEventJson boolean
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localizedNames {[key: string]: string}
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modifyEmailTemplateId string
The Id of the Email Template that is used when User Actions are modified.
name string
The name of this User Action.
options FusionAuthUserActionOption[]
The list of User Action Options.
preventLogin boolean
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
sendEndEvent boolean
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
startEmailTemplateId string
The Id of the Email Template that is used when User Actions are started (created).
temporal boolean
Whether or not this User Action is time-based (temporal).
userActionId string
The id of this User Action.
userEmailingEnabled boolean
Whether or not email is enabled for this User Action.
userNotificationsEnabled boolean
Whether or not user notifications are enabled for this User Action.
cancel_email_template_id str
The Id of the Email Template that is used when User Actions are canceled.
end_email_template_id str
The Id of the Email Template that is used when User Actions expired automatically (end).
include_email_in_event_json bool
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localized_names Mapping[str, str]
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modify_email_template_id str
The Id of the Email Template that is used when User Actions are modified.
name str
The name of this User Action.
options Sequence[FusionAuthUserActionOptionArgs]
The list of User Action Options.
prevent_login bool
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
send_end_event bool
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
start_email_template_id str
The Id of the Email Template that is used when User Actions are started (created).
temporal bool
Whether or not this User Action is time-based (temporal).
user_action_id str
The id of this User Action.
user_emailing_enabled bool
Whether or not email is enabled for this User Action.
user_notifications_enabled bool
Whether or not user notifications are enabled for this User Action.
cancelEmailTemplateId String
The Id of the Email Template that is used when User Actions are canceled.
endEmailTemplateId String
The Id of the Email Template that is used when User Actions expired automatically (end).
includeEmailInEventJson Boolean
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localizedNames Map<String>
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modifyEmailTemplateId String
The Id of the Email Template that is used when User Actions are modified.
name String
The name of this User Action.
options List<Property Map>
The list of User Action Options.
preventLogin Boolean
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
sendEndEvent Boolean
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
startEmailTemplateId String
The Id of the Email Template that is used when User Actions are started (created).
temporal Boolean
Whether or not this User Action is time-based (temporal).
userActionId String
The id of this User Action.
userEmailingEnabled Boolean
Whether or not email is enabled for this User Action.
userNotificationsEnabled Boolean
Whether or not user notifications are enabled for this User Action.

Outputs

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

Get an existing FusionAuthUserAction 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?: FusionAuthUserActionState, opts?: CustomResourceOptions): FusionAuthUserAction
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cancel_email_template_id: Optional[str] = None,
        end_email_template_id: Optional[str] = None,
        include_email_in_event_json: Optional[bool] = None,
        localized_names: Optional[Mapping[str, str]] = None,
        modify_email_template_id: Optional[str] = None,
        name: Optional[str] = None,
        options: Optional[Sequence[FusionAuthUserActionOptionArgs]] = None,
        prevent_login: Optional[bool] = None,
        send_end_event: Optional[bool] = None,
        start_email_template_id: Optional[str] = None,
        temporal: Optional[bool] = None,
        user_action_id: Optional[str] = None,
        user_emailing_enabled: Optional[bool] = None,
        user_notifications_enabled: Optional[bool] = None) -> FusionAuthUserAction
func GetFusionAuthUserAction(ctx *Context, name string, id IDInput, state *FusionAuthUserActionState, opts ...ResourceOption) (*FusionAuthUserAction, error)
public static FusionAuthUserAction Get(string name, Input<string> id, FusionAuthUserActionState? state, CustomResourceOptions? opts = null)
public static FusionAuthUserAction get(String name, Output<String> id, FusionAuthUserActionState state, CustomResourceOptions options)
resources:  _:    type: fusionauth:FusionAuthUserAction    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CancelEmailTemplateId string
The Id of the Email Template that is used when User Actions are canceled.
EndEmailTemplateId string
The Id of the Email Template that is used when User Actions expired automatically (end).
IncludeEmailInEventJson bool
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
LocalizedNames Dictionary<string, string>
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
ModifyEmailTemplateId string
The Id of the Email Template that is used when User Actions are modified.
Name string
The name of this User Action.
Options List<theogravity.Fusionauth.Inputs.FusionAuthUserActionOption>
The list of User Action Options.
PreventLogin bool
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
SendEndEvent bool
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
StartEmailTemplateId string
The Id of the Email Template that is used when User Actions are started (created).
Temporal bool
Whether or not this User Action is time-based (temporal).
UserActionId string
The id of this User Action.
UserEmailingEnabled bool
Whether or not email is enabled for this User Action.
UserNotificationsEnabled bool
Whether or not user notifications are enabled for this User Action.
CancelEmailTemplateId string
The Id of the Email Template that is used when User Actions are canceled.
EndEmailTemplateId string
The Id of the Email Template that is used when User Actions expired automatically (end).
IncludeEmailInEventJson bool
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
LocalizedNames map[string]string
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
ModifyEmailTemplateId string
The Id of the Email Template that is used when User Actions are modified.
Name string
The name of this User Action.
Options []FusionAuthUserActionOptionArgs
The list of User Action Options.
PreventLogin bool
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
SendEndEvent bool
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
StartEmailTemplateId string
The Id of the Email Template that is used when User Actions are started (created).
Temporal bool
Whether or not this User Action is time-based (temporal).
UserActionId string
The id of this User Action.
UserEmailingEnabled bool
Whether or not email is enabled for this User Action.
UserNotificationsEnabled bool
Whether or not user notifications are enabled for this User Action.
cancelEmailTemplateId String
The Id of the Email Template that is used when User Actions are canceled.
endEmailTemplateId String
The Id of the Email Template that is used when User Actions expired automatically (end).
includeEmailInEventJson Boolean
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localizedNames Map<String,String>
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modifyEmailTemplateId String
The Id of the Email Template that is used when User Actions are modified.
name String
The name of this User Action.
options List<FusionAuthUserActionOption>
The list of User Action Options.
preventLogin Boolean
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
sendEndEvent Boolean
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
startEmailTemplateId String
The Id of the Email Template that is used when User Actions are started (created).
temporal Boolean
Whether or not this User Action is time-based (temporal).
userActionId String
The id of this User Action.
userEmailingEnabled Boolean
Whether or not email is enabled for this User Action.
userNotificationsEnabled Boolean
Whether or not user notifications are enabled for this User Action.
cancelEmailTemplateId string
The Id of the Email Template that is used when User Actions are canceled.
endEmailTemplateId string
The Id of the Email Template that is used when User Actions expired automatically (end).
includeEmailInEventJson boolean
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localizedNames {[key: string]: string}
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modifyEmailTemplateId string
The Id of the Email Template that is used when User Actions are modified.
name string
The name of this User Action.
options FusionAuthUserActionOption[]
The list of User Action Options.
preventLogin boolean
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
sendEndEvent boolean
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
startEmailTemplateId string
The Id of the Email Template that is used when User Actions are started (created).
temporal boolean
Whether or not this User Action is time-based (temporal).
userActionId string
The id of this User Action.
userEmailingEnabled boolean
Whether or not email is enabled for this User Action.
userNotificationsEnabled boolean
Whether or not user notifications are enabled for this User Action.
cancel_email_template_id str
The Id of the Email Template that is used when User Actions are canceled.
end_email_template_id str
The Id of the Email Template that is used when User Actions expired automatically (end).
include_email_in_event_json bool
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localized_names Mapping[str, str]
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modify_email_template_id str
The Id of the Email Template that is used when User Actions are modified.
name str
The name of this User Action.
options Sequence[FusionAuthUserActionOptionArgs]
The list of User Action Options.
prevent_login bool
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
send_end_event bool
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
start_email_template_id str
The Id of the Email Template that is used when User Actions are started (created).
temporal bool
Whether or not this User Action is time-based (temporal).
user_action_id str
The id of this User Action.
user_emailing_enabled bool
Whether or not email is enabled for this User Action.
user_notifications_enabled bool
Whether or not user notifications are enabled for this User Action.
cancelEmailTemplateId String
The Id of the Email Template that is used when User Actions are canceled.
endEmailTemplateId String
The Id of the Email Template that is used when User Actions expired automatically (end).
includeEmailInEventJson Boolean
Whether to include the email information in the JSON that is sent to the Webhook when a user action is taken.
localizedNames Map<String>
A mapping of localized names for this User Action. The key is the Locale and the value is the name of the User Action for that language.
modifyEmailTemplateId String
The Id of the Email Template that is used when User Actions are modified.
name String
The name of this User Action.
options List<Property Map>
The list of User Action Options.
preventLogin Boolean
Whether or not this User Action will prevent user login. When this value is set to true the action must also be marked as a time based action. See temporal.
sendEndEvent Boolean
Whether or not FusionAuth will send events to any registered Webhooks when this User Action expires.
startEmailTemplateId String
The Id of the Email Template that is used when User Actions are started (created).
temporal Boolean
Whether or not this User Action is time-based (temporal).
userActionId String
The id of this User Action.
userEmailingEnabled Boolean
Whether or not email is enabled for this User Action.
userNotificationsEnabled Boolean
Whether or not user notifications are enabled for this User Action.

Supporting Types

FusionAuthUserActionOption
, FusionAuthUserActionOptionArgs

Name This property is required. string
The name of this User Action Option.
LocalizedNames Dictionary<string, string>
A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.
Name This property is required. string
The name of this User Action Option.
LocalizedNames map[string]string
A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.
name This property is required. String
The name of this User Action Option.
localizedNames Map<String,String>
A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.
name This property is required. string
The name of this User Action Option.
localizedNames {[key: string]: string}
A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.
name This property is required. str
The name of this User Action Option.
localized_names Mapping[str, str]
A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.
name This property is required. String
The name of this User Action Option.
localizedNames Map<String>
A mapping of localized names for this User Action Option. The key is the Locale and the value is the name of the User Action Option for that language.

Package Details

Repository
fusionauth theogravity/pulumi-fusionauth
License
MIT
Notes
This Pulumi package is based on the fusionauth Terraform Provider.
FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth