Cyan Web API - Version 1


GET api/users?{userName}

            Gets a User by Tenant and UserName.
            

Request Information

Parameters

NameDescriptionAdditional information
userName
The Cyan username of the user

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "userId": "eccab328-ccd7-444a-8729-5a3b4372b90f",
  "tenantId": "1939d158-8e7a-4d04-9d52-7bd4e3c2154c",
  "userGroupId": "d2833fdc-8970-4229-b5df-2668c39aeff7",
  "membershipUserId": 3,
  "userName": "sample string 4",
  "description": "sample string 5",
  "roles": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "password": "sample string 6",
  "disabled": true,
  "emailAddress": "sample string 8",
  "primaryPhone": "sample string 9",
  "custom01": "sample string 10",
  "custom02": "sample string 11",
  "custom03": "sample string 12",
  "custom04": "sample string 13",
  "custom05": "sample string 14",
  "createdDateUtc": "2026-09-23T03:15:51.7748897+00:00",
  "updatedDateUtc": "2026-09-23T03:15:51.7748897+00:00"
}

application/xml, text/xml

Sample:
<UserRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2026-09-23T03:15:51.7748897+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-23T03:15:51.7748897+00:00</UpdatedDateUtc>
  <Custom01>sample string 10</Custom01>
  <Custom02>sample string 11</Custom02>
  <Custom03>sample string 12</Custom03>
  <Custom04>sample string 13</Custom04>
  <Custom05>sample string 14</Custom05>
  <Description>sample string 5</Description>
  <Disabled>true</Disabled>
  <EmailAddress>sample string 8</EmailAddress>
  <MembershipUserId>3</MembershipUserId>
  <Password>sample string 6</Password>
  <PrimaryPhone>sample string 9</PrimaryPhone>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </Roles>
  <TenantId>1939d158-8e7a-4d04-9d52-7bd4e3c2154c</TenantId>
  <UserGroupId>d2833fdc-8970-4229-b5df-2668c39aeff7</UserGroupId>
  <UserId>eccab328-ccd7-444a-8729-5a3b4372b90f</UserId>
  <UserName>sample string 4</UserName>
</UserRepresentation>