1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. UserLifecycleRule
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A UserLifecycleRule represents a rule that applies to users based on their inactivity, state and authentication method.

    The rule either disable or delete users who have been inactive or disabled for a specified number of days.

    The authenticationMethod property specifies the authentication method for the rule, which can be set to “all”, “allNonSso”, or a specific authentication method.

    The rule can also include or exclude site and folder admins from the action.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleUserLifecycleRule = new filescom.UserLifecycleRule("example_user_lifecycle_rule", {
        applyToAllWorkspaces: true,
        authenticationMethod: "all_non_sso",
        groupIds: [
            1,
            2,
            3,
        ],
        inactivityDays: 12,
        includeSiteAdmins: true,
        includeFolderAdmins: true,
        name: "password specific rules",
        notifyUsers: true,
        partnerTag: "guest",
        userState: "inactive",
        userTag: "guest",
        workspaceId: 12,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_user_lifecycle_rule = filescom.UserLifecycleRule("example_user_lifecycle_rule",
        apply_to_all_workspaces=True,
        authentication_method="all_non_sso",
        group_ids=[
            1,
            2,
            3,
        ],
        inactivity_days=12,
        include_site_admins=True,
        include_folder_admins=True,
        name="password specific rules",
        notify_users=True,
        partner_tag="guest",
        user_state="inactive",
        user_tag="guest",
        workspace_id=12)
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.NewUserLifecycleRule(ctx, "example_user_lifecycle_rule", &filescom.UserLifecycleRuleArgs{
    			ApplyToAllWorkspaces: pulumi.Bool(true),
    			AuthenticationMethod: pulumi.String("all_non_sso"),
    			GroupIds: pulumi.IntArray{
    				pulumi.Int(1),
    				pulumi.Int(2),
    				pulumi.Int(3),
    			},
    			InactivityDays:      pulumi.Int(12),
    			IncludeSiteAdmins:   pulumi.Bool(true),
    			IncludeFolderAdmins: pulumi.Bool(true),
    			Name:                pulumi.String("password specific rules"),
    			NotifyUsers:         pulumi.Bool(true),
    			PartnerTag:          pulumi.String("guest"),
    			UserState:           pulumi.String("inactive"),
    			UserTag:             pulumi.String("guest"),
    			WorkspaceId:         pulumi.Int(12),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleUserLifecycleRule = new Filescom.UserLifecycleRule("example_user_lifecycle_rule", new()
        {
            ApplyToAllWorkspaces = true,
            AuthenticationMethod = "all_non_sso",
            GroupIds = new[]
            {
                1,
                2,
                3,
            },
            InactivityDays = 12,
            IncludeSiteAdmins = true,
            IncludeFolderAdmins = true,
            Name = "password specific rules",
            NotifyUsers = true,
            PartnerTag = "guest",
            UserState = "inactive",
            UserTag = "guest",
            WorkspaceId = 12,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.UserLifecycleRule;
    import com.pulumi.filescom.UserLifecycleRuleArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 exampleUserLifecycleRule = new UserLifecycleRule("exampleUserLifecycleRule", UserLifecycleRuleArgs.builder()
                .applyToAllWorkspaces(true)
                .authenticationMethod("all_non_sso")
                .groupIds(            
                    1,
                    2,
                    3)
                .inactivityDays(12)
                .includeSiteAdmins(true)
                .includeFolderAdmins(true)
                .name("password specific rules")
                .notifyUsers(true)
                .partnerTag("guest")
                .userState("inactive")
                .userTag("guest")
                .workspaceId(12)
                .build());
    
        }
    }
    
    resources:
      exampleUserLifecycleRule:
        type: filescom:UserLifecycleRule
        name: example_user_lifecycle_rule
        properties:
          applyToAllWorkspaces: true
          authenticationMethod: all_non_sso
          groupIds:
            - 1
            - 2
            - 3
          inactivityDays: 12
          includeSiteAdmins: true
          includeFolderAdmins: true
          name: password specific rules
          notifyUsers: true
          partnerTag: guest
          userState: inactive
          userTag: guest
          workspaceId: 12
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_userlifecyclerule" "example_user_lifecycle_rule" {
      apply_to_all_workspaces = true
      authentication_method   = "all_non_sso"
      group_ids               = [1, 2, 3]
      inactivity_days         = 12
      include_site_admins     = true
      include_folder_admins   = true
      name                    = "password specific rules"
      notify_users            = true
      partner_tag             = "guest"
      user_state              = "inactive"
      user_tag                = "guest"
      workspace_id            = 12
    }
    

    Create UserLifecycleRule Resource

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

    Constructor syntax

    new UserLifecycleRule(name: string, args?: UserLifecycleRuleArgs, opts?: CustomResourceOptions);
    @overload
    def UserLifecycleRule(resource_name: str,
                          args: Optional[UserLifecycleRuleArgs] = None,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserLifecycleRule(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          action: Optional[str] = None,
                          apply_to_all_workspaces: Optional[bool] = None,
                          authentication_method: Optional[str] = None,
                          group_ids: Optional[Sequence[int]] = None,
                          inactivity_days: Optional[int] = None,
                          include_folder_admins: Optional[bool] = None,
                          include_site_admins: Optional[bool] = None,
                          name: Optional[str] = None,
                          notify_users: Optional[bool] = None,
                          partner_tag: Optional[str] = None,
                          user_state: Optional[str] = None,
                          user_tag: Optional[str] = None,
                          workspace_id: Optional[int] = None)
    func NewUserLifecycleRule(ctx *Context, name string, args *UserLifecycleRuleArgs, opts ...ResourceOption) (*UserLifecycleRule, error)
    public UserLifecycleRule(string name, UserLifecycleRuleArgs? args = null, CustomResourceOptions? opts = null)
    public UserLifecycleRule(String name, UserLifecycleRuleArgs args)
    public UserLifecycleRule(String name, UserLifecycleRuleArgs args, CustomResourceOptions options)
    
    type: filescom:UserLifecycleRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_user_lifecycle_rule" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args UserLifecycleRuleArgs
    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 UserLifecycleRuleArgs
    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 UserLifecycleRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserLifecycleRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserLifecycleRuleArgs
    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 userLifecycleRuleResource = new Filescom.UserLifecycleRule("userLifecycleRuleResource", new()
    {
        Action = "string",
        ApplyToAllWorkspaces = false,
        AuthenticationMethod = "string",
        GroupIds = new[]
        {
            0,
        },
        InactivityDays = 0,
        IncludeFolderAdmins = false,
        IncludeSiteAdmins = false,
        Name = "string",
        NotifyUsers = false,
        PartnerTag = "string",
        UserState = "string",
        UserTag = "string",
        WorkspaceId = 0,
    });
    
    example, err := filescom.NewUserLifecycleRule(ctx, "userLifecycleRuleResource", &filescom.UserLifecycleRuleArgs{
    	Action:               pulumi.String("string"),
    	ApplyToAllWorkspaces: pulumi.Bool(false),
    	AuthenticationMethod: pulumi.String("string"),
    	GroupIds: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    	InactivityDays:      pulumi.Int(0),
    	IncludeFolderAdmins: pulumi.Bool(false),
    	IncludeSiteAdmins:   pulumi.Bool(false),
    	Name:                pulumi.String("string"),
    	NotifyUsers:         pulumi.Bool(false),
    	PartnerTag:          pulumi.String("string"),
    	UserState:           pulumi.String("string"),
    	UserTag:             pulumi.String("string"),
    	WorkspaceId:         pulumi.Int(0),
    })
    
    resource "filescom_user_lifecycle_rule" "userLifecycleRuleResource" {
      lifecycle {
        create_before_destroy = true
      }
      action                  = "string"
      apply_to_all_workspaces = false
      authentication_method   = "string"
      group_ids               = [0]
      inactivity_days         = 0
      include_folder_admins   = false
      include_site_admins     = false
      name                    = "string"
      notify_users            = false
      partner_tag             = "string"
      user_state              = "string"
      user_tag                = "string"
      workspace_id            = 0
    }
    
    var userLifecycleRuleResource = new UserLifecycleRule("userLifecycleRuleResource", UserLifecycleRuleArgs.builder()
        .action("string")
        .applyToAllWorkspaces(false)
        .authenticationMethod("string")
        .groupIds(0)
        .inactivityDays(0)
        .includeFolderAdmins(false)
        .includeSiteAdmins(false)
        .name("string")
        .notifyUsers(false)
        .partnerTag("string")
        .userState("string")
        .userTag("string")
        .workspaceId(0)
        .build());
    
    user_lifecycle_rule_resource = filescom.UserLifecycleRule("userLifecycleRuleResource",
        action="string",
        apply_to_all_workspaces=False,
        authentication_method="string",
        group_ids=[0],
        inactivity_days=0,
        include_folder_admins=False,
        include_site_admins=False,
        name="string",
        notify_users=False,
        partner_tag="string",
        user_state="string",
        user_tag="string",
        workspace_id=0)
    
    const userLifecycleRuleResource = new filescom.UserLifecycleRule("userLifecycleRuleResource", {
        action: "string",
        applyToAllWorkspaces: false,
        authenticationMethod: "string",
        groupIds: [0],
        inactivityDays: 0,
        includeFolderAdmins: false,
        includeSiteAdmins: false,
        name: "string",
        notifyUsers: false,
        partnerTag: "string",
        userState: "string",
        userTag: "string",
        workspaceId: 0,
    });
    
    type: filescom:UserLifecycleRule
    properties:
        action: string
        applyToAllWorkspaces: false
        authenticationMethod: string
        groupIds:
            - 0
        inactivityDays: 0
        includeFolderAdmins: false
        includeSiteAdmins: false
        name: string
        notifyUsers: false
        partnerTag: string
        userState: string
        userTag: string
        workspaceId: 0
    

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

    Action string
    Action to take on inactive users (disable or delete)
    ApplyToAllWorkspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    AuthenticationMethod string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    GroupIds List<int>
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    InactivityDays int
    Number of days of inactivity before the rule applies
    IncludeFolderAdmins bool
    If true, the rule will apply to folder admins.
    IncludeSiteAdmins bool
    If true, the rule will apply to site admins.
    Name string
    User Lifecycle Rule name
    NotifyUsers bool
    If true, users will be emailed before the rule disables or deletes them.
    PartnerTag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    UserState string
    State of the users to apply the rule to (inactive or disabled)
    UserTag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    Action string
    Action to take on inactive users (disable or delete)
    ApplyToAllWorkspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    AuthenticationMethod string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    GroupIds []int
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    InactivityDays int
    Number of days of inactivity before the rule applies
    IncludeFolderAdmins bool
    If true, the rule will apply to folder admins.
    IncludeSiteAdmins bool
    If true, the rule will apply to site admins.
    Name string
    User Lifecycle Rule name
    NotifyUsers bool
    If true, users will be emailed before the rule disables or deletes them.
    PartnerTag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    UserState string
    State of the users to apply the rule to (inactive or disabled)
    UserTag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    action string
    Action to take on inactive users (disable or delete)
    apply_to_all_workspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    authentication_method string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    group_ids list(number)
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivity_days number
    Number of days of inactivity before the rule applies
    include_folder_admins bool
    If true, the rule will apply to folder admins.
    include_site_admins bool
    If true, the rule will apply to site admins.
    name string
    User Lifecycle Rule name
    notify_users bool
    If true, users will be emailed before the rule disables or deletes them.
    partner_tag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    user_state string
    State of the users to apply the rule to (inactive or disabled)
    user_tag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspace_id number
    Workspace ID. 0 means the default workspace.
    action String
    Action to take on inactive users (disable or delete)
    applyToAllWorkspaces Boolean
    If true, a default-workspace rule also applies to users in all workspaces.
    authenticationMethod String
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    groupIds List<Integer>
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivityDays Integer
    Number of days of inactivity before the rule applies
    includeFolderAdmins Boolean
    If true, the rule will apply to folder admins.
    includeSiteAdmins Boolean
    If true, the rule will apply to site admins.
    name String
    User Lifecycle Rule name
    notifyUsers Boolean
    If true, users will be emailed before the rule disables or deletes them.
    partnerTag String
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    userState String
    State of the users to apply the rule to (inactive or disabled)
    userTag String
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    action string
    Action to take on inactive users (disable or delete)
    applyToAllWorkspaces boolean
    If true, a default-workspace rule also applies to users in all workspaces.
    authenticationMethod string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    groupIds number[]
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivityDays number
    Number of days of inactivity before the rule applies
    includeFolderAdmins boolean
    If true, the rule will apply to folder admins.
    includeSiteAdmins boolean
    If true, the rule will apply to site admins.
    name string
    User Lifecycle Rule name
    notifyUsers boolean
    If true, users will be emailed before the rule disables or deletes them.
    partnerTag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    userState string
    State of the users to apply the rule to (inactive or disabled)
    userTag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspaceId number
    Workspace ID. 0 means the default workspace.
    action str
    Action to take on inactive users (disable or delete)
    apply_to_all_workspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    authentication_method str
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    group_ids Sequence[int]
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivity_days int
    Number of days of inactivity before the rule applies
    include_folder_admins bool
    If true, the rule will apply to folder admins.
    include_site_admins bool
    If true, the rule will apply to site admins.
    name str
    User Lifecycle Rule name
    notify_users bool
    If true, users will be emailed before the rule disables or deletes them.
    partner_tag str
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    user_state str
    State of the users to apply the rule to (inactive or disabled)
    user_tag str
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspace_id int
    Workspace ID. 0 means the default workspace.
    action String
    Action to take on inactive users (disable or delete)
    applyToAllWorkspaces Boolean
    If true, a default-workspace rule also applies to users in all workspaces.
    authenticationMethod String
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    groupIds List<Number>
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivityDays Number
    Number of days of inactivity before the rule applies
    includeFolderAdmins Boolean
    If true, the rule will apply to folder admins.
    includeSiteAdmins Boolean
    If true, the rule will apply to site admins.
    name String
    User Lifecycle Rule name
    notifyUsers Boolean
    If true, users will be emailed before the rule disables or deletes them.
    partnerTag String
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    userState String
    State of the users to apply the rule to (inactive or disabled)
    userTag String
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SiteId int
    Site ID
    Id string
    The provider-assigned unique ID for this managed resource.
    SiteId int
    Site ID
    id string
    The provider-assigned unique ID for this managed resource.
    site_id number
    Site ID
    id String
    The provider-assigned unique ID for this managed resource.
    siteId Integer
    Site ID
    id string
    The provider-assigned unique ID for this managed resource.
    siteId number
    Site ID
    id str
    The provider-assigned unique ID for this managed resource.
    site_id int
    Site ID
    id String
    The provider-assigned unique ID for this managed resource.
    siteId Number
    Site ID

    Look up Existing UserLifecycleRule Resource

    Get an existing UserLifecycleRule 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?: UserLifecycleRuleState, opts?: CustomResourceOptions): UserLifecycleRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = None,
            apply_to_all_workspaces: Optional[bool] = None,
            authentication_method: Optional[str] = None,
            group_ids: Optional[Sequence[int]] = None,
            inactivity_days: Optional[int] = None,
            include_folder_admins: Optional[bool] = None,
            include_site_admins: Optional[bool] = None,
            name: Optional[str] = None,
            notify_users: Optional[bool] = None,
            partner_tag: Optional[str] = None,
            site_id: Optional[int] = None,
            user_state: Optional[str] = None,
            user_tag: Optional[str] = None,
            workspace_id: Optional[int] = None) -> UserLifecycleRule
    func GetUserLifecycleRule(ctx *Context, name string, id IDInput, state *UserLifecycleRuleState, opts ...ResourceOption) (*UserLifecycleRule, error)
    public static UserLifecycleRule Get(string name, Input<string> id, UserLifecycleRuleState? state, CustomResourceOptions? opts = null)
    public static UserLifecycleRule get(String name, Output<String> id, UserLifecycleRuleState state, CustomResourceOptions options)
    resources:  _:    type: filescom:UserLifecycleRule    get:      id: ${id}
    import {
      to = filescom_user_lifecycle_rule.example
      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:
    Action string
    Action to take on inactive users (disable or delete)
    ApplyToAllWorkspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    AuthenticationMethod string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    GroupIds List<int>
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    InactivityDays int
    Number of days of inactivity before the rule applies
    IncludeFolderAdmins bool
    If true, the rule will apply to folder admins.
    IncludeSiteAdmins bool
    If true, the rule will apply to site admins.
    Name string
    User Lifecycle Rule name
    NotifyUsers bool
    If true, users will be emailed before the rule disables or deletes them.
    PartnerTag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    SiteId int
    Site ID
    UserState string
    State of the users to apply the rule to (inactive or disabled)
    UserTag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    Action string
    Action to take on inactive users (disable or delete)
    ApplyToAllWorkspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    AuthenticationMethod string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    GroupIds []int
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    InactivityDays int
    Number of days of inactivity before the rule applies
    IncludeFolderAdmins bool
    If true, the rule will apply to folder admins.
    IncludeSiteAdmins bool
    If true, the rule will apply to site admins.
    Name string
    User Lifecycle Rule name
    NotifyUsers bool
    If true, users will be emailed before the rule disables or deletes them.
    PartnerTag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    SiteId int
    Site ID
    UserState string
    State of the users to apply the rule to (inactive or disabled)
    UserTag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    action string
    Action to take on inactive users (disable or delete)
    apply_to_all_workspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    authentication_method string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    group_ids list(number)
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivity_days number
    Number of days of inactivity before the rule applies
    include_folder_admins bool
    If true, the rule will apply to folder admins.
    include_site_admins bool
    If true, the rule will apply to site admins.
    name string
    User Lifecycle Rule name
    notify_users bool
    If true, users will be emailed before the rule disables or deletes them.
    partner_tag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    site_id number
    Site ID
    user_state string
    State of the users to apply the rule to (inactive or disabled)
    user_tag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspace_id number
    Workspace ID. 0 means the default workspace.
    action String
    Action to take on inactive users (disable or delete)
    applyToAllWorkspaces Boolean
    If true, a default-workspace rule also applies to users in all workspaces.
    authenticationMethod String
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    groupIds List<Integer>
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivityDays Integer
    Number of days of inactivity before the rule applies
    includeFolderAdmins Boolean
    If true, the rule will apply to folder admins.
    includeSiteAdmins Boolean
    If true, the rule will apply to site admins.
    name String
    User Lifecycle Rule name
    notifyUsers Boolean
    If true, users will be emailed before the rule disables or deletes them.
    partnerTag String
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    siteId Integer
    Site ID
    userState String
    State of the users to apply the rule to (inactive or disabled)
    userTag String
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    action string
    Action to take on inactive users (disable or delete)
    applyToAllWorkspaces boolean
    If true, a default-workspace rule also applies to users in all workspaces.
    authenticationMethod string
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    groupIds number[]
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivityDays number
    Number of days of inactivity before the rule applies
    includeFolderAdmins boolean
    If true, the rule will apply to folder admins.
    includeSiteAdmins boolean
    If true, the rule will apply to site admins.
    name string
    User Lifecycle Rule name
    notifyUsers boolean
    If true, users will be emailed before the rule disables or deletes them.
    partnerTag string
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    siteId number
    Site ID
    userState string
    State of the users to apply the rule to (inactive or disabled)
    userTag string
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspaceId number
    Workspace ID. 0 means the default workspace.
    action str
    Action to take on inactive users (disable or delete)
    apply_to_all_workspaces bool
    If true, a default-workspace rule also applies to users in all workspaces.
    authentication_method str
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    group_ids Sequence[int]
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivity_days int
    Number of days of inactivity before the rule applies
    include_folder_admins bool
    If true, the rule will apply to folder admins.
    include_site_admins bool
    If true, the rule will apply to site admins.
    name str
    User Lifecycle Rule name
    notify_users bool
    If true, users will be emailed before the rule disables or deletes them.
    partner_tag str
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    site_id int
    Site ID
    user_state str
    State of the users to apply the rule to (inactive or disabled)
    user_tag str
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspace_id int
    Workspace ID. 0 means the default workspace.
    action String
    Action to take on inactive users (disable or delete)
    applyToAllWorkspaces Boolean
    If true, a default-workspace rule also applies to users in all workspaces.
    authenticationMethod String
    User authentication method for which the rule will apply. Use allNonSso to target every non-SSO authentication method with one rule.
    groupIds List<Number>
    Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
    inactivityDays Number
    Number of days of inactivity before the rule applies
    includeFolderAdmins Boolean
    If true, the rule will apply to folder admins.
    includeSiteAdmins Boolean
    If true, the rule will apply to site admins.
    name String
    User Lifecycle Rule name
    notifyUsers Boolean
    If true, users will be emailed before the rule disables or deletes them.
    partnerTag String
    If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    siteId Number
    Site ID
    userState String
    State of the users to apply the rule to (inactive or disabled)
    userTag String
    If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Import

    The pulumi import command can be used, for example:

    User Lifecycle Rules can be imported by specifying the id.

    $ pulumi import filescom:index/userLifecycleRule:UserLifecycleRule example_user_lifecycle_rule 1
    

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

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial