Merge pull request #326 from Syncano/feat/groups-cheatsheet

Groups cheatsheet
Syncano · Nov 17, 2018 · ca69086 · ca69086
2 parents 3040ae7 + 05017b7
commit ca69086
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/docs/cheatsheet/web/index.html b/docs/cheatsheet/web/index.html
@@ -239,6 +239,43 @@ <h4>Catching event</h4>
       <pre data-type="socket"><code class="lang-yaml">event_handlers:
   events.socket name.email_sent:
     file: email-sent.js</code></pre>
+      <!--
+
+      ==== Groups
+
+      -->
+      <h3>Groups</h3>
+      <p>Syncano groups</p>
+      <h4>Import</h4>
+      <pre><code class="lang-js">const {groups} = new Syncano(ctx)</code></pre>
+      <h4>Groups management</h4>
+      <pre><code class="lang-js">
+// Create group
+await groups.create(name, description)
+
+//Delete group
+await groups.delete(name)
+
+//Groups list
+await groups.list()
+
+//Get group with users list
+await groups.get(name)
+      </code></pre>
+      <h4>Users management in groups</h4>
+      <pre><code class="lang-js">
+//Get group with users list
+await groups.get(name)
+
+//Get user groups
+await groups.user(userId)
+
+//Add user to group
+await groups.addUser(name, userId)
+
+//Remove user from group
+await groups.removeUser(name, userId)
+      </code></pre>
     </section>
     <!--