Author: tchemit Date: 2012-10-25 14:04:43 +0200 (Thu, 25 Oct 2012) New Revision: 375 Url: http://nuiton.org/repositories/revision/jredmine/375 Log: refs #2091: Authentification and password secuityvia REST API Key (add doc) Modified: trunk/jredmine-client/src/site/apt/rails_api.apt trunk/jredmine-maven-plugin/src/site/apt/usage.apt trunk/src/site/apt/index.apt Modified: trunk/jredmine-client/src/site/apt/rails_api.apt =================================================================== --- trunk/jredmine-client/src/site/apt/rails_api.apt 2012-10-25 07:20:11 UTC (rev 374) +++ trunk/jredmine-client/src/site/apt/rails_api.apt 2012-10-25 12:04:43 UTC (rev 375) @@ -53,15 +53,17 @@ API de login -*-----------*-----------------------------------------------+ -| <action> | <description> | -*-----------*-----------------------------------------------+ -| <<ping>> | un service de ping qui retourne le mot <ping> | -*-----------*-----------------------------------------------+ -| <<login>> | pour connecter l'utilisateur au serveur | -*-----------*-----------------------------------------------+ -| <<logout>>| pour déconnecter l'utilisateur du serveur | -*-----------*-----------------------------------------------+ +*-----------*----------------------------------------------------------+ +| <action> | <description> | +*-----------*----------------------------------------------------------+ +| <<ping>> | un service de ping qui retourne le mot <ping> | +*-----------*----------------------------------------------------------+ +| <<login>> | pour connecter l'utilisateur au serveur (login/password) | +*-----------*----------------------------------------------------------+ +| <<login>> | pour connecter l'utilisateur au serveur (api key) | +*-----------*----------------------------------------------------------+ +| <<logout>>| pour déconnecter l'utilisateur du serveur | +*-----------*----------------------------------------------------------+ * ping @@ -73,7 +75,7 @@ jredmine/ping -------------------------------------------------------------------------------- -* login +* login (version login/password) Ce service nécessite deux paramètres : @@ -89,6 +91,21 @@ jredmine/login -------------------------------------------------------------------------------- +* login (version api key) (depuis version 1.5) + + Ce service nécessite soit un paramètre : + + * <<key>> + + ou bien un header nommé <<X-Redmine-API-Key>> + +Requète : + +-------------------------------------------------------------------------------- +jredmine/login +-------------------------------------------------------------------------------- + + * logout Ce service ne requiert pas de paramètre. Modified: trunk/jredmine-maven-plugin/src/site/apt/usage.apt =================================================================== --- trunk/jredmine-maven-plugin/src/site/apt/usage.apt 2012-10-25 07:20:11 UTC (rev 374) +++ trunk/jredmine-maven-plugin/src/site/apt/usage.apt 2012-10-25 12:04:43 UTC (rev 375) @@ -34,6 +34,15 @@ This page describes usages of different goals of the plugin. +Authentication notes + + There is some goals which needs to be authenticated in redmine server, + since version <<1.5>> there is two way to do this: + + - using the normal method via <<username>>, <<password>> parameters + + - using the new method via <<apiKey>> parameter + Generate things * Generate the changes.xml file Modified: trunk/src/site/apt/index.apt =================================================================== --- trunk/src/site/apt/index.apt 2012-10-25 07:20:11 UTC (rev 374) +++ trunk/src/site/apt/index.apt 2012-10-25 12:04:43 UTC (rev 375) @@ -54,6 +54,16 @@ Notes +* Version 1.5 + + La version <<1.5>> permet d'utiliser désormais l'authentification via l'api-key. + + Pour ce faire dans le plugin maven on peut utiliser le paramètre <<apiKey>> + au lieu du traditionnel <<username>>, <<password>>. + + A noter qu'il faut obligatoirement utiliser le dernier plugin rails jredmine + (celui de la version 1.5). + * Version 1.4 La version <<1.4>> prépare la passage à la version 2.0 de redmine. La version