Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. PackagesAuthenticationRule
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.PackagesAuthenticationRule

Explore with Pulumi AI

fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

Configure Authentication Rules.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const labelname = new fortimanager.PackagesAuthenticationRule("labelname", {
    ipBased: "enable",
    pkg: "default",
    protocol: "http",
    srcaddrs: ["all"],
    status: "enable",
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

labelname = fortimanager.PackagesAuthenticationRule("labelname",
    ip_based="enable",
    pkg="default",
    protocol="http",
    srcaddrs=["all"],
    status="enable")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewPackagesAuthenticationRule(ctx, "labelname", &fortimanager.PackagesAuthenticationRuleArgs{
			IpBased:  pulumi.String("enable"),
			Pkg:      pulumi.String("default"),
			Protocol: pulumi.String("http"),
			Srcaddrs: pulumi.StringArray{
				pulumi.String("all"),
			},
			Status: pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var labelname = new Fortimanager.PackagesAuthenticationRule("labelname", new()
    {
        IpBased = "enable",
        Pkg = "default",
        Protocol = "http",
        Srcaddrs = new[]
        {
            "all",
        },
        Status = "enable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.PackagesAuthenticationRule;
import com.pulumi.fortimanager.PackagesAuthenticationRuleArgs;
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 labelname = new PackagesAuthenticationRule("labelname", PackagesAuthenticationRuleArgs.builder()
            .ipBased("enable")
            .pkg("default")
            .protocol("http")
            .srcaddrs("all")
            .status("enable")
            .build());

    }
}
Copy
resources:
  labelname:
    type: fortimanager:PackagesAuthenticationRule
    properties:
      ipBased: enable
      pkg: default
      protocol: http
      srcaddrs:
        - all
      status: enable
Copy

Create PackagesAuthenticationRule Resource

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

Constructor syntax

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

@overload
def PackagesAuthenticationRule(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               pkg: Optional[str] = None,
                               packages_authentication_rule_id: Optional[str] = None,
                               pkg_folder_path: Optional[str] = None,
                               comments: Optional[str] = None,
                               cors_depth: Optional[float] = None,
                               cors_stateful: Optional[str] = None,
                               dstaddr6s: Optional[Sequence[str]] = None,
                               dstaddrs: Optional[Sequence[str]] = None,
                               ip_based: Optional[str] = None,
                               name: Optional[str] = None,
                               protocol: Optional[str] = None,
                               cert_auth_cookie: Optional[str] = None,
                               adom: Optional[str] = None,
                               active_auth_method: Optional[str] = None,
                               scopetype: Optional[str] = None,
                               srcaddr6s: Optional[Sequence[str]] = None,
                               srcaddrs: Optional[Sequence[str]] = None,
                               srcintfs: Optional[Sequence[str]] = None,
                               sso_auth_method: Optional[str] = None,
                               status: Optional[str] = None,
                               transaction_based: Optional[str] = None,
                               web_auth_cookie: Optional[str] = None,
                               web_portal: Optional[str] = None)
func NewPackagesAuthenticationRule(ctx *Context, name string, args PackagesAuthenticationRuleArgs, opts ...ResourceOption) (*PackagesAuthenticationRule, error)
public PackagesAuthenticationRule(string name, PackagesAuthenticationRuleArgs args, CustomResourceOptions? opts = null)
public PackagesAuthenticationRule(String name, PackagesAuthenticationRuleArgs args)
public PackagesAuthenticationRule(String name, PackagesAuthenticationRuleArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PackagesAuthenticationRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PackagesAuthenticationRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PackagesAuthenticationRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PackagesAuthenticationRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PackagesAuthenticationRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var packagesAuthenticationRuleResource = new Fortimanager.PackagesAuthenticationRule("packagesAuthenticationRuleResource", new()
{
    Pkg = "string",
    PackagesAuthenticationRuleId = "string",
    PkgFolderPath = "string",
    Comments = "string",
    CorsDepth = 0,
    CorsStateful = "string",
    Dstaddr6s = new[]
    {
        "string",
    },
    Dstaddrs = new[]
    {
        "string",
    },
    IpBased = "string",
    Name = "string",
    Protocol = "string",
    CertAuthCookie = "string",
    Adom = "string",
    ActiveAuthMethod = "string",
    Scopetype = "string",
    Srcaddr6s = new[]
    {
        "string",
    },
    Srcaddrs = new[]
    {
        "string",
    },
    Srcintfs = new[]
    {
        "string",
    },
    SsoAuthMethod = "string",
    Status = "string",
    TransactionBased = "string",
    WebAuthCookie = "string",
    WebPortal = "string",
});
Copy
example, err := fortimanager.NewPackagesAuthenticationRule(ctx, "packagesAuthenticationRuleResource", &fortimanager.PackagesAuthenticationRuleArgs{
	Pkg:                          pulumi.String("string"),
	PackagesAuthenticationRuleId: pulumi.String("string"),
	PkgFolderPath:                pulumi.String("string"),
	Comments:                     pulumi.String("string"),
	CorsDepth:                    pulumi.Float64(0),
	CorsStateful:                 pulumi.String("string"),
	Dstaddr6s: pulumi.StringArray{
		pulumi.String("string"),
	},
	Dstaddrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpBased:          pulumi.String("string"),
	Name:             pulumi.String("string"),
	Protocol:         pulumi.String("string"),
	CertAuthCookie:   pulumi.String("string"),
	Adom:             pulumi.String("string"),
	ActiveAuthMethod: pulumi.String("string"),
	Scopetype:        pulumi.String("string"),
	Srcaddr6s: pulumi.StringArray{
		pulumi.String("string"),
	},
	Srcaddrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Srcintfs: pulumi.StringArray{
		pulumi.String("string"),
	},
	SsoAuthMethod:    pulumi.String("string"),
	Status:           pulumi.String("string"),
	TransactionBased: pulumi.String("string"),
	WebAuthCookie:    pulumi.String("string"),
	WebPortal:        pulumi.String("string"),
})
Copy
var packagesAuthenticationRuleResource = new PackagesAuthenticationRule("packagesAuthenticationRuleResource", PackagesAuthenticationRuleArgs.builder()
    .pkg("string")
    .packagesAuthenticationRuleId("string")
    .pkgFolderPath("string")
    .comments("string")
    .corsDepth(0)
    .corsStateful("string")
    .dstaddr6s("string")
    .dstaddrs("string")
    .ipBased("string")
    .name("string")
    .protocol("string")
    .certAuthCookie("string")
    .adom("string")
    .activeAuthMethod("string")
    .scopetype("string")
    .srcaddr6s("string")
    .srcaddrs("string")
    .srcintfs("string")
    .ssoAuthMethod("string")
    .status("string")
    .transactionBased("string")
    .webAuthCookie("string")
    .webPortal("string")
    .build());
Copy
packages_authentication_rule_resource = fortimanager.PackagesAuthenticationRule("packagesAuthenticationRuleResource",
    pkg="string",
    packages_authentication_rule_id="string",
    pkg_folder_path="string",
    comments="string",
    cors_depth=0,
    cors_stateful="string",
    dstaddr6s=["string"],
    dstaddrs=["string"],
    ip_based="string",
    name="string",
    protocol="string",
    cert_auth_cookie="string",
    adom="string",
    active_auth_method="string",
    scopetype="string",
    srcaddr6s=["string"],
    srcaddrs=["string"],
    srcintfs=["string"],
    sso_auth_method="string",
    status="string",
    transaction_based="string",
    web_auth_cookie="string",
    web_portal="string")
Copy
const packagesAuthenticationRuleResource = new fortimanager.PackagesAuthenticationRule("packagesAuthenticationRuleResource", {
    pkg: "string",
    packagesAuthenticationRuleId: "string",
    pkgFolderPath: "string",
    comments: "string",
    corsDepth: 0,
    corsStateful: "string",
    dstaddr6s: ["string"],
    dstaddrs: ["string"],
    ipBased: "string",
    name: "string",
    protocol: "string",
    certAuthCookie: "string",
    adom: "string",
    activeAuthMethod: "string",
    scopetype: "string",
    srcaddr6s: ["string"],
    srcaddrs: ["string"],
    srcintfs: ["string"],
    ssoAuthMethod: "string",
    status: "string",
    transactionBased: "string",
    webAuthCookie: "string",
    webPortal: "string",
});
Copy
type: fortimanager:PackagesAuthenticationRule
properties:
    activeAuthMethod: string
    adom: string
    certAuthCookie: string
    comments: string
    corsDepth: 0
    corsStateful: string
    dstaddr6s:
        - string
    dstaddrs:
        - string
    ipBased: string
    name: string
    packagesAuthenticationRuleId: string
    pkg: string
    pkgFolderPath: string
    protocol: string
    scopetype: string
    srcaddr6s:
        - string
    srcaddrs:
        - string
    srcintfs:
        - string
    ssoAuthMethod: string
    status: string
    transactionBased: string
    webAuthCookie: string
    webPortal: string
Copy

PackagesAuthenticationRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PackagesAuthenticationRule resource accepts the following input properties:

Pkg This property is required. string
Package.
ActiveAuthMethod string
Select an active authentication method.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
CertAuthCookie string
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
Comments string
Comment.
CorsDepth double
Depth to allow CORS access (default = 3).
CorsStateful string
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
Dstaddr6s List<string>
Select an IPv6 destination address from available options. Required for web proxy authentication.
Dstaddrs List<string>
Select an IPv4 destination address from available options. Required for web proxy authentication.
IpBased string
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
Name string
Authentication rule name.
PackagesAuthenticationRuleId string
an identifier for the resource with format {{name}}.
PkgFolderPath string
Pkg Folder Path.
Protocol string
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Srcaddr6s List<string>
Select an IPv6 source address. Required for web proxy authentication.
Srcaddrs List<string>
Select an IPv4 source address from available options. Required for web proxy authentication.
Srcintfs List<string>
Incoming (ingress) interface.
SsoAuthMethod string
Select a single-sign on (SSO) authentication method.
Status string
Enable/disable this authentication rule. Valid values: disable, enable.
TransactionBased string
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
WebAuthCookie string
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
WebPortal string
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
Pkg This property is required. string
Package.
ActiveAuthMethod string
Select an active authentication method.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
CertAuthCookie string
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
Comments string
Comment.
CorsDepth float64
Depth to allow CORS access (default = 3).
CorsStateful string
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
Dstaddr6s []string
Select an IPv6 destination address from available options. Required for web proxy authentication.
Dstaddrs []string
Select an IPv4 destination address from available options. Required for web proxy authentication.
IpBased string
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
Name string
Authentication rule name.
PackagesAuthenticationRuleId string
an identifier for the resource with format {{name}}.
PkgFolderPath string
Pkg Folder Path.
Protocol string
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Srcaddr6s []string
Select an IPv6 source address. Required for web proxy authentication.
Srcaddrs []string
Select an IPv4 source address from available options. Required for web proxy authentication.
Srcintfs []string
Incoming (ingress) interface.
SsoAuthMethod string
Select a single-sign on (SSO) authentication method.
Status string
Enable/disable this authentication rule. Valid values: disable, enable.
TransactionBased string
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
WebAuthCookie string
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
WebPortal string
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
pkg This property is required. String
Package.
activeAuthMethod String
Select an active authentication method.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
certAuthCookie String
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments String
Comment.
corsDepth Double
Depth to allow CORS access (default = 3).
corsStateful String
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s List<String>
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs List<String>
Select an IPv4 destination address from available options. Required for web proxy authentication.
ipBased String
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name String
Authentication rule name.
packagesAuthenticationRuleId String
an identifier for the resource with format {{name}}.
pkgFolderPath String
Pkg Folder Path.
protocol String
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s List<String>
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs List<String>
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs List<String>
Incoming (ingress) interface.
ssoAuthMethod String
Select a single-sign on (SSO) authentication method.
status String
Enable/disable this authentication rule. Valid values: disable, enable.
transactionBased String
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
webAuthCookie String
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
webPortal String
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
pkg This property is required. string
Package.
activeAuthMethod string
Select an active authentication method.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
certAuthCookie string
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments string
Comment.
corsDepth number
Depth to allow CORS access (default = 3).
corsStateful string
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s string[]
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs string[]
Select an IPv4 destination address from available options. Required for web proxy authentication.
ipBased string
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name string
Authentication rule name.
packagesAuthenticationRuleId string
an identifier for the resource with format {{name}}.
pkgFolderPath string
Pkg Folder Path.
protocol string
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s string[]
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs string[]
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs string[]
Incoming (ingress) interface.
ssoAuthMethod string
Select a single-sign on (SSO) authentication method.
status string
Enable/disable this authentication rule. Valid values: disable, enable.
transactionBased string
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
webAuthCookie string
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
webPortal string
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
pkg This property is required. str
Package.
active_auth_method str
Select an active authentication method.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
cert_auth_cookie str
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments str
Comment.
cors_depth float
Depth to allow CORS access (default = 3).
cors_stateful str
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s Sequence[str]
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs Sequence[str]
Select an IPv4 destination address from available options. Required for web proxy authentication.
ip_based str
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name str
Authentication rule name.
packages_authentication_rule_id str
an identifier for the resource with format {{name}}.
pkg_folder_path str
Pkg Folder Path.
protocol str
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype str
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s Sequence[str]
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs Sequence[str]
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs Sequence[str]
Incoming (ingress) interface.
sso_auth_method str
Select a single-sign on (SSO) authentication method.
status str
Enable/disable this authentication rule. Valid values: disable, enable.
transaction_based str
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
web_auth_cookie str
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
web_portal str
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
pkg This property is required. String
Package.
activeAuthMethod String
Select an active authentication method.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
certAuthCookie String
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments String
Comment.
corsDepth Number
Depth to allow CORS access (default = 3).
corsStateful String
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s List<String>
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs List<String>
Select an IPv4 destination address from available options. Required for web proxy authentication.
ipBased String
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name String
Authentication rule name.
packagesAuthenticationRuleId String
an identifier for the resource with format {{name}}.
pkgFolderPath String
Pkg Folder Path.
protocol String
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s List<String>
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs List<String>
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs List<String>
Incoming (ingress) interface.
ssoAuthMethod String
Select a single-sign on (SSO) authentication method.
status String
Enable/disable this authentication rule. Valid values: disable, enable.
transactionBased String
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
webAuthCookie String
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
webPortal String
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.

Outputs

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

Get an existing PackagesAuthenticationRule 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?: PackagesAuthenticationRuleState, opts?: CustomResourceOptions): PackagesAuthenticationRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_auth_method: Optional[str] = None,
        adom: Optional[str] = None,
        cert_auth_cookie: Optional[str] = None,
        comments: Optional[str] = None,
        cors_depth: Optional[float] = None,
        cors_stateful: Optional[str] = None,
        dstaddr6s: Optional[Sequence[str]] = None,
        dstaddrs: Optional[Sequence[str]] = None,
        ip_based: Optional[str] = None,
        name: Optional[str] = None,
        packages_authentication_rule_id: Optional[str] = None,
        pkg: Optional[str] = None,
        pkg_folder_path: Optional[str] = None,
        protocol: Optional[str] = None,
        scopetype: Optional[str] = None,
        srcaddr6s: Optional[Sequence[str]] = None,
        srcaddrs: Optional[Sequence[str]] = None,
        srcintfs: Optional[Sequence[str]] = None,
        sso_auth_method: Optional[str] = None,
        status: Optional[str] = None,
        transaction_based: Optional[str] = None,
        web_auth_cookie: Optional[str] = None,
        web_portal: Optional[str] = None) -> PackagesAuthenticationRule
func GetPackagesAuthenticationRule(ctx *Context, name string, id IDInput, state *PackagesAuthenticationRuleState, opts ...ResourceOption) (*PackagesAuthenticationRule, error)
public static PackagesAuthenticationRule Get(string name, Input<string> id, PackagesAuthenticationRuleState? state, CustomResourceOptions? opts = null)
public static PackagesAuthenticationRule get(String name, Output<String> id, PackagesAuthenticationRuleState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:PackagesAuthenticationRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActiveAuthMethod string
Select an active authentication method.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
CertAuthCookie string
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
Comments string
Comment.
CorsDepth double
Depth to allow CORS access (default = 3).
CorsStateful string
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
Dstaddr6s List<string>
Select an IPv6 destination address from available options. Required for web proxy authentication.
Dstaddrs List<string>
Select an IPv4 destination address from available options. Required for web proxy authentication.
IpBased string
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
Name string
Authentication rule name.
PackagesAuthenticationRuleId string
an identifier for the resource with format {{name}}.
Pkg string
Package.
PkgFolderPath string
Pkg Folder Path.
Protocol string
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Srcaddr6s List<string>
Select an IPv6 source address. Required for web proxy authentication.
Srcaddrs List<string>
Select an IPv4 source address from available options. Required for web proxy authentication.
Srcintfs List<string>
Incoming (ingress) interface.
SsoAuthMethod string
Select a single-sign on (SSO) authentication method.
Status string
Enable/disable this authentication rule. Valid values: disable, enable.
TransactionBased string
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
WebAuthCookie string
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
WebPortal string
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
ActiveAuthMethod string
Select an active authentication method.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
CertAuthCookie string
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
Comments string
Comment.
CorsDepth float64
Depth to allow CORS access (default = 3).
CorsStateful string
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
Dstaddr6s []string
Select an IPv6 destination address from available options. Required for web proxy authentication.
Dstaddrs []string
Select an IPv4 destination address from available options. Required for web proxy authentication.
IpBased string
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
Name string
Authentication rule name.
PackagesAuthenticationRuleId string
an identifier for the resource with format {{name}}.
Pkg string
Package.
PkgFolderPath string
Pkg Folder Path.
Protocol string
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
Srcaddr6s []string
Select an IPv6 source address. Required for web proxy authentication.
Srcaddrs []string
Select an IPv4 source address from available options. Required for web proxy authentication.
Srcintfs []string
Incoming (ingress) interface.
SsoAuthMethod string
Select a single-sign on (SSO) authentication method.
Status string
Enable/disable this authentication rule. Valid values: disable, enable.
TransactionBased string
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
WebAuthCookie string
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
WebPortal string
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
activeAuthMethod String
Select an active authentication method.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
certAuthCookie String
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments String
Comment.
corsDepth Double
Depth to allow CORS access (default = 3).
corsStateful String
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s List<String>
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs List<String>
Select an IPv4 destination address from available options. Required for web proxy authentication.
ipBased String
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name String
Authentication rule name.
packagesAuthenticationRuleId String
an identifier for the resource with format {{name}}.
pkg String
Package.
pkgFolderPath String
Pkg Folder Path.
protocol String
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s List<String>
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs List<String>
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs List<String>
Incoming (ingress) interface.
ssoAuthMethod String
Select a single-sign on (SSO) authentication method.
status String
Enable/disable this authentication rule. Valid values: disable, enable.
transactionBased String
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
webAuthCookie String
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
webPortal String
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
activeAuthMethod string
Select an active authentication method.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
certAuthCookie string
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments string
Comment.
corsDepth number
Depth to allow CORS access (default = 3).
corsStateful string
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s string[]
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs string[]
Select an IPv4 destination address from available options. Required for web proxy authentication.
ipBased string
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name string
Authentication rule name.
packagesAuthenticationRuleId string
an identifier for the resource with format {{name}}.
pkg string
Package.
pkgFolderPath string
Pkg Folder Path.
protocol string
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype string
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s string[]
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs string[]
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs string[]
Incoming (ingress) interface.
ssoAuthMethod string
Select a single-sign on (SSO) authentication method.
status string
Enable/disable this authentication rule. Valid values: disable, enable.
transactionBased string
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
webAuthCookie string
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
webPortal string
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
active_auth_method str
Select an active authentication method.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
cert_auth_cookie str
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments str
Comment.
cors_depth float
Depth to allow CORS access (default = 3).
cors_stateful str
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s Sequence[str]
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs Sequence[str]
Select an IPv4 destination address from available options. Required for web proxy authentication.
ip_based str
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name str
Authentication rule name.
packages_authentication_rule_id str
an identifier for the resource with format {{name}}.
pkg str
Package.
pkg_folder_path str
Pkg Folder Path.
protocol str
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype str
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s Sequence[str]
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs Sequence[str]
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs Sequence[str]
Incoming (ingress) interface.
sso_auth_method str
Select a single-sign on (SSO) authentication method.
status str
Enable/disable this authentication rule. Valid values: disable, enable.
transaction_based str
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
web_auth_cookie str
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
web_portal str
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.
activeAuthMethod String
Select an active authentication method.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
certAuthCookie String
Enable/disable to use device certificate as authentication cookie (default = enable). Valid values: disable, enable.
comments String
Comment.
corsDepth Number
Depth to allow CORS access (default = 3).
corsStateful String
Enable/disable allowance of CORS access (default = disable). Valid values: disable, enable.
dstaddr6s List<String>
Select an IPv6 destination address from available options. Required for web proxy authentication.
dstaddrs List<String>
Select an IPv4 destination address from available options. Required for web proxy authentication.
ipBased String
Enable/disable IP-based authentication. Once a user authenticates all traffic from the IP address the user authenticated from is allowed. Valid values: disable, enable.
name String
Authentication rule name.
packagesAuthenticationRuleId String
an identifier for the resource with format {{name}}.
pkg String
Package.
pkgFolderPath String
Pkg Folder Path.
protocol String
Select the protocol to use for authentication (default = http). Users connect to the FortiGate using this protocol and are asked to authenticate. Valid values: http, ftp, socks, ssh.
scopetype String
The scope of application of the resource. Valid values: inherit, adom. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
srcaddr6s List<String>
Select an IPv6 source address. Required for web proxy authentication.
srcaddrs List<String>
Select an IPv4 source address from available options. Required for web proxy authentication.
srcintfs List<String>
Incoming (ingress) interface.
ssoAuthMethod String
Select a single-sign on (SSO) authentication method.
status String
Enable/disable this authentication rule. Valid values: disable, enable.
transactionBased String
Enable/disable transaction based authentication (default = disable). Valid values: disable, enable.
webAuthCookie String
Enable/disable Web authentication cookies (default = disable). Valid values: disable, enable.
webPortal String
Enable/disable web portal for proxy transparent policy (default = enable). Valid values: disable, enable.

Import

Packages AuthenticationRule can be imported using any of these accepted formats:

Set import_options = [“pkg_folder_path=YOUR_VALUE”, “pkg=YOUR_VALUE”] in the provider section.

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/packagesAuthenticationRule:PackagesAuthenticationRule labelname {{name}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

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

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.
fortimanager 1.14.0 published on Tuesday, Apr 15, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager