Skip to content

Commit eea4b88

Browse files
committed
Explain realm permissions and custom data for tutorial
1 parent a4c7ef6 commit eea4b88

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

source/tutorial/realm-app.txt

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A. Create an Atlas account, if you don't already have one. *(3 minutes)*
2727
our pre-made Task Tracker backend. *(5 minutes)*
2828

2929
Once we've finished these steps, we can start writing code to implement
30-
a frontend using iOS, Android, or JavaScript.
30+
a frontend using Swift, Kotlin, or JavaScript.
3131

3232
.. _tutorial-task-tracker-create-an-atlas-account:
3333

@@ -321,10 +321,12 @@ import command successfully created a new app:
321321

322322
.. code-block:: console
323323

324-
Successfully imported 'tasktracker-mrksq'
324+
Successfully imported 'tasktracker-...'
325325

326-
You'll use this App ID to connect to your {+app+} in the client SDK
327-
tutorials.
326+
.. important::
327+
328+
Note down this Realm app ID ("tasktracker-..."). You'll use this Realm app ID to
329+
connect to your {+app+} in the client SDK tutorials.
328330

329331
You can also confirm that your app was created successfully by
330332
navigating to the :guilabel:`Realm` tab in the Atlas UI. You should
@@ -435,8 +437,23 @@ write a particular {+realm+}.
435437

436438
.. see::
437439

438-
To learn more about {+sync+} , see the
439-
:ref:`documentation on Sync <sync>`.
440+
To learn more about {+sync+}, see :ref:`sync`.
441+
442+
Custom User Data & Permissions
443+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
444+
445+
In {+service+}, each user can have an associated :ref:`custom data object
446+
<custom-user-data>`. We designed this app to use data stored in the user's
447+
custom data to determine permissions -- that is, whether that user can read or
448+
write a given realm or set of data, such as a project. While {+service-short+}
449+
allows clients to read and write data depending on how you configure your app
450+
permissions, we configured this app so that only :ref:`system functions
451+
<system-functions>` running on the backend can modify a user's custom data
452+
object. This prevents clients from arbitrarily granting themselves permissions.
453+
454+
.. see::
455+
456+
To learn more about custom user data, see :ref:`custom-user-data`.
440457

441458
Functions
442459
~~~~~~~~~

0 commit comments

Comments
 (0)