Class AuthenticationFactorSetting
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.identitydomains.model.AuthenticationFactorSetting
-
@Generated(value="OracleSDKGenerator", comments="API Version: v1") public final class AuthenticationFactorSetting extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Multi Factor Authentication Settings for Tenant
Note: Objects should always be created or deserialized using theAuthenticationFactorSetting.Builder
.This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the
AuthenticationFactorSetting.Builder
, which maintain a set of all explicitly set fields calledAuthenticationFactorSetting.Builder.__explicitlySet__
. ThehashCode()
andequals(Object)
methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AuthenticationFactorSetting.Builder
static class
AuthenticationFactorSetting.UserEnrollmentDisabledFactors
-
Constructor Summary
Constructors Constructor Description AuthenticationFactorSetting(String id, String ocid, List<String> schemas, Meta meta, IdcsCreatedBy idcsCreatedBy, IdcsLastModifiedBy idcsLastModifiedBy, List<IdcsPreventedOperations> idcsPreventedOperations, List<Tags> tags, Boolean deleteInProgress, String idcsLastUpgradedInRelease, String domainOcid, String compartmentOcid, String tenancyOcid, Boolean emailEnabled, Boolean smsEnabled, Boolean phoneCallEnabled, Boolean totpEnabled, Boolean pushEnabled, Boolean bypassCodeEnabled, Boolean securityQuestionsEnabled, Boolean fidoAuthenticatorEnabled, Boolean yubicoOtpEnabled, String mfaEnrollmentType, String mfaEnabledCategory, Boolean hideBackupFactorEnabled, Boolean autoEnrollEmailFactorDisabled, List<AuthenticationFactorSetting.UserEnrollmentDisabledFactors> userEnrollmentDisabledFactors, AuthenticationFactorSettingsEmailSettings emailSettings, AuthenticationFactorSettingsThirdPartyFactor thirdPartyFactor, AuthenticationFactorSettingsNotificationSettings notificationSettings, AuthenticationFactorSettingsIdentityStoreSettings identityStoreSettings, AuthenticationFactorSettingsBypassCodeSettings bypassCodeSettings, AuthenticationFactorSettingsClientAppSettings clientAppSettings, AuthenticationFactorSettingsEndpointRestrictions endpointRestrictions, List<AuthenticationFactorSettingsCompliancePolicy> compliancePolicy, AuthenticationFactorSettingsTotpSettings totpSettings, ExtensionThirdPartyAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings, ExtensionFidoAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AuthenticationFactorSetting.Builder
builder()
Create a new builder.boolean
equals(Object o)
Boolean
getAutoEnrollEmailFactorDisabled()
If true, indicates that email will not be enrolled as a MFA factor automatically if it a account recovery factorBoolean
getBypassCodeEnabled()
If true, indicates that Bypass Code is enabled for authenticationAuthenticationFactorSettingsBypassCodeSettings
getBypassCodeSettings()
AuthenticationFactorSettingsClientAppSettings
getClientAppSettings()
String
getCompartmentOcid()
OCI Compartment Id (ocid) in which the resource lives.List<AuthenticationFactorSettingsCompliancePolicy>
getCompliancePolicy()
Compliance Policy that defines actions to be taken when a condition is violatedBoolean
getDeleteInProgress()
A boolean flag indicating this resource in the process of being deleted.String
getDomainOcid()
OCI Domain Id (ocid) in which the resource lives.Boolean
getEmailEnabled()
If true, indicates that the EMAIL channel is enabled for authenticationAuthenticationFactorSettingsEmailSettings
getEmailSettings()
AuthenticationFactorSettingsEndpointRestrictions
getEndpointRestrictions()
Boolean
getFidoAuthenticatorEnabled()
If true, indicates that the Fido Authenticator channels are enabled for authenticationBoolean
getHideBackupFactorEnabled()
If true, indicates that ‘Show backup factor(s)’ button will be hidden during authenticationString
getId()
Unique identifier for the SCIM Resource as defined by the Service Provider.IdcsCreatedBy
getIdcsCreatedBy()
IdcsLastModifiedBy
getIdcsLastModifiedBy()
String
getIdcsLastUpgradedInRelease()
The release number when the resource was upgraded.List<IdcsPreventedOperations>
getIdcsPreventedOperations()
Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.AuthenticationFactorSettingsIdentityStoreSettings
getIdentityStoreSettings()
Meta
getMeta()
String
getMfaEnabledCategory()
Specifies the category of people for whom Multi-Factor Authentication is enabled.String
getMfaEnrollmentType()
Specifies if Multi-Factor Authentication enrollment is mandatory or optional for a userAuthenticationFactorSettingsNotificationSettings
getNotificationSettings()
String
getOcid()
Unique OCI identifier for the SCIM Resource.Boolean
getPhoneCallEnabled()
If true, indicates that the phone (PHONE_CALL) channel is enabled for authenticationBoolean
getPushEnabled()
If true, indicates that the Mobile App Push Notification channel is enabled for authenticationList<String>
getSchemas()
REQUIRED.Boolean
getSecurityQuestionsEnabled()
If true, indicates that Security Questions are enabled for authenticationBoolean
getSmsEnabled()
If true, indicates that the Short Message Service (SMS) channel is enabled for authenticationList<Tags>
getTags()
A list of tags on this resource.String
getTenancyOcid()
OCI Tenant Id (ocid) in which the resource lives.AuthenticationFactorSettingsThirdPartyFactor
getThirdPartyFactor()
Boolean
getTotpEnabled()
If true, indicates that the Mobile App One Time Passcode channel is enabled for authenticationAuthenticationFactorSettingsTotpSettings
getTotpSettings()
ExtensionFidoAuthenticationFactorSettings
getUrnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings()
ExtensionThirdPartyAuthenticationFactorSettings
getUrnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings()
List<AuthenticationFactorSetting.UserEnrollmentDisabledFactors>
getUserEnrollmentDisabledFactors()
Factors for which enrollment should be blocked for End UserBoolean
getYubicoOtpEnabled()
If true, indicates that the Yubico OTP is enabled for authenticationint
hashCode()
AuthenticationFactorSetting.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
AuthenticationFactorSetting
@Deprecated @ConstructorProperties({"id","ocid","schemas","meta","idcsCreatedBy","idcsLastModifiedBy","idcsPreventedOperations","tags","deleteInProgress","idcsLastUpgradedInRelease","domainOcid","compartmentOcid","tenancyOcid","emailEnabled","smsEnabled","phoneCallEnabled","totpEnabled","pushEnabled","bypassCodeEnabled","securityQuestionsEnabled","fidoAuthenticatorEnabled","yubicoOtpEnabled","mfaEnrollmentType","mfaEnabledCategory","hideBackupFactorEnabled","autoEnrollEmailFactorDisabled","userEnrollmentDisabledFactors","emailSettings","thirdPartyFactor","notificationSettings","identityStoreSettings","bypassCodeSettings","clientAppSettings","endpointRestrictions","compliancePolicy","totpSettings","urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings","urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings"}) public AuthenticationFactorSetting(String id, String ocid, List<String> schemas, Meta meta, IdcsCreatedBy idcsCreatedBy, IdcsLastModifiedBy idcsLastModifiedBy, List<IdcsPreventedOperations> idcsPreventedOperations, List<Tags> tags, Boolean deleteInProgress, String idcsLastUpgradedInRelease, String domainOcid, String compartmentOcid, String tenancyOcid, Boolean emailEnabled, Boolean smsEnabled, Boolean phoneCallEnabled, Boolean totpEnabled, Boolean pushEnabled, Boolean bypassCodeEnabled, Boolean securityQuestionsEnabled, Boolean fidoAuthenticatorEnabled, Boolean yubicoOtpEnabled, String mfaEnrollmentType, String mfaEnabledCategory, Boolean hideBackupFactorEnabled, Boolean autoEnrollEmailFactorDisabled, List<AuthenticationFactorSetting.UserEnrollmentDisabledFactors> userEnrollmentDisabledFactors, AuthenticationFactorSettingsEmailSettings emailSettings, AuthenticationFactorSettingsThirdPartyFactor thirdPartyFactor, AuthenticationFactorSettingsNotificationSettings notificationSettings, AuthenticationFactorSettingsIdentityStoreSettings identityStoreSettings, AuthenticationFactorSettingsBypassCodeSettings bypassCodeSettings, AuthenticationFactorSettingsClientAppSettings clientAppSettings, AuthenticationFactorSettingsEndpointRestrictions endpointRestrictions, List<AuthenticationFactorSettingsCompliancePolicy> compliancePolicy, AuthenticationFactorSettingsTotpSettings totpSettings, ExtensionThirdPartyAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings, ExtensionFidoAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings)
Deprecated.
-
-
Method Detail
-
builder
public static AuthenticationFactorSetting.Builder builder()
Create a new builder.
-
toBuilder
public AuthenticationFactorSetting.Builder toBuilder()
-
getId
public String getId()
Unique identifier for the SCIM Resource as defined by the Service Provider.Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global
- Returns:
- the value
-
getOcid
public String getOcid()
Unique OCI identifier for the SCIM Resource.*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global
- Returns:
- the value
-
getSchemas
public List<String> getSchemas()
REQUIRED.The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getMeta
public Meta getMeta()
-
getIdcsCreatedBy
public IdcsCreatedBy getIdcsCreatedBy()
-
getIdcsLastModifiedBy
public IdcsLastModifiedBy getIdcsLastModifiedBy()
-
getIdcsPreventedOperations
public List<IdcsPreventedOperations> getIdcsPreventedOperations()
Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.*SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none
- Returns:
- the value
-
getTags
public List<Tags> getTags()
A list of tags on this resource.*SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none
- Returns:
- the value
-
getDeleteInProgress
public Boolean getDeleteInProgress()
A boolean flag indicating this resource in the process of being deleted.Usually set to true when synchronous deletion of the resource would take too long.
*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getIdcsLastUpgradedInRelease
public String getIdcsLastUpgradedInRelease()
The release number when the resource was upgraded.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none
- Returns:
- the value
-
getDomainOcid
public String getDomainOcid()
OCI Domain Id (ocid) in which the resource lives.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getCompartmentOcid
public String getCompartmentOcid()
OCI Compartment Id (ocid) in which the resource lives.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getTenancyOcid
public String getTenancyOcid()
OCI Tenant Id (ocid) in which the resource lives.*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getEmailEnabled
public Boolean getEmailEnabled()
If true, indicates that the EMAIL channel is enabled for authentication*Added In:** 18.1.2
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getSmsEnabled
public Boolean getSmsEnabled()
If true, indicates that the Short Message Service (SMS) channel is enabled for authentication*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getPhoneCallEnabled
public Boolean getPhoneCallEnabled()
If true, indicates that the phone (PHONE_CALL) channel is enabled for authentication*Added In:** 20.1.3
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getTotpEnabled
public Boolean getTotpEnabled()
If true, indicates that the Mobile App One Time Passcode channel is enabled for authentication*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getPushEnabled
public Boolean getPushEnabled()
If true, indicates that the Mobile App Push Notification channel is enabled for authentication*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getBypassCodeEnabled
public Boolean getBypassCodeEnabled()
If true, indicates that Bypass Code is enabled for authentication*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getSecurityQuestionsEnabled
public Boolean getSecurityQuestionsEnabled()
If true, indicates that Security Questions are enabled for authentication*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getFidoAuthenticatorEnabled
public Boolean getFidoAuthenticatorEnabled()
If true, indicates that the Fido Authenticator channels are enabled for authentication*Added In:** 2009232244
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getYubicoOtpEnabled
public Boolean getYubicoOtpEnabled()
If true, indicates that the Yubico OTP is enabled for authentication*Added In:** 2109090424
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getMfaEnrollmentType
public String getMfaEnrollmentType()
Specifies if Multi-Factor Authentication enrollment is mandatory or optional for a user*Deprecated Since: 18.1.2**
*SCIM++ Properties:** - idcsCanonicalValueSourceFilter: attrName eq "mfaEnrollmentType" and attrValues.value eq "$(mfaEnrollmentType)" - idcsCanonicalValueSourceResourceType: AllowedValue - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getMfaEnabledCategory
public String getMfaEnabledCategory()
Specifies the category of people for whom Multi-Factor Authentication is enabled.This is a readOnly attribute which reflects the value of mfaEnabledCategory attribute in SsoSettings
*Deprecated Since: 18.1.2**
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getHideBackupFactorEnabled
public Boolean getHideBackupFactorEnabled()
If true, indicates that ‘Show backup factor(s)’ button will be hidden during authentication*Added In:** 19.3.3
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getAutoEnrollEmailFactorDisabled
public Boolean getAutoEnrollEmailFactorDisabled()
If true, indicates that email will not be enrolled as a MFA factor automatically if it a account recovery factor*Added In:** 2011192329
*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none
- Returns:
- the value
-
getUserEnrollmentDisabledFactors
public List<AuthenticationFactorSetting.UserEnrollmentDisabledFactors> getUserEnrollmentDisabledFactors()
Factors for which enrollment should be blocked for End User*Added In:** 2012271618
*SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getEmailSettings
public AuthenticationFactorSettingsEmailSettings getEmailSettings()
-
getThirdPartyFactor
public AuthenticationFactorSettingsThirdPartyFactor getThirdPartyFactor()
-
getNotificationSettings
public AuthenticationFactorSettingsNotificationSettings getNotificationSettings()
-
getIdentityStoreSettings
public AuthenticationFactorSettingsIdentityStoreSettings getIdentityStoreSettings()
-
getBypassCodeSettings
public AuthenticationFactorSettingsBypassCodeSettings getBypassCodeSettings()
-
getClientAppSettings
public AuthenticationFactorSettingsClientAppSettings getClientAppSettings()
-
getEndpointRestrictions
public AuthenticationFactorSettingsEndpointRestrictions getEndpointRestrictions()
-
getCompliancePolicy
public List<AuthenticationFactorSettingsCompliancePolicy> getCompliancePolicy()
Compliance Policy that defines actions to be taken when a condition is violated*SCIM++ Properties:** - idcsCompositeKey: [name] - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: complex - uniqueness: none
- Returns:
- the value
-
getTotpSettings
public AuthenticationFactorSettingsTotpSettings getTotpSettings()
-
getUrnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings
public ExtensionThirdPartyAuthenticationFactorSettings getUrnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings()
-
getUrnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings
public ExtensionFidoAuthenticationFactorSettings getUrnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings()
-
toString
public String toString()
- Overrides:
toString
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents
- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-