1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthUserAction
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity

fusionauth.FusionAuthUserAction

Explore with Pulumi AI

fusionauth logo
FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity

    # User Action Resource

    User Actions API

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Fusionauth = theogravity.Fusionauth;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Fusionauth.FusionAuthUserAction("example", new()
        {
            PreventLogin = true,
            Temporal = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/theogravity/pulumi-fusionauth/sdk/v3/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
    	})
    }
    
    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());
    
        }
    }
    
    import pulumi
    import theogravity_pulumi-fusionauth as fusionauth
    
    example = fusionauth.FusionAuthUserAction("example",
        prevent_login=True,
        temporal=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as fusionauth from "pulumi-fusionauth";
    
    const example = new fusionauth.FusionAuthUserAction("example", {
        preventLogin: true,
        temporal: true,
    });
    
    resources:
      example:
        type: fusionauth:FusionAuthUserAction
        properties:
          preventLogin: true
          temporal: true
    

    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, Any]] = 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 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 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 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 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 String
    The unique name of the resource.
    args FusionAuthUserActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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", "any" },
        },
        ModifyEmailTemplateId = "string",
        Name = "string",
        Options = new[]
        {
            new Fusionauth.Inputs.FusionAuthUserActionOptionArgs
            {
                Name = "string",
                LocalizedNames = 
                {
                    { "string", "any" },
                },
            },
        },
        PreventLogin = false,
        SendEndEvent = false,
        StartEmailTemplateId = "string",
        Temporal = false,
        UserActionId = "string",
        UserEmailingEnabled = false,
        UserNotificationsEnabled = false,
    });
    
    example, err := fusionauth.NewFusionAuthUserAction(ctx, "fusionAuthUserActionResource", &fusionauth.FusionAuthUserActionArgs{
    	CancelEmailTemplateId:   pulumi.String("string"),
    	EndEmailTemplateId:      pulumi.String("string"),
    	IncludeEmailInEventJson: pulumi.Bool(false),
    	LocalizedNames: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	ModifyEmailTemplateId: pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	Options: fusionauth.FusionAuthUserActionOptionArray{
    		&fusionauth.FusionAuthUserActionOptionArgs{
    			Name: pulumi.String("string"),
    			LocalizedNames: pulumi.Map{
    				"string": pulumi.Any("any"),
    			},
    		},
    	},
    	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),
    })
    
    var fusionAuthUserActionResource = new FusionAuthUserAction("fusionAuthUserActionResource", FusionAuthUserActionArgs.builder()        
        .cancelEmailTemplateId("string")
        .endEmailTemplateId("string")
        .includeEmailInEventJson(false)
        .localizedNames(Map.of("string", "any"))
        .modifyEmailTemplateId("string")
        .name("string")
        .options(FusionAuthUserActionOptionArgs.builder()
            .name("string")
            .localizedNames(Map.of("string", "any"))
            .build())
        .preventLogin(false)
        .sendEndEvent(false)
        .startEmailTemplateId("string")
        .temporal(false)
        .userActionId("string")
        .userEmailingEnabled(false)
        .userNotificationsEnabled(false)
        .build());
    
    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": "any",
        },
        modify_email_template_id="string",
        name="string",
        options=[fusionauth.FusionAuthUserActionOptionArgs(
            name="string",
            localized_names={
                "string": "any",
            },
        )],
        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)
    
    const fusionAuthUserActionResource = new fusionauth.FusionAuthUserAction("fusionAuthUserActionResource", {
        cancelEmailTemplateId: "string",
        endEmailTemplateId: "string",
        includeEmailInEventJson: false,
        localizedNames: {
            string: "any",
        },
        modifyEmailTemplateId: "string",
        name: "string",
        options: [{
            name: "string",
            localizedNames: {
                string: "any",
            },
        }],
        preventLogin: false,
        sendEndEvent: false,
        startEmailTemplateId: "string",
        temporal: false,
        userActionId: "string",
        userEmailingEnabled: false,
        userNotificationsEnabled: false,
    });
    
    type: fusionauth:FusionAuthUserAction
    properties:
        cancelEmailTemplateId: string
        endEmailTemplateId: string
        includeEmailInEventJson: false
        localizedNames:
            string: any
        modifyEmailTemplateId: string
        name: string
        options:
            - localizedNames:
                string: any
              name: string
        preventLogin: false
        sendEndEvent: false
        startEmailTemplateId: string
        temporal: false
        userActionId: string
        userEmailingEnabled: false
        userNotificationsEnabled: false
    

    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

    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, object>
    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.
    ModifyEmailTemplateId string
    The Id of the Email Template that is used when User Actions are modified.
    Name string
    The name of this User Action Option.
    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]interface{}
    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.
    ModifyEmailTemplateId string
    The Id of the Email Template that is used when User Actions are modified.
    Name string
    The name of this User Action Option.
    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,Object>
    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.
    modifyEmailTemplateId String
    The Id of the Email Template that is used when User Actions are modified.
    name String
    The name of this User Action Option.
    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]: any}
    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.
    modifyEmailTemplateId string
    The Id of the Email Template that is used when User Actions are modified.
    name string
    The name of this User Action Option.
    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, Any]
    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.
    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 Option.
    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<Any>
    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.
    modifyEmailTemplateId String
    The Id of the Email Template that is used when User Actions are modified.
    name String
    The name of this User Action Option.
    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, Any]] = 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)
    Resource lookup is not supported in YAML
    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:
    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, object>
    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.
    ModifyEmailTemplateId string
    The Id of the Email Template that is used when User Actions are modified.
    Name string
    The name of this User Action Option.
    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]interface{}
    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.
    ModifyEmailTemplateId string
    The Id of the Email Template that is used when User Actions are modified.
    Name string
    The name of this User Action Option.
    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,Object>
    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.
    modifyEmailTemplateId String
    The Id of the Email Template that is used when User Actions are modified.
    name String
    The name of this User Action Option.
    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]: any}
    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.
    modifyEmailTemplateId string
    The Id of the Email Template that is used when User Actions are modified.
    name string
    The name of this User Action Option.
    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, Any]
    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.
    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 Option.
    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<Any>
    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.
    modifyEmailTemplateId String
    The Id of the Email Template that is used when User Actions are modified.
    name String
    The name of this User Action Option.
    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 string
    The name of this User Action Option.
    LocalizedNames Dictionary<string, object>
    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 string
    The name of this User Action Option.
    LocalizedNames map[string]interface{}
    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 String
    The name of this User Action Option.
    localizedNames Map<String,Object>
    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 string
    The name of this User Action Option.
    localizedNames {[key: string]: any}
    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 str
    The name of this User Action Option.
    localized_names Mapping[str, Any]
    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 String
    The name of this User Action Option.
    localizedNames Map<Any>
    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 logo
    FusionAuth v4.0.1 published on Saturday, Sep 30, 2023 by Theo Gravity