GET securitygroups?siteId={siteId}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
siteId `globally unique identifier` Guid ID of the site that is to have its security groups read.	`globally unique identifier` Guid ID of the site that is to have its security groups read.

Body Parameters

None.

Response Information

Resource Description (SecurityGroup)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `globally unique identifier` Required on Update ID of the security group.	`globally unique identifier` Required on Update ID of the security group.
Group `string` Required Name of the security group. (Max length 100 characters)	`string` Required Name of the security group. (Max length 100 characters)
Description `string` Description of the security group	`string` Description of the security group
SiteID `globally unique identifier` Required ID of the site for the security group.	`globally unique identifier` Required ID of the site for the security group.
Created `date` ReadOnly Date the security group was created.	`date` ReadOnly Date the security group was created.
CreatedBy `globally unique identifier` ReadOnly ID of the person that created the security group.	`globally unique identifier` ReadOnly ID of the person that created the security group.
Updated `date` ReadOnly Date the security group was last updated.	`date` ReadOnly Date the security group was last updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the person who updated the security group.	`globally unique identifier` ReadOnly ID of the person who updated the security group.
Deleted `boolean` ReadOnly Deleted status of the security group.	`boolean` ReadOnly Deleted status of the security group.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the security group.	`boolean` ReadOnly Deleted by reference status of the security group.

Response Formats

application/xml, text/xml

Sample

<SecurityGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>c40f93c8-3658-4c7e-a501-63ba074fbd4a</ID>
  <Group>sample string 1</Group>
  <Description>sample string 2</Description>
  <SiteID>bc256054-0534-4469-995e-2e78d241d61b</SiteID>
  <Created>2025-02-04T13:05:43.861198+00:00</Created>
  <CreatedBy>bc2597a3-5a25-4759-8526-f9a9fe9379dd</CreatedBy>
  <Updated>2025-02-04T13:05:43.861198+00:00</Updated>
  <UpdatedBy>ea65e819-e368-4117-a3d9-82fc3ff30899</UpdatedBy>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
</SecurityGroup>

application/json, text/json

Sample

{
  "ID": "c40f93c8-3658-4c7e-a501-63ba074fbd4a",
  "Group": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "bc256054-0534-4469-995e-2e78d241d61b",
  "Created": "2025-02-04T13:05:43.861198+00:00",
  "CreatedBy": "bc2597a3-5a25-4759-8526-f9a9fe9379dd",
  "Updated": "2025-02-04T13:05:43.861198+00:00",
  "UpdatedBy": "ea65e819-e368-4117-a3d9-82fc3ff30899",
  "Deleted": true,
  "DeletedByRef": true
}