Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. user
  5. Group
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.user.Group

Explore with Pulumi AI

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

    Configure user groups.

    Example Usage

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

const trname = new fortios.user.Group("trname", {
    company: "optional",
    email: "enable",
    expire: 14400,
    expireType: "immediately",
    groupType: "firewall",
    maxAccounts: 0,
    members: [{
        name: "guest",
    }],
    mobilePhone: "disable",
    multipleGuestAdd: "disable",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.user.Group("trname",
    company="optional",
    email="enable",
    expire=14400,
    expire_type="immediately",
    group_type="firewall",
    max_accounts=0,
    members=[fortios.user.GroupMemberArgs(
        name="guest",
    )],
    mobile_phone="disable",
    multiple_guest_add="disable")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := user.NewGroup(ctx, "trname", &user.GroupArgs{
			Company:     pulumi.String("optional"),
			Email:       pulumi.String("enable"),
			Expire:      pulumi.Int(14400),
			ExpireType:  pulumi.String("immediately"),
			GroupType:   pulumi.String("firewall"),
			MaxAccounts: pulumi.Int(0),
			Members: user.GroupMemberArray{
				&user.GroupMemberArgs{
					Name: pulumi.String("guest"),
				},
			},
			MobilePhone:      pulumi.String("disable"),
			MultipleGuestAdd: pulumi.String("disable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.User.Group("trname", new()
    {
        Company = "optional",
        Email = "enable",
        Expire = 14400,
        ExpireType = "immediately",
        GroupType = "firewall",
        MaxAccounts = 0,
        Members = new[]
        {
            new Fortios.User.Inputs.GroupMemberArgs
            {
                Name = "guest",
            },
        },
        MobilePhone = "disable",
        MultipleGuestAdd = "disable",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.user.Group;
import com.pulumi.fortios.user.GroupArgs;
import com.pulumi.fortios.user.inputs.GroupMemberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Group("trname", GroupArgs.builder()
            .company("optional")
            .email("enable")
            .expire(14400)
            .expireType("immediately")
            .groupType("firewall")
            .maxAccounts(0)
            .members(GroupMemberArgs.builder()
                .name("guest")
                .build())
            .mobilePhone("disable")
            .multipleGuestAdd("disable")
            .build());

    }
}

    resources:
  trname:
    type: fortios:user:Group
    properties:
      company: optional
      email: enable
      expire: 14400
      expireType: immediately
      groupType: firewall
      maxAccounts: 0
      members:
        - name: guest
      mobilePhone: disable
      multipleGuestAdd: disable

    Create Group Resource

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

    Constructor syntax

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          auth_concurrent_override: Optional[str] = None,
          auth_concurrent_value: Optional[int] = None,
          authtimeout: Optional[int] = None,
          company: Optional[str] = None,
          dynamic_sort_subtable: Optional[str] = None,
          email: Optional[str] = None,
          expire: Optional[int] = None,
          expire_type: Optional[str] = None,
          fosid: Optional[int] = None,
          get_all_tables: Optional[str] = None,
          group_type: Optional[str] = None,
          guests: Optional[Sequence[GroupGuestArgs]] = None,
          http_digest_realm: Optional[str] = None,
          matches: Optional[Sequence[GroupMatchArgs]] = None,
          max_accounts: Optional[int] = None,
          members: Optional[Sequence[GroupMemberArgs]] = None,
          mobile_phone: Optional[str] = None,
          multiple_guest_add: Optional[str] = None,
          name: Optional[str] = None,
          password: Optional[str] = None,
          sms_custom_server: Optional[str] = None,
          sms_server: Optional[str] = None,
          sponsor: Optional[str] = None,
          sso_attribute_value: Optional[str] = None,
          user_id: Optional[str] = None,
          user_name: Optional[str] = None,
          vdomparam: Optional[str] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: fortios:user:Group
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 GroupArgs
    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 GroupArgs
    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 GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    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 examplegroupResourceResourceFromUsergroup = new Fortios.User.Group("examplegroupResourceResourceFromUsergroup", new()
{
    AuthConcurrentOverride = "string",
    AuthConcurrentValue = 0,
    Authtimeout = 0,
    Company = "string",
    DynamicSortSubtable = "string",
    Email = "string",
    Expire = 0,
    ExpireType = "string",
    Fosid = 0,
    GetAllTables = "string",
    GroupType = "string",
    Guests = new[]
    {
        new Fortios.User.Inputs.GroupGuestArgs
        {
            Comment = "string",
            Company = "string",
            Email = "string",
            Expiration = "string",
            Id = 0,
            MobilePhone = "string",
            Name = "string",
            Password = "string",
            Sponsor = "string",
            UserId = "string",
        },
    },
    HttpDigestRealm = "string",
    Matches = new[]
    {
        new Fortios.User.Inputs.GroupMatchArgs
        {
            GroupName = "string",
            Id = 0,
            ServerName = "string",
        },
    },
    MaxAccounts = 0,
    Members = new[]
    {
        new Fortios.User.Inputs.GroupMemberArgs
        {
            Name = "string",
        },
    },
    MobilePhone = "string",
    MultipleGuestAdd = "string",
    Name = "string",
    Password = "string",
    SmsCustomServer = "string",
    SmsServer = "string",
    Sponsor = "string",
    SsoAttributeValue = "string",
    UserId = "string",
    UserName = "string",
    Vdomparam = "string",
});

    example, err := user.NewGroup(ctx, "examplegroupResourceResourceFromUsergroup", &user.GroupArgs{
	AuthConcurrentOverride: pulumi.String("string"),
	AuthConcurrentValue:    pulumi.Int(0),
	Authtimeout:            pulumi.Int(0),
	Company:                pulumi.String("string"),
	DynamicSortSubtable:    pulumi.String("string"),
	Email:                  pulumi.String("string"),
	Expire:                 pulumi.Int(0),
	ExpireType:             pulumi.String("string"),
	Fosid:                  pulumi.Int(0),
	GetAllTables:           pulumi.String("string"),
	GroupType:              pulumi.String("string"),
	Guests: user.GroupGuestArray{
		&user.GroupGuestArgs{
			Comment:     pulumi.String("string"),
			Company:     pulumi.String("string"),
			Email:       pulumi.String("string"),
			Expiration:  pulumi.String("string"),
			Id:          pulumi.Int(0),
			MobilePhone: pulumi.String("string"),
			Name:        pulumi.String("string"),
			Password:    pulumi.String("string"),
			Sponsor:     pulumi.String("string"),
			UserId:      pulumi.String("string"),
		},
	},
	HttpDigestRealm: pulumi.String("string"),
	Matches: user.GroupMatchArray{
		&user.GroupMatchArgs{
			GroupName:  pulumi.String("string"),
			Id:         pulumi.Int(0),
			ServerName: pulumi.String("string"),
		},
	},
	MaxAccounts: pulumi.Int(0),
	Members: user.GroupMemberArray{
		&user.GroupMemberArgs{
			Name: pulumi.String("string"),
		},
	},
	MobilePhone:       pulumi.String("string"),
	MultipleGuestAdd:  pulumi.String("string"),
	Name:              pulumi.String("string"),
	Password:          pulumi.String("string"),
	SmsCustomServer:   pulumi.String("string"),
	SmsServer:         pulumi.String("string"),
	Sponsor:           pulumi.String("string"),
	SsoAttributeValue: pulumi.String("string"),
	UserId:            pulumi.String("string"),
	UserName:          pulumi.String("string"),
	Vdomparam:         pulumi.String("string"),
})

    var examplegroupResourceResourceFromUsergroup = new Group("examplegroupResourceResourceFromUsergroup", GroupArgs.builder()
    .authConcurrentOverride("string")
    .authConcurrentValue(0)
    .authtimeout(0)
    .company("string")
    .dynamicSortSubtable("string")
    .email("string")
    .expire(0)
    .expireType("string")
    .fosid(0)
    .getAllTables("string")
    .groupType("string")
    .guests(GroupGuestArgs.builder()
        .comment("string")
        .company("string")
        .email("string")
        .expiration("string")
        .id(0)
        .mobilePhone("string")
        .name("string")
        .password("string")
        .sponsor("string")
        .userId("string")
        .build())
    .httpDigestRealm("string")
    .matches(GroupMatchArgs.builder()
        .groupName("string")
        .id(0)
        .serverName("string")
        .build())
    .maxAccounts(0)
    .members(GroupMemberArgs.builder()
        .name("string")
        .build())
    .mobilePhone("string")
    .multipleGuestAdd("string")
    .name("string")
    .password("string")
    .smsCustomServer("string")
    .smsServer("string")
    .sponsor("string")
    .ssoAttributeValue("string")
    .userId("string")
    .userName("string")
    .vdomparam("string")
    .build());

    examplegroup_resource_resource_from_usergroup = fortios.user.Group("examplegroupResourceResourceFromUsergroup",
    auth_concurrent_override="string",
    auth_concurrent_value=0,
    authtimeout=0,
    company="string",
    dynamic_sort_subtable="string",
    email="string",
    expire=0,
    expire_type="string",
    fosid=0,
    get_all_tables="string",
    group_type="string",
    guests=[{
        "comment": "string",
        "company": "string",
        "email": "string",
        "expiration": "string",
        "id": 0,
        "mobile_phone": "string",
        "name": "string",
        "password": "string",
        "sponsor": "string",
        "user_id": "string",
    }],
    http_digest_realm="string",
    matches=[{
        "group_name": "string",
        "id": 0,
        "server_name": "string",
    }],
    max_accounts=0,
    members=[{
        "name": "string",
    }],
    mobile_phone="string",
    multiple_guest_add="string",
    name="string",
    password="string",
    sms_custom_server="string",
    sms_server="string",
    sponsor="string",
    sso_attribute_value="string",
    user_id="string",
    user_name="string",
    vdomparam="string")

    const examplegroupResourceResourceFromUsergroup = new fortios.user.Group("examplegroupResourceResourceFromUsergroup", {
    authConcurrentOverride: "string",
    authConcurrentValue: 0,
    authtimeout: 0,
    company: "string",
    dynamicSortSubtable: "string",
    email: "string",
    expire: 0,
    expireType: "string",
    fosid: 0,
    getAllTables: "string",
    groupType: "string",
    guests: [{
        comment: "string",
        company: "string",
        email: "string",
        expiration: "string",
        id: 0,
        mobilePhone: "string",
        name: "string",
        password: "string",
        sponsor: "string",
        userId: "string",
    }],
    httpDigestRealm: "string",
    matches: [{
        groupName: "string",
        id: 0,
        serverName: "string",
    }],
    maxAccounts: 0,
    members: [{
        name: "string",
    }],
    mobilePhone: "string",
    multipleGuestAdd: "string",
    name: "string",
    password: "string",
    smsCustomServer: "string",
    smsServer: "string",
    sponsor: "string",
    ssoAttributeValue: "string",
    userId: "string",
    userName: "string",
    vdomparam: "string",
});

    type: fortios:user:Group
properties:
    authConcurrentOverride: string
    authConcurrentValue: 0
    authtimeout: 0
    company: string
    dynamicSortSubtable: string
    email: string
    expire: 0
    expireType: string
    fosid: 0
    getAllTables: string
    groupType: string
    guests:
        - comment: string
          company: string
          email: string
          expiration: string
          id: 0
          mobilePhone: string
          name: string
          password: string
          sponsor: string
          userId: string
    httpDigestRealm: string
    matches:
        - groupName: string
          id: 0
          serverName: string
    maxAccounts: 0
    members:
        - name: string
    mobilePhone: string
    multipleGuestAdd: string
    name: string
    password: string
    smsCustomServer: string
    smsServer: string
    sponsor: string
    ssoAttributeValue: string
    userId: string
    userName: string
    vdomparam: string

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

    AuthConcurrentOverride string
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    AuthConcurrentValue int
    Maximum number of concurrent authenticated connections per user (0 - 100).
    Authtimeout int
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    Company string
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    Email string
    Enable/disable the guest user email address field. Valid values: disable, enable.
    Expire int
    Time in seconds before guest user accounts expire (1 - 31536000).
    ExpireType string
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    Fosid int
    Group ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    GroupType string
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    Guests List<Pulumiverse.Fortios.User.Inputs.GroupGuest>
    Guest User. The structure of guest block is documented below.
    HttpDigestRealm string
    Realm attribute for MD5-digest authentication.
    Matches List<Pulumiverse.Fortios.User.Inputs.GroupMatch>
    Group matches. The structure of match block is documented below.
    MaxAccounts int
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    Members List<Pulumiverse.Fortios.User.Inputs.GroupMember>
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    MobilePhone string
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    MultipleGuestAdd string
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    Name string
    Group name.
    Password string
    Guest user password type. Valid values: auto-generate, specify, disable.
    SmsCustomServer string
    SMS server.
    SmsServer string
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    string
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    SsoAttributeValue string
    Name of the RADIUS user group that this local user group represents.
    UserId string
    Guest user ID type. Valid values: email, auto-generate, specify.
    UserName string
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    AuthConcurrentOverride string
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    AuthConcurrentValue int
    Maximum number of concurrent authenticated connections per user (0 - 100).
    Authtimeout int
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    Company string
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    Email string
    Enable/disable the guest user email address field. Valid values: disable, enable.
    Expire int
    Time in seconds before guest user accounts expire (1 - 31536000).
    ExpireType string
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    Fosid int
    Group ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    GroupType string
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    Guests []GroupGuestArgs
    Guest User. The structure of guest block is documented below.
    HttpDigestRealm string
    Realm attribute for MD5-digest authentication.
    Matches []GroupMatchArgs
    Group matches. The structure of match block is documented below.
    MaxAccounts int
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    Members []GroupMemberArgs
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    MobilePhone string
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    MultipleGuestAdd string
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    Name string
    Group name.
    Password string
    Guest user password type. Valid values: auto-generate, specify, disable.
    SmsCustomServer string
    SMS server.
    SmsServer string
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    string
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    SsoAttributeValue string
    Name of the RADIUS user group that this local user group represents.
    UserId string
    Guest user ID type. Valid values: email, auto-generate, specify.
    UserName string
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    authConcurrentOverride String
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    authConcurrentValue Integer
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout Integer
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company String
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email String
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire Integer
    Time in seconds before guest user accounts expire (1 - 31536000).
    expireType String
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid Integer
    Group ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    groupType String
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests List<GroupGuest>
    Guest User. The structure of guest block is documented below.
    httpDigestRealm String
    Realm attribute for MD5-digest authentication.
    matches List<GroupMatch>
    Group matches. The structure of match block is documented below.
    maxAccounts Integer
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members List<GroupMember>
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobilePhone String
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multipleGuestAdd String
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name String
    Group name.
    password String
    Guest user password type. Valid values: auto-generate, specify, disable.
    smsCustomServer String
    SMS server.
    smsServer String
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    String
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    ssoAttributeValue String
    Name of the RADIUS user group that this local user group represents.
    userId String
    Guest user ID type. Valid values: email, auto-generate, specify.
    userName String
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    authConcurrentOverride string
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    authConcurrentValue number
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout number
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company string
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email string
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire number
    Time in seconds before guest user accounts expire (1 - 31536000).
    expireType string
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid number
    Group ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    groupType string
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests GroupGuest[]
    Guest User. The structure of guest block is documented below.
    httpDigestRealm string
    Realm attribute for MD5-digest authentication.
    matches GroupMatch[]
    Group matches. The structure of match block is documented below.
    maxAccounts number
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members GroupMember[]
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobilePhone string
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multipleGuestAdd string
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name string
    Group name.
    password string
    Guest user password type. Valid values: auto-generate, specify, disable.
    smsCustomServer string
    SMS server.
    smsServer string
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    string
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    ssoAttributeValue string
    Name of the RADIUS user group that this local user group represents.
    userId string
    Guest user ID type. Valid values: email, auto-generate, specify.
    userName string
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    auth_concurrent_override str
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    auth_concurrent_value int
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout int
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company str
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email str
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire int
    Time in seconds before guest user accounts expire (1 - 31536000).
    expire_type str
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid int
    Group ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    group_type str
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests Sequence[GroupGuestArgs]
    Guest User. The structure of guest block is documented below.
    http_digest_realm str
    Realm attribute for MD5-digest authentication.
    matches Sequence[GroupMatchArgs]
    Group matches. The structure of match block is documented below.
    max_accounts int
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members Sequence[GroupMemberArgs]
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobile_phone str
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multiple_guest_add str
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name str
    Group name.
    password str
    Guest user password type. Valid values: auto-generate, specify, disable.
    sms_custom_server str
    SMS server.
    sms_server str
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    str
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    sso_attribute_value str
    Name of the RADIUS user group that this local user group represents.
    user_id str
    Guest user ID type. Valid values: email, auto-generate, specify.
    user_name str
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    authConcurrentOverride String
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    authConcurrentValue Number
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout Number
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company String
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email String
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire Number
    Time in seconds before guest user accounts expire (1 - 31536000).
    expireType String
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid Number
    Group ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    groupType String
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests List<Property Map>
    Guest User. The structure of guest block is documented below.
    httpDigestRealm String
    Realm attribute for MD5-digest authentication.
    matches List<Property Map>
    Group matches. The structure of match block is documented below.
    maxAccounts Number
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members List<Property Map>
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobilePhone String
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multipleGuestAdd String
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name String
    Group name.
    password String
    Guest user password type. Valid values: auto-generate, specify, disable.
    smsCustomServer String
    SMS server.
    smsServer String
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    String
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    ssoAttributeValue String
    Name of the RADIUS user group that this local user group represents.
    userId String
    Guest user ID type. Valid values: email, auto-generate, specify.
    userName String
    Enable/disable the guest user name entry. Valid values: disable, enable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_concurrent_override: Optional[str] = None,
        auth_concurrent_value: Optional[int] = None,
        authtimeout: Optional[int] = None,
        company: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        email: Optional[str] = None,
        expire: Optional[int] = None,
        expire_type: Optional[str] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        group_type: Optional[str] = None,
        guests: Optional[Sequence[GroupGuestArgs]] = None,
        http_digest_realm: Optional[str] = None,
        matches: Optional[Sequence[GroupMatchArgs]] = None,
        max_accounts: Optional[int] = None,
        members: Optional[Sequence[GroupMemberArgs]] = None,
        mobile_phone: Optional[str] = None,
        multiple_guest_add: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        sms_custom_server: Optional[str] = None,
        sms_server: Optional[str] = None,
        sponsor: Optional[str] = None,
        sso_attribute_value: Optional[str] = None,
        user_id: Optional[str] = None,
        user_name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState 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:
    AuthConcurrentOverride string
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    AuthConcurrentValue int
    Maximum number of concurrent authenticated connections per user (0 - 100).
    Authtimeout int
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    Company string
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    Email string
    Enable/disable the guest user email address field. Valid values: disable, enable.
    Expire int
    Time in seconds before guest user accounts expire (1 - 31536000).
    ExpireType string
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    Fosid int
    Group ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    GroupType string
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    Guests List<Pulumiverse.Fortios.User.Inputs.GroupGuest>
    Guest User. The structure of guest block is documented below.
    HttpDigestRealm string
    Realm attribute for MD5-digest authentication.
    Matches List<Pulumiverse.Fortios.User.Inputs.GroupMatch>
    Group matches. The structure of match block is documented below.
    MaxAccounts int
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    Members List<Pulumiverse.Fortios.User.Inputs.GroupMember>
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    MobilePhone string
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    MultipleGuestAdd string
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    Name string
    Group name.
    Password string
    Guest user password type. Valid values: auto-generate, specify, disable.
    SmsCustomServer string
    SMS server.
    SmsServer string
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    Sponsor string
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    SsoAttributeValue string
    Name of the RADIUS user group that this local user group represents.
    UserId string
    Guest user ID type. Valid values: email, auto-generate, specify.
    UserName string
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    AuthConcurrentOverride string
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    AuthConcurrentValue int
    Maximum number of concurrent authenticated connections per user (0 - 100).
    Authtimeout int
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    Company string
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    Email string
    Enable/disable the guest user email address field. Valid values: disable, enable.
    Expire int
    Time in seconds before guest user accounts expire (1 - 31536000).
    ExpireType string
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    Fosid int
    Group ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    GroupType string
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    Guests []GroupGuestArgs
    Guest User. The structure of guest block is documented below.
    HttpDigestRealm string
    Realm attribute for MD5-digest authentication.
    Matches []GroupMatchArgs
    Group matches. The structure of match block is documented below.
    MaxAccounts int
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    Members []GroupMemberArgs
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    MobilePhone string
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    MultipleGuestAdd string
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    Name string
    Group name.
    Password string
    Guest user password type. Valid values: auto-generate, specify, disable.
    SmsCustomServer string
    SMS server.
    SmsServer string
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    Sponsor string
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    SsoAttributeValue string
    Name of the RADIUS user group that this local user group represents.
    UserId string
    Guest user ID type. Valid values: email, auto-generate, specify.
    UserName string
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    authConcurrentOverride String
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    authConcurrentValue Integer
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout Integer
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company String
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email String
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire Integer
    Time in seconds before guest user accounts expire (1 - 31536000).
    expireType String
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid Integer
    Group ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    groupType String
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests List<GroupGuest>
    Guest User. The structure of guest block is documented below.
    httpDigestRealm String
    Realm attribute for MD5-digest authentication.
    matches List<GroupMatch>
    Group matches. The structure of match block is documented below.
    maxAccounts Integer
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members List<GroupMember>
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobilePhone String
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multipleGuestAdd String
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name String
    Group name.
    password String
    Guest user password type. Valid values: auto-generate, specify, disable.
    smsCustomServer String
    SMS server.
    smsServer String
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    sponsor String
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    ssoAttributeValue String
    Name of the RADIUS user group that this local user group represents.
    userId String
    Guest user ID type. Valid values: email, auto-generate, specify.
    userName String
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    authConcurrentOverride string
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    authConcurrentValue number
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout number
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company string
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email string
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire number
    Time in seconds before guest user accounts expire (1 - 31536000).
    expireType string
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid number
    Group ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    groupType string
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests GroupGuest[]
    Guest User. The structure of guest block is documented below.
    httpDigestRealm string
    Realm attribute for MD5-digest authentication.
    matches GroupMatch[]
    Group matches. The structure of match block is documented below.
    maxAccounts number
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members GroupMember[]
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobilePhone string
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multipleGuestAdd string
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name string
    Group name.
    password string
    Guest user password type. Valid values: auto-generate, specify, disable.
    smsCustomServer string
    SMS server.
    smsServer string
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    sponsor string
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    ssoAttributeValue string
    Name of the RADIUS user group that this local user group represents.
    userId string
    Guest user ID type. Valid values: email, auto-generate, specify.
    userName string
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    auth_concurrent_override str
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    auth_concurrent_value int
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout int
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company str
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email str
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire int
    Time in seconds before guest user accounts expire (1 - 31536000).
    expire_type str
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid int
    Group ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    group_type str
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests Sequence[GroupGuestArgs]
    Guest User. The structure of guest block is documented below.
    http_digest_realm str
    Realm attribute for MD5-digest authentication.
    matches Sequence[GroupMatchArgs]
    Group matches. The structure of match block is documented below.
    max_accounts int
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members Sequence[GroupMemberArgs]
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobile_phone str
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multiple_guest_add str
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name str
    Group name.
    password str
    Guest user password type. Valid values: auto-generate, specify, disable.
    sms_custom_server str
    SMS server.
    sms_server str
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    sponsor str
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    sso_attribute_value str
    Name of the RADIUS user group that this local user group represents.
    user_id str
    Guest user ID type. Valid values: email, auto-generate, specify.
    user_name str
    Enable/disable the guest user name entry. Valid values: disable, enable.
    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.
    authConcurrentOverride String
    Enable/disable overriding the global number of concurrent authentication sessions for this user group. Valid values: enable, disable.
    authConcurrentValue Number
    Maximum number of concurrent authenticated connections per user (0 - 100).
    authtimeout Number
    Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
    company String
    Set the action for the company guest user field. Valid values: optional, mandatory, disabled.
    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 ].
    email String
    Enable/disable the guest user email address field. Valid values: disable, enable.
    expire Number
    Time in seconds before guest user accounts expire (1 - 31536000).
    expireType String
    Determine when the expiration countdown begins. Valid values: immediately, first-successful-login.
    fosid Number
    Group ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    groupType String
    Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Valid values: firewall, fsso-service, rsso, guest.
    guests List<Property Map>
    Guest User. The structure of guest block is documented below.
    httpDigestRealm String
    Realm attribute for MD5-digest authentication.
    matches List<Property Map>
    Group matches. The structure of match block is documented below.
    maxAccounts Number
    Maximum number of guest accounts that can be created for this group (0 means unlimited).
    members List<Property Map>
    Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. The structure of member block is documented below.
    mobilePhone String
    Enable/disable the guest user mobile phone number field. Valid values: disable, enable.
    multipleGuestAdd String
    Enable/disable addition of multiple guests. Valid values: disable, enable.
    name String
    Group name.
    password String
    Guest user password type. Valid values: auto-generate, specify, disable.
    smsCustomServer String
    SMS server.
    smsServer String
    Send SMS through FortiGuard or other external server. Valid values: fortiguard, custom.
    sponsor String
    Set the action for the sponsor guest user field. Valid values: optional, mandatory, disabled.
    ssoAttributeValue String
    Name of the RADIUS user group that this local user group represents.
    userId String
    Guest user ID type. Valid values: email, auto-generate, specify.
    userName String
    Enable/disable the guest user name entry. Valid values: disable, enable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Supporting Types

    GroupGuest, GroupGuestArgs

    Comment string
    Comment.
    Company string
    Set the action for the company guest user field.
    Email string
    Email.
    Expiration string
    Expire time.
    Id int
    Guest ID.
    MobilePhone string
    Mobile phone.
    Name string
    Guest name.
    Password string
    Guest password.
    string
    Set the action for the sponsor guest user field.
    UserId string
    Guest ID.
    Comment string
    Comment.
    Company string
    Set the action for the company guest user field.
    Email string
    Email.
    Expiration string
    Expire time.
    Id int
    Guest ID.
    MobilePhone string
    Mobile phone.
    Name string
    Guest name.
    Password string
    Guest password.
    string
    Set the action for the sponsor guest user field.
    UserId string
    Guest ID.
    comment String
    Comment.
    company String
    Set the action for the company guest user field.
    email String
    Email.
    expiration String
    Expire time.
    id Integer
    Guest ID.
    mobilePhone String
    Mobile phone.
    name String
    Guest name.
    password String
    Guest password.
    String
    Set the action for the sponsor guest user field.
    userId String
    Guest ID.
    comment string
    Comment.
    company string
    Set the action for the company guest user field.
    email string
    Email.
    expiration string
    Expire time.
    id number
    Guest ID.
    mobilePhone string
    Mobile phone.
    name string
    Guest name.
    password string
    Guest password.
    string
    Set the action for the sponsor guest user field.
    userId string
    Guest ID.
    comment str
    Comment.
    company str
    Set the action for the company guest user field.
    email str
    Email.
    expiration str
    Expire time.
    id int
    Guest ID.
    mobile_phone str
    Mobile phone.
    name str
    Guest name.
    password str
    Guest password.
    str
    Set the action for the sponsor guest user field.
    user_id str
    Guest ID.
    comment String
    Comment.
    company String
    Set the action for the company guest user field.
    email String
    Email.
    expiration String
    Expire time.
    id Number
    Guest ID.
    mobilePhone String
    Mobile phone.
    name String
    Guest name.
    password String
    Guest password.
    String
    Set the action for the sponsor guest user field.
    userId String
    Guest ID.

    GroupMatch, GroupMatchArgs

    GroupName string
    Name of matching group on remote auththentication server.
    Id int
    ID.
    ServerName string
    Name of remote auth server.
    GroupName string
    Name of matching group on remote auththentication server.
    Id int
    ID.
    ServerName string
    Name of remote auth server.
    groupName String
    Name of matching group on remote auththentication server.
    id Integer
    ID.
    serverName String
    Name of remote auth server.
    groupName string
    Name of matching group on remote auththentication server.
    id number
    ID.
    serverName string
    Name of remote auth server.
    group_name str
    Name of matching group on remote auththentication server.
    id int
    ID.
    server_name str
    Name of remote auth server.
    groupName String
    Name of matching group on remote auththentication server.
    id Number
    ID.
    serverName String
    Name of remote auth server.

    GroupMember, GroupMemberArgs

    Name string
    Group member name.
    Name string
    Group member name.
    name String
    Group member name.
    name string
    Group member name.
    name str
    Group member name.
    name String
    Group member name.

    Import

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

    $ pulumi import fortios:user/group:Group labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/group:Group 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.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios