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": "926bc6c5-3422-40a8-b34f-1b114bf16d04",
  "tenantId": "8c8a872d-4c14-4131-ac2e-7fcebbaa3b85",
  "userGroupId": "1d3ea3b6-f438-4cc6-82ea-681f3db677ec",
  "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-02-01T08:28:22.0101367+00:00",
  "updatedDateUtc": "2026-02-01T08:28:22.0101367+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-02-01T08:28:22.0101367+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-01T08:28:22.0101367+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>8c8a872d-4c14-4131-ac2e-7fcebbaa3b85</TenantId>
  <UserGroupId>1d3ea3b6-f438-4cc6-82ea-681f3db677ec</UserGroupId>
  <UserId>926bc6c5-3422-40a8-b34f-1b114bf16d04</UserId>
  <UserName>sample string 4</UserName>
</UserRepresentation>