|
@ -12,7 +12,7 @@ User API |
|
|
GET /user HTTP/1.1 |
|
|
GET /user HTTP/1.1 |
|
|
Host: example.tld |
|
|
Host: example.tld |
|
|
Accept: application/json |
|
|
Accept: application/json |
|
|
Authorization: Token <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
X-Auth-Token: <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
**Example response**: |
|
|
**Example response**: |
|
|
|
|
|
|
|
@ -31,7 +31,7 @@ User API |
|
|
{ |
|
|
{ |
|
|
"creationTime": "2018-07-29T11:58:17-05:00", |
|
|
"creationTime": "2018-07-29T11:58:17-05:00", |
|
|
"lastLoginTime": "2018-07-29T12:43:27-05:00", |
|
|
"lastLoginTime": "2018-07-29T12:43:27-05:00", |
|
|
"name": "corvus_administrator", |
|
|
|
|
|
|
|
|
"name": "server_administrator", |
|
|
"role": "ADMIN", |
|
|
"role": "ADMIN", |
|
|
"version": 0 |
|
|
"version": 0 |
|
|
} |
|
|
} |
|
@ -41,7 +41,7 @@ User API |
|
|
:query int page: User page to retrieve |
|
|
:query int page: User page to retrieve |
|
|
:query int perPage: Number of records to retrieve per page (max 100) |
|
|
:query int perPage: Number of records to retrieve per page (max 100) |
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
:<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 |
|
|
:>header Content-Type: Depends on :mailheader:`Accept` header of request |
|
|
:>json int page: Page retrieved |
|
|
:>json int page: Page retrieved |
|
|
:>json int count: Number of items returned |
|
|
:>json int count: Number of items returned |
|
@ -62,10 +62,10 @@ User API |
|
|
|
|
|
|
|
|
.. sourcecode:: http |
|
|
.. sourcecode:: http |
|
|
|
|
|
|
|
|
GET /user/corvus_administrator HTTP/1.1 |
|
|
|
|
|
|
|
|
GET /user/server_administrator HTTP/1.1 |
|
|
Host: example.tld |
|
|
Host: example.tld |
|
|
Accept: application/json |
|
|
Accept: application/json |
|
|
Authorization: Token <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
X-Auth-Token: <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
**Example response**: |
|
|
**Example response**: |
|
|
|
|
|
|
|
@ -78,14 +78,14 @@ User API |
|
|
{ |
|
|
{ |
|
|
"creationTime": "2018-07-29T11:58:17-05:00", |
|
|
"creationTime": "2018-07-29T11:58:17-05:00", |
|
|
"lastLoginTime": "2018-07-29T12:43:27-05:00", |
|
|
"lastLoginTime": "2018-07-29T12:43:27-05:00", |
|
|
"name": "corvus_administrator", |
|
|
|
|
|
|
|
|
"name": "server_administrator", |
|
|
"role": "ADMIN", |
|
|
"role": "ADMIN", |
|
|
"version": 0 |
|
|
"version": 0 |
|
|
} |
|
|
} |
|
|
|
|
|
|
|
|
:param string user_name: Name of the user to retrieve information about |
|
|
:param string user_name: Name of the user to retrieve information about |
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
:<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 |
|
|
:>header Content-Type: Depends on :mailheader:`Accept` header of request |
|
|
:>json datetime creationTime: Creation time for the user |
|
|
:>json datetime creationTime: Creation time for the user |
|
|
:>json datetime lastLoginTime: When the user last logged in, or was last bumped |
|
|
:>json datetime lastLoginTime: When the user last logged in, or was last bumped |
|
@ -104,10 +104,10 @@ User API |
|
|
|
|
|
|
|
|
.. sourcecode:: http |
|
|
.. sourcecode:: http |
|
|
|
|
|
|
|
|
PATCH /user/corvus_administrator HTTP/1.1 |
|
|
|
|
|
|
|
|
PATCH /user/server_administrator HTTP/1.1 |
|
|
Host: example.tld |
|
|
Host: example.tld |
|
|
Accept: application/json |
|
|
Accept: application/json |
|
|
Authorization: Token <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
X-Auth-Token: <Base64(user:userToken)> |
|
|
Content-Type: application/json |
|
|
Content-Type: application/json |
|
|
|
|
|
|
|
|
{ |
|
|
{ |
|
@ -126,14 +126,14 @@ User API |
|
|
{ |
|
|
{ |
|
|
"creationTime": "2018-07-29T11:58:17-05:00", |
|
|
"creationTime": "2018-07-29T11:58:17-05:00", |
|
|
"lastLoginTime": "2019-07-29T12:43:27-05:00", |
|
|
"lastLoginTime": "2019-07-29T12:43:27-05:00", |
|
|
"name": "corvus_administrator", |
|
|
|
|
|
|
|
|
"name": "server_administrator", |
|
|
"role": "ADMIN", |
|
|
"role": "ADMIN", |
|
|
"version": 1 |
|
|
"version": 1 |
|
|
} |
|
|
} |
|
|
|
|
|
|
|
|
:param string user_name: Name of the user to update |
|
|
:param string user_name: Name of the user to update |
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
:<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 |
|
|
:<header Content-Type: application/json |
|
|
:<json datetime createDateTime: Update createDateTime (Administrator Only) |
|
|
:<json datetime createDateTime: Update createDateTime (Administrator Only) |
|
|
:<json datetime lastLoginTime: Update lastLoginTime |
|
|
:<json datetime lastLoginTime: Update lastLoginTime |
|
@ -162,7 +162,7 @@ User API |
|
|
POST /user HTTP/1.1 |
|
|
POST /user HTTP/1.1 |
|
|
Host: example.tld |
|
|
Host: example.tld |
|
|
Accept: application/json |
|
|
Accept: application/json |
|
|
Authorization: Token <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
X-Auth-Token: <Base64(user:userToken)> |
|
|
Content-Type: application/json |
|
|
Content-Type: application/json |
|
|
|
|
|
|
|
|
{ |
|
|
{ |
|
@ -187,7 +187,7 @@ User API |
|
|
} |
|
|
} |
|
|
|
|
|
|
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
:<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 |
|
|
:<header Content-Type: application/json |
|
|
:<json string name: Name of the user |
|
|
:<json string name: Name of the user |
|
|
:<json string password: Password to use |
|
|
:<json string password: Password to use |
|
@ -212,7 +212,7 @@ User API |
|
|
DELETE /user/test_user HTTP/1.1 |
|
|
DELETE /user/test_user HTTP/1.1 |
|
|
Host: example.tld |
|
|
Host: example.tld |
|
|
Accept: application/json |
|
|
Accept: application/json |
|
|
Authorization: Token <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
X-Auth-Token: <Base64(user:userToken)> |
|
|
|
|
|
|
|
|
**Example response**: |
|
|
**Example response**: |
|
|
|
|
|
|
|
@ -229,7 +229,7 @@ User API |
|
|
|
|
|
|
|
|
:param string user_name: Name of the user to delete |
|
|
:param string user_name: Name of the user to delete |
|
|
:<header Accept: Response content type depends on :mailheader:`Accept` header |
|
|
:<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 |
|
|
:>header Content-Type: Depends on :mailheader:`Accept` header of request |
|
|
:>json string message: Success or failure message |
|
|
:>json string message: Success or failure message |
|
|
:>json boolean success: Action status indicator |
|
|
:>json boolean success: Action status indicator |
|
|