Skip to content

Commit 437b74c

Browse files
Merge pull request #10449 from nextcloud/backport/10435/stable27
[stable27] Add a note about encoding in login flow
2 parents cee45c3 + bc75bdb commit 437b74c

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

  • developer_manual/client_apis/LoginFlow

developer_manual/client_apis/LoginFlow/index.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,13 @@ On the final login the server will do a redirect to a url of the following forma
4848
4949
nc://login/server:<server>&user:<loginname>&password:<password>
5050
51-
* 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.
52-
* 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 :code:`<server>/ocs/v1.php/cloud/user`.
53-
* password: The password that the client must use to login and store securely
51+
* ``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.
52+
* ``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 ``<server>/ocs/v1.php/cloud/user``.
53+
* ``password``: The password that the client must use to login and store securely
54+
55+
.. note::
56+
57+
``loginname`` and ``password`` are encoded by PHP's `urlencode <https://www.php.net/manual/en/function.urlencode.php>`_, which differs from `RFC 3986 <http://www.faqs.org/rfcs/rfc3986.html>`_. You may need to replace plus signs :code:`'+'` with spaces :code:`' '` before decoding.
5458

5559
This information will be used by the client to create a new account.
5660
After this the webview is destroyed including all the state the webview holds.

0 commit comments

Comments
 (0)