Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MyAuthenticationFactorValidator

Validate any given Authentication Factor

Properties

Optional additionalAttributes

Additional attributes which will be sent as part of a push notification

*SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

authFactor

authFactor: AuthFactor

Authentication Factor which is being validated

*SCIM++ Properties:** - type: string - multiValued: false - required: true - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false

Optional compartmentOcid

compartmentOcid: undefined | string

OCI Compartment Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Optional createKmsiToken

createKmsiToken: undefined | false | true

Indicates to create kmsi token.

*SCIM++ Properties:** - type: boolean - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional createTrustedAgent

createTrustedAgent: undefined | false | true

Indicates to create trust token.

*SCIM++ Properties:** - type: boolean - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional deleteInProgress

deleteInProgress: undefined | false | true

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.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Optional deviceId

deviceId: undefined | string

Device id whose factor is being validated

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false

Optional displayName

displayName: undefined | string

Display name of the verified device

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false

Optional domainOcid

domainOcid: undefined | string

OCI Domain Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Optional id

id: undefined | 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.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Optional idcsCreatedBy

idcsCreatedBy: model.IdcsCreatedBy

Optional idcsLastModifiedBy

idcsLastModifiedBy: model.IdcsLastModifiedBy

Optional idcsLastUpgradedInRelease

idcsLastUpgradedInRelease: undefined | string

The release number when the resource was upgraded.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Optional idcsPreventedOperations

idcsPreventedOperations: Array<IdcsPreventedOperations>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

*SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Optional isAccRecEnabled

isAccRecEnabled: undefined | false | true

Flag indicates whether the factor is enrolled in account recovery. If the value is not provided or false, then it will be treated as MFA factor validation.

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Optional kmsiTokenId

kmsiTokenId: undefined | string

KMSI token resource identifier.

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional location

location: undefined | string

Location of the trusted client.

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional message

message: undefined | string

Validator message which is passed by the client. When it is a PUSH notification, it can be a rejection message.

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false

Optional meta

meta: model.Meta

Optional name

name: undefined | string

Name of the client to be trusted

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional ocid

ocid: undefined | string

Unique OCI identifier for the SCIM Resource.

*SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global

Optional otpCode

otpCode: undefined | string

The One Time Passcode which needs to be validated

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: never - uniqueness: none - idcsSensitive: encrypt - idcsSearchable: false

Optional platform

platform: undefined | string

Platform of the client to be trusted

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional policyEnabledSecondFactors

policyEnabledSecondFactors: Array<string>

Sign-On Policy dictated allowed second factors.

*SCIM++ Properties:** - type: string - multiValued: true - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional policyTrustedFrequencyMins

policyTrustedFrequencyMins: undefined | number

Sign-On Policy dictated validity duration for trusted client in Minutes.

*SCIM++ Properties:** - type: integer - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional preferenceType

preferenceType: PreferenceType

Indicates whether to user passwordless factor to be updated or mfa factor to be updated

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional requestId

requestId: undefined | string

Request ID which is being validated

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false

scenario

scenario: Scenario

Specifies whether the service is being used to enroll or validate a factor

*SCIM++ Properties:** - type: string - multiValued: false - required: true - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false

schemas

schemas: Array<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.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Optional securityQuestions

List of security questions the user has submitted to get authenticated.

*SCIM++ Properties:** - type: complex - multiValued: true - required: false - mutability: writeOnly - returned: never - uniqueness: none - idcsSearchable: false

Optional status

status: Status

Validation status returned in the response

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readOnly - returned: default - uniqueness: none - idcsSearchable: false

Optional tags

tags: Array<Tags>

A list of tags on this resource.

*SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Optional tenancyOcid

tenancyOcid: undefined | string

OCI Tenant Id (ocid) in which the resource lives.

*SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Optional thirdPartyFactor

thirdPartyFactor: model.MyAuthenticationFactorValidatorThirdPartyFactor

Optional trustedTokenId

trustedTokenId: undefined | string

Trusted token resource identifier.

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional type

type: Type

type indicating whether the flow is OIDC, SAML etc.,

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: writeOnly - returned: default - uniqueness: none

Optional updateUserPreference

updateUserPreference: undefined | false | true

Indicates whether to update user preferred mfa factor or not

*SCIM++ Properties:** - type: boolean - multiValued: false - required: false - mutability: writeOnly - returned: never - uniqueness: none

Optional userId

userId: undefined | string

User guid for whom the validation has initiated. Optional.

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false

Optional userName

userName: undefined | string

User name for whom the validation has initiated

*SCIM++ Properties:** - type: string - multiValued: false - required: false - mutability: readWrite - returned: default - uniqueness: none - idcsSearchable: false - idcsPii: true

Functions

getDeserializedJsonObj

getJsonObj