/password: formalise 'default' for logout_devices

This commit is contained in:
Alexey Rusakov 2021-06-22 17:54:58 +02:00
parent 7abdd45c06
commit 92db4e20da

View file

@ -352,9 +352,10 @@ paths:
example: "ihatebananas" example: "ihatebananas"
logout_devices: logout_devices:
type: boolean type: boolean
default: true
description: |- description: |-
Whether the user's other access tokens, and their associated devices, should be Whether the user's other access tokens, and their associated devices, should be
revoked if the request succeeds. Defaults to true. revoked if the request succeeds.
When `false`, the server can still take advantage of the [soft logout method](/client-server-api/#soft-logout) When `false`, the server can still take advantage of the [soft logout method](/client-server-api/#soft-logout)
for the user's remaining devices. for the user's remaining devices.