|
|
@ -41,7 +41,7 @@ User API |
|
|
|
:query int page: User page to retrieve |
|
|
|
:query int perPage: Number of records to retrieve per page (max 100) |
|
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
|
:<header Authorization: The encoded basic authorization |
|
|
|
:<header X-Auth-Token: Encoded token authorization |
|
|
|
:>header Content-Type: Depends on :mailheader:`Accept` header of request |
|
|
|
:>json int page: Page retrieved |
|
|
|
:>json int count: Number of items returned |
|
|
@ -85,7 +85,7 @@ User API |
|
|
|
|
|
|
|
:param string user_name: Name of the user to retrieve information about |
|
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
|
:<header Authorization: The encoded basic authorization |
|
|
|
:<header X-Auth-Token: Encoded token authorization |
|
|
|
:>header Content-Type: Depends on :mailheader:`Accept` header of request |
|
|
|
:>json datetime creationTime: Creation time for the user |
|
|
|
:>json datetime lastLoginTime: When the user last logged in, or was last bumped |
|
|
@ -133,7 +133,7 @@ User API |
|
|
|
|
|
|
|
:param string user_name: Name of the user to update |
|
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
|
:<header Authorization: Encoded token authorization |
|
|
|
:<header X-Auth-Token: Encoded token authorization |
|
|
|
:<header Content-Type: application/json |
|
|
|
:<json datetime createDateTime: Update createDateTime (Administrator Only) |
|
|
|
:<json datetime lastLoginTime: Update lastLoginTime |
|
|
@ -187,7 +187,7 @@ User API |
|
|
|
} |
|
|
|
|
|
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
|
:<header Authorization: Encoded token authorization |
|
|
|
:<header X-Auth-Token: Encoded token authorization |
|
|
|
:<header Content-Type: application/json |
|
|
|
:<json string name: Name of the user |
|
|
|
:<json string password: Password to use |
|
|
@ -229,7 +229,7 @@ User API |
|
|
|
|
|
|
|
:param string user_name: Name of the user to delete |
|
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
|
:<header Authorization: Encoded token authorization |
|
|
|
:<header X-Auth-Token: Encoded token authorization |
|
|
|
:>header Content-Type: Depends on :mailheader:`Accept` header of request |
|
|
|
:>json string message: Success or failure message |
|
|
|
:>json boolean success: Action status indicator |
|
|
|