aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/logout.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/logout.h')
-rw-r--r--lib/csapi/logout.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/csapi/logout.h b/lib/csapi/logout.h
index 2a705620..e9a7ef89 100644
--- a/lib/csapi/logout.h
+++ b/lib/csapi/logout.h
@@ -8,12 +8,11 @@
namespace Quotient {
-// Operations
-
/*! \brief Invalidates a user access token
*
* Invalidates an existing access token, so that it can no longer be used for
- * authorization.
+ * authorization. The device associated with the access token is also deleted.
+ * `Device keys <#device-keys>`_ for the device are deleted alongside the device.
*/
class LogoutJob : public BaseJob {
public:
@@ -31,7 +30,9 @@ public:
/*! \brief 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.
+ * for authorization. This includes the access token that made this request. All
+ * devices for the user are also deleted. `Device keys <#device-keys>`_ for the
+ * device are deleted alongside the device.
*
* This endpoint does not require UI authorization because UI authorization is
* designed to protect against attacks where the someone gets hold of a single