1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Ssofortigatecloudadmin
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.Ssofortigatecloudadmin

Explore with Pulumi AI

Configure FortiCloud SSO admin users. Applies to FortiOS Version >= 7.2.4.

Create Ssofortigatecloudadmin Resource

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

Constructor syntax

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

@overload
def Ssofortigatecloudadmin(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           accprofile: Optional[str] = None,
                           dynamic_sort_subtable: Optional[str] = None,
                           get_all_tables: Optional[str] = None,
                           name: Optional[str] = None,
                           vdomparam: Optional[str] = None,
                           vdoms: Optional[Sequence[SsofortigatecloudadminVdomArgs]] = None)
func NewSsofortigatecloudadmin(ctx *Context, name string, args *SsofortigatecloudadminArgs, opts ...ResourceOption) (*Ssofortigatecloudadmin, error)
public Ssofortigatecloudadmin(string name, SsofortigatecloudadminArgs? args = null, CustomResourceOptions? opts = null)
public Ssofortigatecloudadmin(String name, SsofortigatecloudadminArgs args)
public Ssofortigatecloudadmin(String name, SsofortigatecloudadminArgs args, CustomResourceOptions options)
type: fortios:system:Ssofortigatecloudadmin
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 SsofortigatecloudadminArgs
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 SsofortigatecloudadminArgs
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 SsofortigatecloudadminArgs
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 SsofortigatecloudadminArgs
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. SsofortigatecloudadminArgs
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 ssofortigatecloudadminResource = new Fortios.System.Ssofortigatecloudadmin("ssofortigatecloudadminResource", new()
{
    Accprofile = "string",
    DynamicSortSubtable = "string",
    GetAllTables = "string",
    Name = "string",
    Vdomparam = "string",
    Vdoms = new[]
    {
        new Fortios.System.Inputs.SsofortigatecloudadminVdomArgs
        {
            Name = "string",
        },
    },
});
Copy
example, err := system.NewSsofortigatecloudadmin(ctx, "ssofortigatecloudadminResource", &system.SsofortigatecloudadminArgs{
	Accprofile:          pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	GetAllTables:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	Vdomparam:           pulumi.String("string"),
	Vdoms: system.SsofortigatecloudadminVdomArray{
		&system.SsofortigatecloudadminVdomArgs{
			Name: pulumi.String("string"),
		},
	},
})
Copy
var ssofortigatecloudadminResource = new Ssofortigatecloudadmin("ssofortigatecloudadminResource", SsofortigatecloudadminArgs.builder()
    .accprofile("string")
    .dynamicSortSubtable("string")
    .getAllTables("string")
    .name("string")
    .vdomparam("string")
    .vdoms(SsofortigatecloudadminVdomArgs.builder()
        .name("string")
        .build())
    .build());
Copy
ssofortigatecloudadmin_resource = fortios.system.Ssofortigatecloudadmin("ssofortigatecloudadminResource",
    accprofile="string",
    dynamic_sort_subtable="string",
    get_all_tables="string",
    name="string",
    vdomparam="string",
    vdoms=[{
        "name": "string",
    }])
Copy
const ssofortigatecloudadminResource = new fortios.system.Ssofortigatecloudadmin("ssofortigatecloudadminResource", {
    accprofile: "string",
    dynamicSortSubtable: "string",
    getAllTables: "string",
    name: "string",
    vdomparam: "string",
    vdoms: [{
        name: "string",
    }],
});
Copy
type: fortios:system:Ssofortigatecloudadmin
properties:
    accprofile: string
    dynamicSortSubtable: string
    getAllTables: string
    name: string
    vdomparam: string
    vdoms:
        - name: string
Copy

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

