Change User Password
====================

Change user's password.

Prerequisites
^^^^^^^^^^^^^

- Credentials as described in :doc:`/getting-started/authentication`

C#
^^

To change user's password, first instantiate **UserChangePassword** and set **Id**, **OldPassword** and **NewPassword**.

Next, get the instance of **CrayonApiClient** and then get the client token using the instance. This client token will be passed when changing the password.

Finally, call **Users.ChangePassword()** method to create user by passing the **token**, **user ID**, **old password** and **new password**.

.. code-block:: c#
	:emphasize-lines: 4

	var client = new CrayonApiClient("http://v1.api.crayon.as/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
	
	client.Users.ChangePassword(token, userId, "oldpassword", "newpassword");


Request
^^^^^^^

Request Syntax:

+---------+-------------------------------------------------------------+
| Method  | Request URI                                                 |
+=========+=============================================================+
| PUT     | *https://api.crayon.com/api/v1/users/{id}/changepassword*   |
+---------+-------------------------------------------------------------+

Request Body:

+-------------------+----------------------------------------------+-----------------------------------+
| Name              | Type                                         | Description                       |
+===================+==============================================+===================================+
| user              | :doc:`/resources/User`                       | The user to create                |
+-------------------+----------------------------------------------+-----------------------------------+

User Properties:

+-------------------------+--------------------+----------------+
| Name                    | Type               | Required       |
+=========================+====================+================+
| Id                      | string             | Yes            |
+-------------------------+--------------------+----------------+
| OldPassword             | string             | Yes            |
+-------------------------+--------------------+----------------+
| NewPassword             | string             | Yes            |
+-------------------------+--------------------+----------------+

Request Headers:

The following HTTP request headers are supported

+------------------+----------------+-----------------------------------------------------------------+
| Header           | Type           | Description                                                     |
+==================+================+=================================================================+
| Authorization    | string         | Required. The authorization token in the form Bearer <token>.   |
+------------------+----------------+----------------------------------------------+------------------+
| Accept           | string         | Specifies the request and response type, "application/json".    |
+------------------+----------------+----------------------------------------------+------------------+
| Content-Type     | string         | Specifies the media type of the resource, "application/json".   |
+------------------+----------------+----------------------------------------------+------------------+


Request Example:

::

	PUT $"https://api.crayon.com/api/v1/users/e758d6be-6fe4-491c-9f1c-5b6b8d6f79b2/changepassword"
	Accept: application/json
	Content-Type: application/json 
	Authorization: Bearer < Token >

.. literalinclude:: /scenarios/_static/UserChangePasswordRequest.json
		:language: json

Response
^^^^^^^^
If successful, this method returns **200 OK**.

Response Body:

.. code-block:: json

    true


If old password is wrong, this method returns **400 Bad Request**.

Response Body:

.. literalinclude:: /scenarios/_static/UserChangesPasswordWrongOldPasswordResponse.json
		:language: json

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error Codes                    | Description                                                                                                                                                                                                                                                                               |
+================================+===========================================================================================================================================================================================================================================================================================+
| 200 Ok                         | The request has succeeded.                                                                                                                                                                                                                                                                |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400 Bad Request                | The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn't be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications.   |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401 Unauthorized               | The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+