Identity Hub API, REST: MfaEnforcement.Get

Field

Description

mfaEnforcementId

string

Required field. id of the MFA enforcement

The maximum string length in characters is 50.

Field

Description

id

string

id of the MFA enforcement

organizationId

string

organization id of the MFA enforcement

acrId

string

acr id of the MFA enforcement

ttl

string (duration)

the period during which the entered MFA factor is considered valid and the
corresponding acr is regarded as satisfied

status

enum (MfaEnforcementStatus)

MFA enforcement status

• MFA_ENFORCEMENT_STATUS_ACTIVE
• MFA_ENFORCEMENT_STATUS_INACTIVE
• MFA_ENFORCEMENT_STATUS_DELETING

applyAt

string (date-time)

the MFA enforcement application start time.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

enrollWindow

string (duration)

the time window during which the user is allowed to create an MFA profile.
this window is measured relative to the MFA enforcement application start time
and the user's most recent successful authentication that falls under the rule
(or the user's creation time, if there has been no authentication).

name

string

name of the MFA enforcement

description

string

description of the MFA enforcement

createdAt

string (date-time)

creation timestamp

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).