Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Properties

Optional bypassCodes

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

Optional devices

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

Optional loginAttempts

loginAttempts: undefined | number

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.

Optional mfaEnabledOn

mfaEnabledOn: undefined | 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

Optional mfaIgnoredApps

mfaIgnoredApps: Array<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

Optional mfaStatus

mfaStatus: MfaStatus

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

Optional preferredAuthenticationFactor

preferredAuthenticationFactor: PreferredAuthenticationFactor

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

Optional preferredAuthenticationMethod

preferredAuthenticationMethod: undefined | 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

Optional preferredDevice

preferredDevice: model.UserExtPreferredDevice

Optional preferredThirdPartyVendor

preferredThirdPartyVendor: undefined | 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

Optional trustedUserAgents

trustedUserAgents: Array<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

Functions

getDeserializedJsonObj

getJsonObj