Update User¶

Update a user.

Prerequisites¶

Credentials as described in Authentication

C#¶

To update user, first instantiate UserUpsert and set Id, UserName and other basic properties such as FirstName and LastName.

If you are updating a tenant administrator, then you need to set TenantAdmin to true.

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.Update() method to update user by passing the token and the instance of UserUpsert.

var user = new UserUpsert
{
        Id = "e758d6be-6fe4-491c-9f1c-5b6b8d6f79b2",
        UserName = "myuser@company.com",
        FirstName = "Firstname",
        LastName = "LastName",
        TenantAdmin = true // set true if you are updating a tenant administrator, otherwise not necessary to set
};

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

Request¶

Request Syntax:

Method	Request URI
PUT	https://api.crayon.com/api/v1/users/{id}

Request Body:

Name	Type	Description
user	User	The user to update

User Properties:

Name	Type	Required
UserName	string	Yes
FirstName	string	Yes
LastName	string	Yes
TenantAdmin	string	No

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/DCAB448F-3137-40A2-9A27-FCC090A65066"
Accept: application/json
Content-Type: application/json
Authorization: Bearer < Token >

{
    "Id": "DCAB448F-3137-40A2-9A27-FCC090A65066",
    "UserName": "myuser@company.com",
    "FirstName": "Firstname",
    "LastName": "LastName"
}

Response¶

If successful, this method returns the updated user as a User resource in the response body.

Response Body:

{
  "Id": "DCAB448F-3137-40A2-9A27-FCC090A65066",
  "TenantId": 1,
  "UserName": "myuser@company.com",
  "FirstName": "Firstname",
  "LastName": "LastName",
  "Email": "myuser@company.com",
  "EmailConfirmed": false,
  "LockoutEnabled": false,
  "LockoutEnd": null,
  "PhoneNumber": null,
  "PhoneNumberConfirmed": false,
  "TwoFactorEnabled": false,
  "TenantAdmin":  false
}

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.

Update User¶

Prerequisites¶

C#¶

Request¶

Response¶

Was this page helpful?

Was this page helpful?