wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clarify that soft logout is about client state

Browse source
This commit is contained in:
Travis Ralston 2020-05-19 08:05:47 -06:00
parent 19cac03305
commit 77d83b9ce5
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
specification/client_server_api.rst
View file

@ -412,17 +412,17 @@ Soft logout
~~~~~~~~~~~ ~~~~~~~~~~~
When a request fails due to a 401 status code per above, the server can When a request fails due to a 401 status code per above, the server can
include an extra response parameter, ``soft_logout``, to indicate if the include an extra response parameter, ``soft_logout``, to indicate if the client's
device information has been retained by the server. This defaults to ``false``, persisted information can be retained. This defaults to ``false``, indicating
implying the server has deleted the device alongside the access token. that the server has destroyed the session. Any persisted state held by the client,
such as encryption keys and device information, will not be able to be reused.
When ``soft_logout`` is true, the client can acquire a new access token by When ``soft_logout`` is true, the client can acquire a new access token by
specifying the device ID it is already using to the login API. In most cases specifying the device ID it is already using to the login API. In most cases
a ``soft_logout: true`` response indicates that the user's session has expired a ``soft_logout: true`` response indicates that the user's session has expired
on the server-side and the user simply needs to provide their credentials again. on the server-side and the user simply needs to provide their credentials again.
If ``soft_logout`` is ``false``, the client will not be able to reuse the device In either case, the client's previously known access token will no longer function.
information it already has - the server has destroyed the session.
User-Interactive Authentication API User-Interactive Authentication API
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~