1. Packages
  2. Fortios
  3. API Docs
  4. user
  5. Externalidentityprovider
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.user.Externalidentityprovider

Explore with Pulumi AI

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

    Configure external identity provider. Applies to FortiOS Version >= 7.4.2.

    Create Externalidentityprovider Resource

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

    Constructor syntax

    new Externalidentityprovider(name: string, args?: ExternalidentityproviderArgs, opts?: CustomResourceOptions);
    @overload
    def Externalidentityprovider(resource_name: str,
                                 args: Optional[ExternalidentityproviderArgs] = None,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Externalidentityprovider(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 group_attr_name: Optional[str] = None,
                                 interface: Optional[str] = None,
                                 interface_select_method: Optional[str] = None,
                                 name: Optional[str] = None,
                                 port: Optional[int] = None,
                                 server_identity_check: Optional[str] = None,
                                 source_ip: Optional[str] = None,
                                 timeout: Optional[int] = None,
                                 type: Optional[str] = None,
                                 url: Optional[str] = None,
                                 user_attr_name: Optional[str] = None,
                                 vdomparam: Optional[str] = None,
                                 version: Optional[str] = None)
    func NewExternalidentityprovider(ctx *Context, name string, args *ExternalidentityproviderArgs, opts ...ResourceOption) (*Externalidentityprovider, error)
    public Externalidentityprovider(string name, ExternalidentityproviderArgs? args = null, CustomResourceOptions? opts = null)
    public Externalidentityprovider(String name, ExternalidentityproviderArgs args)
    public Externalidentityprovider(String name, ExternalidentityproviderArgs args, CustomResourceOptions options)
    
    type: fortios:user:Externalidentityprovider
    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 ExternalidentityproviderArgs
    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 ExternalidentityproviderArgs
    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 ExternalidentityproviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalidentityproviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalidentityproviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var externalidentityproviderResource = new Fortios.User.Externalidentityprovider("externalidentityproviderResource", new()
    {
        GroupAttrName = "string",
        Interface = "string",
        InterfaceSelectMethod = "string",
        Name = "string",
        Port = 0,
        ServerIdentityCheck = "string",
        SourceIp = "string",
        Timeout = 0,
        Type = "string",
        Url = "string",
        UserAttrName = "string",
        Vdomparam = "string",
        Version = "string",
    });
    
    example, err := user.NewExternalidentityprovider(ctx, "externalidentityproviderResource", &user.ExternalidentityproviderArgs{
    	GroupAttrName:         pulumi.String("string"),
    	Interface:             pulumi.String("string"),
    	InterfaceSelectMethod: pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	Port:                  pulumi.Int(0),
    	ServerIdentityCheck:   pulumi.String("string"),
    	SourceIp:              pulumi.String("string"),
    	Timeout:               pulumi.Int(0),
    	Type:                  pulumi.String("string"),
    	Url:                   pulumi.String("string"),
    	UserAttrName:          pulumi.String("string"),
    	Vdomparam:             pulumi.String("string"),
    	Version:               pulumi.String("string"),
    })
    
    var externalidentityproviderResource = new Externalidentityprovider("externalidentityproviderResource", ExternalidentityproviderArgs.builder()        
        .groupAttrName("string")
        .interface_("string")
        .interfaceSelectMethod("string")
        .name("string")
        .port(0)
        .serverIdentityCheck("string")
        .sourceIp("string")
        .timeout(0)
        .type("string")
        .url("string")
        .userAttrName("string")
        .vdomparam("string")
        .version("string")
        .build());
    
    externalidentityprovider_resource = fortios.user.Externalidentityprovider("externalidentityproviderResource",
        group_attr_name="string",
        interface="string",
        interface_select_method="string",
        name="string",
        port=0,
        server_identity_check="string",
        source_ip="string",
        timeout=0,
        type="string",
        url="string",
        user_attr_name="string",
        vdomparam="string",
        version="string")
    
    const externalidentityproviderResource = new fortios.user.Externalidentityprovider("externalidentityproviderResource", {
        groupAttrName: "string",
        "interface": "string",
        interfaceSelectMethod: "string",
        name: "string",
        port: 0,
        serverIdentityCheck: "string",
        sourceIp: "string",
        timeout: 0,
        type: "string",
        url: "string",
        userAttrName: "string",
        vdomparam: "string",
        version: "string",
    });
    
    type: fortios:user:Externalidentityprovider
    properties:
        groupAttrName: string
        interface: string
        interfaceSelectMethod: string
        name: string
        port: 0
        serverIdentityCheck: string
        sourceIp: string
        timeout: 0
        type: string
        url: string
        userAttrName: string
        vdomparam: string
        version: string
    

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

    GroupAttrName string
    Group attribute name in authentication query.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External identity provider name.
    Port int
    External identity provider service port number (0 to use default).
    ServerIdentityCheck string
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    SourceIp string
    Use this IPv4/v6 address to connect to the external identity provider.
    Timeout int
    Connection timeout value in seconds (default=5).
    Type string
    External identity provider type. Valid values: ms-graph.
    Url string
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    UserAttrName string
    User attribute name in authentication query.
    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.
    Version string
    External identity API version. Valid values: v1.0, beta.
    GroupAttrName string
    Group attribute name in authentication query.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External identity provider name.
    Port int
    External identity provider service port number (0 to use default).
    ServerIdentityCheck string
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    SourceIp string
    Use this IPv4/v6 address to connect to the external identity provider.
    Timeout int
    Connection timeout value in seconds (default=5).
    Type string
    External identity provider type. Valid values: ms-graph.
    Url string
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    UserAttrName string
    User attribute name in authentication query.
    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.
    Version string
    External identity API version. Valid values: v1.0, beta.
    groupAttrName String
    Group attribute name in authentication query.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    name String
    External identity provider name.
    port Integer
    External identity provider service port number (0 to use default).
    serverIdentityCheck String
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    sourceIp String
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout Integer
    Connection timeout value in seconds (default=5).
    type String
    External identity provider type. Valid values: ms-graph.
    url String
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    userAttrName String
    User attribute name in authentication query.
    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.
    version String
    External identity API version. Valid values: v1.0, beta.
    groupAttrName string
    Group attribute name in authentication query.
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name string
    External identity provider name.
    port number
    External identity provider service port number (0 to use default).
    serverIdentityCheck string
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    sourceIp string
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout number
    Connection timeout value in seconds (default=5).
    type string
    External identity provider type. Valid values: ms-graph.
    url string
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    userAttrName string
    User attribute name in authentication query.
    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.
    version string
    External identity API version. Valid values: v1.0, beta.
    group_attr_name str
    Group attribute name in authentication query.
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name str
    External identity provider name.
    port int
    External identity provider service port number (0 to use default).
    server_identity_check str
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    source_ip str
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout int
    Connection timeout value in seconds (default=5).
    type str
    External identity provider type. Valid values: ms-graph.
    url str
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    user_attr_name str
    User attribute name in authentication query.
    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.
    version str
    External identity API version. Valid values: v1.0, beta.
    groupAttrName String
    Group attribute name in authentication query.
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name String
    External identity provider name.
    port Number
    External identity provider service port number (0 to use default).
    serverIdentityCheck String
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    sourceIp String
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout Number
    Connection timeout value in seconds (default=5).
    type String
    External identity provider type. Valid values: ms-graph.
    url String
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    userAttrName String
    User attribute name in authentication query.
    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.
    version String
    External identity API version. Valid values: v1.0, beta.

    Outputs

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

    Get an existing Externalidentityprovider 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?: ExternalidentityproviderState, opts?: CustomResourceOptions): Externalidentityprovider
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            group_attr_name: Optional[str] = None,
            interface: Optional[str] = None,
            interface_select_method: Optional[str] = None,
            name: Optional[str] = None,
            port: Optional[int] = None,
            server_identity_check: Optional[str] = None,
            source_ip: Optional[str] = None,
            timeout: Optional[int] = None,
            type: Optional[str] = None,
            url: Optional[str] = None,
            user_attr_name: Optional[str] = None,
            vdomparam: Optional[str] = None,
            version: Optional[str] = None) -> Externalidentityprovider
    func GetExternalidentityprovider(ctx *Context, name string, id IDInput, state *ExternalidentityproviderState, opts ...ResourceOption) (*Externalidentityprovider, error)
    public static Externalidentityprovider Get(string name, Input<string> id, ExternalidentityproviderState? state, CustomResourceOptions? opts = null)
    public static Externalidentityprovider get(String name, Output<String> id, ExternalidentityproviderState 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:
    GroupAttrName string
    Group attribute name in authentication query.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External identity provider name.
    Port int
    External identity provider service port number (0 to use default).
    ServerIdentityCheck string
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    SourceIp string
    Use this IPv4/v6 address to connect to the external identity provider.
    Timeout int
    Connection timeout value in seconds (default=5).
    Type string
    External identity provider type. Valid values: ms-graph.
    Url string
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    UserAttrName string
    User attribute name in authentication query.
    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.
    Version string
    External identity API version. Valid values: v1.0, beta.
    GroupAttrName string
    Group attribute name in authentication query.
    Interface string
    Specify outgoing interface to reach server.
    InterfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    Name string
    External identity provider name.
    Port int
    External identity provider service port number (0 to use default).
    ServerIdentityCheck string
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    SourceIp string
    Use this IPv4/v6 address to connect to the external identity provider.
    Timeout int
    Connection timeout value in seconds (default=5).
    Type string
    External identity provider type. Valid values: ms-graph.
    Url string
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    UserAttrName string
    User attribute name in authentication query.
    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.
    Version string
    External identity API version. Valid values: v1.0, beta.
    groupAttrName String
    Group attribute name in authentication query.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    interface_ String
    Specify outgoing interface to reach server.
    name String
    External identity provider name.
    port Integer
    External identity provider service port number (0 to use default).
    serverIdentityCheck String
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    sourceIp String
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout Integer
    Connection timeout value in seconds (default=5).
    type String
    External identity provider type. Valid values: ms-graph.
    url String
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    userAttrName String
    User attribute name in authentication query.
    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.
    version String
    External identity API version. Valid values: v1.0, beta.
    groupAttrName string
    Group attribute name in authentication query.
    interface string
    Specify outgoing interface to reach server.
    interfaceSelectMethod string
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name string
    External identity provider name.
    port number
    External identity provider service port number (0 to use default).
    serverIdentityCheck string
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    sourceIp string
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout number
    Connection timeout value in seconds (default=5).
    type string
    External identity provider type. Valid values: ms-graph.
    url string
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    userAttrName string
    User attribute name in authentication query.
    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.
    version string
    External identity API version. Valid values: v1.0, beta.
    group_attr_name str
    Group attribute name in authentication query.
    interface str
    Specify outgoing interface to reach server.
    interface_select_method str
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name str
    External identity provider name.
    port int
    External identity provider service port number (0 to use default).
    server_identity_check str
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    source_ip str
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout int
    Connection timeout value in seconds (default=5).
    type str
    External identity provider type. Valid values: ms-graph.
    url str
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    user_attr_name str
    User attribute name in authentication query.
    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.
    version str
    External identity API version. Valid values: v1.0, beta.
    groupAttrName String
    Group attribute name in authentication query.
    interface String
    Specify outgoing interface to reach server.
    interfaceSelectMethod String
    Specify how to select outgoing interface to reach server. Valid values: auto, sdwan, specify.
    name String
    External identity provider name.
    port Number
    External identity provider service port number (0 to use default).
    serverIdentityCheck String
    Enable/disable server's identity check against its certificate and subject alternative name(s). Valid values: disable, enable.
    sourceIp String
    Use this IPv4/v6 address to connect to the external identity provider.
    timeout Number
    Connection timeout value in seconds (default=5).
    type String
    External identity provider type. Valid values: ms-graph.
    url String
    External identity provider URL (e.g. "https://example.com:8080/api/v1").
    userAttrName String
    User attribute name in authentication query.
    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.
    version String
    External identity API version. Valid values: v1.0, beta.

    Import

    User ExternalIdentityProvider can be imported using any of these accepted formats:

    $ pulumi import fortios:user/externalidentityprovider:Externalidentityprovider labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/externalidentityprovider:Externalidentityprovider labelname {{name}}
    

    $ 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