Document the login name during the login flow

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
This commit is contained in:
Morris Jobke
2018-07-03 14:20:44 +02:00
parent ee62034b48
commit 63ec9c90f5

View File

@@ -44,10 +44,10 @@ On the final login the server will do a redirect to a url of the following forma
.. code::
nc://login/server:<server>&user:<username>&password:<password>
nc://login/server:<server>&user:<loginname>&password:<password>
* server: The address of the server to connect to. The server may specify a protocol (http or https). If no protocol is specified the client will assume https.
* username: The username that the client must use to login
* loginname: The username that the client must use to login. **Note:** Keep in mind that this is the loginname and could be different from the username. For example the email address could be used to login but not for generating the webdav URL. You could fetch the actual username from the OCS API endpoint ... .
* password: The password that the client must use to login and store securely
This information will be used by the client to create a new account.