Difference between revisions of "DisableUser"
Jump to navigation
Jump to search
| Line 8: | Line 8: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=A valid token for identifying the API session context. The token can be | + | |ParamDescription=A valid token for identifying the API session context. The token only can be logged. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
Revision as of 20:04, 16 July 2014
Description
Disable the currently user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token only can be logged.
- userId (int, required)
- The user ID to be disabled.
Returns
Returns a JSON object containing a status true or false if the change was a successfully
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
Exceptions
- None
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
