@type t() :: %MscmpSystAuthn.Types.AuthenticationState{
  access_account_id: MscmpSystAuthn.Types.access_account_id() | nil,
  applied_network_rule: MscmpSystAuthn.Types.AppliedNetworkRule.t() | nil,
  deadline: DateTime.t(),
  host_address: MscmpSystAuthn.Types.host_address(),
  identifier: MscmpSystAuthn.Types.account_identifier(),
  identity: Msdata.SystIdentities.t() | nil,
  identity_id: MscmpSystAuthn.Types.identity_id() | nil,
  identity_type_id: MscmpSystAuthn.Types.identity_type_id() | nil,
  instance_id: MscmpSystInstance.Types.instance_id() | :bypass | nil,
  owning_owner_id: MscmpSystInstance.Types.owner_id() | nil,
  pending_operations: [MscmpSystAuthn.Types.authentication_operations()],
  plaintext_credential: MscmpSystAuthn.Types.credential() | nil,
  reset_reason: MscmpSystAuthn.Types.credential_reset_reason() | nil,
  status: MscmpSystAuthn.Types.authentication_status()
}

The return type describing the result of authentication attempts via the authentication functions.

Attributes

• status - the result of the authentication attempt.

• deadline - the date/time by which the authentication attempt must be resolved by before being considered expired. Since the authentication process may be interrupted and resumed, it requires that we establish some limit by which the process must be completed. By default this value will be 5 minutes after the time the authentication process starts.

• access_account_id - the Access Account record ID if the authentication attempt has successfully completed the identification operation.

• instance_id - the Instance ID that the Access Account holder is attempting to authenticate to. For certain authentication types, this value may initially be nil for later resolution to a specific instance. In some special cases, authentication may not be contextually bound to a specific Instance. In this cases, the special value :bypass can be used it indicate that the Instance is not relevant for the authentication.

• identity_type_id - the record ID referencing the Identity Type used to identify the Access Account.

• host_address - the apparent Host IP Address from which the authentication attempt originated.

• applied_network_rule - the Network Rule that was applied during the authentication attempt. This value may be nil if the evaluation of the Network Rules has not yet made.

• pending_operations - the ordered list of remaining authentication operations which must complete successfully prior to the authentication being successfully completed.

• identifier - the user supplied account identifier used to identify the Access Account.

• plaintext_credential - the unencrypted, user supplied credential to test during the authentication process. This value will be made nil as soon as it has been tested or is created nil for the Account Code Authenticator which isn't a true authentication method (it's just a lookup).

• owning_owner_id - an Owner record ID for the Owner which manages the authenticating Access Account in cases where it's an Owned Access Account.

• identity_id - the record ID of the Identity record located to identify the Access Account.

• identity - the Identity record data struct. This should be the same record as that identified by the identity_id attribute

• reset_reason - in cases where a pending operation of :require_credential_reset is added to the authentication process, this value indicates the reason for the reset. Available values are defined in t:credential_reset_reason/0.

See MscmpSystAuthn.Types.AuthenticationState for more.