User Lifecycle Rules

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 authentication_method property specifies the authentication method for the rule, which can be set to "all", "all_non_sso", or a specific authentication method.

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

List User Lifecycle Rules

SDK Method

UserLifecycleRule.list()

Return Object

UserLifecycleRule[]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

import UserLifecycleRule from 'files.com/lib/models/UserLifecycleRule';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userLifecycleRules = await UserLifecycleRule.list();
  for (const userLifecycleRule of userLifecycleRules) {
    // Operate on userLifecycleRule
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show User Lifecycle Rule

SDK Method

UserLifecycleRule.find()

Return Object

UserLifecycleRule

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		User Lifecycle Rule ID.

Example Request

import UserLifecycleRule from 'files.com/lib/models/UserLifecycleRule';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userLifecycleRule = await UserLifecycleRule.find(id);
  // Operate on userLifecycleRule
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Create User Lifecycle Rule

SDK Method

UserLifecycleRule.create()

Return Object

UserLifecycleRule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
apply_to_all_workspaces
boolean		falseIf 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 all_non_sso to target every non-SSO authentication method with one rule.
Possible values: all, password, sso, none, email_signup, password_with_imported_hash, password_and_ssh_key, all_non_sso
group_ids
array(int64)		Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
inactivity_days
int64		Number of days of inactivity before the rule applies
include_site_admins
boolean		falseIf true, the rule will apply to site admins.
include_folder_admins
boolean		falseIf true, the rule will apply to folder admins.
name
string		User Lifecycle Rule name
notify_users
boolean		falseIf 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		"inactive"State of the users to apply the rule to (inactive or disabled)
Possible values: inactive, 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
int64		0Workspace ID. 0 means the default workspace.

Example Request

import UserLifecycleRule from 'files.com/lib/models/UserLifecycleRule';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userLifecycleRule = await UserLifecycleRule.create({
    apply_to_all_workspaces: true,
  });
  // Operate on userLifecycleRule
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Update User Lifecycle Rule

SDK Method

userLifecycleRule.update()

Return Object

UserLifecycleRule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
apply_to_all_workspaces
boolean		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 all_non_sso to target every non-SSO authentication method with one rule.
Possible values: all, password, sso, none, email_signup, password_with_imported_hash, password_and_ssh_key, all_non_sso
group_ids
array(int64)		Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
inactivity_days
int64		Number of days of inactivity before the rule applies
include_site_admins
boolean		If true, the rule will apply to site admins.
include_folder_admins
boolean		If true, the rule will apply to folder admins.
name
string		User Lifecycle Rule name
notify_users
boolean		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)
Possible values: inactive, 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
int64		Workspace ID. 0 means the default workspace.

Example Request

import UserLifecycleRule from 'files.com/lib/models/UserLifecycleRule';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the userLifecycleRule object by its id.
  const userLifecycleRule = await UserLifecycleRule.find(id);
  await userLifecycleRule.update({
    apply_to_all_workspaces: true,
  });
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete User Lifecycle Rule

SDK Method

userLifecycleRule.delete()

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import UserLifecycleRule from 'files.com/lib/models/UserLifecycleRule';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the userLifecycleRule object by its id.
  const userLifecycleRule = await UserLifecycleRule.find(id);
  await userLifecycleRule.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The UserLifecycleRule Object

Some of the methods above return a UserLifecycleRule object. The attributes of this object are listed below.

AttributeDescription
id
int64		User Lifecycle Rule ID
authentication_method
string		User authentication method for which the rule will apply. Use all_non_sso to target every non-SSO authentication method with one rule.
Possible values: all, password, sso, none, email_signup, password_with_imported_hash, password_and_ssh_key, all_non_sso
group_ids
array(int64)		Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
action
string		Action to take on inactive users (disable or delete)
Possible values: disable, delete
inactivity_days
int64		Number of days of inactivity before the rule applies
include_folder_admins
boolean		If true, the rule will apply to folder admins.
include_site_admins
boolean		If true, the rule will apply to site admins.
apply_to_all_workspaces
boolean		If true, a default-workspace rule also applies to users in all workspaces.
name
string		User Lifecycle Rule name
notify_users
boolean		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
int64		Site ID
workspace_id
int64		Workspace ID. 0 means the default workspace.
user_state
string		State of the users to apply the rule to (inactive or disabled)
Possible values: inactive, 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.