Package com.oracle.bmc.identitydomains.model

Class ExtensionMfaUser

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identitydomains.model.ExtensionMfaUser

@Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class ExtensionMfaUser
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

This extension defines attributes used to manage Multi-Factor Authentication within a service provider.

The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA.
Note: Objects should always be created or deserialized using the ExtensionMfaUser.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 ExtensionMfaUser.Builder, which maintain a set of all explicitly set fields called ExtensionMfaUser.Builder.__explicitlySet__. The hashCode() and equals(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	ExtensionMfaUser.Builder
static class	ExtensionMfaUser.MfaStatus	The user opted for MFA.
static class	ExtensionMfaUser.PreferredAuthenticationFactor	The preferred authentication factor type.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

ExtensionMfaUser(ExtensionMfaUser.PreferredAuthenticationFactor preferredAuthenticationFactor, ExtensionMfaUser.MfaStatus mfaStatus, String preferredThirdPartyVendor, String preferredAuthenticationMethod, Integer loginAttempts, String mfaEnabledOn, List<String> mfaIgnoredApps, UserExtPreferredDevice preferredDevice, List<UserExtDevices> devices, List<UserExtBypassCodes> bypassCodes, List<UserExtTrustedUserAgents> trustedUserAgents)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static ExtensionMfaUser.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<UserExtBypassCodes>	getBypassCodes()	A list of bypass codes that belongs to the user.
List<UserExtDevices>	getDevices()	A list of devices enrolled by the user.
Integer	getLoginAttempts()	The number of incorrect multi factor authentication sign in attempts made by this user.
String	getMfaEnabledOn()	The date when the user enrolled in multi factor authentication.
List<String>	getMfaIgnoredApps()	User MFA Ignored Apps Identifiers
ExtensionMfaUser.MfaStatus	getMfaStatus()	The user opted for MFA.
ExtensionMfaUser.PreferredAuthenticationFactor	getPreferredAuthenticationFactor()	The preferred authentication factor type.
String	getPreferredAuthenticationMethod()	The preferred authentication method.
UserExtPreferredDevice	getPreferredDevice()
String	getPreferredThirdPartyVendor()	The preferred third-party vendor name.
List<UserExtTrustedUserAgents>	getTrustedUserAgents()	A list of trusted User Agents owned by this user.
int	hashCode()
ExtensionMfaUser.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtensionMfaUser

@Deprecated
@ConstructorProperties({"preferredAuthenticationFactor","mfaStatus","preferredThirdPartyVendor","preferredAuthenticationMethod","loginAttempts","mfaEnabledOn","mfaIgnoredApps","preferredDevice","devices","bypassCodes","trustedUserAgents"})
public ExtensionMfaUser(ExtensionMfaUser.PreferredAuthenticationFactor preferredAuthenticationFactor,
                        ExtensionMfaUser.MfaStatus mfaStatus,
                        String preferredThirdPartyVendor,
                        String preferredAuthenticationMethod,
                        Integer loginAttempts,
                        String mfaEnabledOn,
                        List<String> mfaIgnoredApps,
                        UserExtPreferredDevice preferredDevice,
                        List<UserExtDevices> devices,
                        List<UserExtBypassCodes> bypassCodes,
                        List<UserExtTrustedUserAgents> trustedUserAgents)

Deprecated.

Method Detail

builder

public static ExtensionMfaUser.Builder builder()

Create a new builder.

toBuilder

public ExtensionMfaUser.Builder toBuilder()

getPreferredAuthenticationFactor

public ExtensionMfaUser.PreferredAuthenticationFactor getPreferredAuthenticationFactor()

The preferred authentication factor type.

*Added In:** 18.3.6

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getMfaStatus

public ExtensionMfaUser.MfaStatus getMfaStatus()

The user opted for MFA.

*Added In:** 18.3.6

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getPreferredThirdPartyVendor

public String getPreferredThirdPartyVendor()

The preferred third-party vendor name.

*Added In:** 19.2.1

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getPreferredAuthenticationMethod

public String getPreferredAuthenticationMethod()

The preferred authentication method.

*Added In:** 2009232244

*SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getLoginAttempts

public Integer getLoginAttempts()

The number of incorrect multi factor authentication sign in attempts made by this user.

The user is locked if this reaches the threshold specified in the maxIncorrectAttempts attribute in AuthenticationFactorSettings.

*Added In:** 18.3.6

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readOnly - idcsRequiresWriteForAccessFlows: true - idcsRequiresImmediateReadAfterWriteForAccessFlows: true - required: false - returned: default - type: integer - uniqueness: none

Returns:

the value

getMfaEnabledOn

public String getMfaEnabledOn()

The date when the user enrolled in multi factor authentication.

This will be set to null, when the user resets their factors.

*Added In:** 18.3.6

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: request - type: dateTime - uniqueness: none

Returns:

the value

getMfaIgnoredApps

public List<String> getMfaIgnoredApps()

User MFA Ignored Apps Identifiers

*Added In:** 19.2.1

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

the value

getPreferredDevice

public UserExtPreferredDevice getPreferredDevice()

getDevices

public List<UserExtDevices> getDevices()

A list of devices enrolled by the user.

*Added In:** 18.3.6

*SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

Returns:

the value

getBypassCodes

public List<UserExtBypassCodes> getBypassCodes()

A list of bypass codes that belongs to the user.

*Added In:** 18.3.6

*SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

Returns:

the value

getTrustedUserAgents

public List<UserExtTrustedUserAgents> getTrustedUserAgents()

A list of trusted User Agents owned by this user.

Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way.

*Added In:** 18.3.6

*SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.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 class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel