Show / Hide Table of Contents

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.

Inheritance
object
ExtensionMfaUser
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
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.
Added In: 18.3.6
SCIM++ Properties:

  • idcsCompositeKey: [value]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none

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.
Added In: 18.3.6
SCIM++ Properties:

  • idcsCompositeKey: [value]
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none

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.
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

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.
Added In: 18.3.6
SCIM++ Properties:

  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: request
  • type: dateTime
  • uniqueness: none

MfaIgnoredApps

Declaration
[JsonProperty(PropertyName = "mfaIgnoredApps")]
public List<string> MfaIgnoredApps { get; set; }
Property Value
Type Description
List<string>

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

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.
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

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.
Added In: 18.3.6
SCIM++ Properties:

  • caseExact: true
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

PreferredAuthenticationMethod

Declaration
[JsonProperty(PropertyName = "preferredAuthenticationMethod")]
public string PreferredAuthenticationMethod { get; set; }
Property Value
Type Description
string

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

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.
Added In: 19.2.1
SCIM++ Properties:

  • caseExact: true
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

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.
Added In: 18.3.6
SCIM++ Properties:

  • idcsCompositeKey: [value]
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none
In this article
Back to top