Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getUserLifecycleRule
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.getUserLifecycleRule

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    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 = filescom.getUserLifecycleRule({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_user_lifecycle_rule = filescom.get_user_lifecycle_rule(id=1)

    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.GetUserLifecycleRule(ctx, &filescom.LookupUserLifecycleRuleArgs{
			Id: 1,
		}, nil)
		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 = Filescom.GetUserLifecycleRule.Invoke(new()
    {
        Id = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import com.pulumi.filescom.inputs.GetUserLifecycleRuleArgs;
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) {
        final var exampleUserLifecycleRule = FilescomFunctions.getUserLifecycleRule(GetUserLifecycleRuleArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  exampleUserLifecycleRule:
    fn::invoke:
      function: filescom:getUserLifecycleRule
      arguments:
        id: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

data "filescom_getuserlifecyclerule" "exampleUserLifecycleRule" {
  id = 1
}

    Using getUserLifecycleRule

    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 getUserLifecycleRule(args: GetUserLifecycleRuleArgs, opts?: InvokeOptions): Promise<GetUserLifecycleRuleResult>
function getUserLifecycleRuleOutput(args: GetUserLifecycleRuleOutputArgs, opts?: InvokeOutputOptions): Output<GetUserLifecycleRuleResult>
    def get_user_lifecycle_rule(id: Optional[int] = None,
                            opts: Optional[InvokeOptions] = None) -> GetUserLifecycleRuleResult
def get_user_lifecycle_rule_output(id: pulumi.Input[Optional[int]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetUserLifecycleRuleResult]
    func LookupUserLifecycleRule(ctx *Context, args *LookupUserLifecycleRuleArgs, opts ...InvokeOption) (*LookupUserLifecycleRuleResult, error)
func LookupUserLifecycleRuleOutput(ctx *Context, args *LookupUserLifecycleRuleOutputArgs, opts ...InvokeOption) LookupUserLifecycleRuleResultOutput

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

    public static class GetUserLifecycleRule 
{
    public static Task<GetUserLifecycleRuleResult> InvokeAsync(GetUserLifecycleRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetUserLifecycleRuleResult> Invoke(GetUserLifecycleRuleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetUserLifecycleRuleResult> Invoke(GetUserLifecycleRuleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetUserLifecycleRuleResult> getUserLifecycleRule(GetUserLifecycleRuleArgs args, InvokeOptions options)
public static Output<GetUserLifecycleRuleResult> getUserLifecycleRule(GetUserLifecycleRuleArgs args, InvokeOptions options)
public static Output<GetUserLifecycleRuleResult> getUserLifecycleRule(GetUserLifecycleRuleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getUserLifecycleRule:getUserLifecycleRule
  arguments:
    # arguments dictionary
    data "filescom_get_user_lifecycle_rule" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    User Lifecycle Rule ID
    Id int
    User Lifecycle Rule ID
    id number
    User Lifecycle Rule ID
    id Integer
    User Lifecycle Rule ID
    id number
    User Lifecycle Rule ID
    id int
    User Lifecycle Rule ID
    id Number
    User Lifecycle Rule ID

    getUserLifecycleRule Result

    The following output properties are available:

    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.
    Id int
    User Lifecycle Rule ID
    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.
    Id int
    User Lifecycle Rule ID
    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.
    id number
    User Lifecycle Rule ID
    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.
    id Integer
    User Lifecycle Rule ID
    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.
    id number
    User Lifecycle Rule ID
    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.
    id int
    User Lifecycle Rule ID
    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.
    id Number
    User Lifecycle Rule ID
    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.

    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
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial