1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. UseridMatchList
Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

scm.UseridMatchList

scm logo
Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

    UseridMatchList resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";

const useridMatchList = new scm.UseridMatchList("userid_match_list", {
    name: "test-userid-match-list",
    description: "User ID match list for monitoring and forwarding user authentication events to external systems",
    folder: "ngfw-shared",
    filter: "All Logs",
    sendSyslogs: ["test-syslog"],
    sendHttps: ["some-http-profile"],
    sendSnmptraps: ["snmp_test"],
    sendEmails: ["test-email"],
    quarantine: false,
    sendToPanorama: false,
});

    import pulumi
import pulumi_scm as scm

userid_match_list = scm.UseridMatchList("userid_match_list",
    name="test-userid-match-list",
    description="User ID match list for monitoring and forwarding user authentication events to external systems",
    folder="ngfw-shared",
    filter="All Logs",
    send_syslogs=["test-syslog"],
    send_https=["some-http-profile"],
    send_snmptraps=["snmp_test"],
    send_emails=["test-email"],
    quarantine=False,
    send_to_panorama=False)

    package main

import (
	"github.com/pulumi/pulumi-scm/sdk/go/scm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.NewUseridMatchList(ctx, "userid_match_list", &scm.UseridMatchListArgs{
			Name:        pulumi.String("test-userid-match-list"),
			Description: pulumi.String("User ID match list for monitoring and forwarding user authentication events to external systems"),
			Folder:      pulumi.String("ngfw-shared"),
			Filter:      pulumi.String("All Logs"),
			SendSyslogs: pulumi.StringArray{
				pulumi.String("test-syslog"),
			},
			SendHttps: pulumi.StringArray{
				pulumi.String("some-http-profile"),
			},
			SendSnmptraps: pulumi.StringArray{
				pulumi.String("snmp_test"),
			},
			SendEmails: pulumi.StringArray{
				pulumi.String("test-email"),
			},
			Quarantine:     pulumi.Bool(false),
			SendToPanorama: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var useridMatchList = new Scm.UseridMatchList("userid_match_list", new()
    {
        Name = "test-userid-match-list",
        Description = "User ID match list for monitoring and forwarding user authentication events to external systems",
        Folder = "ngfw-shared",
        Filter = "All Logs",
        SendSyslogs = new[]
        {
            "test-syslog",
        },
        SendHttps = new[]
        {
            "some-http-profile",
        },
        SendSnmptraps = new[]
        {
            "snmp_test",
        },
        SendEmails = new[]
        {
            "test-email",
        },
        Quarantine = false,
        SendToPanorama = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.UseridMatchList;
import com.pulumi.scm.UseridMatchListArgs;
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 useridMatchList = new UseridMatchList("useridMatchList", UseridMatchListArgs.builder()
            .name("test-userid-match-list")
            .description("User ID match list for monitoring and forwarding user authentication events to external systems")
            .folder("ngfw-shared")
            .filter("All Logs")
            .sendSyslogs("test-syslog")
            .sendHttps("some-http-profile")
            .sendSnmptraps("snmp_test")
            .sendEmails("test-email")
            .quarantine(false)
            .sendToPanorama(false)
            .build());

    }
}

    resources:
  useridMatchList:
    type: scm:UseridMatchList
    name: userid_match_list
    properties:
      name: test-userid-match-list
      description: User ID match list for monitoring and forwarding user authentication events to external systems
      folder: ngfw-shared
      filter: All Logs
      sendSyslogs:
        - test-syslog
      sendHttps:
        - some-http-profile
      sendSnmptraps:
        - snmp_test
      sendEmails:
        - test-email
      quarantine: false
      sendToPanorama: false

    Create UseridMatchList Resource

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

    Constructor syntax

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

@overload
def UseridMatchList(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    description: Optional[str] = None,
                    device: Optional[str] = None,
                    filter: Optional[str] = None,
                    folder: Optional[str] = None,
                    name: Optional[str] = None,
                    quarantine: Optional[bool] = None,
                    send_emails: Optional[Sequence[str]] = None,
                    send_https: Optional[Sequence[str]] = None,
                    send_snmptraps: Optional[Sequence[str]] = None,
                    send_syslogs: Optional[Sequence[str]] = None,
                    send_to_panorama: Optional[bool] = None,
                    snippet: Optional[str] = None)
    func NewUseridMatchList(ctx *Context, name string, args *UseridMatchListArgs, opts ...ResourceOption) (*UseridMatchList, error)
    public UseridMatchList(string name, UseridMatchListArgs? args = null, CustomResourceOptions? opts = null)
    public UseridMatchList(String name, UseridMatchListArgs args)
public UseridMatchList(String name, UseridMatchListArgs args, CustomResourceOptions options)

    type: scm:UseridMatchList
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 UseridMatchListArgs
    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 UseridMatchListArgs
    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 UseridMatchListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UseridMatchListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UseridMatchListArgs
    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 useridMatchListResource = new Scm.UseridMatchList("useridMatchListResource", new()
{
    Description = "string",
    Device = "string",
    Filter = "string",
    Folder = "string",
    Name = "string",
    Quarantine = false,
    SendEmails = new[]
    {
        "string",
    },
    SendHttps = new[]
    {
        "string",
    },
    SendSnmptraps = new[]
    {
        "string",
    },
    SendSyslogs = new[]
    {
        "string",
    },
    SendToPanorama = false,
    Snippet = "string",
});

    example, err := scm.NewUseridMatchList(ctx, "useridMatchListResource", &scm.UseridMatchListArgs{
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Filter:      pulumi.String("string"),
	Folder:      pulumi.String("string"),
	Name:        pulumi.String("string"),
	Quarantine:  pulumi.Bool(false),
	SendEmails: pulumi.StringArray{
		pulumi.String("string"),
	},
	SendHttps: pulumi.StringArray{
		pulumi.String("string"),
	},
	SendSnmptraps: pulumi.StringArray{
		pulumi.String("string"),
	},
	SendSyslogs: pulumi.StringArray{
		pulumi.String("string"),
	},
	SendToPanorama: pulumi.Bool(false),
	Snippet:        pulumi.String("string"),
})

    var useridMatchListResource = new UseridMatchList("useridMatchListResource", UseridMatchListArgs.builder()
    .description("string")
    .device("string")
    .filter("string")
    .folder("string")
    .name("string")
    .quarantine(false)
    .sendEmails("string")
    .sendHttps("string")
    .sendSnmptraps("string")
    .sendSyslogs("string")
    .sendToPanorama(false)
    .snippet("string")
    .build());

    userid_match_list_resource = scm.UseridMatchList("useridMatchListResource",
    description="string",
    device="string",
    filter="string",
    folder="string",
    name="string",
    quarantine=False,
    send_emails=["string"],
    send_https=["string"],
    send_snmptraps=["string"],
    send_syslogs=["string"],
    send_to_panorama=False,
    snippet="string")

    const useridMatchListResource = new scm.UseridMatchList("useridMatchListResource", {
    description: "string",
    device: "string",
    filter: "string",
    folder: "string",
    name: "string",
    quarantine: false,
    sendEmails: ["string"],
    sendHttps: ["string"],
    sendSnmptraps: ["string"],
    sendSyslogs: ["string"],
    sendToPanorama: false,
    snippet: "string",
});

    type: scm:UseridMatchList
properties:
    description: string
    device: string
    filter: string
    folder: string
    name: string
    quarantine: false
    sendEmails:
        - string
    sendHttps:
        - string
    sendSnmptraps:
        - string
    sendSyslogs:
        - string
    sendToPanorama: false
    snippet: string

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

    Description string
    Description of the userid match list entry
    Device string
    The device in which the resource is defined
    Filter string
    Filter of the userid match list entry
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Name of the userid match list entry
    Quarantine bool
    Quarantine Flag of the userid match list entry
    SendEmails List<string>
    Send Email List of the userid match list entry
    SendHttps List<string>
    Send HTTP List of the userid match list entry
    SendSnmptraps List<string>
    Send SNMP Trap List of the userid match list entry
    SendSyslogs List<string>
    Send Sys Log List of the userid match list entry
    SendToPanorama bool
    Send to Panorama Flag of the userid match list entry
    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Description string
    Description of the userid match list entry
    Device string
    The device in which the resource is defined
    Filter string
    Filter of the userid match list entry
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Name of the userid match list entry
    Quarantine bool
    Quarantine Flag of the userid match list entry
    SendEmails []string
    Send Email List of the userid match list entry
    SendHttps []string
    Send HTTP List of the userid match list entry
    SendSnmptraps []string
    Send SNMP Trap List of the userid match list entry
    SendSyslogs []string
    Send Sys Log List of the userid match list entry
    SendToPanorama bool
    Send to Panorama Flag of the userid match list entry
    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    description String
    Description of the userid match list entry
    device String
    The device in which the resource is defined
    filter String
    Filter of the userid match list entry
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Name of the userid match list entry
    quarantine Boolean
    Quarantine Flag of the userid match list entry
    sendEmails List<String>
    Send Email List of the userid match list entry
    sendHttps List<String>
    Send HTTP List of the userid match list entry
    sendSnmptraps List<String>
    Send SNMP Trap List of the userid match list entry
    sendSyslogs List<String>
    Send Sys Log List of the userid match list entry
    sendToPanorama Boolean
    Send to Panorama Flag of the userid match list entry
    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    description string
    Description of the userid match list entry
    device string
    The device in which the resource is defined
    filter string
    Filter of the userid match list entry
    folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name string
    Name of the userid match list entry
    quarantine boolean
    Quarantine Flag of the userid match list entry
    sendEmails string[]
    Send Email List of the userid match list entry
    sendHttps string[]
    Send HTTP List of the userid match list entry
    sendSnmptraps string[]
    Send SNMP Trap List of the userid match list entry
    sendSyslogs string[]
    Send Sys Log List of the userid match list entry
    sendToPanorama boolean
    Send to Panorama Flag of the userid match list entry
    snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    description str
    Description of the userid match list entry
    device str
    The device in which the resource is defined
    filter str
    Filter of the userid match list entry
    folder str

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name str
    Name of the userid match list entry
    quarantine bool
    Quarantine Flag of the userid match list entry
    send_emails Sequence[str]
    Send Email List of the userid match list entry
    send_https Sequence[str]
    Send HTTP List of the userid match list entry
    send_snmptraps Sequence[str]
    Send SNMP Trap List of the userid match list entry
    send_syslogs Sequence[str]
    Send Sys Log List of the userid match list entry
    send_to_panorama bool
    Send to Panorama Flag of the userid match list entry
    snippet str

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    description String
    Description of the userid match list entry
    device String
    The device in which the resource is defined
    filter String
    Filter of the userid match list entry
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Name of the userid match list entry
    quarantine Boolean
    Quarantine Flag of the userid match list entry
    sendEmails List<String>
    Send Email List of the userid match list entry
    sendHttps List<String>
    Send HTTP List of the userid match list entry
    sendSnmptraps List<String>
    Send SNMP Trap List of the userid match list entry
    sendSyslogs List<String>
    Send Sys Log List of the userid match list entry
    sendToPanorama Boolean
    Send to Panorama Flag of the userid match list entry
    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UseridMatchList resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    The Terraform ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    The Terraform ID.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    The Terraform ID.
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    The Terraform ID.
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    The Terraform ID.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    The Terraform ID.

    Look up Existing UseridMatchList Resource

    Get an existing UseridMatchList 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?: UseridMatchListState, opts?: CustomResourceOptions): UseridMatchList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        filter: Optional[str] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        quarantine: Optional[bool] = None,
        send_emails: Optional[Sequence[str]] = None,
        send_https: Optional[Sequence[str]] = None,
        send_snmptraps: Optional[Sequence[str]] = None,
        send_syslogs: Optional[Sequence[str]] = None,
        send_to_panorama: Optional[bool] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = None) -> UseridMatchList
    func GetUseridMatchList(ctx *Context, name string, id IDInput, state *UseridMatchListState, opts ...ResourceOption) (*UseridMatchList, error)
    public static UseridMatchList Get(string name, Input<string> id, UseridMatchListState? state, CustomResourceOptions? opts = null)
    public static UseridMatchList get(String name, Output<String> id, UseridMatchListState state, CustomResourceOptions options)
    resources:  _:    type: scm:UseridMatchList    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:
    Description string
    Description of the userid match list entry
    Device string
    The device in which the resource is defined
    Filter string
    Filter of the userid match list entry
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Name of the userid match list entry
    Quarantine bool
    Quarantine Flag of the userid match list entry
    SendEmails List<string>
    Send Email List of the userid match list entry
    SendHttps List<string>
    Send HTTP List of the userid match list entry
    SendSnmptraps List<string>
    Send SNMP Trap List of the userid match list entry
    SendSyslogs List<string>
    Send Sys Log List of the userid match list entry
    SendToPanorama bool
    Send to Panorama Flag of the userid match list entry
    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Tfid string
    The Terraform ID.
    Description string
    Description of the userid match list entry
    Device string
    The device in which the resource is defined
    Filter string
    Filter of the userid match list entry
    Folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Name string
    Name of the userid match list entry
    Quarantine bool
    Quarantine Flag of the userid match list entry
    SendEmails []string
    Send Email List of the userid match list entry
    SendHttps []string
    Send HTTP List of the userid match list entry
    SendSnmptraps []string
    Send SNMP Trap List of the userid match list entry
    SendSyslogs []string
    Send Sys Log List of the userid match list entry
    SendToPanorama bool
    Send to Panorama Flag of the userid match list entry
    Snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    Tfid string
    The Terraform ID.
    description String
    Description of the userid match list entry
    device String
    The device in which the resource is defined
    filter String
    Filter of the userid match list entry
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Name of the userid match list entry
    quarantine Boolean
    Quarantine Flag of the userid match list entry
    sendEmails List<String>
    Send Email List of the userid match list entry
    sendHttps List<String>
    Send HTTP List of the userid match list entry
    sendSnmptraps List<String>
    Send SNMP Trap List of the userid match list entry
    sendSyslogs List<String>
    Send Sys Log List of the userid match list entry
    sendToPanorama Boolean
    Send to Panorama Flag of the userid match list entry
    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid String
    The Terraform ID.
    description string
    Description of the userid match list entry
    device string
    The device in which the resource is defined
    filter string
    Filter of the userid match list entry
    folder string

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name string
    Name of the userid match list entry
    quarantine boolean
    Quarantine Flag of the userid match list entry
    sendEmails string[]
    Send Email List of the userid match list entry
    sendHttps string[]
    Send HTTP List of the userid match list entry
    sendSnmptraps string[]
    Send SNMP Trap List of the userid match list entry
    sendSyslogs string[]
    Send Sys Log List of the userid match list entry
    sendToPanorama boolean
    Send to Panorama Flag of the userid match list entry
    snippet string

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid string
    The Terraform ID.
    description str
    Description of the userid match list entry
    device str
    The device in which the resource is defined
    filter str
    Filter of the userid match list entry
    folder str

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name str
    Name of the userid match list entry
    quarantine bool
    Quarantine Flag of the userid match list entry
    send_emails Sequence[str]
    Send Email List of the userid match list entry
    send_https Sequence[str]
    Send HTTP List of the userid match list entry
    send_snmptraps Sequence[str]
    Send SNMP Trap List of the userid match list entry
    send_syslogs Sequence[str]
    Send Sys Log List of the userid match list entry
    send_to_panorama bool
    Send to Panorama Flag of the userid match list entry
    snippet str

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid str
    The Terraform ID.
    description String
    Description of the userid match list entry
    device String
    The device in which the resource is defined
    filter String
    Filter of the userid match list entry
    folder String

    The folder in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    name String
    Name of the userid match list entry
    quarantine Boolean
    Quarantine Flag of the userid match list entry
    sendEmails List<String>
    Send Email List of the userid match list entry
    sendHttps List<String>
    Send HTTP List of the userid match list entry
    sendSnmptraps List<String>
    Send SNMP Trap List of the userid match list entry
    sendSyslogs List<String>
    Send Sys Log List of the userid match list entry
    sendToPanorama Boolean
    Send to Panorama Flag of the userid match list entry
    snippet String

    The snippet in which the resource is defined

    ℹ️ Note: You must specify exactly one of device, folder, and snippet.

    tfid String
    The Terraform ID.

    Import

    The following command can be used to import a resource not managed by Terraform:

    $ pulumi import scm:index/useridMatchList:UseridMatchList example folder:::id

    or

    $ pulumi import scm:index/useridMatchList:UseridMatchList example :snippet::id

    or

    $ pulumi import scm:index/useridMatchList:UseridMatchList example ::device:id

    Note: Please provide just one of folder, snippet, or device for the import command.

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

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Viewing docs for Strata Cloud Manager v1.0.5
    published on Saturday, Mar 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-scm
      Try Pulumi Cloud free. Your team will thank you.