Cyan Web API

Cyan Web API - Version 1

GET api/userGroups/{userGroupId}

            Gets a UserGroup.

Request Information

Parameters

NameDescriptionAdditional information
userGroupId 

                
                            
Define this parameter in the request URI.

                		
            

    


        
Response Information
 
        
Response body formats




        
application/json, text/json

        

            Sample:

{
  "userGroupId": "83419770-5dbe-462e-a867-49f0031b2411",
  "tenantId": "f6957529-d0e0-40f3-b288-3bc567bb2b7c",
  "lookupKey": "sample string 3",
  "name": "sample string 4",
  "description": "sample string 5",
  "isDefault": true,
  "createdDateUtc": "2025-06-11T01:39:04.7154487+00:00",
  "updatedDateUtc": "2025-06-11T01:39:04.7154487+00:00"
}


        

        
application/xml, text/xml

        

            Sample:

<UserGroupRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2025-06-11T01:39:04.7154487+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-06-11T01:39:04.7154487+00:00</UpdatedDateUtc>
  <Description>sample string 5</Description>
  <IsDefault>true</IsDefault>
  <LookupKey>sample string 3</LookupKey>
  <Name>sample string 4</Name>
  <TenantId>f6957529-d0e0-40f3-b288-3bc567bb2b7c</TenantId>
  <UserGroupId>83419770-5dbe-462e-a867-49f0031b2411</UserGroupId>
</UserGroupRepresentation>