From c9aa433f746d7f1609d0e3d0ee512cd1953da190 Mon Sep 17 00:00:00 2001
From: kakwa <carpentier.pf@gmail.com>
Date: Mon, 20 Jul 2015 23:32:31 +0200
Subject: [PATCH] adding documentation on "key" attribute

---
 docs/deploy.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/docs/deploy.rst b/docs/deploy.rst
index 219cf3d..ce05027 100644
--- a/docs/deploy.rst
+++ b/docs/deploy.rst
@@ -92,6 +92,28 @@ If **type** is set to **stringlist** the parameter **values** must be filled wit
         backends:
             - <backend id>: <backend attribute name>
 
+Key attribute:
+^^^^^^^^^^^^^^
+
+One attribute must be used as a unique key accross all backends:
+
+To set the key attribute, you must set **key** to **True** on this attribute.
+
+Example:
+
+.. sourcecode:: yaml
+
+    uid:
+        description: "UID of the user"
+        display_name: "UID"
+        search_displayed: True
+        key: True                       # defining the attribute as "key"
+        type: string
+        weight: 50
+        backends:
+            ldap: uid
+            ad: sAMAccountName
+
 Authorize self modification
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^