Class AuthenticationFactorSetting
Multi Factor Authentication Settings for Tenant
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class AuthenticationFactorSettingProperties
AutoEnrollEmailFactorDisabled
Declaration
[JsonProperty(PropertyName = "autoEnrollEmailFactorDisabled")]
public bool? AutoEnrollEmailFactorDisabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that email will not be enrolled as a MFA factor automatically if it a account recovery factor
|
BypassCodeEnabled
Declaration
[Required(ErrorMessage = "BypassCodeEnabled is required.")]
[JsonProperty(PropertyName = "bypassCodeEnabled")]
public bool? BypassCodeEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that Bypass Code is enabled for authentication
|
Remarks
Required
BypassCodeSettings
Declaration
[Required(ErrorMessage = "BypassCodeSettings is required.")]
[JsonProperty(PropertyName = "bypassCodeSettings")]
public AuthenticationFactorSettingsBypassCodeSettings BypassCodeSettings { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsBypassCodeSettings |
Remarks
Required
ClientAppSettings
Declaration
[Required(ErrorMessage = "ClientAppSettings is required.")]
[JsonProperty(PropertyName = "clientAppSettings")]
public AuthenticationFactorSettingsClientAppSettings ClientAppSettings { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsClientAppSettings |
Remarks
Required
CompartmentOcid
Declaration
[JsonProperty(PropertyName = "compartmentOcid")]
public string CompartmentOcid { get; set; }Property Value
| Type | Description |
|---|---|
| string | OCI Compartment Id (ocid) in which the resource lives.
|
CompliancePolicy
Declaration
[Required(ErrorMessage = "CompliancePolicy is required.")]
[JsonProperty(PropertyName = "compliancePolicy")]
public List<AuthenticationFactorSettingsCompliancePolicy> CompliancePolicy { get; set; }Property Value
| Type | Description |
|---|---|
| List<AuthenticationFactorSettingsCompliancePolicy> | Compliance Policy that defines actions to be taken when a condition is violated
|
Remarks
Required
DeleteInProgress
Declaration
[JsonProperty(PropertyName = "deleteInProgress")]
public bool? DeleteInProgress { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | 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.
|
DomainOcid
Declaration
[JsonProperty(PropertyName = "domainOcid")]
public string DomainOcid { get; set; }Property Value
| Type | Description |
|---|---|
| string | OCI Domain Id (ocid) in which the resource lives.
|
EmailEnabled
Declaration
[JsonProperty(PropertyName = "emailEnabled")]
public bool? EmailEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the EMAIL channel is enabled for authentication
|
EmailSettings
Declaration
[JsonProperty(PropertyName = "emailSettings")]
public AuthenticationFactorSettingsEmailSettings EmailSettings { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsEmailSettings |
EndpointRestrictions
Declaration
[Required(ErrorMessage = "EndpointRestrictions is required.")]
[JsonProperty(PropertyName = "endpointRestrictions")]
public AuthenticationFactorSettingsEndpointRestrictions EndpointRestrictions { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsEndpointRestrictions |
Remarks
Required
FidoAuthenticatorEnabled
Declaration
[JsonProperty(PropertyName = "fidoAuthenticatorEnabled")]
public bool? FidoAuthenticatorEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the Fido Authenticator channels are enabled for authentication
|
HideBackupFactorEnabled
Declaration
[JsonProperty(PropertyName = "hideBackupFactorEnabled")]
public bool? HideBackupFactorEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that 'Show backup factor(s)' button will be hidden during authentication
|
Id
Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }Property Value
| Type | Description |
|---|---|
| string | 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.
|
IdcsCreatedBy
Declaration
[JsonProperty(PropertyName = "idcsCreatedBy")]
public IdcsCreatedBy IdcsCreatedBy { get; set; }Property Value
| Type | Description |
|---|---|
| IdcsCreatedBy |
IdcsLastModifiedBy
Declaration
[JsonProperty(PropertyName = "idcsLastModifiedBy")]
public IdcsLastModifiedBy IdcsLastModifiedBy { get; set; }Property Value
| Type | Description |
|---|---|
| IdcsLastModifiedBy |
IdcsLastUpgradedInRelease
Declaration
[JsonProperty(PropertyName = "idcsLastUpgradedInRelease")]
public string IdcsLastUpgradedInRelease { get; set; }Property Value
| Type | Description |
|---|---|
| string | The release number when the resource was upgraded.
|
IdcsPreventedOperations
Declaration
[JsonProperty(PropertyName = "idcsPreventedOperations", ItemConverterType = typeof(ResponseEnumConverter))]
public List<IdcsPreventedOperations> IdcsPreventedOperations { get; set; }Property Value
| Type | Description |
|---|---|
| List<IdcsPreventedOperations> | Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
|
IdentityStoreSettings
Declaration
[JsonProperty(PropertyName = "identityStoreSettings")]
public AuthenticationFactorSettingsIdentityStoreSettings IdentityStoreSettings { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsIdentityStoreSettings |
Meta
Declaration
[JsonProperty(PropertyName = "meta")]
public Meta Meta { get; set; }Property Value
| Type | Description |
|---|---|
| Meta |
MfaEnabledCategory
Declaration
[JsonProperty(PropertyName = "mfaEnabledCategory")]
public string MfaEnabledCategory { get; set; }Property Value
| Type | Description |
|---|---|
| string | 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
|
MfaEnrollmentType
Declaration
[Required(ErrorMessage = "MfaEnrollmentType is required.")]
[JsonProperty(PropertyName = "mfaEnrollmentType")]
public string MfaEnrollmentType { get; set; }Property Value
| Type | Description |
|---|---|
| string | Specifies if Multi-Factor Authentication enrollment is mandatory or optional for a user
|
Remarks
Required
NotificationSettings
Declaration
[Required(ErrorMessage = "NotificationSettings is required.")]
[JsonProperty(PropertyName = "notificationSettings")]
public AuthenticationFactorSettingsNotificationSettings NotificationSettings { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsNotificationSettings |
Remarks
Required
Ocid
Declaration
[JsonProperty(PropertyName = "ocid")]
public string Ocid { get; set; }Property Value
| Type | Description |
|---|---|
| string | Unique OCI identifier for the SCIM Resource.
|
PhoneCallEnabled
Declaration
[JsonProperty(PropertyName = "phoneCallEnabled")]
public bool? PhoneCallEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the phone (PHONE_CALL) channel is enabled for authentication
|
PushEnabled
Declaration
[Required(ErrorMessage = "PushEnabled is required.")]
[JsonProperty(PropertyName = "pushEnabled")]
public bool? PushEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the Mobile App Push Notification channel is enabled for authentication
|
Remarks
Required
Schemas
Declaration
[Required(ErrorMessage = "Schemas is required.")]
[JsonProperty(PropertyName = "schemas")]
public List<string> Schemas { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | 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.
|
Remarks
Required
SecurityQuestionsEnabled
Declaration
[Required(ErrorMessage = "SecurityQuestionsEnabled is required.")]
[JsonProperty(PropertyName = "securityQuestionsEnabled")]
public bool? SecurityQuestionsEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that Security Questions are enabled for authentication
|
Remarks
Required
SmsEnabled
Declaration
[Required(ErrorMessage = "SmsEnabled is required.")]
[JsonProperty(PropertyName = "smsEnabled")]
public bool? SmsEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the Short Message Service (SMS) channel is enabled for authentication
|
Remarks
Required
Tags
Declaration
[JsonProperty(PropertyName = "tags")]
public List<Tags> Tags { get; set; }Property Value
| Type | Description |
|---|---|
| List<Tags> | A list of tags on this resource.
|
TenancyOcid
Declaration
[JsonProperty(PropertyName = "tenancyOcid")]
public string TenancyOcid { get; set; }Property Value
| Type | Description |
|---|---|
| string | OCI Tenant Id (ocid) in which the resource lives.
|
ThirdPartyFactor
Declaration
[JsonProperty(PropertyName = "thirdPartyFactor")]
public AuthenticationFactorSettingsThirdPartyFactor ThirdPartyFactor { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsThirdPartyFactor |
TotpEnabled
Declaration
[Required(ErrorMessage = "TotpEnabled is required.")]
[JsonProperty(PropertyName = "totpEnabled")]
public bool? TotpEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the Mobile App One Time Passcode channel is enabled for authentication
|
Remarks
Required
TotpSettings
Declaration
[Required(ErrorMessage = "TotpSettings is required.")]
[JsonProperty(PropertyName = "totpSettings")]
public AuthenticationFactorSettingsTotpSettings TotpSettings { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsTotpSettings |
Remarks
Required
UrnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings
Declaration
[JsonProperty(PropertyName = "urn:ietf:params:scim:schemas:oracle:idcs:extension:fido:AuthenticationFactorSettings")]
public ExtensionFidoAuthenticationFactorSettings UrnIetfParamsScimSchemasOracleIdcsExtensionFidoAuthenticationFactorSettings { get; set; }Property Value
| Type | Description |
|---|---|
| ExtensionFidoAuthenticationFactorSettings |
UrnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings
Declaration
[JsonProperty(PropertyName = "urn:ietf:params:scim:schemas:oracle:idcs:extension:thirdParty:AuthenticationFactorSettings")]
public ExtensionThirdPartyAuthenticationFactorSettings UrnIetfParamsScimSchemasOracleIdcsExtensionThirdPartyAuthenticationFactorSettings { get; set; }Property Value
| Type | Description |
|---|---|
| ExtensionThirdPartyAuthenticationFactorSettings |
UserEnrollmentDisabledFactors
Declaration
[JsonProperty(PropertyName = "userEnrollmentDisabledFactors", ItemConverterType = typeof(ResponseEnumConverter))]
public List<AuthenticationFactorSetting.UserEnrollmentDisabledFactorsEnum> UserEnrollmentDisabledFactors { get; set; }Property Value
| Type | Description |
|---|---|
| List<AuthenticationFactorSetting.UserEnrollmentDisabledFactorsEnum> | Factors for which enrollment should be blocked for End User
|
YubicoOtpEnabled
Declaration
[JsonProperty(PropertyName = "yubicoOtpEnabled")]
public bool? YubicoOtpEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | If true, indicates that the Yubico OTP is enabled for authentication
|