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

fortios.system.Apiuser

Explore with Pulumi AI

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

    Import

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

    $ pulumi import fortios:system/apiuser:Apiuser labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/apiuser:Apiuser labelname {{name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

    Create Apiuser Resource

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

    Constructor syntax

    new Apiuser(name: string, args: ApiuserArgs, opts?: CustomResourceOptions);
    @overload
    def Apiuser(resource_name: str,
                args: ApiuserArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Apiuser(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                accprofile: Optional[str] = None,
                api_key: Optional[str] = None,
                comments: Optional[str] = None,
                cors_allow_origin: Optional[str] = None,
                dynamic_sort_subtable: Optional[str] = None,
                get_all_tables: Optional[str] = None,
                name: Optional[str] = None,
                peer_auth: Optional[str] = None,
                peer_group: Optional[str] = None,
                schedule: Optional[str] = None,
                trusthosts: Optional[Sequence[ApiuserTrusthostArgs]] = None,
                vdomparam: Optional[str] = None,
                vdoms: Optional[Sequence[ApiuserVdomArgs]] = None)
    func NewApiuser(ctx *Context, name string, args ApiuserArgs, opts ...ResourceOption) (*Apiuser, error)
    public Apiuser(string name, ApiuserArgs args, CustomResourceOptions? opts = null)
    public Apiuser(String name, ApiuserArgs args)
    public Apiuser(String name, ApiuserArgs args, CustomResourceOptions options)
    
    type: fortios:system:Apiuser
    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 ApiuserArgs
    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 ApiuserArgs
    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 ApiuserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiuserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiuserArgs
    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 apiuserResource = new Fortios.System.Apiuser("apiuserResource", new()
    {
        Accprofile = "string",
        ApiKey = "string",
        Comments = "string",
        CorsAllowOrigin = "string",
        DynamicSortSubtable = "string",
        GetAllTables = "string",
        Name = "string",
        PeerAuth = "string",
        PeerGroup = "string",
        Schedule = "string",
        Trusthosts = new[]
        {
            new Fortios.System.Inputs.ApiuserTrusthostArgs
            {
                Id = 0,
                Ipv4Trusthost = "string",
                Ipv6Trusthost = "string",
                Type = "string",
            },
        },
        Vdomparam = "string",
        Vdoms = new[]
        {
            new Fortios.System.Inputs.ApiuserVdomArgs
            {
                Name = "string",
            },
        },
    });
    
    example, err := system.NewApiuser(ctx, "apiuserResource", &system.ApiuserArgs{
    	Accprofile:          pulumi.String("string"),
    	ApiKey:              pulumi.String("string"),
    	Comments:            pulumi.String("string"),
    	CorsAllowOrigin:     pulumi.String("string"),
    	DynamicSortSubtable: pulumi.String("string"),
    	GetAllTables:        pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	PeerAuth:            pulumi.String("string"),
    	PeerGroup:           pulumi.String("string"),
    	Schedule:            pulumi.String("string"),
    	Trusthosts: system.ApiuserTrusthostArray{
    		&system.ApiuserTrusthostArgs{
    			Id:            pulumi.Int(0),
    			Ipv4Trusthost: pulumi.String("string"),
    			Ipv6Trusthost: pulumi.String("string"),
    			Type:          pulumi.String("string"),
    		},
    	},
    	Vdomparam: pulumi.String("string"),
    	Vdoms: system.ApiuserVdomArray{
    		&system.ApiuserVdomArgs{
    			Name: pulumi.String("string"),
    		},
    	},
    })
    
    var apiuserResource = new Apiuser("apiuserResource", ApiuserArgs.builder()        
        .accprofile("string")
        .apiKey("string")
        .comments("string")
        .corsAllowOrigin("string")
        .dynamicSortSubtable("string")
        .getAllTables("string")
        .name("string")
        .peerAuth("string")
        .peerGroup("string")
        .schedule("string")
        .trusthosts(ApiuserTrusthostArgs.builder()
            .id(0)
            .ipv4Trusthost("string")
            .ipv6Trusthost("string")
            .type("string")
            .build())
        .vdomparam("string")
        .vdoms(ApiuserVdomArgs.builder()
            .name("string")
            .build())
        .build());
    
    apiuser_resource = fortios.system.Apiuser("apiuserResource",
        accprofile="string",
        api_key="string",
        comments="string",
        cors_allow_origin="string",
        dynamic_sort_subtable="string",
        get_all_tables="string",
        name="string",
        peer_auth="string",
        peer_group="string",
        schedule="string",
        trusthosts=[fortios.system.ApiuserTrusthostArgs(
            id=0,
            ipv4_trusthost="string",
            ipv6_trusthost="string",
            type="string",
        )],
        vdomparam="string",
        vdoms=[fortios.system.ApiuserVdomArgs(
            name="string",
        )])
    
    const apiuserResource = new fortios.system.Apiuser("apiuserResource", {
        accprofile: "string",
        apiKey: "string",
        comments: "string",
        corsAllowOrigin: "string",
        dynamicSortSubtable: "string",
        getAllTables: "string",
        name: "string",
        peerAuth: "string",
        peerGroup: "string",
        schedule: "string",
        trusthosts: [{
            id: 0,
            ipv4Trusthost: "string",
            ipv6Trusthost: "string",
            type: "string",
        }],
        vdomparam: "string",
        vdoms: [{
            name: "string",
        }],
    });
    
    type: fortios:system:Apiuser
    properties:
        accprofile: string
        apiKey: string
        comments: string
        corsAllowOrigin: string
        dynamicSortSubtable: string
        getAllTables: string
        name: string
        peerAuth: string
        peerGroup: string
        schedule: string
        trusthosts:
            - id: 0
              ipv4Trusthost: string
              ipv6Trusthost: string
              type: string
        vdomparam: string
        vdoms:
            - name: string
    

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

    Accprofile string
    Admin user access profile.
    ApiKey string
    Admin user password.
    Comments string
    Comment.
    CorsAllowOrigin string
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    User name.
    PeerAuth string
    Enable/disable peer authentication. Valid values: enable, disable.
    PeerGroup string
    Peer group name.
    Schedule string
    Schedule name.
    Trusthosts List<Pulumiverse.Fortios.System.Inputs.ApiuserTrusthost>
    Trusthost. The structure of trusthost block is documented below.
    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.
    Vdoms List<Pulumiverse.Fortios.System.Inputs.ApiuserVdom>
    Virtual domains. The structure of vdom block is documented below.
    Accprofile string
    Admin user access profile.
    ApiKey string
    Admin user password.
    Comments string
    Comment.
    CorsAllowOrigin string
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    User name.
    PeerAuth string
    Enable/disable peer authentication. Valid values: enable, disable.
    PeerGroup string
    Peer group name.
    Schedule string
    Schedule name.
    Trusthosts []ApiuserTrusthostArgs
    Trusthost. The structure of trusthost block is documented below.
    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.
    Vdoms []ApiuserVdomArgs
    Virtual domains. The structure of vdom block is documented below.
    accprofile String
    Admin user access profile.
    apiKey String
    Admin user password.
    comments String
    Comment.
    corsAllowOrigin String
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    User name.
    peerAuth String
    Enable/disable peer authentication. Valid values: enable, disable.
    peerGroup String
    Peer group name.
    schedule String
    Schedule name.
    trusthosts List<ApiuserTrusthost>
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms List<ApiuserVdom>
    Virtual domains. The structure of vdom block is documented below.
    accprofile string
    Admin user access profile.
    apiKey string
    Admin user password.
    comments string
    Comment.
    corsAllowOrigin string
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    User name.
    peerAuth string
    Enable/disable peer authentication. Valid values: enable, disable.
    peerGroup string
    Peer group name.
    schedule string
    Schedule name.
    trusthosts ApiuserTrusthost[]
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms ApiuserVdom[]
    Virtual domains. The structure of vdom block is documented below.
    accprofile str
    Admin user access profile.
    api_key str
    Admin user password.
    comments str
    Comment.
    cors_allow_origin str
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    User name.
    peer_auth str
    Enable/disable peer authentication. Valid values: enable, disable.
    peer_group str
    Peer group name.
    schedule str
    Schedule name.
    trusthosts Sequence[ApiuserTrusthostArgs]
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms Sequence[ApiuserVdomArgs]
    Virtual domains. The structure of vdom block is documented below.
    accprofile String
    Admin user access profile.
    apiKey String
    Admin user password.
    comments String
    Comment.
    corsAllowOrigin String
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    User name.
    peerAuth String
    Enable/disable peer authentication. Valid values: enable, disable.
    peerGroup String
    Peer group name.
    schedule String
    Schedule name.
    trusthosts List<Property Map>
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms List<Property Map>
    Virtual domains. The structure of vdom block is documented below.

    Outputs

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

    Get an existing Apiuser 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?: ApiuserState, opts?: CustomResourceOptions): Apiuser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accprofile: Optional[str] = None,
            api_key: Optional[str] = None,
            comments: Optional[str] = None,
            cors_allow_origin: Optional[str] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            name: Optional[str] = None,
            peer_auth: Optional[str] = None,
            peer_group: Optional[str] = None,
            schedule: Optional[str] = None,
            trusthosts: Optional[Sequence[ApiuserTrusthostArgs]] = None,
            vdomparam: Optional[str] = None,
            vdoms: Optional[Sequence[ApiuserVdomArgs]] = None) -> Apiuser
    func GetApiuser(ctx *Context, name string, id IDInput, state *ApiuserState, opts ...ResourceOption) (*Apiuser, error)
    public static Apiuser Get(string name, Input<string> id, ApiuserState? state, CustomResourceOptions? opts = null)
    public static Apiuser get(String name, Output<String> id, ApiuserState 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:
    Accprofile string
    Admin user access profile.
    ApiKey string
    Admin user password.
    Comments string
    Comment.
    CorsAllowOrigin string
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    User name.
    PeerAuth string
    Enable/disable peer authentication. Valid values: enable, disable.
    PeerGroup string
    Peer group name.
    Schedule string
    Schedule name.
    Trusthosts List<Pulumiverse.Fortios.System.Inputs.ApiuserTrusthost>
    Trusthost. The structure of trusthost block is documented below.
    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.
    Vdoms List<Pulumiverse.Fortios.System.Inputs.ApiuserVdom>
    Virtual domains. The structure of vdom block is documented below.
    Accprofile string
    Admin user access profile.
    ApiKey string
    Admin user password.
    Comments string
    Comment.
    CorsAllowOrigin string
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    User name.
    PeerAuth string
    Enable/disable peer authentication. Valid values: enable, disable.
    PeerGroup string
    Peer group name.
    Schedule string
    Schedule name.
    Trusthosts []ApiuserTrusthostArgs
    Trusthost. The structure of trusthost block is documented below.
    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.
    Vdoms []ApiuserVdomArgs
    Virtual domains. The structure of vdom block is documented below.
    accprofile String
    Admin user access profile.
    apiKey String
    Admin user password.
    comments String
    Comment.
    corsAllowOrigin String
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    User name.
    peerAuth String
    Enable/disable peer authentication. Valid values: enable, disable.
    peerGroup String
    Peer group name.
    schedule String
    Schedule name.
    trusthosts List<ApiuserTrusthost>
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms List<ApiuserVdom>
    Virtual domains. The structure of vdom block is documented below.
    accprofile string
    Admin user access profile.
    apiKey string
    Admin user password.
    comments string
    Comment.
    corsAllowOrigin string
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    User name.
    peerAuth string
    Enable/disable peer authentication. Valid values: enable, disable.
    peerGroup string
    Peer group name.
    schedule string
    Schedule name.
    trusthosts ApiuserTrusthost[]
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms ApiuserVdom[]
    Virtual domains. The structure of vdom block is documented below.
    accprofile str
    Admin user access profile.
    api_key str
    Admin user password.
    comments str
    Comment.
    cors_allow_origin str
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    User name.
    peer_auth str
    Enable/disable peer authentication. Valid values: enable, disable.
    peer_group str
    Peer group name.
    schedule str
    Schedule name.
    trusthosts Sequence[ApiuserTrusthostArgs]
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms Sequence[ApiuserVdomArgs]
    Virtual domains. The structure of vdom block is documented below.
    accprofile String
    Admin user access profile.
    apiKey String
    Admin user password.
    comments String
    Comment.
    corsAllowOrigin String
    Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.
    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, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    User name.
    peerAuth String
    Enable/disable peer authentication. Valid values: enable, disable.
    peerGroup String
    Peer group name.
    schedule String
    Schedule name.
    trusthosts List<Property Map>
    Trusthost. The structure of trusthost block is documented below.
    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.
    vdoms List<Property Map>
    Virtual domains. The structure of vdom block is documented below.

    Supporting Types

    ApiuserTrusthost, ApiuserTrusthostArgs

    Id int
    Table ID.
    Ipv4Trusthost string
    IPv4 trusted host address.
    Ipv6Trusthost string
    IPv6 trusted host address.
    Type string
    Trusthost type. Valid values: ipv4-trusthost, ipv6-trusthost.
    Id int
    Table ID.
    Ipv4Trusthost string
    IPv4 trusted host address.
    Ipv6Trusthost string
    IPv6 trusted host address.
    Type string
    Trusthost type. Valid values: ipv4-trusthost, ipv6-trusthost.
    id Integer
    Table ID.
    ipv4Trusthost String
    IPv4 trusted host address.
    ipv6Trusthost String
    IPv6 trusted host address.
    type String
    Trusthost type. Valid values: ipv4-trusthost, ipv6-trusthost.
    id number
    Table ID.
    ipv4Trusthost string
    IPv4 trusted host address.
    ipv6Trusthost string
    IPv6 trusted host address.
    type string
    Trusthost type. Valid values: ipv4-trusthost, ipv6-trusthost.
    id int
    Table ID.
    ipv4_trusthost str
    IPv4 trusted host address.
    ipv6_trusthost str
    IPv6 trusted host address.
    type str
    Trusthost type. Valid values: ipv4-trusthost, ipv6-trusthost.
    id Number
    Table ID.
    ipv4Trusthost String
    IPv4 trusted host address.
    ipv6Trusthost String
    IPv6 trusted host address.
    type String
    Trusthost type. Valid values: ipv4-trusthost, ipv6-trusthost.

    ApiuserVdom, ApiuserVdomArgs

    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.

    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