You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*`prevent_root_permissions_for_non_site_admins` (boolean): If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
486
487
*`protocol_access_groups_only` (boolean): If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
487
488
*`require_2fa` (boolean): Require two-factor authentication for all users?
489
+
*`require_2fa_exempt_all_sso_users` (boolean): If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
488
490
*`require_2fa_stop_time` (date-time): If set, requirement for two-factor authentication has been scheduled to end on this date-time.
489
491
*`revoke_bundle_access_on_disable_or_delete` (boolean): Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
490
492
*`require_2fa_user_type` (string): What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
*`allowed_2fa_method_static` (boolean): Is OTP via static codes for two factor authentication allowed?
861
864
*`allowed_2fa_method_bypass_for_ftp_sftp_dav` (boolean): Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
862
865
*`require_2fa` (boolean): Require two-factor authentication for all users?
866
+
*`require_2fa_exempt_all_sso_users` (boolean): If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
863
867
*`require_2fa_user_type` (string): What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
864
868
*`color2_top` (string): Top bar background color
865
869
*`color2_left` (string): Page link and button color
Copy file name to clipboardExpand all lines: docs/models/SsoStrategy.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@
95
95
*`provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
96
96
*`provision_time_zone` (string): Default time zone for auto provisioned users.
97
97
*`provision_company` (string): Default company for auto provisioned users.
98
-
*`provision_require_2fa` (string): 2FA required setting for auto provisioned users.
98
+
*`provision_require_2fa` (string): 2FA required setting for auto provisioned users.`use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
99
99
*`provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
100
100
*`provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
101
101
*`ldap_base_dn` (string): Base DN for looking up users in LDAP server
Copy file name to clipboardExpand all lines: docs/models/User.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -150,7 +150,7 @@
150
150
*`notify_on_all_sync_failures` (boolean): Should the user receive sync failures via email?
151
151
*`notify_on_all_automation_failures` (boolean): Should the user receive automation failures via email?
152
152
*`notify_on_all_expectation_failures` (boolean): Should the user receive expectation failures and misses via email?
153
-
*`require_2fa` (string): 2FA required setting
153
+
*`require_2fa` (string): 2FA required setting. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
154
154
*`require_login_by` (date-time): Require user to login by specified date otherwise it will be disabled.
155
155
*`active_2fa` (boolean): Is 2fa active for the user?
156
156
*`require_password_change` (boolean): Is a password change required upon next user login?
@@ -354,7 +354,7 @@ await User.create({
354
354
*`ssl_required` (string): SSL required setting
355
355
*`sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
356
356
*`subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
357
-
*`require_2fa` (string): 2FA required setting
357
+
*`require_2fa` (string): 2FA required setting. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
358
358
*`tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
359
359
*`time_zone` (string): User time zone
360
360
*`user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
@@ -537,7 +537,7 @@ await user.update({
537
537
*`ssl_required` (string): SSL required setting
538
538
*`sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
539
539
*`subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
540
-
*`require_2fa` (string): 2FA required setting
540
+
*`require_2fa` (string): 2FA required setting. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
541
541
*`tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
542
542
*`time_zone` (string): User time zone
543
543
*`user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
// boolean # If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
// allowed_2fa_method_static - boolean - Is OTP via static codes for two factor authentication allowed?
958
962
// allowed_2fa_method_bypass_for_ftp_sftp_dav - boolean - Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
959
963
// require_2fa - boolean - Require two-factor authentication for all users?
964
+
// require_2fa_exempt_all_sso_users - boolean - If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
960
965
// require_2fa_user_type - string - What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
961
966
// color2_top - string - Top bar background color
962
967
// color2_left - string - Page link and button color
// string # 2FA required setting for auto provisioned users.
179
+
// string # 2FA required setting for auto provisioned users. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
// string # 2FA required setting. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
@@ -905,7 +905,7 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
905
905
// ssl_required - string - SSL required setting
906
906
// sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
907
907
// subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
908
-
// require_2fa - string - 2FA required setting
908
+
// require_2fa - string - 2FA required setting. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
909
909
// tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
910
910
// time_zone - string - User time zone
911
911
// user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
@@ -1448,7 +1448,7 @@ _User = User;
1448
1448
// ssl_required - string - SSL required setting
1449
1449
// sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
1450
1450
// subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
1451
-
// require_2fa - string - 2FA required setting
1451
+
// require_2fa - string - 2FA required setting. `use_system_setting` uses the site-wide setting, including SSO exemptions. `always_require` and `never_require` override the site-wide setting when user-level overrides are allowed.
1452
1452
// tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
1453
1453
// time_zone - string - User time zone
1454
1454
// user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
0 commit comments