Cyan Web API - Version 1

GET api/userGroups

            Gets all UserGroups.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "userGroupId": "d96c95d9-b556-4529-a4a2-7e1c3d39d8cf",
    "tenantId": "3d7cc763-431f-4864-861e-596b3a1e571a",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2026-02-05T08:27:29.4703205+00:00",
    "updatedDateUtc": "2026-02-05T08:27:29.4703205+00:00"
  },
  {
    "userGroupId": "d96c95d9-b556-4529-a4a2-7e1c3d39d8cf",
    "tenantId": "3d7cc763-431f-4864-861e-596b3a1e571a",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2026-02-05T08:27:29.4703205+00:00",
    "updatedDateUtc": "2026-02-05T08:27:29.4703205+00:00"
  },
  {
    "userGroupId": "d96c95d9-b556-4529-a4a2-7e1c3d39d8cf",
    "tenantId": "3d7cc763-431f-4864-861e-596b3a1e571a",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2026-02-05T08:27:29.4703205+00:00",
    "updatedDateUtc": "2026-02-05T08:27:29.4703205+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserGroupRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <UserGroupRepresentation>
    <CreatedDateUtc>2026-02-05T08:27:29.4703205+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-05T08:27:29.4703205+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>3d7cc763-431f-4864-861e-596b3a1e571a</TenantId>
    <UserGroupId>d96c95d9-b556-4529-a4a2-7e1c3d39d8cf</UserGroupId>
  </UserGroupRepresentation>
  <UserGroupRepresentation>
    <CreatedDateUtc>2026-02-05T08:27:29.4703205+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-05T08:27:29.4703205+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>3d7cc763-431f-4864-861e-596b3a1e571a</TenantId>
    <UserGroupId>d96c95d9-b556-4529-a4a2-7e1c3d39d8cf</UserGroupId>
  </UserGroupRepresentation>
  <UserGroupRepresentation>
    <CreatedDateUtc>2026-02-05T08:27:29.4703205+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-05T08:27:29.4703205+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>3d7cc763-431f-4864-861e-596b3a1e571a</TenantId>
    <UserGroupId>d96c95d9-b556-4529-a4a2-7e1c3d39d8cf</UserGroupId>
  </UserGroupRepresentation>
</ArrayOfUserGroupRepresentation>