Delete User
===========

Delete a user.

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

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

C#
^^

To delete user, set the **user ID**.

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

Finally, call **Users.Delete()** method to delete user by passing the token and the **user ID**.

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

	var id = "e758d6be-6fe4-491c-9f1c-5b6b8d6f79b2";
	
	var client = new CrayonApiClient("http://v1.api.crayon.as/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
	var deleteUserResponse = client.Users.Delete(token, id);


Request
^^^^^^^

Request Syntax:

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

Request Body:

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

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:

::

	DELETE $"https://api.crayon.com/api/v1/users/DCAB448F-3137-40A2-9A27-FCC090A65066"
	Accept: application/json
	Content-Type: application/json 
	Authorization: Bearer < Token >

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

Response Body:

.. code-block:: json

	true

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.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+