Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Saml
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Saml

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Global settings for SAML authentication. Applies to FortiOS Version >= 6.2.4.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.Saml("trname", {
    defaultLoginPage: "normal",
    defaultProfile: "admin_no_access",
    life: 30,
    role: "service-provider",
    status: "disable",
    tolerance: 5,
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Saml("trname",
    default_login_page="normal",
    default_profile="admin_no_access",
    life=30,
    role="service-provider",
    status="disable",
    tolerance=5)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewSaml(ctx, "trname", &system.SamlArgs{
			DefaultLoginPage: pulumi.String("normal"),
			DefaultProfile:   pulumi.String("admin_no_access"),
			Life:             pulumi.Int(30),
			Role:             pulumi.String("service-provider"),
			Status:           pulumi.String("disable"),
			Tolerance:        pulumi.Int(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Saml("trname", new()
    {
        DefaultLoginPage = "normal",
        DefaultProfile = "admin_no_access",
        Life = 30,
        Role = "service-provider",
        Status = "disable",
        Tolerance = 5,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Saml;
import com.pulumi.fortios.system.SamlArgs;
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 trname = new Saml("trname", SamlArgs.builder()        
            .defaultLoginPage("normal")
            .defaultProfile("admin_no_access")
            .life(30)
            .role("service-provider")
            .status("disable")
            .tolerance(5)
            .build());

    }
}

    resources:
  trname:
    type: fortios:system:Saml
    properties:
      defaultLoginPage: normal
      defaultProfile: admin_no_access
      life: 30
      role: service-provider
      status: disable
      tolerance: 5

    Create Saml Resource

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

    Constructor syntax

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

@overload
def Saml(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         binding_protocol: Optional[str] = None,
         cert: Optional[str] = None,
         default_login_page: Optional[str] = None,
         default_profile: Optional[str] = None,
         dynamic_sort_subtable: Optional[str] = None,
         entity_id: Optional[str] = None,
         get_all_tables: Optional[str] = None,
         idp_cert: Optional[str] = None,
         idp_entity_id: Optional[str] = None,
         idp_single_logout_url: Optional[str] = None,
         idp_single_sign_on_url: Optional[str] = None,
         life: Optional[int] = None,
         portal_url: Optional[str] = None,
         role: Optional[str] = None,
         server_address: Optional[str] = None,
         service_providers: Optional[Sequence[SamlServiceProviderArgs]] = None,
         single_logout_url: Optional[str] = None,
         single_sign_on_url: Optional[str] = None,
         status: Optional[str] = None,
         tolerance: Optional[int] = None,
         vdomparam: Optional[str] = None)
    func NewSaml(ctx *Context, name string, args *SamlArgs, opts ...ResourceOption) (*Saml, error)
    public Saml(string name, SamlArgs? args = null, CustomResourceOptions? opts = null)
    public Saml(String name, SamlArgs args)
public Saml(String name, SamlArgs args, CustomResourceOptions options)

    type: fortios:system:Saml
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 SamlArgs
    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 SamlArgs
    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 SamlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SamlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SamlArgs
    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 samlResource = new Fortios.System.Saml("samlResource", new()
{
    BindingProtocol = "string",
    Cert = "string",
    DefaultLoginPage = "string",
    DefaultProfile = "string",
    DynamicSortSubtable = "string",
    EntityId = "string",
    GetAllTables = "string",
    IdpCert = "string",
    IdpEntityId = "string",
    IdpSingleLogoutUrl = "string",
    IdpSingleSignOnUrl = "string",
    Life = 0,
    PortalUrl = "string",
    Role = "string",
    ServerAddress = "string",
    ServiceProviders = new[]
    {
        new Fortios.System.Inputs.SamlServiceProviderArgs
        {
            AssertionAttributes = new[]
            {
                new Fortios.System.Inputs.SamlServiceProviderAssertionAttributeArgs
                {
                    Name = "string",
                    Type = "string",
                },
            },
            IdpEntityId = "string",
            IdpSingleLogoutUrl = "string",
            IdpSingleSignOnUrl = "string",
            Name = "string",
            Prefix = "string",
            SpBindingProtocol = "string",
            SpCert = "string",
            SpEntityId = "string",
            SpPortalUrl = "string",
            SpSingleLogoutUrl = "string",
            SpSingleSignOnUrl = "string",
        },
    },
    SingleLogoutUrl = "string",
    SingleSignOnUrl = "string",
    Status = "string",
    Tolerance = 0,
    Vdomparam = "string",
});

    example, err := system.NewSaml(ctx, "samlResource", &system.SamlArgs{
	BindingProtocol:     pulumi.String("string"),
	Cert:                pulumi.String("string"),
	DefaultLoginPage:    pulumi.String("string"),
	DefaultProfile:      pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	EntityId:            pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	IdpCert:             pulumi.String("string"),
	IdpEntityId:         pulumi.String("string"),
	IdpSingleLogoutUrl:  pulumi.String("string"),
	IdpSingleSignOnUrl:  pulumi.String("string"),
	Life:                pulumi.Int(0),
	PortalUrl:           pulumi.String("string"),
	Role:                pulumi.String("string"),
	ServerAddress:       pulumi.String("string"),
	ServiceProviders: system.SamlServiceProviderArray{
		&system.SamlServiceProviderArgs{
			AssertionAttributes: system.SamlServiceProviderAssertionAttributeArray{
				&system.SamlServiceProviderAssertionAttributeArgs{
					Name: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			IdpEntityId:        pulumi.String("string"),
			IdpSingleLogoutUrl: pulumi.String("string"),
			IdpSingleSignOnUrl: pulumi.String("string"),
			Name:               pulumi.String("string"),
			Prefix:             pulumi.String("string"),
			SpBindingProtocol:  pulumi.String("string"),
			SpCert:             pulumi.String("string"),
			SpEntityId:         pulumi.String("string"),
			SpPortalUrl:        pulumi.String("string"),
			SpSingleLogoutUrl:  pulumi.String("string"),
			SpSingleSignOnUrl:  pulumi.String("string"),
		},
	},
	SingleLogoutUrl: pulumi.String("string"),
	SingleSignOnUrl: pulumi.String("string"),
	Status:          pulumi.String("string"),
	Tolerance:       pulumi.Int(0),
	Vdomparam:       pulumi.String("string"),
})

    var samlResource = new Saml("samlResource", SamlArgs.builder()
    .bindingProtocol("string")
    .cert("string")
    .defaultLoginPage("string")
    .defaultProfile("string")
    .dynamicSortSubtable("string")
    .entityId("string")
    .getAllTables("string")
    .idpCert("string")
    .idpEntityId("string")
    .idpSingleLogoutUrl("string")
    .idpSingleSignOnUrl("string")
    .life(0)
    .portalUrl("string")
    .role("string")
    .serverAddress("string")
    .serviceProviders(SamlServiceProviderArgs.builder()
        .assertionAttributes(SamlServiceProviderAssertionAttributeArgs.builder()
            .name("string")
            .type("string")
            .build())
        .idpEntityId("string")
        .idpSingleLogoutUrl("string")
        .idpSingleSignOnUrl("string")
        .name("string")
        .prefix("string")
        .spBindingProtocol("string")
        .spCert("string")
        .spEntityId("string")
        .spPortalUrl("string")
        .spSingleLogoutUrl("string")
        .spSingleSignOnUrl("string")
        .build())
    .singleLogoutUrl("string")
    .singleSignOnUrl("string")
    .status("string")
    .tolerance(0)
    .vdomparam("string")
    .build());

    saml_resource = fortios.system.Saml("samlResource",
    binding_protocol="string",
    cert="string",
    default_login_page="string",
    default_profile="string",
    dynamic_sort_subtable="string",
    entity_id="string",
    get_all_tables="string",
    idp_cert="string",
    idp_entity_id="string",
    idp_single_logout_url="string",
    idp_single_sign_on_url="string",
    life=0,
    portal_url="string",
    role="string",
    server_address="string",
    service_providers=[fortios.system.SamlServiceProviderArgs(
        assertion_attributes=[fortios.system.SamlServiceProviderAssertionAttributeArgs(
            name="string",
            type="string",
        )],
        idp_entity_id="string",
        idp_single_logout_url="string",
        idp_single_sign_on_url="string",
        name="string",
        prefix="string",
        sp_binding_protocol="string",
        sp_cert="string",
        sp_entity_id="string",
        sp_portal_url="string",
        sp_single_logout_url="string",
        sp_single_sign_on_url="string",
    )],
    single_logout_url="string",
    single_sign_on_url="string",
    status="string",
    tolerance=0,
    vdomparam="string")

    const samlResource = new fortios.system.Saml("samlResource", {
    bindingProtocol: "string",
    cert: "string",
    defaultLoginPage: "string",
    defaultProfile: "string",
    dynamicSortSubtable: "string",
    entityId: "string",
    getAllTables: "string",
    idpCert: "string",
    idpEntityId: "string",
    idpSingleLogoutUrl: "string",
    idpSingleSignOnUrl: "string",
    life: 0,
    portalUrl: "string",
    role: "string",
    serverAddress: "string",
    serviceProviders: [{
        assertionAttributes: [{
            name: "string",
            type: "string",
        }],
        idpEntityId: "string",
        idpSingleLogoutUrl: "string",
        idpSingleSignOnUrl: "string",
        name: "string",
        prefix: "string",
        spBindingProtocol: "string",
        spCert: "string",
        spEntityId: "string",
        spPortalUrl: "string",
        spSingleLogoutUrl: "string",
        spSingleSignOnUrl: "string",
    }],
    singleLogoutUrl: "string",
    singleSignOnUrl: "string",
    status: "string",
    tolerance: 0,
    vdomparam: "string",
});

    type: fortios:system:Saml
properties:
    bindingProtocol: string
    cert: string
    defaultLoginPage: string
    defaultProfile: string
    dynamicSortSubtable: string
    entityId: string
    getAllTables: string
    idpCert: string
    idpEntityId: string
    idpSingleLogoutUrl: string
    idpSingleSignOnUrl: string
    life: 0
    portalUrl: string
    role: string
    serverAddress: string
    serviceProviders:
        - assertionAttributes:
            - name: string
              type: string
          idpEntityId: string
          idpSingleLogoutUrl: string
          idpSingleSignOnUrl: string
          name: string
          prefix: string
          spBindingProtocol: string
          spCert: string
          spEntityId: string
          spPortalUrl: string
          spSingleLogoutUrl: string
          spSingleSignOnUrl: string
    singleLogoutUrl: string
    singleSignOnUrl: string
    status: string
    tolerance: 0
    vdomparam: string

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

    BindingProtocol string
    IdP Binding protocol. Valid values: post, redirect.
    Cert string
    Certificate to sign SAML messages.
    DefaultLoginPage string
    Choose default login page. Valid values: normal, sso.
    DefaultProfile string
    Default profile for new SSO admin.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    EntityId string
    SP entity ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IdpCert string
    IDP certificate name.
    IdpEntityId string
    IDP entity ID.
    IdpSingleLogoutUrl string
    IDP single logout URL.
    IdpSingleSignOnUrl string
    IDP single sign-on URL.
    Life int
    Length of the range of time when the assertion is valid (in minutes).
    PortalUrl string
    SP portal URL.
    Role string
    SAML role. Valid values: identity-provider, service-provider.
    ServerAddress string
    Server address.
    ServiceProviders List<Pulumiverse.Fortios.System.Inputs.SamlServiceProvider>
    Authorized service providers. The structure of service_providers block is documented below.
    SingleLogoutUrl string
    SP single logout URL.
    SingleSignOnUrl string
    SP single sign-on URL.
    Status string
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    Tolerance int
    Tolerance to the range of time when the assertion is valid (in minutes).
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    BindingProtocol string
    IdP Binding protocol. Valid values: post, redirect.
    Cert string
    Certificate to sign SAML messages.
    DefaultLoginPage string
    Choose default login page. Valid values: normal, sso.
    DefaultProfile string
    Default profile for new SSO admin.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    EntityId string
    SP entity ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IdpCert string
    IDP certificate name.
    IdpEntityId string
    IDP entity ID.
    IdpSingleLogoutUrl string
    IDP single logout URL.
    IdpSingleSignOnUrl string
    IDP single sign-on URL.
    Life int
    Length of the range of time when the assertion is valid (in minutes).
    PortalUrl string
    SP portal URL.
    Role string
    SAML role. Valid values: identity-provider, service-provider.
    ServerAddress string
    Server address.
    ServiceProviders []SamlServiceProviderArgs
    Authorized service providers. The structure of service_providers block is documented below.
    SingleLogoutUrl string
    SP single logout URL.
    SingleSignOnUrl string
    SP single sign-on URL.
    Status string
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    Tolerance int
    Tolerance to the range of time when the assertion is valid (in minutes).
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    bindingProtocol String
    IdP Binding protocol. Valid values: post, redirect.
    cert String
    Certificate to sign SAML messages.
    defaultLoginPage String
    Choose default login page. Valid values: normal, sso.
    defaultProfile String
    Default profile for new SSO admin.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entityId String
    SP entity ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idpCert String
    IDP certificate name.
    idpEntityId String
    IDP entity ID.
    idpSingleLogoutUrl String
    IDP single logout URL.
    idpSingleSignOnUrl String
    IDP single sign-on URL.
    life Integer
    Length of the range of time when the assertion is valid (in minutes).
    portalUrl String
    SP portal URL.
    role String
    SAML role. Valid values: identity-provider, service-provider.
    serverAddress String
    Server address.
    serviceProviders List<SamlServiceProvider>
    Authorized service providers. The structure of service_providers block is documented below.
    singleLogoutUrl String
    SP single logout URL.
    singleSignOnUrl String
    SP single sign-on URL.
    status String
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance Integer
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    bindingProtocol string
    IdP Binding protocol. Valid values: post, redirect.
    cert string
    Certificate to sign SAML messages.
    defaultLoginPage string
    Choose default login page. Valid values: normal, sso.
    defaultProfile string
    Default profile for new SSO admin.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entityId string
    SP entity ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idpCert string
    IDP certificate name.
    idpEntityId string
    IDP entity ID.
    idpSingleLogoutUrl string
    IDP single logout URL.
    idpSingleSignOnUrl string
    IDP single sign-on URL.
    life number
    Length of the range of time when the assertion is valid (in minutes).
    portalUrl string
    SP portal URL.
    role string
    SAML role. Valid values: identity-provider, service-provider.
    serverAddress string
    Server address.
    serviceProviders SamlServiceProvider[]
    Authorized service providers. The structure of service_providers block is documented below.
    singleLogoutUrl string
    SP single logout URL.
    singleSignOnUrl string
    SP single sign-on URL.
    status string
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance number
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    binding_protocol str
    IdP Binding protocol. Valid values: post, redirect.
    cert str
    Certificate to sign SAML messages.
    default_login_page str
    Choose default login page. Valid values: normal, sso.
    default_profile str
    Default profile for new SSO admin.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entity_id str
    SP entity ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idp_cert str
    IDP certificate name.
    idp_entity_id str
    IDP entity ID.
    idp_single_logout_url str
    IDP single logout URL.
    idp_single_sign_on_url str
    IDP single sign-on URL.
    life int
    Length of the range of time when the assertion is valid (in minutes).
    portal_url str
    SP portal URL.
    role str
    SAML role. Valid values: identity-provider, service-provider.
    server_address str
    Server address.
    service_providers Sequence[SamlServiceProviderArgs]
    Authorized service providers. The structure of service_providers block is documented below.
    single_logout_url str
    SP single logout URL.
    single_sign_on_url str
    SP single sign-on URL.
    status str
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance int
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    bindingProtocol String
    IdP Binding protocol. Valid values: post, redirect.
    cert String
    Certificate to sign SAML messages.
    defaultLoginPage String
    Choose default login page. Valid values: normal, sso.
    defaultProfile String
    Default profile for new SSO admin.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entityId String
    SP entity ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idpCert String
    IDP certificate name.
    idpEntityId String
    IDP entity ID.
    idpSingleLogoutUrl String
    IDP single logout URL.
    idpSingleSignOnUrl String
    IDP single sign-on URL.
    life Number
    Length of the range of time when the assertion is valid (in minutes).
    portalUrl String
    SP portal URL.
    role String
    SAML role. Valid values: identity-provider, service-provider.
    serverAddress String
    Server address.
    serviceProviders List<Property Map>
    Authorized service providers. The structure of service_providers block is documented below.
    singleLogoutUrl String
    SP single logout URL.
    singleSignOnUrl String
    SP single sign-on URL.
    status String
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance Number
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Get an existing Saml 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?: SamlState, opts?: CustomResourceOptions): Saml
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        binding_protocol: Optional[str] = None,
        cert: Optional[str] = None,
        default_login_page: Optional[str] = None,
        default_profile: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        entity_id: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        idp_cert: Optional[str] = None,
        idp_entity_id: Optional[str] = None,
        idp_single_logout_url: Optional[str] = None,
        idp_single_sign_on_url: Optional[str] = None,
        life: Optional[int] = None,
        portal_url: Optional[str] = None,
        role: Optional[str] = None,
        server_address: Optional[str] = None,
        service_providers: Optional[Sequence[SamlServiceProviderArgs]] = None,
        single_logout_url: Optional[str] = None,
        single_sign_on_url: Optional[str] = None,
        status: Optional[str] = None,
        tolerance: Optional[int] = None,
        vdomparam: Optional[str] = None) -> Saml
    func GetSaml(ctx *Context, name string, id IDInput, state *SamlState, opts ...ResourceOption) (*Saml, error)
    public static Saml Get(string name, Input<string> id, SamlState? state, CustomResourceOptions? opts = null)
    public static Saml get(String name, Output<String> id, SamlState 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:
    BindingProtocol string
    IdP Binding protocol. Valid values: post, redirect.
    Cert string
    Certificate to sign SAML messages.
    DefaultLoginPage string
    Choose default login page. Valid values: normal, sso.
    DefaultProfile string
    Default profile for new SSO admin.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    EntityId string
    SP entity ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IdpCert string
    IDP certificate name.
    IdpEntityId string
    IDP entity ID.
    IdpSingleLogoutUrl string
    IDP single logout URL.
    IdpSingleSignOnUrl string
    IDP single sign-on URL.
    Life int
    Length of the range of time when the assertion is valid (in minutes).
    PortalUrl string
    SP portal URL.
    Role string
    SAML role. Valid values: identity-provider, service-provider.
    ServerAddress string
    Server address.
    ServiceProviders List<Pulumiverse.Fortios.System.Inputs.SamlServiceProvider>
    Authorized service providers. The structure of service_providers block is documented below.
    SingleLogoutUrl string
    SP single logout URL.
    SingleSignOnUrl string
    SP single sign-on URL.
    Status string
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    Tolerance int
    Tolerance to the range of time when the assertion is valid (in minutes).
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    BindingProtocol string
    IdP Binding protocol. Valid values: post, redirect.
    Cert string
    Certificate to sign SAML messages.
    DefaultLoginPage string
    Choose default login page. Valid values: normal, sso.
    DefaultProfile string
    Default profile for new SSO admin.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    EntityId string
    SP entity ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    IdpCert string
    IDP certificate name.
    IdpEntityId string
    IDP entity ID.
    IdpSingleLogoutUrl string
    IDP single logout URL.
    IdpSingleSignOnUrl string
    IDP single sign-on URL.
    Life int
    Length of the range of time when the assertion is valid (in minutes).
    PortalUrl string
    SP portal URL.
    Role string
    SAML role. Valid values: identity-provider, service-provider.
    ServerAddress string
    Server address.
    ServiceProviders []SamlServiceProviderArgs
    Authorized service providers. The structure of service_providers block is documented below.
    SingleLogoutUrl string
    SP single logout URL.
    SingleSignOnUrl string
    SP single sign-on URL.
    Status string
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    Tolerance int
    Tolerance to the range of time when the assertion is valid (in minutes).
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    bindingProtocol String
    IdP Binding protocol. Valid values: post, redirect.
    cert String
    Certificate to sign SAML messages.
    defaultLoginPage String
    Choose default login page. Valid values: normal, sso.
    defaultProfile String
    Default profile for new SSO admin.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entityId String
    SP entity ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idpCert String
    IDP certificate name.
    idpEntityId String
    IDP entity ID.
    idpSingleLogoutUrl String
    IDP single logout URL.
    idpSingleSignOnUrl String
    IDP single sign-on URL.
    life Integer
    Length of the range of time when the assertion is valid (in minutes).
    portalUrl String
    SP portal URL.
    role String
    SAML role. Valid values: identity-provider, service-provider.
    serverAddress String
    Server address.
    serviceProviders List<SamlServiceProvider>
    Authorized service providers. The structure of service_providers block is documented below.
    singleLogoutUrl String
    SP single logout URL.
    singleSignOnUrl String
    SP single sign-on URL.
    status String
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance Integer
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    bindingProtocol string
    IdP Binding protocol. Valid values: post, redirect.
    cert string
    Certificate to sign SAML messages.
    defaultLoginPage string
    Choose default login page. Valid values: normal, sso.
    defaultProfile string
    Default profile for new SSO admin.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entityId string
    SP entity ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idpCert string
    IDP certificate name.
    idpEntityId string
    IDP entity ID.
    idpSingleLogoutUrl string
    IDP single logout URL.
    idpSingleSignOnUrl string
    IDP single sign-on URL.
    life number
    Length of the range of time when the assertion is valid (in minutes).
    portalUrl string
    SP portal URL.
    role string
    SAML role. Valid values: identity-provider, service-provider.
    serverAddress string
    Server address.
    serviceProviders SamlServiceProvider[]
    Authorized service providers. The structure of service_providers block is documented below.
    singleLogoutUrl string
    SP single logout URL.
    singleSignOnUrl string
    SP single sign-on URL.
    status string
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance number
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    binding_protocol str
    IdP Binding protocol. Valid values: post, redirect.
    cert str
    Certificate to sign SAML messages.
    default_login_page str
    Choose default login page. Valid values: normal, sso.
    default_profile str
    Default profile for new SSO admin.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entity_id str
    SP entity ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idp_cert str
    IDP certificate name.
    idp_entity_id str
    IDP entity ID.
    idp_single_logout_url str
    IDP single logout URL.
    idp_single_sign_on_url str
    IDP single sign-on URL.
    life int
    Length of the range of time when the assertion is valid (in minutes).
    portal_url str
    SP portal URL.
    role str
    SAML role. Valid values: identity-provider, service-provider.
    server_address str
    Server address.
    service_providers Sequence[SamlServiceProviderArgs]
    Authorized service providers. The structure of service_providers block is documented below.
    single_logout_url str
    SP single logout URL.
    single_sign_on_url str
    SP single sign-on URL.
    status str
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance int
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    bindingProtocol String
    IdP Binding protocol. Valid values: post, redirect.
    cert String
    Certificate to sign SAML messages.
    defaultLoginPage String
    Choose default login page. Valid values: normal, sso.
    defaultProfile String
    Default profile for new SSO admin.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entityId String
    SP entity ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    idpCert String
    IDP certificate name.
    idpEntityId String
    IDP entity ID.
    idpSingleLogoutUrl String
    IDP single logout URL.
    idpSingleSignOnUrl String
    IDP single sign-on URL.
    life Number
    Length of the range of time when the assertion is valid (in minutes).
    portalUrl String
    SP portal URL.
    role String
    SAML role. Valid values: identity-provider, service-provider.
    serverAddress String
    Server address.
    serviceProviders List<Property Map>
    Authorized service providers. The structure of service_providers block is documented below.
    singleLogoutUrl String
    SP single logout URL.
    singleSignOnUrl String
    SP single sign-on URL.
    status String
    Enable/disable SAML authentication (default = disable). Valid values: enable, disable.
    tolerance Number
    Tolerance to the range of time when the assertion is valid (in minutes).
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    SamlServiceProvider, SamlServiceProviderArgs

    AssertionAttributes List<Pulumiverse.Fortios.System.Inputs.SamlServiceProviderAssertionAttribute>
    Customized SAML attributes to send along with assertion. The structure of assertion_attributes block is documented below.
    IdpEntityId string
    IDP entity ID.
    IdpSingleLogoutUrl string
    IDP single logout URL.
    IdpSingleSignOnUrl string
    IDP single sign-on URL.
    Name string
    Name.
    Prefix string
    Prefix.
    SpBindingProtocol string
    SP binding protocol. Valid values: post, redirect.
    SpCert string
    SP certificate name.
    SpEntityId string
    SP entity ID.
    SpPortalUrl string
    SP portal URL.
    SpSingleLogoutUrl string
    SP single logout URL.
    SpSingleSignOnUrl string
    SP single sign-on URL.
    AssertionAttributes []SamlServiceProviderAssertionAttribute
    Customized SAML attributes to send along with assertion. The structure of assertion_attributes block is documented below.
    IdpEntityId string
    IDP entity ID.
    IdpSingleLogoutUrl string
    IDP single logout URL.
    IdpSingleSignOnUrl string
    IDP single sign-on URL.
    Name string
    Name.
    Prefix string
    Prefix.
    SpBindingProtocol string
    SP binding protocol. Valid values: post, redirect.
    SpCert string
    SP certificate name.
    SpEntityId string
    SP entity ID.
    SpPortalUrl string
    SP portal URL.
    SpSingleLogoutUrl string
    SP single logout URL.
    SpSingleSignOnUrl string
    SP single sign-on URL.
    assertionAttributes List<SamlServiceProviderAssertionAttribute>
    Customized SAML attributes to send along with assertion. The structure of assertion_attributes block is documented below.
    idpEntityId String
    IDP entity ID.
    idpSingleLogoutUrl String
    IDP single logout URL.
    idpSingleSignOnUrl String
    IDP single sign-on URL.
    name String
    Name.
    prefix String
    Prefix.
    spBindingProtocol String
    SP binding protocol. Valid values: post, redirect.
    spCert String
    SP certificate name.
    spEntityId String
    SP entity ID.
    spPortalUrl String
    SP portal URL.
    spSingleLogoutUrl String
    SP single logout URL.
    spSingleSignOnUrl String
    SP single sign-on URL.
    assertionAttributes SamlServiceProviderAssertionAttribute[]
    Customized SAML attributes to send along with assertion. The structure of assertion_attributes block is documented below.
    idpEntityId string
    IDP entity ID.
    idpSingleLogoutUrl string
    IDP single logout URL.
    idpSingleSignOnUrl string
    IDP single sign-on URL.
    name string
    Name.
    prefix string
    Prefix.
    spBindingProtocol string
    SP binding protocol. Valid values: post, redirect.
    spCert string
    SP certificate name.
    spEntityId string
    SP entity ID.
    spPortalUrl string
    SP portal URL.
    spSingleLogoutUrl string
    SP single logout URL.
    spSingleSignOnUrl string
    SP single sign-on URL.
    assertion_attributes Sequence[SamlServiceProviderAssertionAttribute]
    Customized SAML attributes to send along with assertion. The structure of assertion_attributes block is documented below.
    idp_entity_id str
    IDP entity ID.
    idp_single_logout_url str
    IDP single logout URL.
    idp_single_sign_on_url str
    IDP single sign-on URL.
    name str
    Name.
    prefix str
    Prefix.
    sp_binding_protocol str
    SP binding protocol. Valid values: post, redirect.
    sp_cert str
    SP certificate name.
    sp_entity_id str
    SP entity ID.
    sp_portal_url str
    SP portal URL.
    sp_single_logout_url str
    SP single logout URL.
    sp_single_sign_on_url str
    SP single sign-on URL.
    assertionAttributes List<Property Map>
    Customized SAML attributes to send along with assertion. The structure of assertion_attributes block is documented below.
    idpEntityId String
    IDP entity ID.
    idpSingleLogoutUrl String
    IDP single logout URL.
    idpSingleSignOnUrl String
    IDP single sign-on URL.
    name String
    Name.
    prefix String
    Prefix.
    spBindingProtocol String
    SP binding protocol. Valid values: post, redirect.
    spCert String
    SP certificate name.
    spEntityId String
    SP entity ID.
    spPortalUrl String
    SP portal URL.
    spSingleLogoutUrl String
    SP single logout URL.
    spSingleSignOnUrl String
    SP single sign-on URL.

    SamlServiceProviderAssertionAttribute, SamlServiceProviderAssertionAttributeArgs

    Name string
    Name.
    Type string
    Type.
    Name string
    Name.
    Type string
    Type.
    name String
    Name.
    type String
    Type.
    name string
    Name.
    type string
    Type.
    name str
    Name.
    type str
    Type.
    name String
    Name.
    type String
    Type.

    Import

    System Saml can be imported using any of these accepted formats:

    $ pulumi import fortios:system/saml:Saml labelname SystemSaml

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/saml:Saml labelname SystemSaml

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios