document users API

1 files changed, 128 insertions, 0 deletions

diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
new file mode 100644
index 0000000..dfcfe73
--- /dev/null
+++ b/docs/gl_objects/users.rst
@@ -0,0 +1,128 @@
+#####
+Users
+#####
+
+Use :class:`User` objects to manipulate repository branches.
+
+To create :class:`User` objects use the :class:`Gitlab.users` manager.
+
+Examples
+========
+
+Get the list of users:
+
+.. literalinclude:: users.py
+   :start-after: # list
+   :end-before: # end list
+
+Search users whose username match the given string:
+
+.. literalinclude:: users.py
+   :start-after: # search
+   :end-before: # end search
+
+Get a single user:
+
+.. literalinclude:: users.py
+   :start-after: # get
+   :end-before: # end get
+
+Create a user:
+
+.. literalinclude:: users.py
+   :start-after: # create
+   :end-before: # end create
+
+Update a user:
+
+.. literalinclude:: users.py
+   :start-after: # update
+   :end-before: # end update
+
+Delete a user:
+
+.. literalinclude:: users.py
+   :start-after: # delete
+   :end-before: # end delete
+
+Block/Unblock a user:
+
+.. literalinclude:: users.py
+   :start-after: # block
+   :end-before: # end block
+
+SSH keys
+========
+
+Use the :class:`UserKey` objects to manage user keys.
+
+To create :class:`UserKey` objects use the :class:`User.keys` or
+:class:`Gitlab.user_keys` managers.
+
+Exemples
+--------
+
+List SSH keys for a user:
+
+.. literalinclude:: users.py
+   :start-after: # key list
+   :end-before: # end key list
+
+Get an SSH key for a user:
+
+.. literalinclude:: users.py
+   :start-after: # key get
+   :end-before: # end key get
+
+Create an SSH key for a user:
+
+.. literalinclude:: users.py
+   :start-after: # key create
+   :end-before: # end key create
+
+Delete an SSH key for a user:
+
+.. literalinclude:: users.py
+   :start-after: # key delete
+   :end-before: # end key delete
+
+Current User
+============
+
+Use the :class:`CurrentUser` object to get information about the currently
+logged-in user.
+
+Examples
+--------
+
+Get the current user:
+
+.. literalinclude:: users.py
+   :start-after: # currentuser get
+   :end-before: # end currentuser get
+
+List the current user SSH keys:
+
+.. literalinclude:: users.py
+   :start-after: # currentuser key list
+   :end-before: # end currentuser key list
+
+Get a key for the current user:
+
+.. literalinclude:: users.py
+   :start-after: # currentuser key get
+   :end-before: # end currentuser key get
+
+Create a key for the current user:
+
+.. literalinclude:: users.py
+   :start-after: # currentuser key create
+   :end-before: # end currentuser key create
+
+Delete a key for the current user:
+
+.. literalinclude:: users.py
+   :start-after: # currentuser key delete
+   :end-before: # end currentuser key delete
+
+