1. Packages
  2. Okta
  3. API Docs
  4. SecurityNotificationEmails
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

okta.SecurityNotificationEmails

Explore with Pulumi AI

okta logo
Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi

    This resource allows you to configure Security Notification Emails.

    WARNING: This resource is available only when using a SSWS API token in the provider config, it is incompatible with OAuth 2.0 authentication.

    WARNING: This resource makes use of an internal/private Okta API endpoint that could change without notice rendering this resource inoperable.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.SecurityNotificationEmails("example", {
        reportSuspiciousActivityEnabled: true,
        sendEmailForFactorEnrollmentEnabled: true,
        sendEmailForFactorResetEnabled: true,
        sendEmailForNewDeviceEnabled: true,
        sendEmailForPasswordChangedEnabled: true,
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.SecurityNotificationEmails("example",
        report_suspicious_activity_enabled=True,
        send_email_for_factor_enrollment_enabled=True,
        send_email_for_factor_reset_enabled=True,
        send_email_for_new_device_enabled=True,
        send_email_for_password_changed_enabled=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.NewSecurityNotificationEmails(ctx, "example", &okta.SecurityNotificationEmailsArgs{
    			ReportSuspiciousActivityEnabled:     pulumi.Bool(true),
    			SendEmailForFactorEnrollmentEnabled: pulumi.Bool(true),
    			SendEmailForFactorResetEnabled:      pulumi.Bool(true),
    			SendEmailForNewDeviceEnabled:        pulumi.Bool(true),
    			SendEmailForPasswordChangedEnabled:  pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.SecurityNotificationEmails("example", new()
        {
            ReportSuspiciousActivityEnabled = true,
            SendEmailForFactorEnrollmentEnabled = true,
            SendEmailForFactorResetEnabled = true,
            SendEmailForNewDeviceEnabled = true,
            SendEmailForPasswordChangedEnabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.SecurityNotificationEmails;
    import com.pulumi.okta.SecurityNotificationEmailsArgs;
    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 SecurityNotificationEmails("example", SecurityNotificationEmailsArgs.builder()        
                .reportSuspiciousActivityEnabled(true)
                .sendEmailForFactorEnrollmentEnabled(true)
                .sendEmailForFactorResetEnabled(true)
                .sendEmailForNewDeviceEnabled(true)
                .sendEmailForPasswordChangedEnabled(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:SecurityNotificationEmails
        properties:
          reportSuspiciousActivityEnabled: true
          sendEmailForFactorEnrollmentEnabled: true
          sendEmailForFactorResetEnabled: true
          sendEmailForNewDeviceEnabled: true
          sendEmailForPasswordChangedEnabled: true
    

    Create SecurityNotificationEmails Resource

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

    Constructor syntax

    new SecurityNotificationEmails(name: string, args?: SecurityNotificationEmailsArgs, opts?: CustomResourceOptions);
    @overload
    def SecurityNotificationEmails(resource_name: str,
                                   args: Optional[SecurityNotificationEmailsArgs] = None,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def SecurityNotificationEmails(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   report_suspicious_activity_enabled: Optional[bool] = None,
                                   send_email_for_factor_enrollment_enabled: Optional[bool] = None,
                                   send_email_for_factor_reset_enabled: Optional[bool] = None,
                                   send_email_for_new_device_enabled: Optional[bool] = None,
                                   send_email_for_password_changed_enabled: Optional[bool] = None)
    func NewSecurityNotificationEmails(ctx *Context, name string, args *SecurityNotificationEmailsArgs, opts ...ResourceOption) (*SecurityNotificationEmails, error)
    public SecurityNotificationEmails(string name, SecurityNotificationEmailsArgs? args = null, CustomResourceOptions? opts = null)
    public SecurityNotificationEmails(String name, SecurityNotificationEmailsArgs args)
    public SecurityNotificationEmails(String name, SecurityNotificationEmailsArgs args, CustomResourceOptions options)
    
    type: okta:SecurityNotificationEmails
    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 SecurityNotificationEmailsArgs
    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 SecurityNotificationEmailsArgs
    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 SecurityNotificationEmailsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecurityNotificationEmailsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecurityNotificationEmailsArgs
    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 securityNotificationEmailsResource = new Okta.SecurityNotificationEmails("securityNotificationEmailsResource", new()
    {
        ReportSuspiciousActivityEnabled = false,
        SendEmailForFactorEnrollmentEnabled = false,
        SendEmailForFactorResetEnabled = false,
        SendEmailForNewDeviceEnabled = false,
        SendEmailForPasswordChangedEnabled = false,
    });
    
    example, err := okta.NewSecurityNotificationEmails(ctx, "securityNotificationEmailsResource", &okta.SecurityNotificationEmailsArgs{
    	ReportSuspiciousActivityEnabled:     pulumi.Bool(false),
    	SendEmailForFactorEnrollmentEnabled: pulumi.Bool(false),
    	SendEmailForFactorResetEnabled:      pulumi.Bool(false),
    	SendEmailForNewDeviceEnabled:        pulumi.Bool(false),
    	SendEmailForPasswordChangedEnabled:  pulumi.Bool(false),
    })
    
    var securityNotificationEmailsResource = new SecurityNotificationEmails("securityNotificationEmailsResource", SecurityNotificationEmailsArgs.builder()        
        .reportSuspiciousActivityEnabled(false)
        .sendEmailForFactorEnrollmentEnabled(false)
        .sendEmailForFactorResetEnabled(false)
        .sendEmailForNewDeviceEnabled(false)
        .sendEmailForPasswordChangedEnabled(false)
        .build());
    
    security_notification_emails_resource = okta.SecurityNotificationEmails("securityNotificationEmailsResource",
        report_suspicious_activity_enabled=False,
        send_email_for_factor_enrollment_enabled=False,
        send_email_for_factor_reset_enabled=False,
        send_email_for_new_device_enabled=False,
        send_email_for_password_changed_enabled=False)
    
    const securityNotificationEmailsResource = new okta.SecurityNotificationEmails("securityNotificationEmailsResource", {
        reportSuspiciousActivityEnabled: false,
        sendEmailForFactorEnrollmentEnabled: false,
        sendEmailForFactorResetEnabled: false,
        sendEmailForNewDeviceEnabled: false,
        sendEmailForPasswordChangedEnabled: false,
    });
    
    type: okta:SecurityNotificationEmails
    properties:
        reportSuspiciousActivityEnabled: false
        sendEmailForFactorEnrollmentEnabled: false
        sendEmailForFactorResetEnabled: false
        sendEmailForNewDeviceEnabled: false
        sendEmailForPasswordChangedEnabled: false
    

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

    ReportSuspiciousActivityEnabled bool
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    SendEmailForFactorEnrollmentEnabled bool
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    SendEmailForFactorResetEnabled bool
    Notifies end users that one or more factors have been reset for their account. Default is true.
    SendEmailForNewDeviceEnabled bool
    Notifies end users about new sign-on activity. Default is true.
    SendEmailForPasswordChangedEnabled bool
    Notifies end users that the password for their account has changed. Default is true.
    ReportSuspiciousActivityEnabled bool
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    SendEmailForFactorEnrollmentEnabled bool
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    SendEmailForFactorResetEnabled bool
    Notifies end users that one or more factors have been reset for their account. Default is true.
    SendEmailForNewDeviceEnabled bool
    Notifies end users about new sign-on activity. Default is true.
    SendEmailForPasswordChangedEnabled bool
    Notifies end users that the password for their account has changed. Default is true.
    reportSuspiciousActivityEnabled Boolean
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    sendEmailForFactorEnrollmentEnabled Boolean
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    sendEmailForFactorResetEnabled Boolean
    Notifies end users that one or more factors have been reset for their account. Default is true.
    sendEmailForNewDeviceEnabled Boolean
    Notifies end users about new sign-on activity. Default is true.
    sendEmailForPasswordChangedEnabled Boolean
    Notifies end users that the password for their account has changed. Default is true.
    reportSuspiciousActivityEnabled boolean
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    sendEmailForFactorEnrollmentEnabled boolean
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    sendEmailForFactorResetEnabled boolean
    Notifies end users that one or more factors have been reset for their account. Default is true.
    sendEmailForNewDeviceEnabled boolean
    Notifies end users about new sign-on activity. Default is true.
    sendEmailForPasswordChangedEnabled boolean
    Notifies end users that the password for their account has changed. Default is true.
    report_suspicious_activity_enabled bool
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    send_email_for_factor_enrollment_enabled bool
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    send_email_for_factor_reset_enabled bool
    Notifies end users that one or more factors have been reset for their account. Default is true.
    send_email_for_new_device_enabled bool
    Notifies end users about new sign-on activity. Default is true.
    send_email_for_password_changed_enabled bool
    Notifies end users that the password for their account has changed. Default is true.
    reportSuspiciousActivityEnabled Boolean
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    sendEmailForFactorEnrollmentEnabled Boolean
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    sendEmailForFactorResetEnabled Boolean
    Notifies end users that one or more factors have been reset for their account. Default is true.
    sendEmailForNewDeviceEnabled Boolean
    Notifies end users about new sign-on activity. Default is true.
    sendEmailForPasswordChangedEnabled Boolean
    Notifies end users that the password for their account has changed. Default is true.

    Outputs

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

    Get an existing SecurityNotificationEmails 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?: SecurityNotificationEmailsState, opts?: CustomResourceOptions): SecurityNotificationEmails
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            report_suspicious_activity_enabled: Optional[bool] = None,
            send_email_for_factor_enrollment_enabled: Optional[bool] = None,
            send_email_for_factor_reset_enabled: Optional[bool] = None,
            send_email_for_new_device_enabled: Optional[bool] = None,
            send_email_for_password_changed_enabled: Optional[bool] = None) -> SecurityNotificationEmails
    func GetSecurityNotificationEmails(ctx *Context, name string, id IDInput, state *SecurityNotificationEmailsState, opts ...ResourceOption) (*SecurityNotificationEmails, error)
    public static SecurityNotificationEmails Get(string name, Input<string> id, SecurityNotificationEmailsState? state, CustomResourceOptions? opts = null)
    public static SecurityNotificationEmails get(String name, Output<String> id, SecurityNotificationEmailsState 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:
    ReportSuspiciousActivityEnabled bool
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    SendEmailForFactorEnrollmentEnabled bool
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    SendEmailForFactorResetEnabled bool
    Notifies end users that one or more factors have been reset for their account. Default is true.
    SendEmailForNewDeviceEnabled bool
    Notifies end users about new sign-on activity. Default is true.
    SendEmailForPasswordChangedEnabled bool
    Notifies end users that the password for their account has changed. Default is true.
    ReportSuspiciousActivityEnabled bool
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    SendEmailForFactorEnrollmentEnabled bool
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    SendEmailForFactorResetEnabled bool
    Notifies end users that one or more factors have been reset for their account. Default is true.
    SendEmailForNewDeviceEnabled bool
    Notifies end users about new sign-on activity. Default is true.
    SendEmailForPasswordChangedEnabled bool
    Notifies end users that the password for their account has changed. Default is true.
    reportSuspiciousActivityEnabled Boolean
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    sendEmailForFactorEnrollmentEnabled Boolean
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    sendEmailForFactorResetEnabled Boolean
    Notifies end users that one or more factors have been reset for their account. Default is true.
    sendEmailForNewDeviceEnabled Boolean
    Notifies end users about new sign-on activity. Default is true.
    sendEmailForPasswordChangedEnabled Boolean
    Notifies end users that the password for their account has changed. Default is true.
    reportSuspiciousActivityEnabled boolean
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    sendEmailForFactorEnrollmentEnabled boolean
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    sendEmailForFactorResetEnabled boolean
    Notifies end users that one or more factors have been reset for their account. Default is true.
    sendEmailForNewDeviceEnabled boolean
    Notifies end users about new sign-on activity. Default is true.
    sendEmailForPasswordChangedEnabled boolean
    Notifies end users that the password for their account has changed. Default is true.
    report_suspicious_activity_enabled bool
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    send_email_for_factor_enrollment_enabled bool
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    send_email_for_factor_reset_enabled bool
    Notifies end users that one or more factors have been reset for their account. Default is true.
    send_email_for_new_device_enabled bool
    Notifies end users about new sign-on activity. Default is true.
    send_email_for_password_changed_enabled bool
    Notifies end users that the password for their account has changed. Default is true.
    reportSuspiciousActivityEnabled Boolean
    Notifies end users about suspicious or unrecognized activity from their account. Default is true.
    sendEmailForFactorEnrollmentEnabled Boolean
    Notifies end users of any activity on their account related to MFA factor enrollment. Default is true.
    sendEmailForFactorResetEnabled Boolean
    Notifies end users that one or more factors have been reset for their account. Default is true.
    sendEmailForNewDeviceEnabled Boolean
    Notifies end users about new sign-on activity. Default is true.
    sendEmailForPasswordChangedEnabled Boolean
    Notifies end users that the password for their account has changed. Default is true.

    Import

    Security Notification Emails can be imported without any parameters.

    $ pulumi import okta:index/securityNotificationEmails:SecurityNotificationEmails example _
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.8.1 published on Thursday, Apr 18, 2024 by Pulumi