Kazv::Api::LogoutAllJob Class Reference

Invalidates all access tokens for a user. More...

#include <logout.hpp>

Inheritance diagram for Kazv::Api::LogoutAllJob:
Collaboration diagram for Kazv::Api::LogoutAllJob:


class  JobResponse

Public Member Functions

 LogoutAllJob (std::string serverUrl, std::string _accessToken)
 Invalidates all access tokens for a user. More...
LogoutAllJob withData (JsonWrap j) &&
LogoutAllJob withData (JsonWrap j) const &
- Public Member Functions inherited from Kazv::BaseJob
 BaseJob (std::string serverUrl, std::string requestUrl, Method method, std::string jobId, std::string token={}, ReturnType returnType=ReturnType::Json, Body body=EmptyBody{}, Query query={}, Header header={}, std::optional< FileDesc > responseFile=std::nullopt)
 ~BaseJob ()
bool shouldReturnJson () const
std::string url () const
Body requestBody () const
Header requestHeader () const
ReturnType returnType () const
Query requestQuery () const
 returns the non-encoded query as an array of pairs More...
Method requestMethod () const
Response genResponse (Response r) const
BaseJob withData (JsonWrap j) &&
BaseJob withData (JsonWrap j) const &
BaseJob withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) &&
BaseJob withQueue (std::string id, JobQueuePolicy policy=AlwaysContinue) const &
json dataJson (const std::string &key) const
std::string dataStr (const std::string &key) const
std::string jobId () const
std::optional< std::string > queueId () const
JobQueuePolicy queuePolicy () const
std::optional< FileDescresponseFile () const

Static Public Member Functions

static constexpr auto needsAuth ()
static BaseJob::Query buildQuery ()
static BaseJob::Body buildBody ()
- Static Public Member Functions inherited from Kazv::BaseJob
static bool contentTypeMatches (immer::array< std::string > expected, std::string actual)

Additional Inherited Members

- Public Types inherited from Kazv::BaseJob
enum  ReturnType { Json, File }
using Method = std::variant< Get, Post, Put, Delete >
using Body = ::Kazv::Body
using BytesBody = ::Kazv::BytesBody
using JsonBody = ::Kazv::JsonBody
using EmptyBody = ::Kazv::EmptyBody
using Header = ::Kazv::Header
using Response = ::Kazv::Response
- Static Public Attributes inherited from Kazv::BaseJob
static Get GET {}
static Post POST {}
static Put PUT {}
static Delete DELETE {}
- Protected Member Functions inherited from Kazv::BaseJob
void attachData (JsonWrap data)

Detailed Description

Invalidates all access tokens for a user.

Invalidates all access tokens for a user, so that they can no longer be used for authorization. This includes the access token that made this request. All devices for the user are also deleted. Device keys for the device are deleted alongside the device.

This endpoint does not use the User-Interactive Authentication API because User-Interactive Authentication is designed to protect against attacks where the someone gets hold of a single access token then takes over the account. This endpoint invalidates all access tokens for the user, including the token used in the request, and therefore the attacker is unable to take over the account in this way.

Constructor & Destructor Documentation

◆ LogoutAllJob()

Kazv::Api::LogoutAllJob::LogoutAllJob ( std::string  serverUrl,
std::string  _accessToken 

Invalidates all access tokens for a user.

Member Function Documentation

◆ buildBody()

BaseJob::Body Kazv::Api::LogoutAllJob::buildBody ( )

◆ buildQuery()

BaseJob::Query Kazv::Api::LogoutAllJob::buildQuery ( )

◆ needsAuth()

static constexpr auto Kazv::Api::LogoutAllJob::needsAuth ( )

◆ withData() [1/2]

LogoutAllJob Kazv::Api::LogoutAllJob::withData ( JsonWrap  j) &&

◆ withData() [2/2]

LogoutAllJob Kazv::Api::LogoutAllJob::withData ( JsonWrap  j) const &

The documentation for this class was generated from the following files: