JSON API » user » user/login

Gets the login data for the authentication user, based on the person logging in as.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
token	Integer	1 to get an authentication token, 0 not to.	No	0

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

Fields of user.

Example: With required parameters

http://enswitch.example.com/api/json/user/login/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "username":"user", ... } }

Change history

Version	Changes
4.1	token input parameter added.
3.13	Function added.