aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/logout.h
blob: 4bbb852688bd6da11feee010658f56b6a4bc78f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

namespace QMatrixClient {
    // Operations

    /// Invalidates a user access token
    ///
    /// Invalidates an existing access token, so that it can no longer be used
    /// for authorization.
    class LogoutJob : public BaseJob
    {
        public:
        explicit LogoutJob();

        /*! Construct a URL without creating a full-fledged job object
         *
         * This function can be used when a URL for
         * LogoutJob is necessary but the job
         * itself isn't.
         */
        static QUrl makeRequestUrl(QUrl baseUrl);
    };

    /// 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.
    ///
    /// This endpoint does not require UI authorization because UI authorization
    /// 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.
    class LogoutAllJob : public BaseJob
    {
        public:
        explicit LogoutAllJob();

        /*! Construct a URL without creating a full-fledged job object
         *
         * This function can be used when a URL for
         * LogoutAllJob is necessary but the job
         * itself isn't.
         */
        static QUrl makeRequestUrl(QUrl baseUrl);
    };
} // namespace QMatrixClient