AUTH: Difference between revisions

From Lundman Wiki
No edit summary
 
mNo edit summary
Line 1: Line 1:
** AUTH
* AUTH


Send USER and PASS for authentication. This requires a valid user and
Send USER and PASS for authentication. This requires a valid user and
Line 7: Line 7:




[ Minimal Required Fields]
[ Minimal Required Fields]
>> USER=<str>      - USER name
>> PASS=<str>      - PASSWORD


>> USER=<str>      - USER name
>> PASS=<str>      - PASSWORD


[ Optional Arguments ]


[ Optional Arguments ]




[ Returns ]
>> OK              - Authentication was successful.
>> CODE=<int>      - Failure code.
>> MSG=<str>        - Human readable string message.


[ Returns ]


>> OK              - Authentication was successful.
[ Example ]
>> CODE=<int>      - Failure code.
<< AUTH|USER=admin|PASS=admin
>> MSG=<str>        - Human readable string message.
>> AUTH|OK|MSG=Successful
 
or
 
>> AUTH|CODE=502|MSG=Login incorrect
[ Example ]
or
 
>> AUTH|CODE=503|MSG=Secure channel enforced.
<< AUTH|USER=admin|PASS=admin
>> AUTH|OK|MSG=Successful
 
>> AUTH|CODE=502|MSG=Login incorrect
 
>> AUTH|CODE=503|MSG=Secure channel enforced.

Revision as of 07:11, 21 October 2005

  • AUTH

Send USER and PASS for authentication. This requires a valid user and password pair already registered on FXP.One. If FXP.One was started with no user database files, it will create one with the account user "admin" and password "admin".


[ Minimal Required Fields]
>> USER=<str>       - USER name
>> PASS=<str>       - PASSWORD


[ Optional Arguments ]


[ Returns ]
>> OK               - Authentication was successful.
>> CODE=<int>       - Failure code.
>> MSG=<str>        - Human readable string message.


[ Example ]
<< AUTH|USER=admin|PASS=admin
>> AUTH|OK|MSG=Successful
or
>> AUTH|CODE=502|MSG=Login incorrect
or
>> AUTH|CODE=503|MSG=Secure channel enforced.