Class ExtensionMfaUser
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.
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class ExtensionMfaUser
Properties
BypassCodes
Declaration
[JsonProperty(PropertyName = "bypassCodes")]
public List<UserExtBypassCodes> BypassCodes { get; set; }
Property Value
Type | Description |
---|---|
List<UserExtBypassCodes> | A list of bypass codes that belongs to the user.
|
Devices
Declaration
[JsonProperty(PropertyName = "devices")]
public List<UserExtDevices> Devices { get; set; }
Property Value
Type | Description |
---|---|
List<UserExtDevices> | A list of devices enrolled by the user.
|
LoginAttempts
Declaration
[JsonProperty(PropertyName = "loginAttempts")]
public int? LoginAttempts { get; set; }
Property Value
Type | Description |
---|---|
int? | 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.
|
MfaEnabledOn
Declaration
[JsonProperty(PropertyName = "mfaEnabledOn")]
public string MfaEnabledOn { get; set; }
Property Value
Type | Description |
---|---|
string | The date when the user enrolled in multi factor authentication. This will be set to null, when the user resets their factors.
|
MfaIgnoredApps
Declaration
[JsonProperty(PropertyName = "mfaIgnoredApps")]
public List<string> MfaIgnoredApps { get; set; }
Property Value
Type | Description |
---|---|
List<string> | User MFA Ignored Apps Identifiers
|
MfaStatus
Declaration
[JsonProperty(PropertyName = "mfaStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ExtensionMfaUser.MfaStatusEnum? MfaStatus { get; set; }
Property Value
Type | Description |
---|---|
ExtensionMfaUser.MfaStatusEnum? | The user opted for MFA.
|
PreferredAuthenticationFactor
Declaration
[JsonProperty(PropertyName = "preferredAuthenticationFactor")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ExtensionMfaUser.PreferredAuthenticationFactorEnum? PreferredAuthenticationFactor { get; set; }
Property Value
Type | Description |
---|---|
ExtensionMfaUser.PreferredAuthenticationFactorEnum? | The preferred authentication factor type.
|
PreferredAuthenticationMethod
Declaration
[JsonProperty(PropertyName = "preferredAuthenticationMethod")]
public string PreferredAuthenticationMethod { get; set; }
Property Value
Type | Description |
---|---|
string | The preferred authentication method.
|
PreferredDevice
Declaration
[JsonProperty(PropertyName = "preferredDevice")]
public UserExtPreferredDevice PreferredDevice { get; set; }
Property Value
Type | Description |
---|---|
UserExtPreferredDevice |
PreferredThirdPartyVendor
Declaration
[JsonProperty(PropertyName = "preferredThirdPartyVendor")]
public string PreferredThirdPartyVendor { get; set; }
Property Value
Type | Description |
---|---|
string | The preferred third-party vendor name.
|
TrustedUserAgents
Declaration
[JsonProperty(PropertyName = "trustedUserAgents")]
public List<UserExtTrustedUserAgents> TrustedUserAgents { get; set; }
Property Value
Type | Description |
---|---|
List<UserExtTrustedUserAgents> | 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.
|