====/api/auth====

===Usage===

Authenticates against the ARDI server to allow elevated function execution.

Note that you **must** call this function before calling any other ARDI function other than [[/api/connect]] when the server is not in guest mode.

Note that this documentation covers the //traditional// version (passing a username and password) to authenticate with ARDI. If you want to use 3rd party sign-in services or interactive login (where the username and password is not shared with the host application), please see the 
[[api_auth_inter|interactive method]].

===Details==

^Detail^Value^
|Group|Server|
|From Server Version|0.9.0|
|Permission|[[permission_guest|Public]]|
|Methods|GET or POST|

==Parameters==

^Parameter^Notes^Meaning^
|**username**|The users name|
|**password**|The users password|
|**format**|String (xml)|Either 'xml' or 'json'|

===Return Value===

The return value is an XML or JSON file that returns an //authcode//. This code is included with all future API requests as part of [[signing your request]].

===Examples===

==Request==

<code>
http://<servername>/s/<sitename>/api/auth?username=average&password=user
</code>

==Success (XML)==

<code>
<login>
    <authcode>db86d3b005999c126a727f53a96415b5</authcode>
    <level>admin</level>
  </login>
</code>

==Success (JSON)==

<code>
{
	"authcode":"db86d3b005999c126a727f53a96415b5",
	"level":"admin"
}
</code>