Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
user_lifecycle_rules
User Lifecycle Rules

Update User Lifecycle Rule

Update User Lifecycle Rule

patch/user_lifecycle_rules/{id}

Path parameters

idinteger required

User Lifecycle Rule ID.

Response

The UserLifecycleRules object.

idinteger

User Lifecycle Rule ID

authentication_method'all' | 'password' | 'sso' | 'none' | 'email_signup' | 'password_with_imported_hash' | 'password_and_ssh_key' | 'all_non_sso'

User authentication method for which the rule will apply. Use all_non_sso to target every non-SSO authentication method with one rule.

group_idsinteger[]

Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.

action'disable' | 'delete'

Action to take on inactive users (disable or delete)

inactivity_daysinteger

Number of days of inactivity before the rule applies

include_folder_adminsboolean

If true, the rule will apply to folder admins.

include_site_adminsboolean

If true, the rule will apply to site admins.

apply_to_all_workspacesboolean

If true, a default-workspace rule also applies to users in all workspaces.

namestring

User Lifecycle Rule name

notify_usersboolean

If true, users will be emailed before the rule disables or deletes them.

partner_tagstring

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_idinteger

Site ID

workspace_idinteger

Workspace ID. 0 means the default workspace.

user_state'inactive' | 'disabled'

State of the users to apply the rule to (inactive or disabled)

user_tagstring

If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.

Example response

{
  "id": 1,
  "authentication_method": "all_non_sso",
  "group_ids": [
    1,
    2,
    3
  ],
  "action": "disable",
  "inactivity_days": 12,
  "include_folder_admins": true,
  "include_site_admins": true,
  "apply_to_all_workspaces": true,
  "name": "password specific rules",
  "notify_users": true,
  "partner_tag": "guest",
  "site_id": 1,
  "workspace_id": 12,
  "user_state": "inactive",
  "user_tag": "guest"
}