Accounts-accountId-user:PUT - Revision history

Mike.robski: 1 revision: Release 90

2014-01-31T18:23:34Z

1 revision: Release 90

Dinh.anh: /* Parameters */

2013-11-14T15:22:11Z

Parameters

Mike.robski: 1 revision

2013-02-20T15:28:54Z

1 revision

Mike.robski at 23:31, 19 February 2013

2013-02-19T23:31:09Z

New page

= PUT /accounts/''{accountId}''/user =
Updates account user credentials.
__TOC__
== Request ==
<code>PUT /accounts/''{accountId}''/user</code>

==== Parameters ====
; accountId - ''string''
: The Id of the account.

=== URI Parameters ===
None.

=== Request Headers ===
{{Authorization}}

; Content-Type
: application/json

=== Request Body ===
<nowiki>
{
"userName": "{username}",
"password": "{password}"
}
</nowiki>

==== Parameters ====
; userName - ''string''
: The account user name.

; password - ''string''
: The new password. String that meets the password complexity requirements.

== Response ==

=== Status Code ===
; 204 No Content
: Success

; 400 Bad Request
: The format of the request body is invalid or the password does not meet the complexity requirements.

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 404 Not Found
: The account Id does not exist or the username did not match the username set for the account.

; 415 Unsupported Media Type
: The Content-Type header was not specified or the specified type is not supported. Use application/json.

== Examples ==

''Request''
<nowiki>
PUT /accounts/test-account/user

{ "userName":"testuser", "password":"password12" }
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

''Request''
<nowiki>
PUT /accounts/test-account/user
Authorization: Basic base64_encode(username:password)

{ "userName":"testuser", "password":"password12" }
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type

{"badMediaType": {"message": "Unsupported media", "code": 415, "details": ""}}
</nowiki>

''Request''
<nowiki>
PUT /accounts/test-account/user
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{ "userName":"notvalid-user", "password":"password12" }
</nowiki>

''Response''
<nowiki>
404 Not Found

{"itemNotFound": {"message": "Resource not found", "code": 404, "details": ""}}
</nowiki>

''Request''
<nowiki>
PUT /accounts/test-account/user
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{ "userName":"testuser", "password":"" }
</nowiki>

''Response''
<nowiki>
400 Bad Request

{"badRequest": {"message": "POST data error", "code": 400, "details": {"password": "Required"}}}
</nowiki>

''Request''
<nowiki>
PUT /accounts/test-account/user
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{ "userName":"testuser", "password":"pass" }
</nowiki>

''Response''
<nowiki>
400 Bad Request

{"computeFault": {"message": "The password should be at least 8 characters", "code": 400, "details": ""}}
</nowiki>

''Request''
<nowiki>
PUT /accounts/test-account/user
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{ "userName":"testuser", "password":"pa$$word" }
</nowiki>

''Response''
<nowiki>
400 Bad Request

{"computeFault": {"message": "The password must contains digits and letters", "code": 400, "details": ""}}
</nowiki>

''Request''
<nowiki>
PUT /accounts/test-account/user
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{ "userName":"testuser", "password":"password" }
</nowiki>

''Response''
<nowiki>
400 Bad Request

{"computeFault": {"message": "The password must contains at least one digit", "code": 400, "details": ""}}
</nowiki>

''Request''
<nowiki>
PUT /accounts/test-account/user
Authorization: Basic base64_encode(username:password)
Content-Type: application/json

{ "userName":"testuser", "password":"password12" }
</nowiki>

''Response''
<nowiki>
204 No Content
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

@@ Line 23: / Line 23: @@
    "userName": "{username}",
    "password": "{password}"
+}
   </nowiki>
 ==== Parameters ====
-; userName - ''string''
+;userName
-: The account user name.
+: ''Required.'' A name for the user that's about to be created. This needs to be unique within the entire security realm (not just within the account).
 ;password
-; password - ''string''
+: ''Required only if securityQuestion and securityAnswer were not provided.'' A password for the user. This needs to be between 8 and 50 characters long inclusive, must contain at least one alpha ''and'' at least one numeric character, and must not contain any of the following characters: & ` ' " \ / < > $
-: The new password. String that meets the password complexity requirements.
+;securityQuestionCode
 == Response ==
 === Status Code ===
-; 204 No Content
+;;204 No Content
-: Success
+: The user was successfully updated
 ;400 Bad Request
-; 400 Bad Request
+: The request body was missing a required field or one of the fields did not comply with the requirements (in this case, the response body will contain hints for what went wrong)
-: The format of the request body is invalid or the password does not meet the complexity requirements.
+;401 Unauthorized
+: Authentication failed
-; 401 Unauthorized
+;403 Forbidden
-: The supplied credentials are invalid or do not provide permissions for this operation.
+: Authentication succeeded, but the logged-in user is not allowed to update users in this account. The only users allowed to update this user resource  are ''this very user'', account owner(s) of ''this'' account, and sales/support agents. An account owner is any account user with the "sitecontrol_account_owner" role.
 ;404 Not Found
-; 404 Not Found
+: Either the account or user does not exist
-: The account Id does not exist or the username did not match the username set for the account.
+;415 Unsupported Media Type
-−
 ; 415 Unsupported Media Type
 : The Content-Type header was not specified or the specified type is not supported. Use application/json.