Interface: AuthenticationResult

Defined in: src/types/interfaces/auth.interface.ts:261

Authentication result.

Remarks

Returned from authentication attempts.

Properties

did?

readonly optional did: DID

Defined in: src/types/interfaces/auth.interface.ts:278

Authenticated user's DID.

Remarks

Only present if success is true or mfaRequired is true.

---

errors?

readonly optional errors: readonly string[]

Defined in: src/types/interfaces/auth.interface.ts:311

Error messages.

Remarks

Present when success is false.

---

mfaChallenge?

readonly optional mfaChallenge: MFAChallenge

Defined in: src/types/interfaces/auth.interface.ts:303

MFA challenge details.

Remarks

Present when mfaRequired is true.

---

mfaRequired?

readonly optional mfaRequired: boolean

Defined in: src/types/interfaces/auth.interface.ts:295

Whether MFA is required to complete authentication.

Remarks

If true, client should prompt for MFA and call completeMFAChallenge with the provided challenge.

---

sessionToken?

readonly optional sessionToken: SessionToken

Defined in: src/types/interfaces/auth.interface.ts:286

Session tokens.

Remarks

Only present if success is true and MFA is not required.

---

success

readonly success: boolean

Defined in: src/types/interfaces/auth.interface.ts:270

Whether authentication succeeded.

Remarks

If true, sessionToken will be populated. If false, errors will describe the failure. If MFA is required, mfaRequired will be true.