Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectUserGroupMatch
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectUserGroupMatch

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Group matches.

    This resource is a sub resource for variable match of resource fortimanager.ObjectUserGroup. Conflict and overwrite may occur if use both of them.

    Create ObjectUserGroupMatch Resource

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

    Constructor syntax

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

@overload
def ObjectUserGroupMatch(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         group: Optional[str] = None,
                         _gui_meta: Optional[str] = None,
                         adom: Optional[str] = None,
                         fosid: Optional[float] = None,
                         group_name: Optional[str] = None,
                         object_user_group_match_id: Optional[str] = None,
                         scopetype: Optional[str] = None,
                         server_name: Optional[str] = None)
    func NewObjectUserGroupMatch(ctx *Context, name string, args ObjectUserGroupMatchArgs, opts ...ResourceOption) (*ObjectUserGroupMatch, error)
    public ObjectUserGroupMatch(string name, ObjectUserGroupMatchArgs args, CustomResourceOptions? opts = null)
    public ObjectUserGroupMatch(String name, ObjectUserGroupMatchArgs args)
public ObjectUserGroupMatch(String name, ObjectUserGroupMatchArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectUserGroupMatch
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 ObjectUserGroupMatchArgs
    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 ObjectUserGroupMatchInitArgs
    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 ObjectUserGroupMatchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectUserGroupMatchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectUserGroupMatchArgs
    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 objectUserGroupMatchResource = new Fortimanager.ObjectUserGroupMatch("objectUserGroupMatchResource", new()
{
    Group = "string",
    _guiMeta = "string",
    Adom = "string",
    Fosid = 0,
    GroupName = "string",
    ObjectUserGroupMatchId = "string",
    Scopetype = "string",
    ServerName = "string",
});

    example, err := fortimanager.NewObjectUserGroupMatch(ctx, "objectUserGroupMatchResource", &fortimanager.ObjectUserGroupMatchArgs{
Group: pulumi.String("string"),
_guiMeta: pulumi.String("string"),
Adom: pulumi.String("string"),
Fosid: pulumi.Float64(0),
GroupName: pulumi.String("string"),
ObjectUserGroupMatchId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
ServerName: pulumi.String("string"),
})

    var objectUserGroupMatchResource = new ObjectUserGroupMatch("objectUserGroupMatchResource", ObjectUserGroupMatchArgs.builder()
    .group("string")
    ._guiMeta("string")
    .adom("string")
    .fosid(0)
    .groupName("string")
    .objectUserGroupMatchId("string")
    .scopetype("string")
    .serverName("string")
    .build());

    object_user_group_match_resource = fortimanager.ObjectUserGroupMatch("objectUserGroupMatchResource",
    group="string",
    _gui_meta="string",
    adom="string",
    fosid=0,
    group_name="string",
    object_user_group_match_id="string",
    scopetype="string",
    server_name="string")

    const objectUserGroupMatchResource = new fortimanager.ObjectUserGroupMatch("objectUserGroupMatchResource", {
    group: "string",
    _guiMeta: "string",
    adom: "string",
    fosid: 0,
    groupName: "string",
    objectUserGroupMatchId: "string",
    scopetype: "string",
    serverName: "string",
});

    type: fortimanager:ObjectUserGroupMatch
properties:
    _guiMeta: string
    adom: string
    fosid: 0
    group: string
    groupName: string
    objectUserGroupMatchId: string
    scopetype: string
    serverName: string

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

    Group string
    Group.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Fosid double
    ID.
    GroupName string
    Name of matching user or group on remote authentication server.
    ObjectUserGroupMatchId string
    an identifier for the resource with format {{fosid}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerName string
    Name of remote auth server.
    _guiMeta string
    _Gui_Meta.
    Group string
    Group.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Fosid float64
    ID.
    GroupName string
    Name of matching user or group on remote authentication server.
    ObjectUserGroupMatchId string
    an identifier for the resource with format {{fosid}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerName string
    Name of remote auth server.
    _guiMeta string
    _Gui_Meta.
    group String
    Group.
    _guiMeta String
    _Gui_Meta.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid Double
    ID.
    groupName String
    Name of matching user or group on remote authentication server.
    objectUserGroupMatchId String
    an identifier for the resource with format {{fosid}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverName String
    Name of remote auth server.
    group string
    Group.
    _guiMeta string
    _Gui_Meta.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid number
    ID.
    groupName string
    Name of matching user or group on remote authentication server.
    objectUserGroupMatchId string
    an identifier for the resource with format {{fosid}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverName string
    Name of remote auth server.
    group str
    Group.
    _gui_meta str
    _Gui_Meta.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid float
    ID.
    group_name str
    Name of matching user or group on remote authentication server.
    object_user_group_match_id str
    an identifier for the resource with format {{fosid}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server_name str
    Name of remote auth server.
    group String
    Group.
    _guiMeta String
    _Gui_Meta.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid Number
    ID.
    groupName String
    Name of matching user or group on remote authentication server.
    objectUserGroupMatchId String
    an identifier for the resource with format {{fosid}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverName String
    Name of remote auth server.

    Outputs

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

    Get an existing ObjectUserGroupMatch 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?: ObjectUserGroupMatchState, opts?: CustomResourceOptions): ObjectUserGroupMatch
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        _gui_meta: Optional[str] = None,
        adom: Optional[str] = None,
        fosid: Optional[float] = None,
        group: Optional[str] = None,
        group_name: Optional[str] = None,
        object_user_group_match_id: Optional[str] = None,
        scopetype: Optional[str] = None,
        server_name: Optional[str] = None) -> ObjectUserGroupMatch
    func GetObjectUserGroupMatch(ctx *Context, name string, id IDInput, state *ObjectUserGroupMatchState, opts ...ResourceOption) (*ObjectUserGroupMatch, error)
    public static ObjectUserGroupMatch Get(string name, Input<string> id, ObjectUserGroupMatchState? state, CustomResourceOptions? opts = null)
    public static ObjectUserGroupMatch get(String name, Output<String> id, ObjectUserGroupMatchState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectUserGroupMatch    get:      id: ${id}
    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:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Fosid double
    ID.
    Group string
    Group.
    GroupName string
    Name of matching user or group on remote authentication server.
    ObjectUserGroupMatchId string
    an identifier for the resource with format {{fosid}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerName string
    Name of remote auth server.
    _guiMeta string
    _Gui_Meta.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Fosid float64
    ID.
    Group string
    Group.
    GroupName string
    Name of matching user or group on remote authentication server.
    ObjectUserGroupMatchId string
    an identifier for the resource with format {{fosid}}.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    ServerName string
    Name of remote auth server.
    _guiMeta string
    _Gui_Meta.
    _guiMeta String
    _Gui_Meta.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid Double
    ID.
    group String
    Group.
    groupName String
    Name of matching user or group on remote authentication server.
    objectUserGroupMatchId String
    an identifier for the resource with format {{fosid}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverName String
    Name of remote auth server.
    _guiMeta string
    _Gui_Meta.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid number
    ID.
    group string
    Group.
    groupName string
    Name of matching user or group on remote authentication server.
    objectUserGroupMatchId string
    an identifier for the resource with format {{fosid}}.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverName string
    Name of remote auth server.
    _gui_meta str
    _Gui_Meta.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid float
    ID.
    group str
    Group.
    group_name str
    Name of matching user or group on remote authentication server.
    object_user_group_match_id str
    an identifier for the resource with format {{fosid}}.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    server_name str
    Name of remote auth server.
    _guiMeta String
    _Gui_Meta.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    fosid Number
    ID.
    group String
    Group.
    groupName String
    Name of matching user or group on remote authentication server.
    objectUserGroupMatchId String
    an identifier for the resource with format {{fosid}}.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    serverName String
    Name of remote auth server.

    Import

    ObjectUser GroupMatch can be imported using any of these accepted formats:

    Set import_options = [“group=YOUR_VALUE”] in the provider section.

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectUserGroupMatch:ObjectUserGroupMatch labelname {{fosid}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager