FNGi DHCPatriot Version 6, Руководство по эксплуатации

Страница: 76 / 104

Authenticate Device
This API function allows a user device to be authenticated remotely similarly to what can
be done with manually authorizing customers. The default admin level required for this
feature is five. As of version 5.4.0, you can authenticate the device using its current IP
address as the identifier. The MAC address would be omitted in that case.
The GET string to send is as follows:
https://patriot.[domain]/cli/?function=AuthorizeCustomer&username=[API
username]&password=[API Password]&user=[username for device]&pass=[password
for device]&MAC=[MAC address of device]&ip=[current device IP]&note=[optional url
encoded note]
Here is an example of what a properly formatted URL might look like for the authorize
device API:
https://patriot.network1.net/cli/?function=AuthorizeCustomer&
username=apiuser&password=apipass&user=linux&pass=Geqp9t4k&MAC=00:a0:cc:d9
:9 6:a2&note=Jim+Smith's+Xbox360
Success will present the text RETURN=1. Failure will present RETURN=0 with some
text given below as a reason for the failure.
Suspend Device
This allows a user to be suspended on the DHCPatriot system. It will suspend all
devices belonging to the specified username. The default admin level required for this
feature is five. This feature behaves the same as the Suspend User function on the web
administration interface with the exception that mass suspending is not possible, each
user must be sent one at a time.
The GET string to send is as follows: https://patriot.[domain]/cli/?
function=SuspendEnable&username=[username]&password=[password]&action=suspe
nd&user=[username to suspend]&note=[optional url encoded note]
As of version 4.2.1, the suspension note can now be included just as if you were
suspending from the suspend user page. The customer WILL see the contents of this
note on the login screen. Please be sure to URL encode the note string as spaces and
other special characters will not be passed properly in a URL without proper encoding.
Here is an example of what a properly formatted URL might look like:
https://patriot.[domain]/cli/?
function=SuspendEnable&username=apiuser&password=apipass&action=suspend&us
er=linux&note=our+office.
Chapter 11: Remote Access API 76
DHCPatriot Version 6 Operations Manual This document © 2017 First Network Group Inc. All Rights Reserved