published on Friday, Aug 28, 2026 by onelogin
published on Friday, Aug 28, 2026 by onelogin
Manages a OneLogin security policy.
A policy is one of two kinds, set by kind and fixed for the life of the policy:
- A user policy governs how people sign in — passwords, MFA, lockout, session length,
self-service password reset, the portal, and so on. Assign it to users through the
policy_idon a group, or make it the account default in the OneLogin admin UI. Roles cannot carry a policy: OneLogin has no role-to-policy assignment. - An app policy governs a single application — whether opening it forces re-authentication, and how long that lasts.
The two share one API resource, so most arguments belong to only one kind. Each argument
below says which. Setting one on the wrong kind is refused during pulumi preview, before
anything reaches OneLogin.
Custom security policies are a licensed feature. If your plan does not include
Custom Security Policies, creating one returns 406 Not Acceptable.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as onelogin from "@pulumi/onelogin";
const engineering = new onelogin.Policies("engineering", {
name: "Engineering",
kind: "user",
minimumPasswordLength: 12,
passwordExpirationDays: 90,
passwordsRemembered: 5,
passwordComplexityRequirements: 3,
maximumInvalidLoginAttempts: 5,
lockEffectiveMinutes: 15,
otpAuthEnabled: true,
mfaRegistrationEnabled: true,
authenticationFactorIds: [
12345,
67890,
],
sessionTimeoutByInactivityValue: 30,
sessionTimeoutByInactivityUnit: 0,
termsAndConditions: {
enabled: true,
content: "Access is monitored and logged.",
},
});
const financeApp = new onelogin.Policies("finance_app", {
name: "Finance app step-up",
kind: "app",
forceAuthn: true,
appForceAuthnOffset: 60,
});
// An app policy takes effect through the app that uses it.
const finance = new onelogin.Apps("finance", {
name: "Finance",
connectorId: 108419,
policyId: financeApp.policiesId,
});
import pulumi
import pulumi_onelogin as onelogin
engineering = onelogin.Policies("engineering",
name="Engineering",
kind="user",
minimum_password_length=12,
password_expiration_days=90,
passwords_remembered=5,
password_complexity_requirements=3,
maximum_invalid_login_attempts=5,
lock_effective_minutes=15,
otp_auth_enabled=True,
mfa_registration_enabled=True,
authentication_factor_ids=[
12345,
67890,
],
session_timeout_by_inactivity_value=30,
session_timeout_by_inactivity_unit=0,
terms_and_conditions={
"enabled": True,
"content": "Access is monitored and logged.",
})
finance_app = onelogin.Policies("finance_app",
name="Finance app step-up",
kind="app",
force_authn=True,
app_force_authn_offset=60)
# An app policy takes effect through the app that uses it.
finance = onelogin.Apps("finance",
name="Finance",
connector_id=108419,
policy_id=finance_app.policies_id)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/onelogin/onelogin"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := onelogin.NewPolicies(ctx, "engineering", &onelogin.PoliciesArgs{
Name: pulumi.String("Engineering"),
Kind: pulumi.String("user"),
MinimumPasswordLength: pulumi.Float64(12),
PasswordExpirationDays: pulumi.Float64(90),
PasswordsRemembered: pulumi.Float64(5),
PasswordComplexityRequirements: pulumi.Float64(3),
MaximumInvalidLoginAttempts: pulumi.Float64(5),
LockEffectiveMinutes: pulumi.Float64(15),
OtpAuthEnabled: pulumi.Bool(true),
MfaRegistrationEnabled: pulumi.Bool(true),
AuthenticationFactorIds: pulumi.Float64Array{
pulumi.Float64(12345),
pulumi.Float64(67890),
},
SessionTimeoutByInactivityValue: pulumi.Float64(30),
SessionTimeoutByInactivityUnit: pulumi.Float64(0),
TermsAndConditions: &onelogin.PoliciesTermsAndConditionsArgs{
Enabled: pulumi.Bool(true),
Content: pulumi.String("Access is monitored and logged."),
},
})
if err != nil {
return err
}
financeApp, err := onelogin.NewPolicies(ctx, "finance_app", &onelogin.PoliciesArgs{
Name: pulumi.String("Finance app step-up"),
Kind: pulumi.String("app"),
ForceAuthn: pulumi.Bool(true),
AppForceAuthnOffset: pulumi.Float64(60),
})
if err != nil {
return err
}
// An app policy takes effect through the app that uses it.
_, err = onelogin.NewApps(ctx, "finance", &onelogin.AppsArgs{
Name: pulumi.String("Finance"),
ConnectorId: pulumi.Float64(108419),
PolicyId: financeApp.PoliciesId,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Onelogin = Pulumi.Onelogin;
return await Deployment.RunAsync(() =>
{
var engineering = new Onelogin.Policies("engineering", new()
{
Name = "Engineering",
Kind = "user",
MinimumPasswordLength = 12,
PasswordExpirationDays = 90,
PasswordsRemembered = 5,
PasswordComplexityRequirements = 3,
MaximumInvalidLoginAttempts = 5,
LockEffectiveMinutes = 15,
OtpAuthEnabled = true,
MfaRegistrationEnabled = true,
AuthenticationFactorIds = new[]
{
12345,
67890,
},
SessionTimeoutByInactivityValue = 30,
SessionTimeoutByInactivityUnit = 0,
TermsAndConditions = new Onelogin.Inputs.PoliciesTermsAndConditionsArgs
{
Enabled = true,
Content = "Access is monitored and logged.",
},
});
var financeApp = new Onelogin.Policies("finance_app", new()
{
Name = "Finance app step-up",
Kind = "app",
ForceAuthn = true,
AppForceAuthnOffset = 60,
});
// An app policy takes effect through the app that uses it.
var finance = new Onelogin.Apps("finance", new()
{
Name = "Finance",
ConnectorId = 108419,
PolicyId = financeApp.PoliciesId,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.onelogin.Policies;
import com.pulumi.onelogin.PoliciesArgs;
import com.pulumi.onelogin.inputs.PoliciesTermsAndConditionsArgs;
import com.pulumi.onelogin.Apps;
import com.pulumi.onelogin.AppsArgs;
import java.util.List;
import java.util.ArrayList;
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 engineering = new Policies("engineering", PoliciesArgs.builder()
.name("Engineering")
.kind("user")
.minimumPasswordLength(12.0)
.passwordExpirationDays(90.0)
.passwordsRemembered(5.0)
.passwordComplexityRequirements(3.0)
.maximumInvalidLoginAttempts(5.0)
.lockEffectiveMinutes(15.0)
.otpAuthEnabled(true)
.mfaRegistrationEnabled(true)
.authenticationFactorIds(
12345.0,
67890.0)
.sessionTimeoutByInactivityValue(30.0)
.sessionTimeoutByInactivityUnit(0.0)
.termsAndConditions(PoliciesTermsAndConditionsArgs.builder()
.enabled(true)
.content("Access is monitored and logged.")
.build())
.build());
var financeApp = new Policies("financeApp", PoliciesArgs.builder()
.name("Finance app step-up")
.kind("app")
.forceAuthn(true)
.appForceAuthnOffset(60.0)
.build());
// An app policy takes effect through the app that uses it.
var finance = new Apps("finance", AppsArgs.builder()
.name("Finance")
.connectorId(108419.0)
.policyId(financeApp.policiesId())
.build());
}
}
resources:
engineering:
type: onelogin:Policies
properties:
name: Engineering
kind: user
minimumPasswordLength: 12
passwordExpirationDays: 90
passwordsRemembered: 5
passwordComplexityRequirements: 3 # Lockout
maximumInvalidLoginAttempts: 5
lockEffectiveMinutes: 15 # MFA
otpAuthEnabled: true
mfaRegistrationEnabled: true
authenticationFactorIds:
- 12345
- 67890
sessionTimeoutByInactivityValue: 30
sessionTimeoutByInactivityUnit: 0
termsAndConditions:
enabled: true
content: Access is monitored and logged.
financeApp:
type: onelogin:Policies
name: finance_app
properties:
name: Finance app step-up
kind: app
forceAuthn: true
appForceAuthnOffset: 60
# An app policy takes effect through the app that uses it.
finance:
type: onelogin:Apps
properties:
name: Finance
connectorId: 108419
policyId: ${financeApp.policiesId}
Example coming soon!
Applying a policy
Creating a policy does not by itself apply it to anyone.
App policies are applied through the app: set
policy_idononelogin.Apps,onelogin.SamlAppsoronelogin.OidcApps, as above.Unassign with
policy_id = 0. Note that removing the argument does not unassign — it leaves the last value in place, becausepolicy_idis computed as well as optional, which is what stops a configuration that never mentioned a policy from clearing one assigned in the admin UI.User policies are applied by assigning them to a group, using
policy_idononelogin.Groups:import * as pulumi from "@pulumi/pulumi"; import * as onelogin from "@pulumi/onelogin"; const engineering = new onelogin.Policies("engineering", { name: "Engineering", kind: "user", }); const engineeringGroups = new onelogin.Groups("engineering", { name: "Engineering", policyId: engineering.policiesId, });import pulumi import pulumi_onelogin as onelogin engineering = onelogin.Policies("engineering", name="Engineering", kind="user") engineering_groups = onelogin.Groups("engineering", name="Engineering", policy_id=engineering.policies_id)package main import ( "github.com/pulumi/pulumi-terraform-provider/sdks/go/onelogin/onelogin" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { engineering, err := onelogin.NewPolicies(ctx, "engineering", &onelogin.PoliciesArgs{ Name: pulumi.String("Engineering"), Kind: pulumi.String("user"), }) if err != nil { return err } _, err = onelogin.NewGroups(ctx, "engineering", &onelogin.GroupsArgs{ Name: pulumi.String("Engineering"), PolicyId: engineering.PoliciesId, }) if err != nil { return err } return nil }) }using System.Collections.Generic; using System.Linq; using Pulumi; using Onelogin = Pulumi.Onelogin; return await Deployment.RunAsync(() => { var engineering = new Onelogin.Policies("engineering", new() { Name = "Engineering", Kind = "user", }); var engineeringGroups = new Onelogin.Groups("engineering", new() { Name = "Engineering", PolicyId = engineering.PoliciesId, }); });package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.onelogin.Policies; import com.pulumi.onelogin.PoliciesArgs; import com.pulumi.onelogin.Groups; import com.pulumi.onelogin.GroupsArgs; import java.util.List; import java.util.ArrayList; 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 engineering = new Policies("engineering", PoliciesArgs.builder() .name("Engineering") .kind("user") .build()); var engineeringGroups = new Groups("engineeringGroups", GroupsArgs.builder() .name("Engineering") .policyId(engineering.policiesId()) .build()); } }resources: engineering: type: onelogin:Policies properties: name: Engineering kind: user engineeringGroups: type: onelogin:Groups name: engineering properties: name: Engineering policyId: ${engineering.policiesId}Example coming soon!Making a policy the account default is not manageable here; that is still set in the OneLogin admin UI.
Create Policies Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Policies(name: string, args: PoliciesArgs, opts?: CustomResourceOptions);@overload def Policies(resource_name: str, args: PoliciesArgs, opts: Optional[ResourceOptions] = None) @overload def Policies(resource_name: str, opts: Optional[ResourceOptions] = None, kind: Optional[str] = None, admin_policy_id: Optional[float] = None, allow_add_company_app: Optional[bool] = None, allow_add_personal_app: Optional[bool] = None, app_force_authn_offset: Optional[float] = None, app_otp_offset: Optional[float] = None, app_otp_offset_enabled: Optional[bool] = None, authentication_factor_ids: Optional[Sequence[float]] = None, browser_cert_required: Optional[bool] = None, browser_pki_expiration: Optional[float] = None, disable_browser_password_manager: Optional[bool] = None, disable_protect_push_notifications: Optional[bool] = None, disable_protect_push_recovery: Optional[bool] = None, dynamic_blacklist_attributes: Optional[str] = None, enable_browser_extensions: Optional[bool] = None, enable_email_hint: Optional[bool] = None, enable_email_password_reset: Optional[bool] = None, enable_number_match: Optional[bool] = None, enable_password_change: Optional[bool] = None, enable_question_password_reset: Optional[bool] = None, enable_smart_access: Optional[bool] = None, enable_sms_password_reset: Optional[bool] = None, enable_system_use_notification: Optional[bool] = None, enable_unlock_via_password_reset: Optional[bool] = None, enforce_account_password_blacklist: Optional[bool] = None, enforce_compromised_credentials_check: Optional[bool] = None, euba_enabled: Optional[bool] = None, euba_risk_threshold: Optional[float] = None, facebook: Optional[bool] = None, force_authn: Optional[bool] = None, gdt_required: Optional[bool] = None, google: Optional[bool] = None, ignore_xff: Optional[bool] = None, invite_expiration_time_unit: Optional[float] = None, invite_expiration_time_value: Optional[float] = None, ip_addr_restriction: Optional[str] = None, linkedin: Optional[bool] = None, lock_effective_minutes: Optional[float] = None, maximum_invalid_login_attempts: Optional[float] = None, mfa_registration_enabled: Optional[bool] = None, minimum_password_length: Optional[float] = None, name: Optional[str] = None, new_portal_setting: Optional[str] = None, otp_auth_enabled: Optional[bool] = None, otp_config: Optional[float] = None, otp_security_token_expiration_days: Optional[float] = None, otp_trigger_condition: Optional[float] = None, password_complexity_requirements: Optional[float] = None, password_expiration_days: Optional[float] = None, password_redirect_enabled: Optional[bool] = None, password_redirect_message: Optional[str] = None, password_redirect_url: Optional[str] = None, passwords_remembered: Optional[float] = None, persistent_session_enabled: Optional[bool] = None, policies_id: Optional[str] = None, preferred_auth_state_machine: Optional[float] = None, profile_policy_id: Optional[float] = None, require_security_questions: Optional[bool] = None, reset_password_authentication_factor_ids: Optional[Sequence[float]] = None, secure_admin: Optional[bool] = None, secure_area_otp_timeout_minutes: Optional[float] = None, secure_profile: Optional[bool] = None, self_install_cert: Optional[bool] = None, session_timeout_by_fixed_time_unit: Optional[float] = None, session_timeout_by_fixed_time_value: Optional[float] = None, session_timeout_by_inactivity_unit: Optional[float] = None, session_timeout_by_inactivity_value: Optional[float] = None, session_timeout_minutes: Optional[float] = None, session_timeout_type: Optional[float] = None, smart_access_risk_threshold: Optional[float] = None, social_sign_in: Optional[bool] = None, system_use_notification: Optional[str] = None, terms_and_conditions: Optional[PoliciesTermsAndConditionsArgs] = None, third_party_device_trust: Optional[bool] = None, track_inactive_users: Optional[bool] = None, trusted_device_login_enabled: Optional[bool] = None, trusted_device_login_mfa_allowed: Optional[bool] = None, twitter: Optional[bool] = None, user_phone_update_allowed: Optional[bool] = None, voluntary_mfa_registration_enabled: Optional[bool] = None)func NewPolicies(ctx *Context, name string, args PoliciesArgs, opts ...ResourceOption) (*Policies, error)public Policies(string name, PoliciesArgs args, CustomResourceOptions? opts = null)public Policies(String name, PoliciesArgs args) public Policies(String name, PoliciesArgs args, CustomResourceOptions options)type: onelogin:Policies properties: # The arguments to resource properties. options: # Bag of options to control resource's behavior.resource "onelogin_policies" "name" { # resource properties }Parameters
- name string
- The unique name of the resource.
- args PoliciesArgs
- 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 PoliciesArgs
- 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 PoliciesArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PoliciesArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PoliciesArgs
- 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 policiesResource = new Onelogin.Policies("policiesResource", new() { Kind = "string", AdminPolicyId = 0.0, AllowAddCompanyApp = false, AllowAddPersonalApp = false, AppForceAuthnOffset = 0.0, AppOtpOffset = 0.0, AppOtpOffsetEnabled = false, AuthenticationFactorIds = new[] { 0.0, }, BrowserCertRequired = false, BrowserPkiExpiration = 0.0, DisableBrowserPasswordManager = false, DisableProtectPushNotifications = false, DisableProtectPushRecovery = false, DynamicBlacklistAttributes = "string", EnableBrowserExtensions = false, EnableEmailHint = false, EnableEmailPasswordReset = false, EnableNumberMatch = false, EnablePasswordChange = false, EnableQuestionPasswordReset = false, EnableSmartAccess = false, EnableSmsPasswordReset = false, EnableSystemUseNotification = false, EnableUnlockViaPasswordReset = false, EnforceAccountPasswordBlacklist = false, EnforceCompromisedCredentialsCheck = false, EubaEnabled = false, EubaRiskThreshold = 0.0, Facebook = false, ForceAuthn = false, GdtRequired = false, Google = false, IgnoreXff = false, InviteExpirationTimeUnit = 0.0, InviteExpirationTimeValue = 0.0, IpAddrRestriction = "string", Linkedin = false, LockEffectiveMinutes = 0.0, MaximumInvalidLoginAttempts = 0.0, MfaRegistrationEnabled = false, MinimumPasswordLength = 0.0, Name = "string", NewPortalSetting = "string", OtpAuthEnabled = false, OtpConfig = 0.0, OtpSecurityTokenExpirationDays = 0.0, OtpTriggerCondition = 0.0, PasswordComplexityRequirements = 0.0, PasswordExpirationDays = 0.0, PasswordRedirectEnabled = false, PasswordRedirectMessage = "string", PasswordRedirectUrl = "string", PasswordsRemembered = 0.0, PersistentSessionEnabled = false, PoliciesId = "string", PreferredAuthStateMachine = 0.0, ProfilePolicyId = 0.0, RequireSecurityQuestions = false, ResetPasswordAuthenticationFactorIds = new[] { 0.0, }, SecureAdmin = false, SecureAreaOtpTimeoutMinutes = 0.0, SecureProfile = false, SelfInstallCert = false, SessionTimeoutByFixedTimeUnit = 0.0, SessionTimeoutByFixedTimeValue = 0.0, SessionTimeoutByInactivityUnit = 0.0, SessionTimeoutByInactivityValue = 0.0, SessionTimeoutMinutes = 0.0, SessionTimeoutType = 0.0, SmartAccessRiskThreshold = 0.0, SocialSignIn = false, SystemUseNotification = "string", TermsAndConditions = new Onelogin.Inputs.PoliciesTermsAndConditionsArgs { Content = "string", Enabled = false, }, ThirdPartyDeviceTrust = false, TrackInactiveUsers = false, TrustedDeviceLoginEnabled = false, TrustedDeviceLoginMfaAllowed = false, Twitter = false, UserPhoneUpdateAllowed = false, VoluntaryMfaRegistrationEnabled = false, });example, err := onelogin.NewPolicies(ctx, "policiesResource", &onelogin.PoliciesArgs{ Kind: pulumi.String("string"), AdminPolicyId: pulumi.Float64(0), AllowAddCompanyApp: pulumi.Bool(false), AllowAddPersonalApp: pulumi.Bool(false), AppForceAuthnOffset: pulumi.Float64(0), AppOtpOffset: pulumi.Float64(0), AppOtpOffsetEnabled: pulumi.Bool(false), AuthenticationFactorIds: pulumi.Float64Array{ pulumi.Float64(0), }, BrowserCertRequired: pulumi.Bool(false), BrowserPkiExpiration: pulumi.Float64(0), DisableBrowserPasswordManager: pulumi.Bool(false), DisableProtectPushNotifications: pulumi.Bool(false), DisableProtectPushRecovery: pulumi.Bool(false), DynamicBlacklistAttributes: pulumi.String("string"), EnableBrowserExtensions: pulumi.Bool(false), EnableEmailHint: pulumi.Bool(false), EnableEmailPasswordReset: pulumi.Bool(false), EnableNumberMatch: pulumi.Bool(false), EnablePasswordChange: pulumi.Bool(false), EnableQuestionPasswordReset: pulumi.Bool(false), EnableSmartAccess: pulumi.Bool(false), EnableSmsPasswordReset: pulumi.Bool(false), EnableSystemUseNotification: pulumi.Bool(false), EnableUnlockViaPasswordReset: pulumi.Bool(false), EnforceAccountPasswordBlacklist: pulumi.Bool(false), EnforceCompromisedCredentialsCheck: pulumi.Bool(false), EubaEnabled: pulumi.Bool(false), EubaRiskThreshold: pulumi.Float64(0), Facebook: pulumi.Bool(false), ForceAuthn: pulumi.Bool(false), GdtRequired: pulumi.Bool(false), Google: pulumi.Bool(false), IgnoreXff: pulumi.Bool(false), InviteExpirationTimeUnit: pulumi.Float64(0), InviteExpirationTimeValue: pulumi.Float64(0), IpAddrRestriction: pulumi.String("string"), Linkedin: pulumi.Bool(false), LockEffectiveMinutes: pulumi.Float64(0), MaximumInvalidLoginAttempts: pulumi.Float64(0), MfaRegistrationEnabled: pulumi.Bool(false), MinimumPasswordLength: pulumi.Float64(0), Name: pulumi.String("string"), NewPortalSetting: pulumi.String("string"), OtpAuthEnabled: pulumi.Bool(false), OtpConfig: pulumi.Float64(0), OtpSecurityTokenExpirationDays: pulumi.Float64(0), OtpTriggerCondition: pulumi.Float64(0), PasswordComplexityRequirements: pulumi.Float64(0), PasswordExpirationDays: pulumi.Float64(0), PasswordRedirectEnabled: pulumi.Bool(false), PasswordRedirectMessage: pulumi.String("string"), PasswordRedirectUrl: pulumi.String("string"), PasswordsRemembered: pulumi.Float64(0), PersistentSessionEnabled: pulumi.Bool(false), PoliciesId: pulumi.String("string"), PreferredAuthStateMachine: pulumi.Float64(0), ProfilePolicyId: pulumi.Float64(0), RequireSecurityQuestions: pulumi.Bool(false), ResetPasswordAuthenticationFactorIds: pulumi.Float64Array{ pulumi.Float64(0), }, SecureAdmin: pulumi.Bool(false), SecureAreaOtpTimeoutMinutes: pulumi.Float64(0), SecureProfile: pulumi.Bool(false), SelfInstallCert: pulumi.Bool(false), SessionTimeoutByFixedTimeUnit: pulumi.Float64(0), SessionTimeoutByFixedTimeValue: pulumi.Float64(0), SessionTimeoutByInactivityUnit: pulumi.Float64(0), SessionTimeoutByInactivityValue: pulumi.Float64(0), SessionTimeoutMinutes: pulumi.Float64(0), SessionTimeoutType: pulumi.Float64(0), SmartAccessRiskThreshold: pulumi.Float64(0), SocialSignIn: pulumi.Bool(false), SystemUseNotification: pulumi.String("string"), TermsAndConditions: &onelogin.PoliciesTermsAndConditionsArgs{ Content: pulumi.String("string"), Enabled: pulumi.Bool(false), }, ThirdPartyDeviceTrust: pulumi.Bool(false), TrackInactiveUsers: pulumi.Bool(false), TrustedDeviceLoginEnabled: pulumi.Bool(false), TrustedDeviceLoginMfaAllowed: pulumi.Bool(false), Twitter: pulumi.Bool(false), UserPhoneUpdateAllowed: pulumi.Bool(false), VoluntaryMfaRegistrationEnabled: pulumi.Bool(false), })resource "onelogin_policies" "policiesResource" { lifecycle { create_before_destroy = true } kind = "string" admin_policy_id = 0 allow_add_company_app = false allow_add_personal_app = false app_force_authn_offset = 0 app_otp_offset = 0 app_otp_offset_enabled = false authentication_factor_ids = [0] browser_cert_required = false browser_pki_expiration = 0 disable_browser_password_manager = false disable_protect_push_notifications = false disable_protect_push_recovery = false dynamic_blacklist_attributes = "string" enable_browser_extensions = false enable_email_hint = false enable_email_password_reset = false enable_number_match = false enable_password_change = false enable_question_password_reset = false enable_smart_access = false enable_sms_password_reset = false enable_system_use_notification = false enable_unlock_via_password_reset = false enforce_account_password_blacklist = false enforce_compromised_credentials_check = false euba_enabled = false euba_risk_threshold = 0 facebook = false force_authn = false gdt_required = false google = false ignore_xff = false invite_expiration_time_unit = 0 invite_expiration_time_value = 0 ip_addr_restriction = "string" linkedin = false lock_effective_minutes = 0 maximum_invalid_login_attempts = 0 mfa_registration_enabled = false minimum_password_length = 0 name = "string" new_portal_setting = "string" otp_auth_enabled = false otp_config = 0 otp_security_token_expiration_days = 0 otp_trigger_condition = 0 password_complexity_requirements = 0 password_expiration_days = 0 password_redirect_enabled = false password_redirect_message = "string" password_redirect_url = "string" passwords_remembered = 0 persistent_session_enabled = false policies_id = "string" preferred_auth_state_machine = 0 profile_policy_id = 0 require_security_questions = false reset_password_authentication_factor_ids = [0] secure_admin = false secure_area_otp_timeout_minutes = 0 secure_profile = false self_install_cert = false session_timeout_by_fixed_time_unit = 0 session_timeout_by_fixed_time_value = 0 session_timeout_by_inactivity_unit = 0 session_timeout_by_inactivity_value = 0 session_timeout_minutes = 0 session_timeout_type = 0 smart_access_risk_threshold = 0 social_sign_in = false system_use_notification = "string" terms_and_conditions = { content = "string" enabled = false } third_party_device_trust = false track_inactive_users = false trusted_device_login_enabled = false trusted_device_login_mfa_allowed = false twitter = false user_phone_update_allowed = false voluntary_mfa_registration_enabled = false }var policiesResource = new Policies("policiesResource", PoliciesArgs.builder() .kind("string") .adminPolicyId(0.0) .allowAddCompanyApp(false) .allowAddPersonalApp(false) .appForceAuthnOffset(0.0) .appOtpOffset(0.0) .appOtpOffsetEnabled(false) .authenticationFactorIds(0.0) .browserCertRequired(false) .browserPkiExpiration(0.0) .disableBrowserPasswordManager(false) .disableProtectPushNotifications(false) .disableProtectPushRecovery(false) .dynamicBlacklistAttributes("string") .enableBrowserExtensions(false) .enableEmailHint(false) .enableEmailPasswordReset(false) .enableNumberMatch(false) .enablePasswordChange(false) .enableQuestionPasswordReset(false) .enableSmartAccess(false) .enableSmsPasswordReset(false) .enableSystemUseNotification(false) .enableUnlockViaPasswordReset(false) .enforceAccountPasswordBlacklist(false) .enforceCompromisedCredentialsCheck(false) .eubaEnabled(false) .eubaRiskThreshold(0.0) .facebook(false) .forceAuthn(false) .gdtRequired(false) .google(false) .ignoreXff(false) .inviteExpirationTimeUnit(0.0) .inviteExpirationTimeValue(0.0) .ipAddrRestriction("string") .linkedin(false) .lockEffectiveMinutes(0.0) .maximumInvalidLoginAttempts(0.0) .mfaRegistrationEnabled(false) .minimumPasswordLength(0.0) .name("string") .newPortalSetting("string") .otpAuthEnabled(false) .otpConfig(0.0) .otpSecurityTokenExpirationDays(0.0) .otpTriggerCondition(0.0) .passwordComplexityRequirements(0.0) .passwordExpirationDays(0.0) .passwordRedirectEnabled(false) .passwordRedirectMessage("string") .passwordRedirectUrl("string") .passwordsRemembered(0.0) .persistentSessionEnabled(false) .policiesId("string") .preferredAuthStateMachine(0.0) .profilePolicyId(0.0) .requireSecurityQuestions(false) .resetPasswordAuthenticationFactorIds(0.0) .secureAdmin(false) .secureAreaOtpTimeoutMinutes(0.0) .secureProfile(false) .selfInstallCert(false) .sessionTimeoutByFixedTimeUnit(0.0) .sessionTimeoutByFixedTimeValue(0.0) .sessionTimeoutByInactivityUnit(0.0) .sessionTimeoutByInactivityValue(0.0) .sessionTimeoutMinutes(0.0) .sessionTimeoutType(0.0) .smartAccessRiskThreshold(0.0) .socialSignIn(false) .systemUseNotification("string") .termsAndConditions(PoliciesTermsAndConditionsArgs.builder() .content("string") .enabled(false) .build()) .thirdPartyDeviceTrust(false) .trackInactiveUsers(false) .trustedDeviceLoginEnabled(false) .trustedDeviceLoginMfaAllowed(false) .twitter(false) .userPhoneUpdateAllowed(false) .voluntaryMfaRegistrationEnabled(false) .build());policies_resource = onelogin.Policies("policiesResource", kind="string", admin_policy_id=float(0), allow_add_company_app=False, allow_add_personal_app=False, app_force_authn_offset=float(0), app_otp_offset=float(0), app_otp_offset_enabled=False, authentication_factor_ids=[float(0)], browser_cert_required=False, browser_pki_expiration=float(0), disable_browser_password_manager=False, disable_protect_push_notifications=False, disable_protect_push_recovery=False, dynamic_blacklist_attributes="string", enable_browser_extensions=False, enable_email_hint=False, enable_email_password_reset=False, enable_number_match=False, enable_password_change=False, enable_question_password_reset=False, enable_smart_access=False, enable_sms_password_reset=False, enable_system_use_notification=False, enable_unlock_via_password_reset=False, enforce_account_password_blacklist=False, enforce_compromised_credentials_check=False, euba_enabled=False, euba_risk_threshold=float(0), facebook=False, force_authn=False, gdt_required=False, google=False, ignore_xff=False, invite_expiration_time_unit=float(0), invite_expiration_time_value=float(0), ip_addr_restriction="string", linkedin=False, lock_effective_minutes=float(0), maximum_invalid_login_attempts=float(0), mfa_registration_enabled=False, minimum_password_length=float(0), name="string", new_portal_setting="string", otp_auth_enabled=False, otp_config=float(0), otp_security_token_expiration_days=float(0), otp_trigger_condition=float(0), password_complexity_requirements=float(0), password_expiration_days=float(0), password_redirect_enabled=False, password_redirect_message="string", password_redirect_url="string", passwords_remembered=float(0), persistent_session_enabled=False, policies_id="string", preferred_auth_state_machine=float(0), profile_policy_id=float(0), require_security_questions=False, reset_password_authentication_factor_ids=[float(0)], secure_admin=False, secure_area_otp_timeout_minutes=float(0), secure_profile=False, self_install_cert=False, session_timeout_by_fixed_time_unit=float(0), session_timeout_by_fixed_time_value=float(0), session_timeout_by_inactivity_unit=float(0), session_timeout_by_inactivity_value=float(0), session_timeout_minutes=float(0), session_timeout_type=float(0), smart_access_risk_threshold=float(0), social_sign_in=False, system_use_notification="string", terms_and_conditions={ "content": "string", "enabled": False, }, third_party_device_trust=False, track_inactive_users=False, trusted_device_login_enabled=False, trusted_device_login_mfa_allowed=False, twitter=False, user_phone_update_allowed=False, voluntary_mfa_registration_enabled=False)const policiesResource = new onelogin.Policies("policiesResource", { kind: "string", adminPolicyId: 0, allowAddCompanyApp: false, allowAddPersonalApp: false, appForceAuthnOffset: 0, appOtpOffset: 0, appOtpOffsetEnabled: false, authenticationFactorIds: [0], browserCertRequired: false, browserPkiExpiration: 0, disableBrowserPasswordManager: false, disableProtectPushNotifications: false, disableProtectPushRecovery: false, dynamicBlacklistAttributes: "string", enableBrowserExtensions: false, enableEmailHint: false, enableEmailPasswordReset: false, enableNumberMatch: false, enablePasswordChange: false, enableQuestionPasswordReset: false, enableSmartAccess: false, enableSmsPasswordReset: false, enableSystemUseNotification: false, enableUnlockViaPasswordReset: false, enforceAccountPasswordBlacklist: false, enforceCompromisedCredentialsCheck: false, eubaEnabled: false, eubaRiskThreshold: 0, facebook: false, forceAuthn: false, gdtRequired: false, google: false, ignoreXff: false, inviteExpirationTimeUnit: 0, inviteExpirationTimeValue: 0, ipAddrRestriction: "string", linkedin: false, lockEffectiveMinutes: 0, maximumInvalidLoginAttempts: 0, mfaRegistrationEnabled: false, minimumPasswordLength: 0, name: "string", newPortalSetting: "string", otpAuthEnabled: false, otpConfig: 0, otpSecurityTokenExpirationDays: 0, otpTriggerCondition: 0, passwordComplexityRequirements: 0, passwordExpirationDays: 0, passwordRedirectEnabled: false, passwordRedirectMessage: "string", passwordRedirectUrl: "string", passwordsRemembered: 0, persistentSessionEnabled: false, policiesId: "string", preferredAuthStateMachine: 0, profilePolicyId: 0, requireSecurityQuestions: false, resetPasswordAuthenticationFactorIds: [0], secureAdmin: false, secureAreaOtpTimeoutMinutes: 0, secureProfile: false, selfInstallCert: false, sessionTimeoutByFixedTimeUnit: 0, sessionTimeoutByFixedTimeValue: 0, sessionTimeoutByInactivityUnit: 0, sessionTimeoutByInactivityValue: 0, sessionTimeoutMinutes: 0, sessionTimeoutType: 0, smartAccessRiskThreshold: 0, socialSignIn: false, systemUseNotification: "string", termsAndConditions: { content: "string", enabled: false, }, thirdPartyDeviceTrust: false, trackInactiveUsers: false, trustedDeviceLoginEnabled: false, trustedDeviceLoginMfaAllowed: false, twitter: false, userPhoneUpdateAllowed: false, voluntaryMfaRegistrationEnabled: false, });type: onelogin:Policies properties: adminPolicyId: 0 allowAddCompanyApp: false allowAddPersonalApp: false appForceAuthnOffset: 0 appOtpOffset: 0 appOtpOffsetEnabled: false authenticationFactorIds: - 0 browserCertRequired: false browserPkiExpiration: 0 disableBrowserPasswordManager: false disableProtectPushNotifications: false disableProtectPushRecovery: false dynamicBlacklistAttributes: string enableBrowserExtensions: false enableEmailHint: false enableEmailPasswordReset: false enableNumberMatch: false enablePasswordChange: false enableQuestionPasswordReset: false enableSmartAccess: false enableSmsPasswordReset: false enableSystemUseNotification: false enableUnlockViaPasswordReset: false enforceAccountPasswordBlacklist: false enforceCompromisedCredentialsCheck: false eubaEnabled: false eubaRiskThreshold: 0 facebook: false forceAuthn: false gdtRequired: false google: false ignoreXff: false inviteExpirationTimeUnit: 0 inviteExpirationTimeValue: 0 ipAddrRestriction: string kind: string linkedin: false lockEffectiveMinutes: 0 maximumInvalidLoginAttempts: 0 mfaRegistrationEnabled: false minimumPasswordLength: 0 name: string newPortalSetting: string otpAuthEnabled: false otpConfig: 0 otpSecurityTokenExpirationDays: 0 otpTriggerCondition: 0 passwordComplexityRequirements: 0 passwordExpirationDays: 0 passwordRedirectEnabled: false passwordRedirectMessage: string passwordRedirectUrl: string passwordsRemembered: 0 persistentSessionEnabled: false policiesId: string preferredAuthStateMachine: 0 profilePolicyId: 0 requireSecurityQuestions: false resetPasswordAuthenticationFactorIds: - 0 secureAdmin: false secureAreaOtpTimeoutMinutes: 0 secureProfile: false selfInstallCert: false sessionTimeoutByFixedTimeUnit: 0 sessionTimeoutByFixedTimeValue: 0 sessionTimeoutByInactivityUnit: 0 sessionTimeoutByInactivityValue: 0 sessionTimeoutMinutes: 0 sessionTimeoutType: 0 smartAccessRiskThreshold: 0 socialSignIn: false systemUseNotification: string termsAndConditions: content: string enabled: false thirdPartyDeviceTrust: false trackInactiveUsers: false trustedDeviceLoginEnabled: false trustedDeviceLoginMfaAllowed: false twitter: false userPhoneUpdateAllowed: false voluntaryMfaRegistrationEnabled: falsePolicies 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 Policies resource accepts the following input properties:
- Kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - Admin
Policy doubleId - App policy that governs step-up authentication for the admin area.
- Allow
Add boolCompany App - Let users add company apps to their portal.
- Allow
Add boolPersonal App - Let users add personal apps to their portal.
- App
Force doubleAuthn Offset - Minutes before force_authn applies again.
- App
Otp doubleOffset - Minutes an app MFA prompt is remembered.
- App
Otp boolOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- Authentication
Factor List<double>Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - Browser
Cert boolRequired - Require a browser certificate.
- Browser
Pki doubleExpiration - Days a browser certificate stays valid.
- Disable
Browser boolPassword Manager - Stop the browser offering to save passwords.
- Disable
Protect boolPush Notifications - Turn off OneLogin Protect push notifications.
- Disable
Protect boolPush Recovery - Turn off OneLogin Protect push recovery.
- Dynamic
Blacklist stringAttributes - User attributes whose values may not appear in a password.
- Enable
Browser boolExtensions - Allow the OneLogin browser extension.
- Enable
Email boolHint - Prefill the email field on the login page.
- Enable
Email boolPassword Reset - Offer password reset by email.
- Enable
Number boolMatch - Require number matching on push notifications.
- Enable
Password boolChange - Let users change their own password.
- Enable
Question boolPassword Reset - Offer password reset by security question.
- Enable
Smart boolAccess - Enable SmartAccess risk scoring.
- Enable
Sms boolPassword Reset - Offer password reset by SMS.
- Enable
System boolUse Notification - Show a system use notification before login.
- Enable
Unlock boolVia Password Reset - Unlock a locked account when the user resets their password.
- Enforce
Account boolPassword Blacklist - Reject passwords on the account's blacklist.
- Enforce
Compromised boolCredentials Check - Check credentials against known breaches.
- Euba
Enabled bool - Enable end-user behaviour analytics.
- Euba
Risk doubleThreshold - Risk score above which EUBA acts.
- Facebook bool
- Allow sign-in with Facebook.
- Force
Authn bool - Force re-authentication when the app is opened.
- Gdt
Required bool - Require OneLogin Desktop for this app.
- Google bool
- Allow sign-in with Google.
- Ignore
Xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- Invite
Expiration doubleTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- Invite
Expiration doubleTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- Ip
Addr stringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- Linkedin bool
- Allow sign-in with LinkedIn.
- Lock
Effective doubleMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- Maximum
Invalid doubleLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- Mfa
Registration boolEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- Minimum
Password doubleLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- Name string
- Name of the policy.
- New
Portal stringSetting - Access to the new portal: required, allowed or forbidden.
- Otp
Auth boolEnabled - Require multi-factor authentication.
- Otp
Config double - Which factors MFA accepts.
- Otp
Security doubleToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- Otp
Trigger doubleCondition - When MFA is triggered.
- Password
Complexity doubleRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- Password
Expiration doubleDays - Days before a password expires. 0 never expires.
- Password
Redirect boolEnabled - Send password changes to an external URL instead.
- Password
Redirect stringMessage - Message shown alongside the password redirect.
- Password
Redirect stringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- Passwords
Remembered double - How many previous passwords cannot be reused. 0, 3 or 5.
- Persistent
Session boolEnabled - Let sessions survive a browser restart.
- Policies
Id string - The policy ID.
- Preferred
Auth doubleState Machine - Login flow the policy prefers.
- Profile
Policy doubleId - App policy that governs step-up authentication for the profile area.
- Require
Security boolQuestions - Require users to set security questions.
- Reset
Password List<double>Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- Secure
Admin bool - Require step-up authentication to reach the admin area.
- Secure
Area doubleOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- Secure
Profile bool - Require step-up authentication to reach the user profile area.
- Self
Install boolCert - Let users install their own browser certificate.
- Session
Timeout doubleBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- Session
Timeout doubleBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- Session
Timeout doubleBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- Session
Timeout doubleBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- Session
Timeout doubleMinutes - Session length in minutes, in the older single-value format.
- Session
Timeout doubleType - Which session timeout applies: by inactivity or at a fixed time.
- Smart
Access doubleRisk Threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- System
Use stringNotification - Text of the system use notification.
- Terms
And PoliciesConditions Terms And Conditions - Terms users must accept before signing in. Applies to user policies only.
- Third
Party boolDevice Trust - Require a third-party device trust check.
- Track
Inactive boolUsers - Track users who have not logged in recently.
- Trusted
Device boolLogin Enabled - Allow login from trusted devices.
- Trusted
Device boolLogin Mfa Allowed - Allow MFA on trusted device login.
- Twitter bool
- Allow sign-in with Twitter.
- User
Phone boolUpdate Allowed - Let users change their registered phone number.
- Voluntary
Mfa boolRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- Kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - Admin
Policy float64Id - App policy that governs step-up authentication for the admin area.
- Allow
Add boolCompany App - Let users add company apps to their portal.
- Allow
Add boolPersonal App - Let users add personal apps to their portal.
- App
Force float64Authn Offset - Minutes before force_authn applies again.
- App
Otp float64Offset - Minutes an app MFA prompt is remembered.
- App
Otp boolOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- Authentication
Factor []float64Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - Browser
Cert boolRequired - Require a browser certificate.
- Browser
Pki float64Expiration - Days a browser certificate stays valid.
- Disable
Browser boolPassword Manager - Stop the browser offering to save passwords.
- Disable
Protect boolPush Notifications - Turn off OneLogin Protect push notifications.
- Disable
Protect boolPush Recovery - Turn off OneLogin Protect push recovery.
- Dynamic
Blacklist stringAttributes - User attributes whose values may not appear in a password.
- Enable
Browser boolExtensions - Allow the OneLogin browser extension.
- Enable
Email boolHint - Prefill the email field on the login page.
- Enable
Email boolPassword Reset - Offer password reset by email.
- Enable
Number boolMatch - Require number matching on push notifications.
- Enable
Password boolChange - Let users change their own password.
- Enable
Question boolPassword Reset - Offer password reset by security question.
- Enable
Smart boolAccess - Enable SmartAccess risk scoring.
- Enable
Sms boolPassword Reset - Offer password reset by SMS.
- Enable
System boolUse Notification - Show a system use notification before login.
- Enable
Unlock boolVia Password Reset - Unlock a locked account when the user resets their password.
- Enforce
Account boolPassword Blacklist - Reject passwords on the account's blacklist.
- Enforce
Compromised boolCredentials Check - Check credentials against known breaches.
- Euba
Enabled bool - Enable end-user behaviour analytics.
- Euba
Risk float64Threshold - Risk score above which EUBA acts.
- Facebook bool
- Allow sign-in with Facebook.
- Force
Authn bool - Force re-authentication when the app is opened.
- Gdt
Required bool - Require OneLogin Desktop for this app.
- Google bool
- Allow sign-in with Google.
- Ignore
Xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- Invite
Expiration float64Time Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- Invite
Expiration float64Time Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- Ip
Addr stringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- Linkedin bool
- Allow sign-in with LinkedIn.
- Lock
Effective float64Minutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- Maximum
Invalid float64Login Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- Mfa
Registration boolEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- Minimum
Password float64Length - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- Name string
- Name of the policy.
- New
Portal stringSetting - Access to the new portal: required, allowed or forbidden.
- Otp
Auth boolEnabled - Require multi-factor authentication.
- Otp
Config float64 - Which factors MFA accepts.
- Otp
Security float64Token Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- Otp
Trigger float64Condition - When MFA is triggered.
- Password
Complexity float64Requirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- Password
Expiration float64Days - Days before a password expires. 0 never expires.
- Password
Redirect boolEnabled - Send password changes to an external URL instead.
- Password
Redirect stringMessage - Message shown alongside the password redirect.
- Password
Redirect stringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- Passwords
Remembered float64 - How many previous passwords cannot be reused. 0, 3 or 5.
- Persistent
Session boolEnabled - Let sessions survive a browser restart.
- Policies
Id string - The policy ID.
- Preferred
Auth float64State Machine - Login flow the policy prefers.
- Profile
Policy float64Id - App policy that governs step-up authentication for the profile area.
- Require
Security boolQuestions - Require users to set security questions.
- Reset
Password []float64Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- Secure
Admin bool - Require step-up authentication to reach the admin area.
- Secure
Area float64Otp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- Secure
Profile bool - Require step-up authentication to reach the user profile area.
- Self
Install boolCert - Let users install their own browser certificate.
- Session
Timeout float64By Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- Session
Timeout float64By Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- Session
Timeout float64By Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- Session
Timeout float64By Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- Session
Timeout float64Minutes - Session length in minutes, in the older single-value format.
- Session
Timeout float64Type - Which session timeout applies: by inactivity or at a fixed time.
- Smart
Access float64Risk Threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- System
Use stringNotification - Text of the system use notification.
- Terms
And PoliciesConditions Terms And Conditions Args - Terms users must accept before signing in. Applies to user policies only.
- Third
Party boolDevice Trust - Require a third-party device trust check.
- Track
Inactive boolUsers - Track users who have not logged in recently.
- Trusted
Device boolLogin Enabled - Allow login from trusted devices.
- Trusted
Device boolLogin Mfa Allowed - Allow MFA on trusted device login.
- Twitter bool
- Allow sign-in with Twitter.
- User
Phone boolUpdate Allowed - Let users change their registered phone number.
- Voluntary
Mfa boolRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - admin_
policy_ numberid - App policy that governs step-up authentication for the admin area.
- allow_
add_ boolcompany_ app - Let users add company apps to their portal.
- allow_
add_ boolpersonal_ app - Let users add personal apps to their portal.
- app_
force_ numberauthn_ offset - Minutes before force_authn applies again.
- app_
otp_ numberoffset - Minutes an app MFA prompt is remembered.
- app_
otp_ booloffset_ enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication_
factor_ list(number)ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser_
cert_ boolrequired - Require a browser certificate.
- browser_
pki_ numberexpiration - Days a browser certificate stays valid.
- disable_
browser_ boolpassword_ manager - Stop the browser offering to save passwords.
- disable_
protect_ boolpush_ notifications - Turn off OneLogin Protect push notifications.
- disable_
protect_ boolpush_ recovery - Turn off OneLogin Protect push recovery.
- dynamic_
blacklist_ stringattributes - User attributes whose values may not appear in a password.
- enable_
browser_ boolextensions - Allow the OneLogin browser extension.
- enable_
email_ boolhint - Prefill the email field on the login page.
- enable_
email_ boolpassword_ reset - Offer password reset by email.
- enable_
number_ boolmatch - Require number matching on push notifications.
- enable_
password_ boolchange - Let users change their own password.
- enable_
question_ boolpassword_ reset - Offer password reset by security question.
- enable_
smart_ boolaccess - Enable SmartAccess risk scoring.
- enable_
sms_ boolpassword_ reset - Offer password reset by SMS.
- enable_
system_ booluse_ notification - Show a system use notification before login.
- enable_
unlock_ boolvia_ password_ reset - Unlock a locked account when the user resets their password.
- enforce_
account_ boolpassword_ blacklist - Reject passwords on the account's blacklist.
- enforce_
compromised_ boolcredentials_ check - Check credentials against known breaches.
- euba_
enabled bool - Enable end-user behaviour analytics.
- euba_
risk_ numberthreshold - Risk score above which EUBA acts.
- facebook bool
- Allow sign-in with Facebook.
- force_
authn bool - Force re-authentication when the app is opened.
- gdt_
required bool - Require OneLogin Desktop for this app.
- google bool
- Allow sign-in with Google.
- ignore_
xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite_
expiration_ numbertime_ unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite_
expiration_ numbertime_ value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip_
addr_ stringrestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- linkedin bool
- Allow sign-in with LinkedIn.
- lock_
effective_ numberminutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum_
invalid_ numberlogin_ attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa_
registration_ boolenabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum_
password_ numberlength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name string
- Name of the policy.
- new_
portal_ stringsetting - Access to the new portal: required, allowed or forbidden.
- otp_
auth_ boolenabled - Require multi-factor authentication.
- otp_
config number - Which factors MFA accepts.
- otp_
security_ numbertoken_ expiration_ days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp_
trigger_ numbercondition - When MFA is triggered.
- password_
complexity_ numberrequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password_
expiration_ numberdays - Days before a password expires. 0 never expires.
- password_
redirect_ boolenabled - Send password changes to an external URL instead.
- password_
redirect_ stringmessage - Message shown alongside the password redirect.
- password_
redirect_ stringurl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords_
remembered number - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent_
session_ boolenabled - Let sessions survive a browser restart.
- policies_
id string - The policy ID.
- preferred_
auth_ numberstate_ machine - Login flow the policy prefers.
- profile_
policy_ numberid - App policy that governs step-up authentication for the profile area.
- require_
security_ boolquestions - Require users to set security questions.
- reset_
password_ list(number)authentication_ factor_ ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure_
admin bool - Require step-up authentication to reach the admin area.
- secure_
area_ numberotp_ timeout_ minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure_
profile bool - Require step-up authentication to reach the user profile area.
- self_
install_ boolcert - Let users install their own browser certificate.
- session_
timeout_ numberby_ fixed_ time_ unit - Unit for session_timeout_by_fixed_time_value.
- session_
timeout_ numberby_ fixed_ time_ value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session_
timeout_ numberby_ inactivity_ unit - Unit for session_timeout_by_inactivity_value.
- session_
timeout_ numberby_ inactivity_ value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session_
timeout_ numberminutes - Session length in minutes, in the older single-value format.
- session_
timeout_ numbertype - Which session timeout applies: by inactivity or at a fixed time.
- smart_
access_ numberrisk_ threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- system_
use_ stringnotification - Text of the system use notification.
- terms_
and_ objectconditions - Terms users must accept before signing in. Applies to user policies only.
- third_
party_ booldevice_ trust - Require a third-party device trust check.
- track_
inactive_ boolusers - Track users who have not logged in recently.
- trusted_
device_ boollogin_ enabled - Allow login from trusted devices.
- trusted_
device_ boollogin_ mfa_ allowed - Allow MFA on trusted device login.
- twitter bool
- Allow sign-in with Twitter.
- user_
phone_ boolupdate_ allowed - Let users change their registered phone number.
- voluntary_
mfa_ boolregistration_ enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- kind String
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - admin
Policy DoubleId - App policy that governs step-up authentication for the admin area.
- allow
Add BooleanCompany App - Let users add company apps to their portal.
- allow
Add BooleanPersonal App - Let users add personal apps to their portal.
- app
Force DoubleAuthn Offset - Minutes before force_authn applies again.
- app
Otp DoubleOffset - Minutes an app MFA prompt is remembered.
- app
Otp BooleanOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication
Factor List<Double>Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser
Cert BooleanRequired - Require a browser certificate.
- browser
Pki DoubleExpiration - Days a browser certificate stays valid.
- disable
Browser BooleanPassword Manager - Stop the browser offering to save passwords.
- disable
Protect BooleanPush Notifications - Turn off OneLogin Protect push notifications.
- disable
Protect BooleanPush Recovery - Turn off OneLogin Protect push recovery.
- dynamic
Blacklist StringAttributes - User attributes whose values may not appear in a password.
- enable
Browser BooleanExtensions - Allow the OneLogin browser extension.
- enable
Email BooleanHint - Prefill the email field on the login page.
- enable
Email BooleanPassword Reset - Offer password reset by email.
- enable
Number BooleanMatch - Require number matching on push notifications.
- enable
Password BooleanChange - Let users change their own password.
- enable
Question BooleanPassword Reset - Offer password reset by security question.
- enable
Smart BooleanAccess - Enable SmartAccess risk scoring.
- enable
Sms BooleanPassword Reset - Offer password reset by SMS.
- enable
System BooleanUse Notification - Show a system use notification before login.
- enable
Unlock BooleanVia Password Reset - Unlock a locked account when the user resets their password.
- enforce
Account BooleanPassword Blacklist - Reject passwords on the account's blacklist.
- enforce
Compromised BooleanCredentials Check - Check credentials against known breaches.
- euba
Enabled Boolean - Enable end-user behaviour analytics.
- euba
Risk DoubleThreshold - Risk score above which EUBA acts.
- facebook Boolean
- Allow sign-in with Facebook.
- force
Authn Boolean - Force re-authentication when the app is opened.
- gdt
Required Boolean - Require OneLogin Desktop for this app.
- google Boolean
- Allow sign-in with Google.
- ignore
Xff Boolean - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite
Expiration DoubleTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite
Expiration DoubleTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip
Addr StringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- linkedin Boolean
- Allow sign-in with LinkedIn.
- lock
Effective DoubleMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum
Invalid DoubleLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa
Registration BooleanEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum
Password DoubleLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name String
- Name of the policy.
- new
Portal StringSetting - Access to the new portal: required, allowed or forbidden.
- otp
Auth BooleanEnabled - Require multi-factor authentication.
- otp
Config Double - Which factors MFA accepts.
- otp
Security DoubleToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp
Trigger DoubleCondition - When MFA is triggered.
- password
Complexity DoubleRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password
Expiration DoubleDays - Days before a password expires. 0 never expires.
- password
Redirect BooleanEnabled - Send password changes to an external URL instead.
- password
Redirect StringMessage - Message shown alongside the password redirect.
- password
Redirect StringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords
Remembered Double - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent
Session BooleanEnabled - Let sessions survive a browser restart.
- policies
Id String - The policy ID.
- preferred
Auth DoubleState Machine - Login flow the policy prefers.
- profile
Policy DoubleId - App policy that governs step-up authentication for the profile area.
- require
Security BooleanQuestions - Require users to set security questions.
- reset
Password List<Double>Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure
Admin Boolean - Require step-up authentication to reach the admin area.
- secure
Area DoubleOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure
Profile Boolean - Require step-up authentication to reach the user profile area.
- self
Install BooleanCert - Let users install their own browser certificate.
- session
Timeout DoubleBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- session
Timeout DoubleBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session
Timeout DoubleBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- session
Timeout DoubleBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session
Timeout DoubleMinutes - Session length in minutes, in the older single-value format.
- session
Timeout DoubleType - Which session timeout applies: by inactivity or at a fixed time.
- smart
Access DoubleRisk Threshold - Risk score above which SmartAccess acts.
- Boolean
- Allow social sign-in.
- system
Use StringNotification - Text of the system use notification.
- terms
And PoliciesConditions Terms And Conditions - Terms users must accept before signing in. Applies to user policies only.
- third
Party BooleanDevice Trust - Require a third-party device trust check.
- track
Inactive BooleanUsers - Track users who have not logged in recently.
- trusted
Device BooleanLogin Enabled - Allow login from trusted devices.
- trusted
Device BooleanLogin Mfa Allowed - Allow MFA on trusted device login.
- twitter Boolean
- Allow sign-in with Twitter.
- user
Phone BooleanUpdate Allowed - Let users change their registered phone number.
- voluntary
Mfa BooleanRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - admin
Policy numberId - App policy that governs step-up authentication for the admin area.
- allow
Add booleanCompany App - Let users add company apps to their portal.
- allow
Add booleanPersonal App - Let users add personal apps to their portal.
- app
Force numberAuthn Offset - Minutes before force_authn applies again.
- app
Otp numberOffset - Minutes an app MFA prompt is remembered.
- app
Otp booleanOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication
Factor number[]Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser
Cert booleanRequired - Require a browser certificate.
- browser
Pki numberExpiration - Days a browser certificate stays valid.
- disable
Browser booleanPassword Manager - Stop the browser offering to save passwords.
- disable
Protect booleanPush Notifications - Turn off OneLogin Protect push notifications.
- disable
Protect booleanPush Recovery - Turn off OneLogin Protect push recovery.
- dynamic
Blacklist stringAttributes - User attributes whose values may not appear in a password.
- enable
Browser booleanExtensions - Allow the OneLogin browser extension.
- enable
Email booleanHint - Prefill the email field on the login page.
- enable
Email booleanPassword Reset - Offer password reset by email.
- enable
Number booleanMatch - Require number matching on push notifications.
- enable
Password booleanChange - Let users change their own password.
- enable
Question booleanPassword Reset - Offer password reset by security question.
- enable
Smart booleanAccess - Enable SmartAccess risk scoring.
- enable
Sms booleanPassword Reset - Offer password reset by SMS.
- enable
System booleanUse Notification - Show a system use notification before login.
- enable
Unlock booleanVia Password Reset - Unlock a locked account when the user resets their password.
- enforce
Account booleanPassword Blacklist - Reject passwords on the account's blacklist.
- enforce
Compromised booleanCredentials Check - Check credentials against known breaches.
- euba
Enabled boolean - Enable end-user behaviour analytics.
- euba
Risk numberThreshold - Risk score above which EUBA acts.
- facebook boolean
- Allow sign-in with Facebook.
- force
Authn boolean - Force re-authentication when the app is opened.
- gdt
Required boolean - Require OneLogin Desktop for this app.
- google boolean
- Allow sign-in with Google.
- ignore
Xff boolean - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite
Expiration numberTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite
Expiration numberTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip
Addr stringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- linkedin boolean
- Allow sign-in with LinkedIn.
- lock
Effective numberMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum
Invalid numberLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa
Registration booleanEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum
Password numberLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name string
- Name of the policy.
- new
Portal stringSetting - Access to the new portal: required, allowed or forbidden.
- otp
Auth booleanEnabled - Require multi-factor authentication.
- otp
Config number - Which factors MFA accepts.
- otp
Security numberToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp
Trigger numberCondition - When MFA is triggered.
- password
Complexity numberRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password
Expiration numberDays - Days before a password expires. 0 never expires.
- password
Redirect booleanEnabled - Send password changes to an external URL instead.
- password
Redirect stringMessage - Message shown alongside the password redirect.
- password
Redirect stringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords
Remembered number - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent
Session booleanEnabled - Let sessions survive a browser restart.
- policies
Id string - The policy ID.
- preferred
Auth numberState Machine - Login flow the policy prefers.
- profile
Policy numberId - App policy that governs step-up authentication for the profile area.
- require
Security booleanQuestions - Require users to set security questions.
- reset
Password number[]Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure
Admin boolean - Require step-up authentication to reach the admin area.
- secure
Area numberOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure
Profile boolean - Require step-up authentication to reach the user profile area.
- self
Install booleanCert - Let users install their own browser certificate.
- session
Timeout numberBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- session
Timeout numberBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session
Timeout numberBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- session
Timeout numberBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session
Timeout numberMinutes - Session length in minutes, in the older single-value format.
- session
Timeout numberType - Which session timeout applies: by inactivity or at a fixed time.
- smart
Access numberRisk Threshold - Risk score above which SmartAccess acts.
- boolean
- Allow social sign-in.
- system
Use stringNotification - Text of the system use notification.
- terms
And PoliciesConditions Terms And Conditions - Terms users must accept before signing in. Applies to user policies only.
- third
Party booleanDevice Trust - Require a third-party device trust check.
- track
Inactive booleanUsers - Track users who have not logged in recently.
- trusted
Device booleanLogin Enabled - Allow login from trusted devices.
- trusted
Device booleanLogin Mfa Allowed - Allow MFA on trusted device login.
- twitter boolean
- Allow sign-in with Twitter.
- user
Phone booleanUpdate Allowed - Let users change their registered phone number.
- voluntary
Mfa booleanRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- kind str
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - admin_
policy_ floatid - App policy that governs step-up authentication for the admin area.
- allow_
add_ boolcompany_ app - Let users add company apps to their portal.
- allow_
add_ boolpersonal_ app - Let users add personal apps to their portal.
- app_
force_ floatauthn_ offset - Minutes before force_authn applies again.
- app_
otp_ floatoffset - Minutes an app MFA prompt is remembered.
- app_
otp_ booloffset_ enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication_
factor_ Sequence[float]ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser_
cert_ boolrequired - Require a browser certificate.
- browser_
pki_ floatexpiration - Days a browser certificate stays valid.
- disable_
browser_ boolpassword_ manager - Stop the browser offering to save passwords.
- disable_
protect_ boolpush_ notifications - Turn off OneLogin Protect push notifications.
- disable_
protect_ boolpush_ recovery - Turn off OneLogin Protect push recovery.
- dynamic_
blacklist_ strattributes - User attributes whose values may not appear in a password.
- enable_
browser_ boolextensions - Allow the OneLogin browser extension.
- enable_
email_ boolhint - Prefill the email field on the login page.
- enable_
email_ boolpassword_ reset - Offer password reset by email.
- enable_
number_ boolmatch - Require number matching on push notifications.
- enable_
password_ boolchange - Let users change their own password.
- enable_
question_ boolpassword_ reset - Offer password reset by security question.
- enable_
smart_ boolaccess - Enable SmartAccess risk scoring.
- enable_
sms_ boolpassword_ reset - Offer password reset by SMS.
- enable_
system_ booluse_ notification - Show a system use notification before login.
- enable_
unlock_ boolvia_ password_ reset - Unlock a locked account when the user resets their password.
- enforce_
account_ boolpassword_ blacklist - Reject passwords on the account's blacklist.
- enforce_
compromised_ boolcredentials_ check - Check credentials against known breaches.
- euba_
enabled bool - Enable end-user behaviour analytics.
- euba_
risk_ floatthreshold - Risk score above which EUBA acts.
- facebook bool
- Allow sign-in with Facebook.
- force_
authn bool - Force re-authentication when the app is opened.
- gdt_
required bool - Require OneLogin Desktop for this app.
- google bool
- Allow sign-in with Google.
- ignore_
xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite_
expiration_ floattime_ unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite_
expiration_ floattime_ value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip_
addr_ strrestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- linkedin bool
- Allow sign-in with LinkedIn.
- lock_
effective_ floatminutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum_
invalid_ floatlogin_ attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa_
registration_ boolenabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum_
password_ floatlength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name str
- Name of the policy.
- new_
portal_ strsetting - Access to the new portal: required, allowed or forbidden.
- otp_
auth_ boolenabled - Require multi-factor authentication.
- otp_
config float - Which factors MFA accepts.
- otp_
security_ floattoken_ expiration_ days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp_
trigger_ floatcondition - When MFA is triggered.
- password_
complexity_ floatrequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password_
expiration_ floatdays - Days before a password expires. 0 never expires.
- password_
redirect_ boolenabled - Send password changes to an external URL instead.
- password_
redirect_ strmessage - Message shown alongside the password redirect.
- password_
redirect_ strurl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords_
remembered float - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent_
session_ boolenabled - Let sessions survive a browser restart.
- policies_
id str - The policy ID.
- preferred_
auth_ floatstate_ machine - Login flow the policy prefers.
- profile_
policy_ floatid - App policy that governs step-up authentication for the profile area.
- require_
security_ boolquestions - Require users to set security questions.
- reset_
password_ Sequence[float]authentication_ factor_ ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure_
admin bool - Require step-up authentication to reach the admin area.
- secure_
area_ floatotp_ timeout_ minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure_
profile bool - Require step-up authentication to reach the user profile area.
- self_
install_ boolcert - Let users install their own browser certificate.
- session_
timeout_ floatby_ fixed_ time_ unit - Unit for session_timeout_by_fixed_time_value.
- session_
timeout_ floatby_ fixed_ time_ value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session_
timeout_ floatby_ inactivity_ unit - Unit for session_timeout_by_inactivity_value.
- session_
timeout_ floatby_ inactivity_ value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session_
timeout_ floatminutes - Session length in minutes, in the older single-value format.
- session_
timeout_ floattype - Which session timeout applies: by inactivity or at a fixed time.
- smart_
access_ floatrisk_ threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- system_
use_ strnotification - Text of the system use notification.
- terms_
and_ Policiesconditions Terms And Conditions Args - Terms users must accept before signing in. Applies to user policies only.
- third_
party_ booldevice_ trust - Require a third-party device trust check.
- track_
inactive_ boolusers - Track users who have not logged in recently.
- trusted_
device_ boollogin_ enabled - Allow login from trusted devices.
- trusted_
device_ boollogin_ mfa_ allowed - Allow MFA on trusted device login.
- twitter bool
- Allow sign-in with Twitter.
- user_
phone_ boolupdate_ allowed - Let users change their registered phone number.
- voluntary_
mfa_ boolregistration_ enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- kind String
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - admin
Policy NumberId - App policy that governs step-up authentication for the admin area.
- allow
Add BooleanCompany App - Let users add company apps to their portal.
- allow
Add BooleanPersonal App - Let users add personal apps to their portal.
- app
Force NumberAuthn Offset - Minutes before force_authn applies again.
- app
Otp NumberOffset - Minutes an app MFA prompt is remembered.
- app
Otp BooleanOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication
Factor List<Number>Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser
Cert BooleanRequired - Require a browser certificate.
- browser
Pki NumberExpiration - Days a browser certificate stays valid.
- disable
Browser BooleanPassword Manager - Stop the browser offering to save passwords.
- disable
Protect BooleanPush Notifications - Turn off OneLogin Protect push notifications.
- disable
Protect BooleanPush Recovery - Turn off OneLogin Protect push recovery.
- dynamic
Blacklist StringAttributes - User attributes whose values may not appear in a password.
- enable
Browser BooleanExtensions - Allow the OneLogin browser extension.
- enable
Email BooleanHint - Prefill the email field on the login page.
- enable
Email BooleanPassword Reset - Offer password reset by email.
- enable
Number BooleanMatch - Require number matching on push notifications.
- enable
Password BooleanChange - Let users change their own password.
- enable
Question BooleanPassword Reset - Offer password reset by security question.
- enable
Smart BooleanAccess - Enable SmartAccess risk scoring.
- enable
Sms BooleanPassword Reset - Offer password reset by SMS.
- enable
System BooleanUse Notification - Show a system use notification before login.
- enable
Unlock BooleanVia Password Reset - Unlock a locked account when the user resets their password.
- enforce
Account BooleanPassword Blacklist - Reject passwords on the account's blacklist.
- enforce
Compromised BooleanCredentials Check - Check credentials against known breaches.
- euba
Enabled Boolean - Enable end-user behaviour analytics.
- euba
Risk NumberThreshold - Risk score above which EUBA acts.
- facebook Boolean
- Allow sign-in with Facebook.
- force
Authn Boolean - Force re-authentication when the app is opened.
- gdt
Required Boolean - Require OneLogin Desktop for this app.
- google Boolean
- Allow sign-in with Google.
- ignore
Xff Boolean - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite
Expiration NumberTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite
Expiration NumberTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip
Addr StringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- linkedin Boolean
- Allow sign-in with LinkedIn.
- lock
Effective NumberMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum
Invalid NumberLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa
Registration BooleanEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum
Password NumberLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name String
- Name of the policy.
- new
Portal StringSetting - Access to the new portal: required, allowed or forbidden.
- otp
Auth BooleanEnabled - Require multi-factor authentication.
- otp
Config Number - Which factors MFA accepts.
- otp
Security NumberToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp
Trigger NumberCondition - When MFA is triggered.
- password
Complexity NumberRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password
Expiration NumberDays - Days before a password expires. 0 never expires.
- password
Redirect BooleanEnabled - Send password changes to an external URL instead.
- password
Redirect StringMessage - Message shown alongside the password redirect.
- password
Redirect StringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords
Remembered Number - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent
Session BooleanEnabled - Let sessions survive a browser restart.
- policies
Id String - The policy ID.
- preferred
Auth NumberState Machine - Login flow the policy prefers.
- profile
Policy NumberId - App policy that governs step-up authentication for the profile area.
- require
Security BooleanQuestions - Require users to set security questions.
- reset
Password List<Number>Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure
Admin Boolean - Require step-up authentication to reach the admin area.
- secure
Area NumberOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure
Profile Boolean - Require step-up authentication to reach the user profile area.
- self
Install BooleanCert - Let users install their own browser certificate.
- session
Timeout NumberBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- session
Timeout NumberBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session
Timeout NumberBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- session
Timeout NumberBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session
Timeout NumberMinutes - Session length in minutes, in the older single-value format.
- session
Timeout NumberType - Which session timeout applies: by inactivity or at a fixed time.
- smart
Access NumberRisk Threshold - Risk score above which SmartAccess acts.
- Boolean
- Allow social sign-in.
- system
Use StringNotification - Text of the system use notification.
- terms
And Property MapConditions - Terms users must accept before signing in. Applies to user policies only.
- third
Party BooleanDevice Trust - Require a third-party device trust check.
- track
Inactive BooleanUsers - Track users who have not logged in recently.
- trusted
Device BooleanLogin Enabled - Allow login from trusted devices.
- trusted
Device BooleanLogin Mfa Allowed - Allow MFA on trusted device login.
- twitter Boolean
- Allow sign-in with Twitter.
- user
Phone BooleanUpdate Allowed - Let users change their registered phone number.
- voluntary
Mfa BooleanRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
Outputs
All input properties are implicitly available as output properties. Additionally, the Policies resource produces the following output properties:
- id string
- The provider-assigned unique ID for this managed resource.
- is_
default bool - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
default bool - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
Look up Existing Policies Resource
Get an existing Policies 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?: PoliciesState, opts?: CustomResourceOptions): Policies@staticmethod def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, admin_policy_id: Optional[float] = None, allow_add_company_app: Optional[bool] = None, allow_add_personal_app: Optional[bool] = None, app_force_authn_offset: Optional[float] = None, app_otp_offset: Optional[float] = None, app_otp_offset_enabled: Optional[bool] = None, authentication_factor_ids: Optional[Sequence[float]] = None, browser_cert_required: Optional[bool] = None, browser_pki_expiration: Optional[float] = None, disable_browser_password_manager: Optional[bool] = None, disable_protect_push_notifications: Optional[bool] = None, disable_protect_push_recovery: Optional[bool] = None, dynamic_blacklist_attributes: Optional[str] = None, enable_browser_extensions: Optional[bool] = None, enable_email_hint: Optional[bool] = None, enable_email_password_reset: Optional[bool] = None, enable_number_match: Optional[bool] = None, enable_password_change: Optional[bool] = None, enable_question_password_reset: Optional[bool] = None, enable_smart_access: Optional[bool] = None, enable_sms_password_reset: Optional[bool] = None, enable_system_use_notification: Optional[bool] = None, enable_unlock_via_password_reset: Optional[bool] = None, enforce_account_password_blacklist: Optional[bool] = None, enforce_compromised_credentials_check: Optional[bool] = None, euba_enabled: Optional[bool] = None, euba_risk_threshold: Optional[float] = None, facebook: Optional[bool] = None, force_authn: Optional[bool] = None, gdt_required: Optional[bool] = None, google: Optional[bool] = None, ignore_xff: Optional[bool] = None, invite_expiration_time_unit: Optional[float] = None, invite_expiration_time_value: Optional[float] = None, ip_addr_restriction: Optional[str] = None, is_default: Optional[bool] = None, kind: Optional[str] = None, linkedin: Optional[bool] = None, lock_effective_minutes: Optional[float] = None, maximum_invalid_login_attempts: Optional[float] = None, mfa_registration_enabled: Optional[bool] = None, minimum_password_length: Optional[float] = None, name: Optional[str] = None, new_portal_setting: Optional[str] = None, otp_auth_enabled: Optional[bool] = None, otp_config: Optional[float] = None, otp_security_token_expiration_days: Optional[float] = None, otp_trigger_condition: Optional[float] = None, password_complexity_requirements: Optional[float] = None, password_expiration_days: Optional[float] = None, password_redirect_enabled: Optional[bool] = None, password_redirect_message: Optional[str] = None, password_redirect_url: Optional[str] = None, passwords_remembered: Optional[float] = None, persistent_session_enabled: Optional[bool] = None, policies_id: Optional[str] = None, preferred_auth_state_machine: Optional[float] = None, profile_policy_id: Optional[float] = None, require_security_questions: Optional[bool] = None, reset_password_authentication_factor_ids: Optional[Sequence[float]] = None, secure_admin: Optional[bool] = None, secure_area_otp_timeout_minutes: Optional[float] = None, secure_profile: Optional[bool] = None, self_install_cert: Optional[bool] = None, session_timeout_by_fixed_time_unit: Optional[float] = None, session_timeout_by_fixed_time_value: Optional[float] = None, session_timeout_by_inactivity_unit: Optional[float] = None, session_timeout_by_inactivity_value: Optional[float] = None, session_timeout_minutes: Optional[float] = None, session_timeout_type: Optional[float] = None, smart_access_risk_threshold: Optional[float] = None, social_sign_in: Optional[bool] = None, system_use_notification: Optional[str] = None, terms_and_conditions: Optional[PoliciesTermsAndConditionsArgs] = None, third_party_device_trust: Optional[bool] = None, track_inactive_users: Optional[bool] = None, trusted_device_login_enabled: Optional[bool] = None, trusted_device_login_mfa_allowed: Optional[bool] = None, twitter: Optional[bool] = None, user_phone_update_allowed: Optional[bool] = None, voluntary_mfa_registration_enabled: Optional[bool] = None) -> Policiesfunc GetPolicies(ctx *Context, name string, id IDInput, state *PoliciesState, opts ...ResourceOption) (*Policies, error)public static Policies Get(string name, Input<string> id, PoliciesState? state, CustomResourceOptions? opts = null)public static Policies get(String name, Output<String> id, PoliciesState state, CustomResourceOptions options)resources: _: type: onelogin:Policies get: id: ${id}import { to = onelogin_policies.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: - Admin
Policy doubleId - App policy that governs step-up authentication for the admin area.
- Allow
Add boolCompany App - Let users add company apps to their portal.
- Allow
Add boolPersonal App - Let users add personal apps to their portal.
- App
Force doubleAuthn Offset - Minutes before force_authn applies again.
- App
Otp doubleOffset - Minutes an app MFA prompt is remembered.
- App
Otp boolOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- Authentication
Factor List<double>Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - Browser
Cert boolRequired - Require a browser certificate.
- Browser
Pki doubleExpiration - Days a browser certificate stays valid.
- Disable
Browser boolPassword Manager - Stop the browser offering to save passwords.
- Disable
Protect boolPush Notifications - Turn off OneLogin Protect push notifications.
- Disable
Protect boolPush Recovery - Turn off OneLogin Protect push recovery.
- Dynamic
Blacklist stringAttributes - User attributes whose values may not appear in a password.
- Enable
Browser boolExtensions - Allow the OneLogin browser extension.
- Enable
Email boolHint - Prefill the email field on the login page.
- Enable
Email boolPassword Reset - Offer password reset by email.
- Enable
Number boolMatch - Require number matching on push notifications.
- Enable
Password boolChange - Let users change their own password.
- Enable
Question boolPassword Reset - Offer password reset by security question.
- Enable
Smart boolAccess - Enable SmartAccess risk scoring.
- Enable
Sms boolPassword Reset - Offer password reset by SMS.
- Enable
System boolUse Notification - Show a system use notification before login.
- Enable
Unlock boolVia Password Reset - Unlock a locked account when the user resets their password.
- Enforce
Account boolPassword Blacklist - Reject passwords on the account's blacklist.
- Enforce
Compromised boolCredentials Check - Check credentials against known breaches.
- Euba
Enabled bool - Enable end-user behaviour analytics.
- Euba
Risk doubleThreshold - Risk score above which EUBA acts.
- Facebook bool
- Allow sign-in with Facebook.
- Force
Authn bool - Force re-authentication when the app is opened.
- Gdt
Required bool - Require OneLogin Desktop for this app.
- Google bool
- Allow sign-in with Google.
- Ignore
Xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- Invite
Expiration doubleTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- Invite
Expiration doubleTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- Ip
Addr stringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- Is
Default bool - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- Kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - Linkedin bool
- Allow sign-in with LinkedIn.
- Lock
Effective doubleMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- Maximum
Invalid doubleLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- Mfa
Registration boolEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- Minimum
Password doubleLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- Name string
- Name of the policy.
- New
Portal stringSetting - Access to the new portal: required, allowed or forbidden.
- Otp
Auth boolEnabled - Require multi-factor authentication.
- Otp
Config double - Which factors MFA accepts.
- Otp
Security doubleToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- Otp
Trigger doubleCondition - When MFA is triggered.
- Password
Complexity doubleRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- Password
Expiration doubleDays - Days before a password expires. 0 never expires.
- Password
Redirect boolEnabled - Send password changes to an external URL instead.
- Password
Redirect stringMessage - Message shown alongside the password redirect.
- Password
Redirect stringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- Passwords
Remembered double - How many previous passwords cannot be reused. 0, 3 or 5.
- Persistent
Session boolEnabled - Let sessions survive a browser restart.
- Policies
Id string - The policy ID.
- Preferred
Auth doubleState Machine - Login flow the policy prefers.
- Profile
Policy doubleId - App policy that governs step-up authentication for the profile area.
- Require
Security boolQuestions - Require users to set security questions.
- Reset
Password List<double>Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- Secure
Admin bool - Require step-up authentication to reach the admin area.
- Secure
Area doubleOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- Secure
Profile bool - Require step-up authentication to reach the user profile area.
- Self
Install boolCert - Let users install their own browser certificate.
- Session
Timeout doubleBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- Session
Timeout doubleBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- Session
Timeout doubleBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- Session
Timeout doubleBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- Session
Timeout doubleMinutes - Session length in minutes, in the older single-value format.
- Session
Timeout doubleType - Which session timeout applies: by inactivity or at a fixed time.
- Smart
Access doubleRisk Threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- System
Use stringNotification - Text of the system use notification.
- Terms
And PoliciesConditions Terms And Conditions - Terms users must accept before signing in. Applies to user policies only.
- Third
Party boolDevice Trust - Require a third-party device trust check.
- Track
Inactive boolUsers - Track users who have not logged in recently.
- Trusted
Device boolLogin Enabled - Allow login from trusted devices.
- Trusted
Device boolLogin Mfa Allowed - Allow MFA on trusted device login.
- Twitter bool
- Allow sign-in with Twitter.
- User
Phone boolUpdate Allowed - Let users change their registered phone number.
- Voluntary
Mfa boolRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- Admin
Policy float64Id - App policy that governs step-up authentication for the admin area.
- Allow
Add boolCompany App - Let users add company apps to their portal.
- Allow
Add boolPersonal App - Let users add personal apps to their portal.
- App
Force float64Authn Offset - Minutes before force_authn applies again.
- App
Otp float64Offset - Minutes an app MFA prompt is remembered.
- App
Otp boolOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- Authentication
Factor []float64Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - Browser
Cert boolRequired - Require a browser certificate.
- Browser
Pki float64Expiration - Days a browser certificate stays valid.
- Disable
Browser boolPassword Manager - Stop the browser offering to save passwords.
- Disable
Protect boolPush Notifications - Turn off OneLogin Protect push notifications.
- Disable
Protect boolPush Recovery - Turn off OneLogin Protect push recovery.
- Dynamic
Blacklist stringAttributes - User attributes whose values may not appear in a password.
- Enable
Browser boolExtensions - Allow the OneLogin browser extension.
- Enable
Email boolHint - Prefill the email field on the login page.
- Enable
Email boolPassword Reset - Offer password reset by email.
- Enable
Number boolMatch - Require number matching on push notifications.
- Enable
Password boolChange - Let users change their own password.
- Enable
Question boolPassword Reset - Offer password reset by security question.
- Enable
Smart boolAccess - Enable SmartAccess risk scoring.
- Enable
Sms boolPassword Reset - Offer password reset by SMS.
- Enable
System boolUse Notification - Show a system use notification before login.
- Enable
Unlock boolVia Password Reset - Unlock a locked account when the user resets their password.
- Enforce
Account boolPassword Blacklist - Reject passwords on the account's blacklist.
- Enforce
Compromised boolCredentials Check - Check credentials against known breaches.
- Euba
Enabled bool - Enable end-user behaviour analytics.
- Euba
Risk float64Threshold - Risk score above which EUBA acts.
- Facebook bool
- Allow sign-in with Facebook.
- Force
Authn bool - Force re-authentication when the app is opened.
- Gdt
Required bool - Require OneLogin Desktop for this app.
- Google bool
- Allow sign-in with Google.
- Ignore
Xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- Invite
Expiration float64Time Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- Invite
Expiration float64Time Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- Ip
Addr stringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- Is
Default bool - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- Kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - Linkedin bool
- Allow sign-in with LinkedIn.
- Lock
Effective float64Minutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- Maximum
Invalid float64Login Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- Mfa
Registration boolEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- Minimum
Password float64Length - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- Name string
- Name of the policy.
- New
Portal stringSetting - Access to the new portal: required, allowed or forbidden.
- Otp
Auth boolEnabled - Require multi-factor authentication.
- Otp
Config float64 - Which factors MFA accepts.
- Otp
Security float64Token Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- Otp
Trigger float64Condition - When MFA is triggered.
- Password
Complexity float64Requirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- Password
Expiration float64Days - Days before a password expires. 0 never expires.
- Password
Redirect boolEnabled - Send password changes to an external URL instead.
- Password
Redirect stringMessage - Message shown alongside the password redirect.
- Password
Redirect stringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- Passwords
Remembered float64 - How many previous passwords cannot be reused. 0, 3 or 5.
- Persistent
Session boolEnabled - Let sessions survive a browser restart.
- Policies
Id string - The policy ID.
- Preferred
Auth float64State Machine - Login flow the policy prefers.
- Profile
Policy float64Id - App policy that governs step-up authentication for the profile area.
- Require
Security boolQuestions - Require users to set security questions.
- Reset
Password []float64Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- Secure
Admin bool - Require step-up authentication to reach the admin area.
- Secure
Area float64Otp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- Secure
Profile bool - Require step-up authentication to reach the user profile area.
- Self
Install boolCert - Let users install their own browser certificate.
- Session
Timeout float64By Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- Session
Timeout float64By Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- Session
Timeout float64By Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- Session
Timeout float64By Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- Session
Timeout float64Minutes - Session length in minutes, in the older single-value format.
- Session
Timeout float64Type - Which session timeout applies: by inactivity or at a fixed time.
- Smart
Access float64Risk Threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- System
Use stringNotification - Text of the system use notification.
- Terms
And PoliciesConditions Terms And Conditions Args - Terms users must accept before signing in. Applies to user policies only.
- Third
Party boolDevice Trust - Require a third-party device trust check.
- Track
Inactive boolUsers - Track users who have not logged in recently.
- Trusted
Device boolLogin Enabled - Allow login from trusted devices.
- Trusted
Device boolLogin Mfa Allowed - Allow MFA on trusted device login.
- Twitter bool
- Allow sign-in with Twitter.
- User
Phone boolUpdate Allowed - Let users change their registered phone number.
- Voluntary
Mfa boolRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- admin_
policy_ numberid - App policy that governs step-up authentication for the admin area.
- allow_
add_ boolcompany_ app - Let users add company apps to their portal.
- allow_
add_ boolpersonal_ app - Let users add personal apps to their portal.
- app_
force_ numberauthn_ offset - Minutes before force_authn applies again.
- app_
otp_ numberoffset - Minutes an app MFA prompt is remembered.
- app_
otp_ booloffset_ enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication_
factor_ list(number)ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser_
cert_ boolrequired - Require a browser certificate.
- browser_
pki_ numberexpiration - Days a browser certificate stays valid.
- disable_
browser_ boolpassword_ manager - Stop the browser offering to save passwords.
- disable_
protect_ boolpush_ notifications - Turn off OneLogin Protect push notifications.
- disable_
protect_ boolpush_ recovery - Turn off OneLogin Protect push recovery.
- dynamic_
blacklist_ stringattributes - User attributes whose values may not appear in a password.
- enable_
browser_ boolextensions - Allow the OneLogin browser extension.
- enable_
email_ boolhint - Prefill the email field on the login page.
- enable_
email_ boolpassword_ reset - Offer password reset by email.
- enable_
number_ boolmatch - Require number matching on push notifications.
- enable_
password_ boolchange - Let users change their own password.
- enable_
question_ boolpassword_ reset - Offer password reset by security question.
- enable_
smart_ boolaccess - Enable SmartAccess risk scoring.
- enable_
sms_ boolpassword_ reset - Offer password reset by SMS.
- enable_
system_ booluse_ notification - Show a system use notification before login.
- enable_
unlock_ boolvia_ password_ reset - Unlock a locked account when the user resets their password.
- enforce_
account_ boolpassword_ blacklist - Reject passwords on the account's blacklist.
- enforce_
compromised_ boolcredentials_ check - Check credentials against known breaches.
- euba_
enabled bool - Enable end-user behaviour analytics.
- euba_
risk_ numberthreshold - Risk score above which EUBA acts.
- facebook bool
- Allow sign-in with Facebook.
- force_
authn bool - Force re-authentication when the app is opened.
- gdt_
required bool - Require OneLogin Desktop for this app.
- google bool
- Allow sign-in with Google.
- ignore_
xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite_
expiration_ numbertime_ unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite_
expiration_ numbertime_ value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip_
addr_ stringrestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- is_
default bool - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - linkedin bool
- Allow sign-in with LinkedIn.
- lock_
effective_ numberminutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum_
invalid_ numberlogin_ attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa_
registration_ boolenabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum_
password_ numberlength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name string
- Name of the policy.
- new_
portal_ stringsetting - Access to the new portal: required, allowed or forbidden.
- otp_
auth_ boolenabled - Require multi-factor authentication.
- otp_
config number - Which factors MFA accepts.
- otp_
security_ numbertoken_ expiration_ days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp_
trigger_ numbercondition - When MFA is triggered.
- password_
complexity_ numberrequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password_
expiration_ numberdays - Days before a password expires. 0 never expires.
- password_
redirect_ boolenabled - Send password changes to an external URL instead.
- password_
redirect_ stringmessage - Message shown alongside the password redirect.
- password_
redirect_ stringurl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords_
remembered number - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent_
session_ boolenabled - Let sessions survive a browser restart.
- policies_
id string - The policy ID.
- preferred_
auth_ numberstate_ machine - Login flow the policy prefers.
- profile_
policy_ numberid - App policy that governs step-up authentication for the profile area.
- require_
security_ boolquestions - Require users to set security questions.
- reset_
password_ list(number)authentication_ factor_ ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure_
admin bool - Require step-up authentication to reach the admin area.
- secure_
area_ numberotp_ timeout_ minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure_
profile bool - Require step-up authentication to reach the user profile area.
- self_
install_ boolcert - Let users install their own browser certificate.
- session_
timeout_ numberby_ fixed_ time_ unit - Unit for session_timeout_by_fixed_time_value.
- session_
timeout_ numberby_ fixed_ time_ value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session_
timeout_ numberby_ inactivity_ unit - Unit for session_timeout_by_inactivity_value.
- session_
timeout_ numberby_ inactivity_ value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session_
timeout_ numberminutes - Session length in minutes, in the older single-value format.
- session_
timeout_ numbertype - Which session timeout applies: by inactivity or at a fixed time.
- smart_
access_ numberrisk_ threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- system_
use_ stringnotification - Text of the system use notification.
- terms_
and_ objectconditions - Terms users must accept before signing in. Applies to user policies only.
- third_
party_ booldevice_ trust - Require a third-party device trust check.
- track_
inactive_ boolusers - Track users who have not logged in recently.
- trusted_
device_ boollogin_ enabled - Allow login from trusted devices.
- trusted_
device_ boollogin_ mfa_ allowed - Allow MFA on trusted device login.
- twitter bool
- Allow sign-in with Twitter.
- user_
phone_ boolupdate_ allowed - Let users change their registered phone number.
- voluntary_
mfa_ boolregistration_ enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- admin
Policy DoubleId - App policy that governs step-up authentication for the admin area.
- allow
Add BooleanCompany App - Let users add company apps to their portal.
- allow
Add BooleanPersonal App - Let users add personal apps to their portal.
- app
Force DoubleAuthn Offset - Minutes before force_authn applies again.
- app
Otp DoubleOffset - Minutes an app MFA prompt is remembered.
- app
Otp BooleanOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication
Factor List<Double>Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser
Cert BooleanRequired - Require a browser certificate.
- browser
Pki DoubleExpiration - Days a browser certificate stays valid.
- disable
Browser BooleanPassword Manager - Stop the browser offering to save passwords.
- disable
Protect BooleanPush Notifications - Turn off OneLogin Protect push notifications.
- disable
Protect BooleanPush Recovery - Turn off OneLogin Protect push recovery.
- dynamic
Blacklist StringAttributes - User attributes whose values may not appear in a password.
- enable
Browser BooleanExtensions - Allow the OneLogin browser extension.
- enable
Email BooleanHint - Prefill the email field on the login page.
- enable
Email BooleanPassword Reset - Offer password reset by email.
- enable
Number BooleanMatch - Require number matching on push notifications.
- enable
Password BooleanChange - Let users change their own password.
- enable
Question BooleanPassword Reset - Offer password reset by security question.
- enable
Smart BooleanAccess - Enable SmartAccess risk scoring.
- enable
Sms BooleanPassword Reset - Offer password reset by SMS.
- enable
System BooleanUse Notification - Show a system use notification before login.
- enable
Unlock BooleanVia Password Reset - Unlock a locked account when the user resets their password.
- enforce
Account BooleanPassword Blacklist - Reject passwords on the account's blacklist.
- enforce
Compromised BooleanCredentials Check - Check credentials against known breaches.
- euba
Enabled Boolean - Enable end-user behaviour analytics.
- euba
Risk DoubleThreshold - Risk score above which EUBA acts.
- facebook Boolean
- Allow sign-in with Facebook.
- force
Authn Boolean - Force re-authentication when the app is opened.
- gdt
Required Boolean - Require OneLogin Desktop for this app.
- google Boolean
- Allow sign-in with Google.
- ignore
Xff Boolean - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite
Expiration DoubleTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite
Expiration DoubleTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip
Addr StringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- is
Default Boolean - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- kind String
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - linkedin Boolean
- Allow sign-in with LinkedIn.
- lock
Effective DoubleMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum
Invalid DoubleLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa
Registration BooleanEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum
Password DoubleLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name String
- Name of the policy.
- new
Portal StringSetting - Access to the new portal: required, allowed or forbidden.
- otp
Auth BooleanEnabled - Require multi-factor authentication.
- otp
Config Double - Which factors MFA accepts.
- otp
Security DoubleToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp
Trigger DoubleCondition - When MFA is triggered.
- password
Complexity DoubleRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password
Expiration DoubleDays - Days before a password expires. 0 never expires.
- password
Redirect BooleanEnabled - Send password changes to an external URL instead.
- password
Redirect StringMessage - Message shown alongside the password redirect.
- password
Redirect StringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords
Remembered Double - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent
Session BooleanEnabled - Let sessions survive a browser restart.
- policies
Id String - The policy ID.
- preferred
Auth DoubleState Machine - Login flow the policy prefers.
- profile
Policy DoubleId - App policy that governs step-up authentication for the profile area.
- require
Security BooleanQuestions - Require users to set security questions.
- reset
Password List<Double>Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure
Admin Boolean - Require step-up authentication to reach the admin area.
- secure
Area DoubleOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure
Profile Boolean - Require step-up authentication to reach the user profile area.
- self
Install BooleanCert - Let users install their own browser certificate.
- session
Timeout DoubleBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- session
Timeout DoubleBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session
Timeout DoubleBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- session
Timeout DoubleBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session
Timeout DoubleMinutes - Session length in minutes, in the older single-value format.
- session
Timeout DoubleType - Which session timeout applies: by inactivity or at a fixed time.
- smart
Access DoubleRisk Threshold - Risk score above which SmartAccess acts.
- Boolean
- Allow social sign-in.
- system
Use StringNotification - Text of the system use notification.
- terms
And PoliciesConditions Terms And Conditions - Terms users must accept before signing in. Applies to user policies only.
- third
Party BooleanDevice Trust - Require a third-party device trust check.
- track
Inactive BooleanUsers - Track users who have not logged in recently.
- trusted
Device BooleanLogin Enabled - Allow login from trusted devices.
- trusted
Device BooleanLogin Mfa Allowed - Allow MFA on trusted device login.
- twitter Boolean
- Allow sign-in with Twitter.
- user
Phone BooleanUpdate Allowed - Let users change their registered phone number.
- voluntary
Mfa BooleanRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- admin
Policy numberId - App policy that governs step-up authentication for the admin area.
- allow
Add booleanCompany App - Let users add company apps to their portal.
- allow
Add booleanPersonal App - Let users add personal apps to their portal.
- app
Force numberAuthn Offset - Minutes before force_authn applies again.
- app
Otp numberOffset - Minutes an app MFA prompt is remembered.
- app
Otp booleanOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication
Factor number[]Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser
Cert booleanRequired - Require a browser certificate.
- browser
Pki numberExpiration - Days a browser certificate stays valid.
- disable
Browser booleanPassword Manager - Stop the browser offering to save passwords.
- disable
Protect booleanPush Notifications - Turn off OneLogin Protect push notifications.
- disable
Protect booleanPush Recovery - Turn off OneLogin Protect push recovery.
- dynamic
Blacklist stringAttributes - User attributes whose values may not appear in a password.
- enable
Browser booleanExtensions - Allow the OneLogin browser extension.
- enable
Email booleanHint - Prefill the email field on the login page.
- enable
Email booleanPassword Reset - Offer password reset by email.
- enable
Number booleanMatch - Require number matching on push notifications.
- enable
Password booleanChange - Let users change their own password.
- enable
Question booleanPassword Reset - Offer password reset by security question.
- enable
Smart booleanAccess - Enable SmartAccess risk scoring.
- enable
Sms booleanPassword Reset - Offer password reset by SMS.
- enable
System booleanUse Notification - Show a system use notification before login.
- enable
Unlock booleanVia Password Reset - Unlock a locked account when the user resets their password.
- enforce
Account booleanPassword Blacklist - Reject passwords on the account's blacklist.
- enforce
Compromised booleanCredentials Check - Check credentials against known breaches.
- euba
Enabled boolean - Enable end-user behaviour analytics.
- euba
Risk numberThreshold - Risk score above which EUBA acts.
- facebook boolean
- Allow sign-in with Facebook.
- force
Authn boolean - Force re-authentication when the app is opened.
- gdt
Required boolean - Require OneLogin Desktop for this app.
- google boolean
- Allow sign-in with Google.
- ignore
Xff boolean - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite
Expiration numberTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite
Expiration numberTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip
Addr stringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- is
Default boolean - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- kind string
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - linkedin boolean
- Allow sign-in with LinkedIn.
- lock
Effective numberMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum
Invalid numberLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa
Registration booleanEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum
Password numberLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name string
- Name of the policy.
- new
Portal stringSetting - Access to the new portal: required, allowed or forbidden.
- otp
Auth booleanEnabled - Require multi-factor authentication.
- otp
Config number - Which factors MFA accepts.
- otp
Security numberToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp
Trigger numberCondition - When MFA is triggered.
- password
Complexity numberRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password
Expiration numberDays - Days before a password expires. 0 never expires.
- password
Redirect booleanEnabled - Send password changes to an external URL instead.
- password
Redirect stringMessage - Message shown alongside the password redirect.
- password
Redirect stringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords
Remembered number - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent
Session booleanEnabled - Let sessions survive a browser restart.
- policies
Id string - The policy ID.
- preferred
Auth numberState Machine - Login flow the policy prefers.
- profile
Policy numberId - App policy that governs step-up authentication for the profile area.
- require
Security booleanQuestions - Require users to set security questions.
- reset
Password number[]Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure
Admin boolean - Require step-up authentication to reach the admin area.
- secure
Area numberOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure
Profile boolean - Require step-up authentication to reach the user profile area.
- self
Install booleanCert - Let users install their own browser certificate.
- session
Timeout numberBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- session
Timeout numberBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session
Timeout numberBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- session
Timeout numberBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session
Timeout numberMinutes - Session length in minutes, in the older single-value format.
- session
Timeout numberType - Which session timeout applies: by inactivity or at a fixed time.
- smart
Access numberRisk Threshold - Risk score above which SmartAccess acts.
- boolean
- Allow social sign-in.
- system
Use stringNotification - Text of the system use notification.
- terms
And PoliciesConditions Terms And Conditions - Terms users must accept before signing in. Applies to user policies only.
- third
Party booleanDevice Trust - Require a third-party device trust check.
- track
Inactive booleanUsers - Track users who have not logged in recently.
- trusted
Device booleanLogin Enabled - Allow login from trusted devices.
- trusted
Device booleanLogin Mfa Allowed - Allow MFA on trusted device login.
- twitter boolean
- Allow sign-in with Twitter.
- user
Phone booleanUpdate Allowed - Let users change their registered phone number.
- voluntary
Mfa booleanRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- admin_
policy_ floatid - App policy that governs step-up authentication for the admin area.
- allow_
add_ boolcompany_ app - Let users add company apps to their portal.
- allow_
add_ boolpersonal_ app - Let users add personal apps to their portal.
- app_
force_ floatauthn_ offset - Minutes before force_authn applies again.
- app_
otp_ floatoffset - Minutes an app MFA prompt is remembered.
- app_
otp_ booloffset_ enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication_
factor_ Sequence[float]ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser_
cert_ boolrequired - Require a browser certificate.
- browser_
pki_ floatexpiration - Days a browser certificate stays valid.
- disable_
browser_ boolpassword_ manager - Stop the browser offering to save passwords.
- disable_
protect_ boolpush_ notifications - Turn off OneLogin Protect push notifications.
- disable_
protect_ boolpush_ recovery - Turn off OneLogin Protect push recovery.
- dynamic_
blacklist_ strattributes - User attributes whose values may not appear in a password.
- enable_
browser_ boolextensions - Allow the OneLogin browser extension.
- enable_
email_ boolhint - Prefill the email field on the login page.
- enable_
email_ boolpassword_ reset - Offer password reset by email.
- enable_
number_ boolmatch - Require number matching on push notifications.
- enable_
password_ boolchange - Let users change their own password.
- enable_
question_ boolpassword_ reset - Offer password reset by security question.
- enable_
smart_ boolaccess - Enable SmartAccess risk scoring.
- enable_
sms_ boolpassword_ reset - Offer password reset by SMS.
- enable_
system_ booluse_ notification - Show a system use notification before login.
- enable_
unlock_ boolvia_ password_ reset - Unlock a locked account when the user resets their password.
- enforce_
account_ boolpassword_ blacklist - Reject passwords on the account's blacklist.
- enforce_
compromised_ boolcredentials_ check - Check credentials against known breaches.
- euba_
enabled bool - Enable end-user behaviour analytics.
- euba_
risk_ floatthreshold - Risk score above which EUBA acts.
- facebook bool
- Allow sign-in with Facebook.
- force_
authn bool - Force re-authentication when the app is opened.
- gdt_
required bool - Require OneLogin Desktop for this app.
- google bool
- Allow sign-in with Google.
- ignore_
xff bool - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite_
expiration_ floattime_ unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite_
expiration_ floattime_ value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip_
addr_ strrestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- is_
default bool - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- kind str
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - linkedin bool
- Allow sign-in with LinkedIn.
- lock_
effective_ floatminutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum_
invalid_ floatlogin_ attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa_
registration_ boolenabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum_
password_ floatlength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name str
- Name of the policy.
- new_
portal_ strsetting - Access to the new portal: required, allowed or forbidden.
- otp_
auth_ boolenabled - Require multi-factor authentication.
- otp_
config float - Which factors MFA accepts.
- otp_
security_ floattoken_ expiration_ days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp_
trigger_ floatcondition - When MFA is triggered.
- password_
complexity_ floatrequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password_
expiration_ floatdays - Days before a password expires. 0 never expires.
- password_
redirect_ boolenabled - Send password changes to an external URL instead.
- password_
redirect_ strmessage - Message shown alongside the password redirect.
- password_
redirect_ strurl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords_
remembered float - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent_
session_ boolenabled - Let sessions survive a browser restart.
- policies_
id str - The policy ID.
- preferred_
auth_ floatstate_ machine - Login flow the policy prefers.
- profile_
policy_ floatid - App policy that governs step-up authentication for the profile area.
- require_
security_ boolquestions - Require users to set security questions.
- reset_
password_ Sequence[float]authentication_ factor_ ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure_
admin bool - Require step-up authentication to reach the admin area.
- secure_
area_ floatotp_ timeout_ minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure_
profile bool - Require step-up authentication to reach the user profile area.
- self_
install_ boolcert - Let users install their own browser certificate.
- session_
timeout_ floatby_ fixed_ time_ unit - Unit for session_timeout_by_fixed_time_value.
- session_
timeout_ floatby_ fixed_ time_ value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session_
timeout_ floatby_ inactivity_ unit - Unit for session_timeout_by_inactivity_value.
- session_
timeout_ floatby_ inactivity_ value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session_
timeout_ floatminutes - Session length in minutes, in the older single-value format.
- session_
timeout_ floattype - Which session timeout applies: by inactivity or at a fixed time.
- smart_
access_ floatrisk_ threshold - Risk score above which SmartAccess acts.
- bool
- Allow social sign-in.
- system_
use_ strnotification - Text of the system use notification.
- terms_
and_ Policiesconditions Terms And Conditions Args - Terms users must accept before signing in. Applies to user policies only.
- third_
party_ booldevice_ trust - Require a third-party device trust check.
- track_
inactive_ boolusers - Track users who have not logged in recently.
- trusted_
device_ boollogin_ enabled - Allow login from trusted devices.
- trusted_
device_ boollogin_ mfa_ allowed - Allow MFA on trusted device login.
- twitter bool
- Allow sign-in with Twitter.
- user_
phone_ boolupdate_ allowed - Let users change their registered phone number.
- voluntary_
mfa_ boolregistration_ enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
- admin
Policy NumberId - App policy that governs step-up authentication for the admin area.
- allow
Add BooleanCompany App - Let users add company apps to their portal.
- allow
Add BooleanPersonal App - Let users add personal apps to their portal.
- app
Force NumberAuthn Offset - Minutes before force_authn applies again.
- app
Otp NumberOffset - Minutes an app MFA prompt is remembered.
- app
Otp BooleanOffset Enabled - Remember an app MFA prompt for app_otp_offset minutes.
- authentication
Factor List<Number>Ids - IDs of the authentication factors this
policy accepts. Setting it replaces the whole list; setting it to
[]clears it. Applies to both kinds. - browser
Cert BooleanRequired - Require a browser certificate.
- browser
Pki NumberExpiration - Days a browser certificate stays valid.
- disable
Browser BooleanPassword Manager - Stop the browser offering to save passwords.
- disable
Protect BooleanPush Notifications - Turn off OneLogin Protect push notifications.
- disable
Protect BooleanPush Recovery - Turn off OneLogin Protect push recovery.
- dynamic
Blacklist StringAttributes - User attributes whose values may not appear in a password.
- enable
Browser BooleanExtensions - Allow the OneLogin browser extension.
- enable
Email BooleanHint - Prefill the email field on the login page.
- enable
Email BooleanPassword Reset - Offer password reset by email.
- enable
Number BooleanMatch - Require number matching on push notifications.
- enable
Password BooleanChange - Let users change their own password.
- enable
Question BooleanPassword Reset - Offer password reset by security question.
- enable
Smart BooleanAccess - Enable SmartAccess risk scoring.
- enable
Sms BooleanPassword Reset - Offer password reset by SMS.
- enable
System BooleanUse Notification - Show a system use notification before login.
- enable
Unlock BooleanVia Password Reset - Unlock a locked account when the user resets their password.
- enforce
Account BooleanPassword Blacklist - Reject passwords on the account's blacklist.
- enforce
Compromised BooleanCredentials Check - Check credentials against known breaches.
- euba
Enabled Boolean - Enable end-user behaviour analytics.
- euba
Risk NumberThreshold - Risk score above which EUBA acts.
- facebook Boolean
- Allow sign-in with Facebook.
- force
Authn Boolean - Force re-authentication when the app is opened.
- gdt
Required Boolean - Require OneLogin Desktop for this app.
- google Boolean
- Allow sign-in with Google.
- ignore
Xff Boolean - Ignore the X-Forwarded-For header when matching ip_addr_restriction.
- invite
Expiration NumberTime Unit - Unit for invite_expiration_time_value: 0 minutes, 1 hours, 2 days.
- invite
Expiration NumberTime Value - How long an invite link stays valid, in invite_expiration_time_unit units. Must be greater than 0.
- ip
Addr StringRestriction - Newline-separated list of allowed IP addresses or CIDR ranges.
- is
Default Boolean - Whether this is the account's default user policy. Read-only: which policy is the default belongs to the account and is set elsewhere, and a policy cannot stop being the default except by another policy becoming it.
- kind String
- Either
userorapp. Changing it replaces the policy, because the API refuses to move an existing one between kinds. - linkedin Boolean
- Allow sign-in with LinkedIn.
- lock
Effective NumberMinutes - Minutes an account stays locked. 15, 30, 60, or 0 to require an admin.
- maximum
Invalid NumberLogin Attempts - Failed logins before lockout. 3 to 10, or 0 for no limit.
- mfa
Registration BooleanEnabled - Prompt users to register a factor. Combined with voluntary_mfa_registration_enabled: true/false is required, true/true voluntary, false/false not prompted.
- minimum
Password NumberLength - Minimum password length. One of 5, 6, 8, 10, 12 or 16.
- name String
- Name of the policy.
- new
Portal StringSetting - Access to the new portal: required, allowed or forbidden.
- otp
Auth BooleanEnabled - Require multi-factor authentication.
- otp
Config Number - Which factors MFA accepts.
- otp
Security NumberToken Expiration Days - Days a remembered MFA device stays trusted. 1 to 99999.
- otp
Trigger NumberCondition - When MFA is triggered.
- password
Complexity NumberRequirements - Password complexity: 0 none, 1 letters and digits, 2 mixed case and digits, 3 mixed case, digits and special characters, 4 any three of those four.
- password
Expiration NumberDays - Days before a password expires. 0 never expires.
- password
Redirect BooleanEnabled - Send password changes to an external URL instead.
- password
Redirect StringMessage - Message shown alongside the password redirect.
- password
Redirect StringUrl - URL to send password changes to. Required when password_redirect_enabled is true.
- passwords
Remembered Number - How many previous passwords cannot be reused. 0, 3 or 5.
- persistent
Session BooleanEnabled - Let sessions survive a browser restart.
- policies
Id String - The policy ID.
- preferred
Auth NumberState Machine - Login flow the policy prefers.
- profile
Policy NumberId - App policy that governs step-up authentication for the profile area.
- require
Security BooleanQuestions - Require users to set security questions.
- reset
Password List<Number>Authentication Factor Ids - IDs of the authentication factors accepted for password reset. Applies to user policies only.
- secure
Admin Boolean - Require step-up authentication to reach the admin area.
- secure
Area NumberOtp Timeout Minutes - Minutes a step-up authentication lasts. One of 5, 10, 15, 20, 30, 45 or 60.
- secure
Profile Boolean - Require step-up authentication to reach the user profile area.
- self
Install BooleanCert - Let users install their own browser certificate.
- session
Timeout NumberBy Fixed Time Unit - Unit for session_timeout_by_fixed_time_value.
- session
Timeout NumberBy Fixed Time Value - Fixed session length, in session_timeout_by_fixed_time_unit units.
- session
Timeout NumberBy Inactivity Unit - Unit for session_timeout_by_inactivity_value.
- session
Timeout NumberBy Inactivity Value - Inactivity timeout, in session_timeout_by_inactivity_unit units.
- session
Timeout NumberMinutes - Session length in minutes, in the older single-value format.
- session
Timeout NumberType - Which session timeout applies: by inactivity or at a fixed time.
- smart
Access NumberRisk Threshold - Risk score above which SmartAccess acts.
- Boolean
- Allow social sign-in.
- system
Use StringNotification - Text of the system use notification.
- terms
And Property MapConditions - Terms users must accept before signing in. Applies to user policies only.
- third
Party BooleanDevice Trust - Require a third-party device trust check.
- track
Inactive BooleanUsers - Track users who have not logged in recently.
- trusted
Device BooleanLogin Enabled - Allow login from trusted devices.
- trusted
Device BooleanLogin Mfa Allowed - Allow MFA on trusted device login.
- twitter Boolean
- Allow sign-in with Twitter.
- user
Phone BooleanUpdate Allowed - Let users change their registered phone number.
- voluntary
Mfa BooleanRegistration Enabled - Make factor registration voluntary rather than required. See mfa_registration_enabled.
Supporting Types
Policies
Terms And Conditions , Policies Terms And Conditions Args - Content string
Text of the terms.
Every remaining argument is optional, and OneLogin supplies a default for most of them. An argument you do not set keeps whatever value the API reports, so the plan stays empty rather than showing a diff for a default you never chose. The consequence is that removing an argument from your configuration does not reset it — state keeps the last value OneLogin returned and nothing is sent. To undo a setting, set it explicitly to the value you want.
- Enabled bool
- Whether the terms are shown and must be accepted.
- Content string
Text of the terms.
Every remaining argument is optional, and OneLogin supplies a default for most of them. An argument you do not set keeps whatever value the API reports, so the plan stays empty rather than showing a diff for a default you never chose. The consequence is that removing an argument from your configuration does not reset it — state keeps the last value OneLogin returned and nothing is sent. To undo a setting, set it explicitly to the value you want.
- Enabled bool
- Whether the terms are shown and must be accepted.
- content string
Text of the terms.
Every remaining argument is optional, and OneLogin supplies a default for most of them. An argument you do not set keeps whatever value the API reports, so the plan stays empty rather than showing a diff for a default you never chose. The consequence is that removing an argument from your configuration does not reset it — state keeps the last value OneLogin returned and nothing is sent. To undo a setting, set it explicitly to the value you want.
- enabled bool
- Whether the terms are shown and must be accepted.
- content String
Text of the terms.
Every remaining argument is optional, and OneLogin supplies a default for most of them. An argument you do not set keeps whatever value the API reports, so the plan stays empty rather than showing a diff for a default you never chose. The consequence is that removing an argument from your configuration does not reset it — state keeps the last value OneLogin returned and nothing is sent. To undo a setting, set it explicitly to the value you want.
- enabled Boolean
- Whether the terms are shown and must be accepted.
- content string
Text of the terms.
Every remaining argument is optional, and OneLogin supplies a default for most of them. An argument you do not set keeps whatever value the API reports, so the plan stays empty rather than showing a diff for a default you never chose. The consequence is that removing an argument from your configuration does not reset it — state keeps the last value OneLogin returned and nothing is sent. To undo a setting, set it explicitly to the value you want.
- enabled boolean
- Whether the terms are shown and must be accepted.
- content str
Text of the terms.
Every remaining argument is optional, and OneLogin supplies a default for most of them. An argument you do not set keeps whatever value the API reports, so the plan stays empty rather than showing a diff for a default you never chose. The consequence is that removing an argument from your configuration does not reset it — state keeps the last value OneLogin returned and nothing is sent. To undo a setting, set it explicitly to the value you want.
- enabled bool
- Whether the terms are shown and must be accepted.
- content String
Text of the terms.
Every remaining argument is optional, and OneLogin supplies a default for most of them. An argument you do not set keeps whatever value the API reports, so the plan stays empty rather than showing a diff for a default you never chose. The consequence is that removing an argument from your configuration does not reset it — state keeps the last value OneLogin returned and nothing is sent. To undo a setting, set it explicitly to the value you want.
- enabled Boolean
- Whether the terms are shown and must be accepted.
Import
Policies are imported by ID:
$ pulumi import onelogin:index/policies:Policies engineering 123456To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- onelogin onelogin/terraform-provider-onelogin
- License
- Notes
- This Pulumi package is based on the
oneloginTerraform Provider.
published on Friday, Aug 28, 2026 by onelogin