|
147 | 147 | to observe worked examples with the library. Of small note is that the Python |
148 | 148 | library supports the ability to get and set single sections of the pfSense |
149 | 149 | system, not just the entire system configuration as with the Bash library.</p> |
150 | | -<p><strong>update-aws-aliases.py</strong> - a reasonable Python based worked example using the API can |
151 | | -be found with <code>update-aws-aliases.py</code> under the <a href="https://github.com/ndejong/pfsense_fauxapi/blob/master/extras/examples"><code>extras/examples</code></a> |
152 | | -path - the tool pulls in the latest AWS <code>ip-ranges.json</code> parses them and injects them |
153 | | -into the aliases section if required.</p> |
| 150 | +<p><strong>Python examples</strong></p> |
| 151 | +<ul> |
| 152 | +<li> |
| 153 | +<code>usergroup-management.py</code> - example code that provides the ability to <code>get_users</code>, |
| 154 | +<code>add_user</code>, <code>manage_user</code>, <code>remove_user</code> and perform the same functions on groups.</li> |
| 155 | +<li> |
| 156 | +<code>update-aws-aliases.py</code> - example code that pulls in the latest AWS <code>ip-ranges.json</code> |
| 157 | +data, parses it and injects them into the pfSense aliases section if required.</li> |
| 158 | +<li><a href="https://github.com/ndejong/pfsense_fauxapi/blob/master/extras/examples">github.com/ndejong/pfsense_fauxapi/blob/master/extras/examples</a></li> |
| 159 | +</ul> |
154 | 160 | <h4> |
155 | 161 | <a id="user-content-bash" class="anchor" href="#bash" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Bash</h4> |
156 | 162 | <p>The <a href="https://github.com/ndejong/pfsense_fauxapi/tree/master/extras/client-libs">Bash client library</a> |
|
166 | 172 | to get a better idea how to use it.</p> |
167 | 173 | <h4> |
168 | 174 | <a id="user-content-php" class="anchor" href="#php" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>PHP</h4> |
169 | | -<p>A PHP interface does not yet exist, it should be fairly easy to develop by |
170 | | -observing the Bash and Python examples - if you do please submit it as a github |
171 | | -pull request, there are no doubt others that will appreciate a PHP interface.</p> |
| 175 | +<p>A PHP client has been developed by a third party and is available here</p> |
| 176 | +<ul> |
| 177 | +<li><a href="https://github.com/travisghansen/pfsense_fauxapi_php_client">github.com/travisghansen/pfsense_fauxapi_php_client</a></li> |
| 178 | +<li><a href="https://packagist.org/packages/travisghansen/pfsense_fauxapi_php_client" rel="nofollow">packagist.org/packages/travisghansen/pfsense_fauxapi_php_client</a></li> |
| 179 | +</ul> |
172 | 180 | <h2> |
173 | 181 | <a id="user-content-api-authentication" class="anchor" href="#api-authentication" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>API Authentication</h2> |
174 | 182 | <p>A deliberate design decision to decouple FauxAPI authentication from both the |
|
0 commit comments