Update doc (#1379)
Xavier Guimard
7 years ago
parent
7c4748b51c
commit
cd3e50cb9f
@ -0,0 +1,125 @@ |
||||
<!DOCTYPE html> |
||||
<html lang="en" dir="ltr"> |
||||
<head> |
||||
<meta charset="utf-8" /> |
||||
<title>documentation:2.0:rest2f</title> |
||||
<meta name="generator" content="DokuWiki"/> |
||||
<meta name="robots" content="noindex,nofollow"/> |
||||
<meta name="keywords" content="documentation,2.0,rest2f"/> |
||||
<link rel="search" type="application/opensearchdescription+xml" href="lib/exe/opensearch.html" title="LemonLDAP::NG"/> |
||||
<link rel="start" href="rest2f.html"/> |
||||
<link rel="contents" href="rest2f.html" title="Sitemap"/> |
||||
<link rel="stylesheet" type="text/css" href="lib/exe/css.php.t.bootstrap3.css"/> |
||||
<!-- //if:usedebianlibs |
||||
<link rel="stylesheet" type="text/css" href="/javascript/bootstrap/css/bootstrap.min.css" /> |
||||
//elsif:useexternallibs |
||||
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"></script> |
||||
//elsif:cssminified |
||||
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.min.css" /> |
||||
//else --> |
||||
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.css" /> |
||||
<!-- //endif --> |
||||
<script type="text/javascript">/*<![CDATA[*/var NS='documentation:2.0';var JSINFO = {"id":"documentation:2.0:rest2f","namespace":"documentation:2.0"}; |
||||
/*!]]>*/</script> |
||||
<script type="text/javascript" charset="utf-8" src="lib/exe/js.php.t.bootstrap3.js"></script> |
||||
<!-- //if:usedebianlibs |
||||
<script type="text/javascript" src="/javascript/jquery/jquery.min.js"></script> |
||||
//elsif:useexternallibs |
||||
<script type="text/javascript" src="http://code.jquery.com/jquery-2.2.0.min.js"></script> |
||||
//elsif:jsminified |
||||
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.min.js"></script> |
||||
//else --> |
||||
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.js"></script> |
||||
<!-- //endif --> |
||||
<!-- //if:usedebianlibs |
||||
<script type="text/javascript" src="/javascript/jquery-ui/jquery-ui.min.js"></script> |
||||
//elsif:useexternallibs |
||||
<script type="text/javascript" src="http://code.jquery.com/ui/1.10.4/jquery-ui.min.js"></script> |
||||
//elsif:jsminified |
||||
<script type="text/javascript" src="/lib/scripts/jquery-ui.min.js"></script> |
||||
//else --> |
||||
<script type="text/javascript" src="/lib/scripts/jquery-ui.js"></script> |
||||
<!-- //endif --> |
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export container"> |
||||
<!-- TOC START --> |
||||
<div id="dw__toc"> |
||||
<h3 class="toggle">Table of Contents</h3> |
||||
<div> |
||||
|
||||
<ul class="toc"> |
||||
<li class="level2"><div class="li"><a href="#configuration">Configuration</a></div></li> |
||||
<li class="level1"><div class="li"><a href="#arguments">Arguments</a></div></li> |
||||
<li class="level1"><div class="li"><a href="#rest_dialog">REST Dialog</a></div></li> |
||||
</ul> |
||||
</div> |
||||
</div> |
||||
<!-- TOC END --> |
||||
|
||||
<h1 class="sectionedit1" id="rest_second_factor">REST Second Factor</h1> |
||||
<div class="level1"> |
||||
|
||||
<p> |
||||
This plugin can be used to add a second factor for authentication (SMS, OTP,…). It uses external web service to send and validate the second factor. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- EDIT1 SECTION "REST Second Factor" [1-186] --> |
||||
<h3 class="sectionedit2" id="configuration">Configuration</h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
All parameters are configured in “General Parameters » Portal Parameters » Second Factors » REST 2nd Factor”. |
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <strong>Activation</strong></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Init <abbr title="Uniform Resource Locator">URL</abbr></strong> <em>(optional)</em>: REST <abbr title="Uniform Resource Locator">URL</abbr> to initialize dialog <em>(send OTP)</em>. Leave it blank if your <abbr title="Application Programming Interface">API</abbr> doesn't need any initialization</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Init arguments</strong>: list of arguments to send <em>(see below)</em></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Verify <abbr title="Uniform Resource Locator">URL</abbr></strong> <em>(required)</em>: REST <abbr title="Uniform Resource Locator">URL</abbr> to verify code</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Verify arguments</strong>: list of arguments to send <em>(see below)</em></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Authentication Level</strong>: if you want to overwrite the value sent by your authentication module, you can define here the new authentication level. Example: 5</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- EDIT2 SECTION "Configuration" [187-837] --> |
||||
<h2 class="sectionedit3" id="arguments">Arguments</h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
Arguments are a list of key/value. Key is the name of JSON entry, value is attribute or macro name. |
||||
</p> |
||||
<div class="noteimportant">For Verify <abbr title="Uniform Resource Locator">URL</abbr>, you should send $code at least |
||||
</div> |
||||
</div> |
||||
<!-- EDIT3 SECTION "Arguments" [838-1032] --> |
||||
<h2 class="sectionedit4" id="rest_dialog">REST Dialog</h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
REST web services just have to respond with a “result” key in a JSON file. Auth/UserDB can add a “info” array to will be copied is session data (without reading “Exported variables”). |
||||
</p> |
||||
<div class="table sectionedit5"><table class="inline table table-bordered table-striped"> |
||||
<thead> |
||||
<tr class="row0 roweven"> |
||||
<th class="col0 centeralign"> <abbr title="Uniform Resource Locator">URL</abbr> </th><th class="col1 centeralign"> Query </th><th class="col2 centeralign"> Response </th> |
||||
</tr> |
||||
</thead> |
||||
<tr class="row1 rowodd"> |
||||
<td class="col0 centeralign"> Init <abbr title="Uniform Resource Locator">URL</abbr> </td><td class="col1"> JSON file: <code>{“user”:$user,…}</code> </td><td class="col2"> JSON file: <code>{“result”:true/false}</code> </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<td class="col0 centeralign"> Verify <abbr title="Uniform Resource Locator">URL</abbr> </td><td class="col1"> JSON file: <code>{“user”:$user,“code”:“$code”,…}</code> </td><td class="col2"> JSON file: <code>{“result”:true/false}</code> </td> |
||||
</tr> |
||||
</table></div> |
||||
<!-- EDIT5 TABLE [1243-1472] --> |
||||
</div> |
||||
<!-- EDIT4 SECTION "REST Dialog" [1033-] --></div> |
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,125 @@ |
||||
<!DOCTYPE html> |
||||
<html lang="en" dir="ltr"> |
||||
<head> |
||||
<meta charset="utf-8" /> |
||||
<title>documentation:2.0:rest2f</title> |
||||
<meta name="generator" content="DokuWiki"/> |
||||
<meta name="robots" content="noindex,nofollow"/> |
||||
<meta name="keywords" content="documentation,2.0,rest2f"/> |
||||
<link rel="search" type="application/opensearchdescription+xml" href="lib/exe/opensearch.html" title="LemonLDAP::NG"/> |
||||
<link rel="start" href="rest2f.html"/> |
||||
<link rel="contents" href="rest2f.html" title="Sitemap"/> |
||||
<link rel="stylesheet" type="text/css" href="lib/exe/css.php.t.bootstrap3.css"/> |
||||
<!-- //if:usedebianlibs |
||||
<link rel="stylesheet" type="text/css" href="/javascript/bootstrap/css/bootstrap.min.css" /> |
||||
//elsif:useexternallibs |
||||
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"></script> |
||||
//elsif:cssminified |
||||
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.min.css" /> |
||||
//else --> |
||||
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.css" /> |
||||
<!-- //endif --> |
||||
<script type="text/javascript">/*<![CDATA[*/var NS='documentation:2.0';var JSINFO = {"id":"documentation:2.0:rest2f","namespace":"documentation:2.0"}; |
||||
/*!]]>*/</script> |
||||
<script type="text/javascript" charset="utf-8" src="lib/exe/js.php.t.bootstrap3.js"></script> |
||||
<!-- //if:usedebianlibs |
||||
<script type="text/javascript" src="/javascript/jquery/jquery.min.js"></script> |
||||
//elsif:useexternallibs |
||||
<script type="text/javascript" src="http://code.jquery.com/jquery-2.2.0.min.js"></script> |
||||
//elsif:jsminified |
||||
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.min.js"></script> |
||||
//else --> |
||||
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.js"></script> |
||||
<!-- //endif --> |
||||
<!-- //if:usedebianlibs |
||||
<script type="text/javascript" src="/javascript/jquery-ui/jquery-ui.min.js"></script> |
||||
//elsif:useexternallibs |
||||
<script type="text/javascript" src="http://code.jquery.com/ui/1.10.4/jquery-ui.min.js"></script> |
||||
//elsif:jsminified |
||||
<script type="text/javascript" src="/lib/scripts/jquery-ui.min.js"></script> |
||||
//else --> |
||||
<script type="text/javascript" src="/lib/scripts/jquery-ui.js"></script> |
||||
<!-- //endif --> |
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export container"> |
||||
<!-- TOC START --> |
||||
<div id="dw__toc"> |
||||
<h3 class="toggle">Table of Contents</h3> |
||||
<div> |
||||
|
||||
<ul class="toc"> |
||||
<li class="level2"><div class="li"><a href="#configuration">Configuration</a></div></li> |
||||
<li class="level1"><div class="li"><a href="#arguments">Arguments</a></div></li> |
||||
<li class="level1"><div class="li"><a href="#rest_dialog">REST Dialog</a></div></li> |
||||
</ul> |
||||
</div> |
||||
</div> |
||||
<!-- TOC END --> |
||||
|
||||
<h1 class="sectionedit1" id="rest_second_factor">REST Second Factor</h1> |
||||
<div class="level1"> |
||||
|
||||
<p> |
||||
This plugin can be used to add a second factor for authentication (SMS, OTP,…). It uses external web service to send and validate the second factor. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- EDIT1 SECTION "REST Second Factor" [1-186] --> |
||||
<h3 class="sectionedit2" id="configuration">Configuration</h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
All parameters are configured in “General Parameters » Portal Parameters » Second Factors » REST 2nd Factor”. |
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <strong>Activation</strong></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Init <abbr title="Uniform Resource Locator">URL</abbr></strong> <em>(optional)</em>: REST <abbr title="Uniform Resource Locator">URL</abbr> to initialize dialog <em>(send OTP)</em>. Leave it blank if your <abbr title="Application Programming Interface">API</abbr> doesn't need any initialization</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Init arguments</strong>: list of arguments to send <em>(see below)</em></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Verify <abbr title="Uniform Resource Locator">URL</abbr></strong> <em>(required)</em>: REST <abbr title="Uniform Resource Locator">URL</abbr> to verify code</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Verify arguments</strong>: list of arguments to send <em>(see below)</em></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Authentication Level</strong>: if you want to overwrite the value sent by your authentication module, you can define here the new authentication level. Example: 5</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- EDIT2 SECTION "Configuration" [187-837] --> |
||||
<h2 class="sectionedit3" id="arguments">Arguments</h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
Arguments are a list of key/value. Key is the name of JSON entry, value is attribute or macro name. |
||||
</p> |
||||
<div class="noteimportant">For Verify <abbr title="Uniform Resource Locator">URL</abbr>, you should send $code at least |
||||
</div> |
||||
</div> |
||||
<!-- EDIT3 SECTION "Arguments" [838-1032] --> |
||||
<h2 class="sectionedit4" id="rest_dialog">REST Dialog</h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
REST web services just have to respond with a “result” key in a JSON file. Auth/UserDB can add a “info” array to will be copied is session data (without reading “Exported variables”). |
||||
</p> |
||||
<div class="table sectionedit5"><table class="inline table table-bordered table-striped"> |
||||
<thead> |
||||
<tr class="row0 roweven"> |
||||
<th class="col0 centeralign"> <abbr title="Uniform Resource Locator">URL</abbr> </th><th class="col1 centeralign"> Query </th><th class="col2 centeralign"> Response </th> |
||||
</tr> |
||||
</thead> |
||||
<tr class="row1 rowodd"> |
||||
<td class="col0 centeralign"> Init <abbr title="Uniform Resource Locator">URL</abbr> </td><td class="col1"> JSON file: <code>{“user”:$user,…}</code> </td><td class="col2"> JSON file: <code>{“result”:true/false}</code> </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<td class="col0 centeralign"> Verify <abbr title="Uniform Resource Locator">URL</abbr> </td><td class="col1"> JSON file: <code>{“user”:$user,“code”:“$code”,…}</code> </td><td class="col2"> JSON file: <code>{“result”:true/false}</code> </td> |
||||
</tr> |
||||
</table></div> |
||||
<!-- EDIT5 TABLE [1243-1472] --> |
||||
</div> |
||||
<!-- EDIT4 SECTION "REST Dialog" [1033-] --></div> |
||||
</body> |
||||
</html> |
||||
Loading…
Reference in new issue