1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getAuthenticationRuleList
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
scm logo
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

    Retrieves a listing of config items.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const allPreRules = scm.getAuthenticationRuleList({
        limit: 10,
        offset: 15,
        position: "pre",
        folder: "All",
    });
    export const fetchedRuleListSummary = {
        countOfRulesFetched: allPreRules.then(allPreRules => allPreRules.total),
        firstRuleName: allPreRules.then(allPreRules => allPreRules.datas?.[0]?.name),
    };
    
    import pulumi
    import pulumi_scm as scm
    
    all_pre_rules = scm.get_authentication_rule_list(limit=10,
        offset=15,
        position="pre",
        folder="All")
    pulumi.export("fetchedRuleListSummary", {
        "countOfRulesFetched": all_pre_rules.total,
        "firstRuleName": all_pre_rules.datas[0].name,
    })
    
    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 {
    		allPreRules, err := scm.GetAuthenticationRuleList(ctx, &scm.GetAuthenticationRuleListArgs{
    			Limit:    pulumi.IntRef(10),
    			Offset:   pulumi.IntRef(15),
    			Position: "pre",
    			Folder:   pulumi.StringRef("All"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("fetchedRuleListSummary", pulumi.Map{
    			"countOfRulesFetched": allPreRules.Total,
    			"firstRuleName":       allPreRules.Datas[0].Name,
    		})
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var allPreRules = Scm.GetAuthenticationRuleList.Invoke(new()
        {
            Limit = 10,
            Offset = 15,
            Position = "pre",
            Folder = "All",
        });
    
        return new Dictionary<string, object?>
        {
            ["fetchedRuleListSummary"] = 
            {
                { "countOfRulesFetched", allPreRules.Apply(getAuthenticationRuleListResult => getAuthenticationRuleListResult.Total) },
                { "firstRuleName", allPreRules.Apply(getAuthenticationRuleListResult => getAuthenticationRuleListResult.Datas[0]?.Name) },
            },
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetAuthenticationRuleListArgs;
    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) {
            final var allPreRules = ScmFunctions.getAuthenticationRuleList(GetAuthenticationRuleListArgs.builder()
                .limit(10)
                .offset(15)
                .position("pre")
                .folder("All")
                .build());
    
            ctx.export("fetchedRuleListSummary", Map.ofEntries(
                Map.entry("countOfRulesFetched", allPreRules.total()),
                Map.entry("firstRuleName", allPreRules.datas()[0].name())
            ));
        }
    }
    
    variables:
      allPreRules:
        fn::invoke:
          function: scm:getAuthenticationRuleList
          arguments:
            limit: 10
            offset: 15
            position: pre
            folder: All
    outputs:
      # -----------------------------------------------------------------------------
      # 5. OUTPUT: Display the fetched list data
      # -----------------------------------------------------------------------------
      fetchedRuleListSummary:
        countOfRulesFetched: ${allPreRules.total}
        firstRuleName: ${allPreRules.datas[0].name}
    

    Using getAuthenticationRuleList

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAuthenticationRuleList(args: GetAuthenticationRuleListArgs, opts?: InvokeOptions): Promise<GetAuthenticationRuleListResult>
    function getAuthenticationRuleListOutput(args: GetAuthenticationRuleListOutputArgs, opts?: InvokeOptions): Output<GetAuthenticationRuleListResult>
    def get_authentication_rule_list(device: Optional[str] = None,
                                     folder: Optional[str] = None,
                                     limit: Optional[int] = None,
                                     name: Optional[str] = None,
                                     offset: Optional[int] = None,
                                     position: Optional[str] = None,
                                     snippet: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetAuthenticationRuleListResult
    def get_authentication_rule_list_output(device: Optional[pulumi.Input[str]] = None,
                                     folder: Optional[pulumi.Input[str]] = None,
                                     limit: Optional[pulumi.Input[int]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     offset: Optional[pulumi.Input[int]] = None,
                                     position: Optional[pulumi.Input[str]] = None,
                                     snippet: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetAuthenticationRuleListResult]
    func GetAuthenticationRuleList(ctx *Context, args *GetAuthenticationRuleListArgs, opts ...InvokeOption) (*GetAuthenticationRuleListResult, error)
    func GetAuthenticationRuleListOutput(ctx *Context, args *GetAuthenticationRuleListOutputArgs, opts ...InvokeOption) GetAuthenticationRuleListResultOutput

    > Note: This function is named GetAuthenticationRuleList in the Go SDK.

    public static class GetAuthenticationRuleList 
    {
        public static Task<GetAuthenticationRuleListResult> InvokeAsync(GetAuthenticationRuleListArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthenticationRuleListResult> Invoke(GetAuthenticationRuleListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthenticationRuleListResult> getAuthenticationRuleList(GetAuthenticationRuleListArgs args, InvokeOptions options)
    public static Output<GetAuthenticationRuleListResult> getAuthenticationRuleList(GetAuthenticationRuleListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getAuthenticationRuleList:getAuthenticationRuleList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Position string
    The relative position of the rule
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Position string
    The relative position of the rule
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    position String
    The relative position of the rule
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    position string
    The relative position of the rule
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    position str
    The relative position of the rule
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    position String
    The relative position of the rule
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    getAuthenticationRuleList Result

    The following output properties are available:

    Datas List<GetAuthenticationRuleListData>
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Position string
    The relative position of the rule
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Datas []GetAuthenticationRuleListData
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Position string
    The relative position of the rule
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    datas List<GetAuthenticationRuleListData>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    position String
    The relative position of the rule
    tfid String
    total Integer
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    datas GetAuthenticationRuleListData[]
    The data.
    id string
    The provider-assigned unique ID for this managed resource.
    position string
    The relative position of the rule
    tfid string
    total number
    The total number of items.
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    datas Sequence[GetAuthenticationRuleListData]
    The data.
    id str
    The provider-assigned unique ID for this managed resource.
    position str
    The relative position of the rule
    tfid str
    total int
    The total number of items.
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    datas List<Property Map>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    position String
    The relative position of the rule
    tfid String
    total Number
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    Supporting Types

    GetAuthenticationRuleListData

    AuthenticationEnforcement string
    The authentication profile name
    Categories List<string>
    The destination URL categories
    Description string
    The description of the authentication rule
    DestinationHips List<string>
    The destination Host Integrity Profile (HIP)
    Destinations List<string>
    The destination addresses
    Device string
    Device
    Disabled bool
    Is the authentication rule disabled?
    Folder string
    Folder
    Froms List<string>
    The source security zones
    GroupTag string
    Group tag
    HipProfiles List<string>
    The source Host Integrity Profile (HIP)
    Id string
    The UUID of the authentication rule
    LogAuthenticationTimeout bool
    Log authentication timeouts?
    LogSetting string
    The log forwarding profile name
    Name string
    The name of the authentication rule
    NegateDestination bool
    Are the destination addresses negated?
    NegateSource bool
    Are the source addresses negated?
    Position string
    The relative position of the rule
    RelativePosition string
    Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
    Services List<string>
    The destination ports
    Snippet string
    Snippet
    SourceHips List<string>
    The source Host Integrity Profile (HIP)
    SourceUsers List<string>
    The source users
    Sources List<string>
    The source addresses
    Tags List<string>
    The authentication rule tags
    TargetRule string
    The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
    Tfid string
    Timeout int
    The authentication session timeout (seconds)
    Tos List<string>
    The destination security zones
    AuthenticationEnforcement string
    The authentication profile name
    Categories []string
    The destination URL categories
    Description string
    The description of the authentication rule
    DestinationHips []string
    The destination Host Integrity Profile (HIP)
    Destinations []string
    The destination addresses
    Device string
    Device
    Disabled bool
    Is the authentication rule disabled?
    Folder string
    Folder
    Froms []string
    The source security zones
    GroupTag string
    Group tag
    HipProfiles []string
    The source Host Integrity Profile (HIP)
    Id string
    The UUID of the authentication rule
    LogAuthenticationTimeout bool
    Log authentication timeouts?
    LogSetting string
    The log forwarding profile name
    Name string
    The name of the authentication rule
    NegateDestination bool
    Are the destination addresses negated?
    NegateSource bool
    Are the source addresses negated?
    Position string
    The relative position of the rule
    RelativePosition string
    Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
    Services []string
    The destination ports
    Snippet string
    Snippet
    SourceHips []string
    The source Host Integrity Profile (HIP)
    SourceUsers []string
    The source users
    Sources []string
    The source addresses
    Tags []string
    The authentication rule tags
    TargetRule string
    The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
    Tfid string
    Timeout int
    The authentication session timeout (seconds)
    Tos []string
    The destination security zones
    authenticationEnforcement String
    The authentication profile name
    categories List<String>
    The destination URL categories
    description String
    The description of the authentication rule
    destinationHips List<String>
    The destination Host Integrity Profile (HIP)
    destinations List<String>
    The destination addresses
    device String
    Device
    disabled Boolean
    Is the authentication rule disabled?
    folder String
    Folder
    froms List<String>
    The source security zones
    groupTag String
    Group tag
    hipProfiles List<String>
    The source Host Integrity Profile (HIP)
    id String
    The UUID of the authentication rule
    logAuthenticationTimeout Boolean
    Log authentication timeouts?
    logSetting String
    The log forwarding profile name
    name String
    The name of the authentication rule
    negateDestination Boolean
    Are the destination addresses negated?
    negateSource Boolean
    Are the source addresses negated?
    position String
    The relative position of the rule
    relativePosition String
    Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
    services List<String>
    The destination ports
    snippet String
    Snippet
    sourceHips List<String>
    The source Host Integrity Profile (HIP)
    sourceUsers List<String>
    The source users
    sources List<String>
    The source addresses
    tags List<String>
    The authentication rule tags
    targetRule String
    The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
    tfid String
    timeout Integer
    The authentication session timeout (seconds)
    tos List<String>
    The destination security zones
    authenticationEnforcement string
    The authentication profile name
    categories string[]
    The destination URL categories
    description string
    The description of the authentication rule
    destinationHips string[]
    The destination Host Integrity Profile (HIP)
    destinations string[]
    The destination addresses
    device string
    Device
    disabled boolean
    Is the authentication rule disabled?
    folder string
    Folder
    froms string[]
    The source security zones
    groupTag string
    Group tag
    hipProfiles string[]
    The source Host Integrity Profile (HIP)
    id string
    The UUID of the authentication rule
    logAuthenticationTimeout boolean
    Log authentication timeouts?
    logSetting string
    The log forwarding profile name
    name string
    The name of the authentication rule
    negateDestination boolean
    Are the destination addresses negated?
    negateSource boolean
    Are the source addresses negated?
    position string
    The relative position of the rule
    relativePosition string
    Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
    services string[]
    The destination ports
    snippet string
    Snippet
    sourceHips string[]
    The source Host Integrity Profile (HIP)
    sourceUsers string[]
    The source users
    sources string[]
    The source addresses
    tags string[]
    The authentication rule tags
    targetRule string
    The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
    tfid string
    timeout number
    The authentication session timeout (seconds)
    tos string[]
    The destination security zones
    authentication_enforcement str
    The authentication profile name
    categories Sequence[str]
    The destination URL categories
    description str
    The description of the authentication rule
    destination_hips Sequence[str]
    The destination Host Integrity Profile (HIP)
    destinations Sequence[str]
    The destination addresses
    device str
    Device
    disabled bool
    Is the authentication rule disabled?
    folder str
    Folder
    froms Sequence[str]
    The source security zones
    group_tag str
    Group tag
    hip_profiles Sequence[str]
    The source Host Integrity Profile (HIP)
    id str
    The UUID of the authentication rule
    log_authentication_timeout bool
    Log authentication timeouts?
    log_setting str
    The log forwarding profile name
    name str
    The name of the authentication rule
    negate_destination bool
    Are the destination addresses negated?
    negate_source bool
    Are the source addresses negated?
    position str
    The relative position of the rule
    relative_position str
    Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
    services Sequence[str]
    The destination ports
    snippet str
    Snippet
    source_hips Sequence[str]
    The source Host Integrity Profile (HIP)
    source_users Sequence[str]
    The source users
    sources Sequence[str]
    The source addresses
    tags Sequence[str]
    The authentication rule tags
    target_rule str
    The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
    tfid str
    timeout int
    The authentication session timeout (seconds)
    tos Sequence[str]
    The destination security zones
    authenticationEnforcement String
    The authentication profile name
    categories List<String>
    The destination URL categories
    description String
    The description of the authentication rule
    destinationHips List<String>
    The destination Host Integrity Profile (HIP)
    destinations List<String>
    The destination addresses
    device String
    Device
    disabled Boolean
    Is the authentication rule disabled?
    folder String
    Folder
    froms List<String>
    The source security zones
    groupTag String
    Group tag
    hipProfiles List<String>
    The source Host Integrity Profile (HIP)
    id String
    The UUID of the authentication rule
    logAuthenticationTimeout Boolean
    Log authentication timeouts?
    logSetting String
    The log forwarding profile name
    name String
    The name of the authentication rule
    negateDestination Boolean
    Are the destination addresses negated?
    negateSource Boolean
    Are the source addresses negated?
    position String
    The relative position of the rule
    relativePosition String
    Relative positioning rule. String must be one of these: "before", "after", "top", "bottom". If not specified, rule is created at the bottom of the ruleset.
    services List<String>
    The destination ports
    snippet String
    Snippet
    sourceHips List<String>
    The source Host Integrity Profile (HIP)
    sourceUsers List<String>
    The source users
    sources List<String>
    The source addresses
    tags List<String>
    The authentication rule tags
    targetRule String
    The name or UUID of the rule to position this rule relative to. Required when relative_position is "before" or "after".
    tfid String
    timeout Number
    The authentication session timeout (seconds)
    tos List<String>
    The destination security zones

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate