@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
328 lines (327 loc) • 11.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Global settings for SAML authentication. Applies to FortiOS Version `>= 6.2.4`.
*
* ## Example Usage
*
* ```typescript
* 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
*
* System Saml can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:system/saml:Saml labelname SystemSaml
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:system/saml:Saml labelname SystemSaml
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Saml extends pulumi.CustomResource {
/**
* Get an existing Saml resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SamlState, opts?: pulumi.CustomResourceOptions): Saml;
/**
* Returns true if the given object is an instance of Saml. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Saml;
/**
* IdP Binding protocol. Valid values: `post`, `redirect`.
*/
readonly bindingProtocol: pulumi.Output<string>;
/**
* Certificate to sign SAML messages.
*/
readonly cert: pulumi.Output<string>;
/**
* Choose default login page. Valid values: `normal`, `sso`.
*/
readonly defaultLoginPage: pulumi.Output<string>;
/**
* Default profile for new SSO admin.
*/
readonly defaultProfile: pulumi.Output<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 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* SP entity ID.
*/
readonly entityId: pulumi.Output<string>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* IDP certificate name.
*/
readonly idpCert: pulumi.Output<string>;
/**
* IDP entity ID.
*/
readonly idpEntityId: pulumi.Output<string>;
/**
* IDP single logout URL.
*/
readonly idpSingleLogoutUrl: pulumi.Output<string>;
/**
* IDP single sign-on URL.
*/
readonly idpSingleSignOnUrl: pulumi.Output<string>;
/**
* Length of the range of time when the assertion is valid (in minutes).
*/
readonly life: pulumi.Output<number>;
/**
* SP portal URL.
*/
readonly portalUrl: pulumi.Output<string>;
/**
* SAML role. Valid values: `identity-provider`, `service-provider`.
*/
readonly role: pulumi.Output<string>;
/**
* Server address.
*/
readonly serverAddress: pulumi.Output<string>;
/**
* Authorized service providers. The structure of `serviceProviders` block is documented below.
*/
readonly serviceProviders: pulumi.Output<outputs.system.SamlServiceProvider[] | undefined>;
/**
* SP single logout URL.
*/
readonly singleLogoutUrl: pulumi.Output<string>;
/**
* SP single sign-on URL.
*/
readonly singleSignOnUrl: pulumi.Output<string>;
/**
* Enable/disable SAML authentication (default = disable). Valid values: `enable`, `disable`.
*/
readonly status: pulumi.Output<string>;
/**
* Tolerance to the range of time when the assertion is valid (in minutes).
*/
readonly tolerance: pulumi.Output<number>;
/**
* 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.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Create a Saml resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: SamlArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Saml resources.
*/
export interface SamlState {
/**
* IdP Binding protocol. Valid values: `post`, `redirect`.
*/
bindingProtocol?: pulumi.Input<string>;
/**
* Certificate to sign SAML messages.
*/
cert?: pulumi.Input<string>;
/**
* Choose default login page. Valid values: `normal`, `sso`.
*/
defaultLoginPage?: pulumi.Input<string>;
/**
* Default profile for new SSO admin.
*/
defaultProfile?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* SP entity ID.
*/
entityId?: pulumi.Input<string>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* IDP certificate name.
*/
idpCert?: pulumi.Input<string>;
/**
* IDP entity ID.
*/
idpEntityId?: pulumi.Input<string>;
/**
* IDP single logout URL.
*/
idpSingleLogoutUrl?: pulumi.Input<string>;
/**
* IDP single sign-on URL.
*/
idpSingleSignOnUrl?: pulumi.Input<string>;
/**
* Length of the range of time when the assertion is valid (in minutes).
*/
life?: pulumi.Input<number>;
/**
* SP portal URL.
*/
portalUrl?: pulumi.Input<string>;
/**
* SAML role. Valid values: `identity-provider`, `service-provider`.
*/
role?: pulumi.Input<string>;
/**
* Server address.
*/
serverAddress?: pulumi.Input<string>;
/**
* Authorized service providers. The structure of `serviceProviders` block is documented below.
*/
serviceProviders?: pulumi.Input<pulumi.Input<inputs.system.SamlServiceProvider>[]>;
/**
* SP single logout URL.
*/
singleLogoutUrl?: pulumi.Input<string>;
/**
* SP single sign-on URL.
*/
singleSignOnUrl?: pulumi.Input<string>;
/**
* Enable/disable SAML authentication (default = disable). Valid values: `enable`, `disable`.
*/
status?: pulumi.Input<string>;
/**
* Tolerance to the range of time when the assertion is valid (in minutes).
*/
tolerance?: pulumi.Input<number>;
/**
* 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.
*/
vdomparam?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Saml resource.
*/
export interface SamlArgs {
/**
* IdP Binding protocol. Valid values: `post`, `redirect`.
*/
bindingProtocol?: pulumi.Input<string>;
/**
* Certificate to sign SAML messages.
*/
cert?: pulumi.Input<string>;
/**
* Choose default login page. Valid values: `normal`, `sso`.
*/
defaultLoginPage?: pulumi.Input<string>;
/**
* Default profile for new SSO admin.
*/
defaultProfile?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* SP entity ID.
*/
entityId?: pulumi.Input<string>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* IDP certificate name.
*/
idpCert?: pulumi.Input<string>;
/**
* IDP entity ID.
*/
idpEntityId?: pulumi.Input<string>;
/**
* IDP single logout URL.
*/
idpSingleLogoutUrl?: pulumi.Input<string>;
/**
* IDP single sign-on URL.
*/
idpSingleSignOnUrl?: pulumi.Input<string>;
/**
* Length of the range of time when the assertion is valid (in minutes).
*/
life?: pulumi.Input<number>;
/**
* SP portal URL.
*/
portalUrl?: pulumi.Input<string>;
/**
* SAML role. Valid values: `identity-provider`, `service-provider`.
*/
role?: pulumi.Input<string>;
/**
* Server address.
*/
serverAddress?: pulumi.Input<string>;
/**
* Authorized service providers. The structure of `serviceProviders` block is documented below.
*/
serviceProviders?: pulumi.Input<pulumi.Input<inputs.system.SamlServiceProvider>[]>;
/**
* SP single logout URL.
*/
singleLogoutUrl?: pulumi.Input<string>;
/**
* SP single sign-on URL.
*/
singleSignOnUrl?: pulumi.Input<string>;
/**
* Enable/disable SAML authentication (default = disable). Valid values: `enable`, `disable`.
*/
status?: pulumi.Input<string>;
/**
* Tolerance to the range of time when the assertion is valid (in minutes).
*/
tolerance?: pulumi.Input<number>;
/**
* 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.
*/
vdomparam?: pulumi.Input<string>;
}