dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1154
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2014-07-23 14:31:03 +0200
message:
  User account invite docs
modified:
  src/docbkx/en/dhis2_user_man_web_api.xml


--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs

Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription

=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml	2014-07-22 16:53:59 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-07-23 12:31:03 +0000
@@ -5142,6 +5142,18 @@
     </section>
   </section>
   <section>
+    <title>User account invitations</title>
+    <para>The Web API supports inviting people to create user accounts through the <emphasis
+        role="italic">invite</emphasis> resource. To create an invitation you shoudl POST a user in
+      XML or JSON format to the invite resource. A specific username can be forced by defining the
+      username in the posted entity. By omitting the username, the person will be able to specify it
+      herself. The system will send out an invitation through email. This requires that email
+      settings have been properly configured. The invite resource is useful in order to securely
+      allow people to create accounts without anyone else knowing the password or by transferring
+      the password in plain text. The user entity can be posted like this:</para>
+    <screen>curl -d @user.json "localhost/api/users/invite" -H "Content-Type:application/json" -u admin:district -v</screen>
+  </section>
+  <section>
     <title>Schema Resource</title>
     <para>A new resource was included in DHIS 2.15 which can be used to introspect all available DXF2 classes, this resource can be found on
         <emphasis role="italic">/api/schemas</emphasis> and for a specific resource, you can have a look at <emphasis role="italic"