com.oracle.bmc.identitydomains.model

Class AuthenticationFactorSetting.Builder

java.lang.Object

com.oracle.bmc.identitydomains.model.AuthenticationFactorSetting.Builder

Enclosing class:

AuthenticationFactorSetting

public static class AuthenticationFactorSetting.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AuthenticationFactorSetting.Builder	autoEnrollEmailFactorDisabled(Boolean autoEnrollEmailFactorDisabled) If true, indicates that email will not be enrolled as a MFA factor automatically if it a account recovery factor
AuthenticationFactorSetting	build()
AuthenticationFactorSetting.Builder	bypassCodeEnabled(Boolean bypassCodeEnabled) If true, indicates that Bypass Code is enabled for authentication
AuthenticationFactorSetting.Builder	bypassCodeSettings(AuthenticationFactorSettingsBypassCodeSettings bypassCodeSettings)
AuthenticationFactorSetting.Builder	clientAppSettings(AuthenticationFactorSettingsClientAppSettings clientAppSettings)
AuthenticationFactorSetting.Builder	compartmentOcid(String compartmentOcid) OCI Compartment Id (ocid) in which the resource lives.
AuthenticationFactorSetting.Builder	compliancePolicy(List<AuthenticationFactorSettingsCompliancePolicy> compliancePolicy) Compliance Policy that defines actions to be taken when a condition is violated
AuthenticationFactorSetting.Builder	copy(AuthenticationFactorSetting model)
AuthenticationFactorSetting.Builder	deleteInProgress(Boolean deleteInProgress) A boolean flag indicating this resource in the process of being deleted.
AuthenticationFactorSetting.Builder	domainOcid(String domainOcid) OCI Domain Id (ocid) in which the resource lives.
AuthenticationFactorSetting.Builder	emailEnabled(Boolean emailEnabled) If true, indicates that the EMAIL channel is enabled for authentication
AuthenticationFactorSetting.Builder	emailSettings(AuthenticationFactorSettingsEmailSettings emailSettings)
AuthenticationFactorSetting.Builder	endpointRestrictions(AuthenticationFactorSettingsEndpointRestrictions endpointRestrictions)
AuthenticationFactorSetting.Builder	fidoAuthenticatorEnabled(Boolean fidoAuthenticatorEnabled) If true, indicates that the Fido Authenticator channels are enabled for authentication
AuthenticationFactorSetting.Builder	hideBackupFactorEnabled(Boolean hideBackupFactorEnabled) If true, indicates that ‘Show backup factor(s)’ button will be hidden during authentication
AuthenticationFactorSetting.Builder	id(String id) Unique identifier for the SCIM Resource as defined by the Service Provider.
AuthenticationFactorSetting.Builder	idcsCreatedBy(IdcsCreatedBy idcsCreatedBy)
AuthenticationFactorSetting.Builder	idcsLastModifiedBy(IdcsLastModifiedBy idcsLastModifiedBy)
AuthenticationFactorSetting.Builder	idcsLastUpgradedInRelease(String idcsLastUpgradedInRelease) The release number when the resource was upgraded.
AuthenticationFactorSetting.Builder	idcsPreventedOperations(List<IdcsPreventedOperations> idcsPreventedOperations) Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
AuthenticationFactorSetting.Builder	identityStoreSettings(AuthenticationFactorSettingsIdentityStoreSettings identityStoreSettings)
AuthenticationFactorSetting.Builder	meta(Meta meta)
AuthenticationFactorSetting.Builder	mfaEnabledCategory(String mfaEnabledCategory) Specifies the category of people for whom Multi-Factor Authentication is enabled.
AuthenticationFactorSetting.Builder	mfaEnrollmentType(String mfaEnrollmentType) Specifies if Multi-Factor Authentication enrollment is mandatory or optional for a user
AuthenticationFactorSetting.Builder	notificationSettings(AuthenticationFactorSettingsNotificationSettings notificationSettings)
AuthenticationFactorSetting.Builder	ocid(String ocid) Unique OCI identifier for the SCIM Resource.
AuthenticationFactorSetting.Builder	phoneCallEnabled(Boolean phoneCallEnabled) If true, indicates that the phone (PHONE_CALL) channel is enabled for authentication
AuthenticationFactorSetting.Builder	pushEnabled(Boolean pushEnabled) If true, indicates that the Mobile App Push Notification channel is enabled for authentication
AuthenticationFactorSetting.Builder	schemas(List<String> schemas) REQUIRED.
AuthenticationFactorSetting.Builder	securityQuestionsEnabled(Boolean securityQuestionsEnabled) If true, indicates that Security Questions are enabled for authentication
AuthenticationFactorSetting.Builder	smsEnabled(Boolean smsEnabled) If true, indicates that the Short Message Service (SMS) channel is enabled for authentication
AuthenticationFactorSetting.Builder	tags(List<Tags> tags) A list of tags on this resource.
AuthenticationFactorSetting.Builder	tenancyOcid(String tenancyOcid) OCI Tenant Id (ocid) in which the resource lives.
AuthenticationFactorSetting.Builder	thirdPartyFactor(AuthenticationFactorSettingsThirdPartyFactor thirdPartyFactor)
AuthenticationFactorSetting.Builder	totpEnabled(Boolean totpEnabled) If true, indicates that the Mobile App One Time Passcode channel is enabled for authentication
AuthenticationFactorSetting.Builder	totpSettings(AuthenticationFactorSettingsTotpSettings totpSettings)
AuthenticationFactorSetting.Builder	urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings(ExtensionFidoAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings)
AuthenticationFactorSetting.Builder	urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings(ExtensionThirdPartyAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings)
AuthenticationFactorSetting.Builder	userEnrollmentDisabledFactors(List<AuthenticationFactorSetting.UserEnrollmentDisabledFactors> userEnrollmentDisabledFactors) Factors for which enrollment should be blocked for End User
AuthenticationFactorSetting.Builder	yubicoOtpEnabled(Boolean yubicoOtpEnabled) If true, indicates that the Yubico OTP is enabled for authentication

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public AuthenticationFactorSetting.Builder id(String id)

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

