/** * Identity Domains API * Use the Identity Domains API to manage resources within an identity domain, for example, users, dynamic resource groups, groups, and identity providers. For information about managing resources within identity domains, see [Identity and Access Management (with identity domains)](https://docs.oracle.com/iaas/Content/Identity/home.htm). Use this pattern to construct endpoints for identity domains: {@code https:///admin/v1/}. See [Finding an Identity Domain URL](https://docs.oracle.com/en-us/iaas/Content/Identity/api-getstarted/locate-identity-domain-url.htm) to locate the domain URL you need. Use the table of contents and search tool to explore the Identity Domains API. * OpenAPI spec version: v1 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * 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. */ export interface ExtensionMfaUser { /** * 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 */ "preferredAuthenticationFactor"?: ExtensionMfaUser.PreferredAuthenticationFactor; /** * 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 */ "mfaStatus"?: ExtensionMfaUser.MfaStatus; /** * 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 */ "preferredThirdPartyVendor"?: 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 */ "preferredAuthenticationMethod"?: string; /** * 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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "loginAttempts"?: number; /** * 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 */ "mfaEnabledOn"?: 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 */ "mfaIgnoredApps"?: Array; "preferredDevice"?: model.UserExtPreferredDevice; /** * 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 */ "devices"?: Array; /** * 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 */ "bypassCodes"?: Array; /** * 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 */ "trustedUserAgents"?: Array; } export declare namespace ExtensionMfaUser { enum PreferredAuthenticationFactor { Email = "EMAIL", Sms = "SMS", Totp = "TOTP", Push = "PUSH", Offlinetotp = "OFFLINETOTP", UsernamePassword = "USERNAME_PASSWORD", SecurityQuestions = "SECURITY_QUESTIONS", Voice = "VOICE", PhoneCall = "PHONE_CALL", Thirdparty = "THIRDPARTY", FidoAuthenticator = "FIDO_AUTHENTICATOR", YubicoOtp = "YUBICO_OTP", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum MfaStatus { Enrolled = "ENROLLED", Ignored = "IGNORED", UnEnrolled = "UN_ENROLLED", Disabled = "DISABLED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: ExtensionMfaUser): object; function getDeserializedJsonObj(obj: ExtensionMfaUser): object; }