Cyan Web API - Version 1

GET api/userGroups

            Gets all UserGroups.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "userGroupId": "5318ff05-5516-4ce1-ab70-e24ac26e8600",
    "tenantId": "f3dd7013-9f81-4f7a-a719-2b0204eb5c7e",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2025-07-08T01:37:19.2752425+00:00",
    "updatedDateUtc": "2025-07-08T01:37:19.2752425+00:00"
  },
  {
    "userGroupId": "5318ff05-5516-4ce1-ab70-e24ac26e8600",
    "tenantId": "f3dd7013-9f81-4f7a-a719-2b0204eb5c7e",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2025-07-08T01:37:19.2752425+00:00",
    "updatedDateUtc": "2025-07-08T01:37:19.2752425+00:00"
  },
  {
    "userGroupId": "5318ff05-5516-4ce1-ab70-e24ac26e8600",
    "tenantId": "f3dd7013-9f81-4f7a-a719-2b0204eb5c7e",
    "lookupKey": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "isDefault": true,
    "createdDateUtc": "2025-07-08T01:37:19.2752425+00:00",
    "updatedDateUtc": "2025-07-08T01:37:19.2752425+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>2025-07-08T01:37:19.2752425+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-08T01:37:19.2752425+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>f3dd7013-9f81-4f7a-a719-2b0204eb5c7e</TenantId>
    <UserGroupId>5318ff05-5516-4ce1-ab70-e24ac26e8600</UserGroupId>
  </UserGroupRepresentation>
  <UserGroupRepresentation>
    <CreatedDateUtc>2025-07-08T01:37:19.2752425+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-08T01:37:19.2752425+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>f3dd7013-9f81-4f7a-a719-2b0204eb5c7e</TenantId>
    <UserGroupId>5318ff05-5516-4ce1-ab70-e24ac26e8600</UserGroupId>
  </UserGroupRepresentation>
  <UserGroupRepresentation>
    <CreatedDateUtc>2025-07-08T01:37:19.2752425+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-08T01:37:19.2752425+00:00</UpdatedDateUtc>
    <Description>sample string 5</Description>
    <IsDefault>true</IsDefault>
    <LookupKey>sample string 3</LookupKey>
    <Name>sample string 4</Name>
    <TenantId>f3dd7013-9f81-4f7a-a719-2b0204eb5c7e</TenantId>
    <UserGroupId>5318ff05-5516-4ce1-ab70-e24ac26e8600</UserGroupId>
  </UserGroupRepresentation>
</ArrayOfUserGroupRepresentation>