PUT /api/users/{UserID}/password

Modifies the password of a user in the system.

Authorization Roles/Permissions: Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/users/{UserID}/password

Back to top

Sample Request

In the example below, the user changes the password from Margaret10 to Margaret11.

Request URL

https://{hostname}/api/users/eceffbe3-3386-495b-80d3-7526f0eb0edc.acmepaymentscorp/password

Sample request headers

PUT /api/users/eceffbe3-3386-495b-80d3-7526f0eb0edc.acmepaymentscorp/password HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "OldPassword":"Margaret10",
  "NewPassword":"Margaret11"
}

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept text/plain
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.
PasswordChange Body PasswordChange Required Contains information about a change of user password or email address.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the UserID in plain text.

Back to top

Sample Response

The sample response below shows the user ID returned as confirmation that the operation was successful.

Sample response headers

HTTP/1.1 200 OK
Date: 	
Thu, 25 May 2017 18:39:17 GMT
Content-Type: text/plain

Sample response body

eceffbe3-3386-495b-80d3-7526f0eb0edc.acmepaymentscorp

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
UserID string The unique ID for a specific user.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics