axiam::LoginResult Struct Reference

Result of login / verify_mfa. More...

#include <types.hpp>

Public Attributes
bool	mfa_required = false
std::optional< UserInfo >	user
std::string	session_id
std::int64_t	expires_in = 0
Sensitive< std::string >	challenge_token
	Short-lived MFA challenge token.
std::vector< std::string >	available_methods

Detailed Description

Result of login / verify_mfa.

mfa_required distinguishes the 202 challenge branch (challenge_token + available_methods populated) from the 200 success branch (user + session_id + expires_in populated).

Member Data Documentation

mfa_required

bool axiam::LoginResult::mfa_required = false

user

std::optional<UserInfo> axiam::LoginResult::user

session_id

std::string axiam::LoginResult::session_id

expires_in

std::int64_t axiam::LoginResult::expires_in = 0

challenge_token

Sensitive<std::string> axiam::LoginResult::challenge_token

Short-lived MFA challenge token.

§7 classes this as secret material, so it is wrapped: it never appears in a log line, stream insertion or to_string(). Pass it straight back to Client::verify_mfa(), which takes the wrapper.

available_methods

std::vector<std::string> axiam::LoginResult::available_methods

---

The documentation for this struct was generated from the following file:

• include/axiam/types.hpp