Kazv::Api::AuthenticationData Struct Reference

Used by clients to submit authentication information to the interactive-authentication API. More...

#include <auth_data.hpp>

Public Attributes
std::optional< std::string >	type
	The authentication type that the client is attempting to complete. More...
std::optional< std::string >	session
	The value of the session key given by the homeserver. More...
immer::map< std::string, JsonWrap >	authInfo
	Keys dependent on the login type. More...

Detailed Description

Used by clients to submit authentication information to the interactive-authentication API.

Member Data Documentation

authInfo

immer::map<std::string, JsonWrap> Kazv::Api::AuthenticationData::authInfo

Keys dependent on the login type.

session

std::optional<std::string> Kazv::Api::AuthenticationData::session

The value of the session key given by the homeserver.

type

std::optional<std::string> Kazv::Api::AuthenticationData::type

The authentication type that the client is attempting to complete.

May be omitted if session is given, and the client is reissuing a request which it believes has been completed out-of-band (for example, via the fallback mechanism).

---

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

• src/api/csapi/definitions/auth_data.hpp