Parameters:

id - the value to set

Returns:

this builder

ocid

public AuthenticationFactorSetting.Builder ocid(String ocid)

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

Parameters:

ocid - the value to set

Returns:

this builder

schemas

public AuthenticationFactorSetting.Builder schemas(List<String> schemas)

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

Parameters:

schemas - the value to set

Returns:

this builder

meta

public AuthenticationFactorSetting.Builder meta(Meta meta)

idcsCreatedBy

public AuthenticationFactorSetting.Builder idcsCreatedBy(IdcsCreatedBy idcsCreatedBy)

idcsLastModifiedBy

public AuthenticationFactorSetting.Builder idcsLastModifiedBy(IdcsLastModifiedBy idcsLastModifiedBy)

idcsPreventedOperations

public AuthenticationFactorSetting.Builder idcsPreventedOperations(List<IdcsPreventedOperations> idcsPreventedOperations)

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

Parameters:

idcsPreventedOperations - the value to set

Returns:

this builder

tags

public AuthenticationFactorSetting.Builder tags(List<Tags> tags)

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

Parameters:

tags - the value to set

Returns:

this builder

deleteInProgress

public AuthenticationFactorSetting.Builder deleteInProgress(Boolean deleteInProgress)

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

Parameters:

deleteInProgress - the value to set

Returns:

this builder

idcsLastUpgradedInRelease

public AuthenticationFactorSetting.Builder idcsLastUpgradedInRelease(String idcsLastUpgradedInRelease)

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

Parameters:

idcsLastUpgradedInRelease - the value to set

Returns:

this builder

domainOcid

public AuthenticationFactorSetting.Builder domainOcid(String domainOcid)

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

Parameters:

domainOcid - the value to set

Returns:

this builder

compartmentOcid

public AuthenticationFactorSetting.Builder compartmentOcid(String compartmentOcid)

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

Parameters:

compartmentOcid - the value to set

Returns:

this builder

tenancyOcid

public AuthenticationFactorSetting.Builder tenancyOcid(String tenancyOcid)

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

Parameters:

tenancyOcid - the value to set

Returns:

this builder

emailEnabled

public AuthenticationFactorSetting.Builder emailEnabled(Boolean emailEnabled)

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

Parameters:

emailEnabled - the value to set

Returns:

this builder

smsEnabled

public AuthenticationFactorSetting.Builder smsEnabled(Boolean smsEnabled)

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

Parameters:

smsEnabled - the value to set

Returns:

this builder

phoneCallEnabled

public AuthenticationFactorSetting.Builder phoneCallEnabled(Boolean phoneCallEnabled)

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

Parameters:

phoneCallEnabled - the value to set

Returns:

this builder

totpEnabled