Accprofile string
FortiCloud SSO admin user access profile.
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 ].
GetAllTables 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.
Name Changes to this property will trigger replacement. string
FortiCloud SSO admin name.
Vdomparam Changes to this property will trigger replacement. 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.
Vdoms List<Pulumiverse.Fortios.System.Inputs.SsofortigatecloudadminVdom>
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
Accprofile string
FortiCloud SSO admin user access profile.
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 ].
GetAllTables 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.
Name Changes to this property will trigger replacement. string
FortiCloud SSO admin name.
Vdomparam Changes to this property will trigger replacement. 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.
Vdoms []SsofortigatecloudadminVdomArgs
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile String
FortiCloud SSO admin user access profile.
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 ].
getAllTables 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.
name Changes to this property will trigger replacement. String
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms List<SsofortigatecloudadminVdom>
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile string
FortiCloud SSO admin user access profile.
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 ].
getAllTables 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.
name Changes to this property will trigger replacement. string
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms SsofortigatecloudadminVdom[]
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile str
FortiCloud SSO admin user access profile.
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 ].
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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. str
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms Sequence[SsofortigatecloudadminVdomArgs]
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile String
FortiCloud SSO admin user access profile.
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 ].
getAllTables 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.
name Changes to this property will trigger replacement. String
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms List<Property Map>
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.

Outputs

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

Get an existing Ssofortigatecloudadmin 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?: SsofortigatecloudadminState, opts?: CustomResourceOptions): Ssofortigatecloudadmin
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accprofile: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None,
        vdoms: Optional[Sequence[SsofortigatecloudadminVdomArgs]] = None) -> Ssofortigatecloudadmin
func GetSsofortigatecloudadmin(ctx *Context, name string, id IDInput, state *SsofortigatecloudadminState, opts ...ResourceOption) (*Ssofortigatecloudadmin, error)
public static Ssofortigatecloudadmin Get(string name, Input<string> id, SsofortigatecloudadminState? state, CustomResourceOptions? opts = null)
public static Ssofortigatecloudadmin get(String name, Output<String> id, SsofortigatecloudadminState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Ssofortigatecloudadmin    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:
Accprofile string
FortiCloud SSO admin user access profile.
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 ].
GetAllTables 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.
Name Changes to this property will trigger replacement. string
FortiCloud SSO admin name.
Vdomparam Changes to this property will trigger replacement. 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.
Vdoms List<Pulumiverse.Fortios.System.Inputs.SsofortigatecloudadminVdom>
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
Accprofile string
FortiCloud SSO admin user access profile.
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 ].
GetAllTables 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.
Name Changes to this property will trigger replacement. string
FortiCloud SSO admin name.
Vdomparam Changes to this property will trigger replacement. 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.
Vdoms []SsofortigatecloudadminVdomArgs
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile String
FortiCloud SSO admin user access profile.
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 ].
getAllTables 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.
name Changes to this property will trigger replacement. String
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms List<SsofortigatecloudadminVdom>
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile string
FortiCloud SSO admin user access profile.
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 ].
getAllTables 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.
name Changes to this property will trigger replacement. string
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms SsofortigatecloudadminVdom[]
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile str
FortiCloud SSO admin user access profile.
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 ].
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, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
name Changes to this property will trigger replacement. str
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms Sequence[SsofortigatecloudadminVdomArgs]
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.
accprofile String
FortiCloud SSO admin user access profile.
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 ].
getAllTables 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.
name Changes to this property will trigger replacement. String
FortiCloud SSO admin name.
vdomparam Changes to this property will trigger replacement. 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.
vdoms List<Property Map>
Virtual domain(s) that the administrator can access. The structure of vdom block is documented below.

Supporting Types

SsofortigatecloudadminVdom
, SsofortigatecloudadminVdomArgs

Name string
Virtual domain name.
Name string
Virtual domain name.
name String
Virtual domain name.
name string
Virtual domain name.
name str
Virtual domain name.
name String
Virtual domain name.

Import

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

$ pulumi import fortios:system/ssofortigatecloudadmin:Ssofortigatecloudadmin labelname {{name}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/ssofortigatecloudadmin:Ssofortigatecloudadmin labelname {{name}}
Copy

$ 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.