JSON API » people » people/unlock

Unlocks a person after too many failed logins.

Input parameters

Requires authentication and the user or wholesale role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of person to unlock.	Yes

Responses

Code	Description
204	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The person does not exist, or you do not have permission to unlock them.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/people/unlock/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.