FusionAuth

Community
Package contributed by a community member
v0.9.7 published on Thursday, Jul 28, 2022 by Theo Gravity

FusionAuthUserAction

# User Action Resource

User Actions API

Example Usage

using Pulumi;
using Fusionauth = theogravity.Fusionauth;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Fusionauth.FusionAuthUserAction("example", new Fusionauth.FusionAuthUserActionArgs
        {
            PreventLogin = true,
            Temporal = true,
        });
    }

}
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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 a FusionAuthUserAction Resource

new FusionAuthUserAction(name: string, args?: FusionAuthUserActionArgs, opts?: CustomResourceOptions);
@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_emailing_enabled: Optional[bool] = None,
                         user_notifications_enabled: Optional[bool] = None)
@overload
def FusionAuthUserAction(resource_name: str,
                         args: Optional[FusionAuthUserActionArgs] = None,
                         opts: Optional[ResourceOptions] = 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.

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.

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.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).

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).

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<FusionAuthUserActionOptionArgs>

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).

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 FusionAuthUserActionOptionArgs[]

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).

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_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).

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 an 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_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.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).

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).

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<FusionAuthUserActionOptionArgs>

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).

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 FusionAuthUserActionOptionArgs[]

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).

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_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).

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

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
https://github.com/theogravity/pulumi-fusionauth
License
MIT
Notes

This Pulumi package is based on the fusionauth Terraform Provider.