1. Packages
  2. Okta
  3. API Docs
  4. ThreatInsightSettings
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

okta.ThreatInsightSettings

Explore with Pulumi AI

okta logo
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

    This resource allows you to configure Threat Insight Settings.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var ipNetworkZoneExample = new Okta.Network.Zone("ipNetworkZoneExample", new()
        {
            Type = "IP",
            Gateways = new[]
            {
                "1.2.3.4/24",
                "2.3.4.5-2.3.4.15",
            },
            Proxies = new[]
            {
                "2.2.3.4/24",
                "3.3.4.5-3.3.4.15",
            },
        });
    
        var example = new Okta.ThreatInsightSettings("example", new()
        {
            Action = "block",
            NetworkExcludes = new[]
            {
                ipNetworkZoneExample.Id,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		ipNetworkZoneExample, err := network.NewZone(ctx, "ipNetworkZoneExample", &network.ZoneArgs{
    			Type: pulumi.String("IP"),
    			Gateways: pulumi.StringArray{
    				pulumi.String("1.2.3.4/24"),
    				pulumi.String("2.3.4.5-2.3.4.15"),
    			},
    			Proxies: pulumi.StringArray{
    				pulumi.String("2.2.3.4/24"),
    				pulumi.String("3.3.4.5-3.3.4.15"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = okta.NewThreatInsightSettings(ctx, "example", &okta.ThreatInsightSettingsArgs{
    			Action: pulumi.String("block"),
    			NetworkExcludes: pulumi.StringArray{
    				ipNetworkZoneExample.ID(),
    			},
    		})
    		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.okta.network.Zone;
    import com.pulumi.okta.network.ZoneArgs;
    import com.pulumi.okta.ThreatInsightSettings;
    import com.pulumi.okta.ThreatInsightSettingsArgs;
    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 ipNetworkZoneExample = new Zone("ipNetworkZoneExample", ZoneArgs.builder()        
                .type("IP")
                .gateways(            
                    "1.2.3.4/24",
                    "2.3.4.5-2.3.4.15")
                .proxies(            
                    "2.2.3.4/24",
                    "3.3.4.5-3.3.4.15")
                .build());
    
            var example = new ThreatInsightSettings("example", ThreatInsightSettingsArgs.builder()        
                .action("block")
                .networkExcludes(ipNetworkZoneExample.id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    ip_network_zone_example = okta.network.Zone("ipNetworkZoneExample",
        type="IP",
        gateways=[
            "1.2.3.4/24",
            "2.3.4.5-2.3.4.15",
        ],
        proxies=[
            "2.2.3.4/24",
            "3.3.4.5-3.3.4.15",
        ])
    example = okta.ThreatInsightSettings("example",
        action="block",
        network_excludes=[ip_network_zone_example.id])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const ipNetworkZoneExample = new okta.network.Zone("ipNetworkZoneExample", {
        type: "IP",
        gateways: [
            "1.2.3.4/24",
            "2.3.4.5-2.3.4.15",
        ],
        proxies: [
            "2.2.3.4/24",
            "3.3.4.5-3.3.4.15",
        ],
    });
    const example = new okta.ThreatInsightSettings("example", {
        action: "block",
        networkExcludes: [ipNetworkZoneExample.id],
    });
    
    resources:
      ipNetworkZoneExample:
        type: okta:network:Zone
        properties:
          type: IP
          gateways:
            - 1.2.3.4/24
            - 2.3.4.5-2.3.4.15
          proxies:
            - 2.2.3.4/24
            - 3.3.4.5-3.3.4.15
      example:
        type: okta:ThreatInsightSettings
        properties:
          action: block
          networkExcludes:
            - ${ipNetworkZoneExample.id}
    

    Create ThreatInsightSettings Resource

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

    Constructor syntax

    new ThreatInsightSettings(name: string, args: ThreatInsightSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def ThreatInsightSettings(resource_name: str,
                              args: ThreatInsightSettingsArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ThreatInsightSettings(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              action: Optional[str] = None,
                              network_excludes: Optional[Sequence[str]] = None)
    func NewThreatInsightSettings(ctx *Context, name string, args ThreatInsightSettingsArgs, opts ...ResourceOption) (*ThreatInsightSettings, error)
    public ThreatInsightSettings(string name, ThreatInsightSettingsArgs args, CustomResourceOptions? opts = null)
    public ThreatInsightSettings(String name, ThreatInsightSettingsArgs args)
    public ThreatInsightSettings(String name, ThreatInsightSettingsArgs args, CustomResourceOptions options)
    
    type: okta:ThreatInsightSettings
    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 ThreatInsightSettingsArgs
    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 ThreatInsightSettingsArgs
    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 ThreatInsightSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ThreatInsightSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ThreatInsightSettingsArgs
    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 threatInsightSettingsResource = new Okta.ThreatInsightSettings("threatInsightSettingsResource", new()
    {
        Action = "string",
        NetworkExcludes = new[]
        {
            "string",
        },
    });
    
    example, err := okta.NewThreatInsightSettings(ctx, "threatInsightSettingsResource", &okta.ThreatInsightSettingsArgs{
    	Action: pulumi.String("string"),
    	NetworkExcludes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var threatInsightSettingsResource = new ThreatInsightSettings("threatInsightSettingsResource", ThreatInsightSettingsArgs.builder()        
        .action("string")
        .networkExcludes("string")
        .build());
    
    threat_insight_settings_resource = okta.ThreatInsightSettings("threatInsightSettingsResource",
        action="string",
        network_excludes=["string"])
    
    const threatInsightSettingsResource = new okta.ThreatInsightSettings("threatInsightSettingsResource", {
        action: "string",
        networkExcludes: ["string"],
    });
    
    type: okta:ThreatInsightSettings
    properties:
        action: string
        networkExcludes:
            - string
    

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

    Action string
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    NetworkExcludes List<string>
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    Action string
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    NetworkExcludes []string
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action String
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    networkExcludes List<String>
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action string
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    networkExcludes string[]
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action str
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    network_excludes Sequence[str]
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action String
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    networkExcludes List<String>
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides

    Outputs

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

    Get an existing ThreatInsightSettings 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?: ThreatInsightSettingsState, opts?: CustomResourceOptions): ThreatInsightSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = None,
            network_excludes: Optional[Sequence[str]] = None) -> ThreatInsightSettings
    func GetThreatInsightSettings(ctx *Context, name string, id IDInput, state *ThreatInsightSettingsState, opts ...ResourceOption) (*ThreatInsightSettings, error)
    public static ThreatInsightSettings Get(string name, Input<string> id, ThreatInsightSettingsState? state, CustomResourceOptions? opts = null)
    public static ThreatInsightSettings get(String name, Output<String> id, ThreatInsightSettingsState 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:
    Action string
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    NetworkExcludes List<string>
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    Action string
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    NetworkExcludes []string
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action String
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    networkExcludes List<String>
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action string
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    networkExcludes string[]
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action str
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    network_excludes Sequence[str]
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides
    action String
    Specifies how Okta responds to authentication requests from suspicious IPs. Valid values are "none", "audit", or "block". A value of "none" indicates that ThreatInsight is disabled. A value of "audit" indicates that Okta logs suspicious requests in the System Log. A value of "block" indicates that Okta logs suspicious requests in the System Log and blocks the requests.
    networkExcludes List<String>
    Accepts a list of Network Zone IDs. Can only accept zones of "IP" type. IPs in the excluded Network Zones aren't logged or blocked by Okta ThreatInsight and proceed to Sign On rules evaluation. This ensures that traffic from known, trusted IPs isn't accidentally logged or blocked. The ordering of the network zone is not guarantee from the API sides

    Import

    Threat Insight Settings can be imported without any parameters.

     $ pulumi import okta:index/threatInsightSettings:ThreatInsightSettings 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.0 published on Saturday, Mar 2, 2024 by Pulumi