Cyan Web API - Version 1


GET api/users

            Gets all of the users within a tenant.
            

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "userId": "fe42f6ea-f3a5-4a26-b3ca-dbb5533ade8a",
    "tenantId": "2ea6d760-9786-490d-a6c0-79d4e43f6cb9",
    "userGroupId": "3f1d09ba-85b5-4bce-8c4a-a9bbe3aca704",
    "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": "2024-08-31T11:03:53.3701532+00:00",
    "updatedDateUtc": "2024-08-31T11:03:53.3701532+00:00"
  },
  {
    "userId": "fe42f6ea-f3a5-4a26-b3ca-dbb5533ade8a",
    "tenantId": "2ea6d760-9786-490d-a6c0-79d4e43f6cb9",
    "userGroupId": "3f1d09ba-85b5-4bce-8c4a-a9bbe3aca704",
    "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": "2024-08-31T11:03:53.3701532+00:00",
    "updatedDateUtc": "2024-08-31T11:03:53.3701532+00:00"
  },
  {
    "userId": "fe42f6ea-f3a5-4a26-b3ca-dbb5533ade8a",
    "tenantId": "2ea6d760-9786-490d-a6c0-79d4e43f6cb9",
    "userGroupId": "3f1d09ba-85b5-4bce-8c4a-a9bbe3aca704",
    "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": "2024-08-31T11:03:53.3701532+00:00",
    "updatedDateUtc": "2024-08-31T11:03:53.3701532+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfUserRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <UserRepresentation>
    <CreatedDateUtc>2024-08-31T11:03:53.3701532+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-08-31T11:03:53.3701532+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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </Roles>
    <TenantId>2ea6d760-9786-490d-a6c0-79d4e43f6cb9</TenantId>
    <UserGroupId>3f1d09ba-85b5-4bce-8c4a-a9bbe3aca704</UserGroupId>
    <UserId>fe42f6ea-f3a5-4a26-b3ca-dbb5533ade8a</UserId>
    <UserName>sample string 4</UserName>
  </UserRepresentation>
  <UserRepresentation>
    <CreatedDateUtc>2024-08-31T11:03:53.3701532+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-08-31T11:03:53.3701532+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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </Roles>
    <TenantId>2ea6d760-9786-490d-a6c0-79d4e43f6cb9</TenantId>
    <UserGroupId>3f1d09ba-85b5-4bce-8c4a-a9bbe3aca704</UserGroupId>
    <UserId>fe42f6ea-f3a5-4a26-b3ca-dbb5533ade8a</UserId>
    <UserName>sample string 4</UserName>
  </UserRepresentation>
  <UserRepresentation>
    <CreatedDateUtc>2024-08-31T11:03:53.3701532+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-08-31T11:03:53.3701532+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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </Roles>
    <TenantId>2ea6d760-9786-490d-a6c0-79d4e43f6cb9</TenantId>
    <UserGroupId>3f1d09ba-85b5-4bce-8c4a-a9bbe3aca704</UserGroupId>
    <UserId>fe42f6ea-f3a5-4a26-b3ca-dbb5533ade8a</UserId>
    <UserName>sample string 4</UserName>
  </UserRepresentation>
</ArrayOfUserRepresentation>