From 33e7be35e3a01ad0666a0833a9ace0584579428f Mon Sep 17 00:00:00 2001
From: Henrik Levkowetz <henrik@levkowetz.com>
Date: Sun, 8 Apr 2018 13:24:14 +0000
Subject: [PATCH] Added more information about personal API keys to the API
 help page.  - Legacy-Id: 15031

---
 ietf/api/views.py             |  2 +-
 ietf/templates/api/index.html | 43 +++++++++++++++++++++++++++++++----
 2 files changed, 39 insertions(+), 6 deletions(-)

diff --git a/ietf/api/views.py b/ietf/api/views.py
index 4ffff0a54..74d453513 100644
--- a/ietf/api/views.py
+++ b/ietf/api/views.py
@@ -48,5 +48,5 @@ def api_help(request):
     key = JWK()
     # import just public part here, for display in info page
     key.import_from_pem(settings.API_PUBLIC_KEY_PEM)
-    return render(request, "api/index.html", {'key': key, })
+    return render(request, "api/index.html", {'key': key, 'settings':settings, })
     
diff --git a/ietf/templates/api/index.html b/ietf/templates/api/index.html
index ed32ca5ee..ef1cbe3c1 100644
--- a/ietf/templates/api/index.html
+++ b/ietf/templates/api/index.html
@@ -164,7 +164,7 @@
       etc.
     </p>
 
-    <h3>API Keys</h3>
+    <h3 id="personal-api-keys" class="anchor-target">Personal API Keys</h3>
 
     <p>
 
@@ -172,12 +172,45 @@
       rather than username/password login, see for example details for
       <code>{% url 'ietf.doc.views_ballot.api_set_position' %}</code> further
       down on this page.  Personal API keys are available from your <a
-      href="{% url 'ietf.ietfauth.views.apikey_index'%}"> Account API Key</a>
+      href="{% url 'ietf.ietfauth.views.apikey_index'%}"> Account API Keys</a>
       page when you are logged in.
 
     </p>
+    <p>
 
-    <h3>Signing</h3>
+      Personal API keys have some characteristics you should be aware of:
+      <ul>
+	<li>
+
+	  Each API key is valid only for a specific endpoint.  If you try to use a key for
+	  a different API endpoint than it's created for, it will not work.
+
+	</li>
+	<li>
+
+	  The API keys will cause you to be given access with the datatracker
+	  roles you have, thus giving you appropriate access to the various
+	  API endpoints according to the role limitations indicated for each
+	  endpoint.
+
+	</li>
+	<li>
+
+	  An API key will only give you access to its related endpoint if you have logged
+	  in to the datatracker using your regular login and password during the last
+	  {{ settings.UTILS_APIKEY_GUI_LOGIN_LIMIT_DAYS }} days.  If you receive the
+	  error message "<code>Too long since last regular login</code>" you should do
+	  a regular login in order to activate access.
+
+	</li>
+	
+      </ul>
+
+      
+
+    </p>
+
+    <h3 id="signing-keys" class="anchor-target">Signing Keys</h3>
     <p>
 
       When sending notifications to other APIs, the datatracker may sign
@@ -192,7 +225,7 @@
 
     <pre>{{key.export_to_pem}}</pre>
 
-    <h3 id="iesg-position-api">IESG ballot position API</h3>
+    <h3 id="iesg-position-api" class="anchor-target">IESG ballot position API</h3>
 
     <p>
 
@@ -228,7 +261,7 @@
 
 
 
-    <h3 id="session-video-url-api">Set session video URL</h3>
+    <h3 id="session-video-url-api" class="anchor-target">Set session video URL</h3>
 
     <p>