public AuthenticationFactorSetting.Builder totpEnabled(Boolean totpEnabled)

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

Parameters:

totpEnabled - the value to set

Returns:

this builder

pushEnabled

public AuthenticationFactorSetting.Builder pushEnabled(Boolean pushEnabled)

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

Parameters:

pushEnabled - the value to set

Returns:

this builder

bypassCodeEnabled

public AuthenticationFactorSetting.Builder bypassCodeEnabled(Boolean bypassCodeEnabled)

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

Parameters:

bypassCodeEnabled - the value to set

Returns:

this builder

securityQuestionsEnabled

public AuthenticationFactorSetting.Builder securityQuestionsEnabled(Boolean securityQuestionsEnabled)

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

Parameters:

securityQuestionsEnabled - the value to set

Returns:

this builder

fidoAuthenticatorEnabled

public AuthenticationFactorSetting.Builder fidoAuthenticatorEnabled(Boolean fidoAuthenticatorEnabled)

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

Parameters:

fidoAuthenticatorEnabled - the value to set

Returns:

this builder

yubicoOtpEnabled

public AuthenticationFactorSetting.Builder yubicoOtpEnabled(Boolean yubicoOtpEnabled)

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

Parameters:

yubicoOtpEnabled - the value to set

Returns:

this builder

mfaEnrollmentType

public AuthenticationFactorSetting.Builder mfaEnrollmentType(String mfaEnrollmentType)

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

Parameters:

mfaEnrollmentType - the value to set

Returns:

this builder

mfaEnabledCategory

public AuthenticationFactorSetting.Builder mfaEnabledCategory(String mfaEnabledCategory)

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

Parameters:

mfaEnabledCategory - the value to set

Returns:

this builder

hideBackupFactorEnabled

public AuthenticationFactorSetting.Builder hideBackupFactorEnabled(Boolean hideBackupFactorEnabled)

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

Parameters:

hideBackupFactorEnabled - the value to set

Returns:

this builder

autoEnrollEmailFactorDisabled

public AuthenticationFactorSetting.Builder autoEnrollEmailFactorDisabled(Boolean autoEnrollEmailFactorDisabled)

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

Parameters:

autoEnrollEmailFactorDisabled - the value to set

Returns:

this builder

userEnrollmentDisabledFactors

public AuthenticationFactorSetting.Builder userEnrollmentDisabledFactors(List<AuthenticationFactorSetting.UserEnrollmentDisabledFactors> userEnrollmentDisabledFactors)

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

Parameters:

userEnrollmentDisabledFactors - the value to set

Returns:

this builder

emailSettings

public AuthenticationFactorSetting.Builder emailSettings(AuthenticationFactorSettingsEmailSettings emailSettings)

thirdPartyFactor

public AuthenticationFactorSetting.Builder thirdPartyFactor(AuthenticationFactorSettingsThirdPartyFactor thirdPartyFactor)

notificationSettings

public AuthenticationFactorSetting.Builder notificationSettings(AuthenticationFactorSettingsNotificationSettings notificationSettings)

identityStoreSettings

public AuthenticationFactorSetting.Builder identityStoreSettings(AuthenticationFactorSettingsIdentityStoreSettings identityStoreSettings)

bypassCodeSettings

public AuthenticationFactorSetting.Builder bypassCodeSettings(AuthenticationFactorSettingsBypassCodeSettings bypassCodeSettings)

clientAppSettings

public AuthenticationFactorSetting.Builder clientAppSettings(AuthenticationFactorSettingsClientAppSettings clientAppSettings)

endpointRestrictions

public AuthenticationFactorSetting.Builder endpointRestrictions(AuthenticationFactorSettingsEndpointRestrictions endpointRestrictions)

compliancePolicy

public AuthenticationFactorSetting.Builder compliancePolicy(List<AuthenticationFactorSettingsCompliancePolicy> compliancePolicy)

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

Parameters:

compliancePolicy - the value to set

Returns:

this builder

totpSettings

public AuthenticationFactorSetting.Builder totpSettings(AuthenticationFactorSettingsTotpSettings totpSettings)

urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings

public AuthenticationFactorSetting.Builder urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings(ExtensionThirdPartyAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings)

urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings

public AuthenticationFactorSetting.Builder urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings(ExtensionFidoAuthenticationFactorSettings urnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings)

build

public AuthenticationFactorSetting build()

copy

public AuthenticationFactorSetting.Builder copy(AuthenticationFactorSetting model)