Get user by username

Returns a single user by username



To get user, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call Users.GetByUserName() method to get the user by passing token and username.

var username = <username>;
var client = new CrayonApiClient("");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

var result = client.Users.GetByUserName(token, username);


Request Syntax:

Method Request URI

Request Parameters:

Name Type Description
userName string Username of user, usually an email

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:

GET $"{userName}""
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >


If successful, this method returns a list of User resources in the response body.

  "Id": "2DAB448F-4677-40A2-9A27-FCC090A65066",
  "TenantId": 1,
  "UserName": "",
  "FirstName": "Firstname",
  "LastName": "Lastname",
  "Email": "",
  "EmailConfirmed": false,
  "LockoutEnabled": false,
  "LockoutEnd": null,
  "PhoneNumber": null,
  "PhoneNumberConfirmed": false,
  "TwoFactorEnabled": 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.
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.