Back

GET sites/{siteId}/securitygroups

Read security groups.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
siteId 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
ID globally unique identifier Required on Update

ID of the security group.
Group string Required

Name of the security group. (Max length 100 characters)
Description string

Description of the security group
SiteID globally unique identifier Required

ID of the site for the security group.
Created date ReadOnly

Date the security group was created.
CreatedBy globally unique identifier ReadOnly

ID of the person that created the security group.
Updated date ReadOnly

Date the security group was last updated.
UpdatedBy globally unique identifier ReadOnly

ID of the person who updated the security group.
Deleted boolean ReadOnly

Deleted status of the security group.
DeletedByRef 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>9d7ddfea-4b50-44d6-be70-4a1f729f57a0</ID>
  <Group>sample string 1</Group>
  <Description>sample string 2</Description>
  <SiteID>639b2c8e-2360-410c-a88e-8d3367d860a4</SiteID>
  <Created>2024-10-24T15:50:15.6506837+00:00</Created>
  <CreatedBy>cae6a766-4d17-4558-9e1c-a4fcdba91326</CreatedBy>
  <Updated>2024-10-24T15:50:15.6506837+00:00</Updated>
  <UpdatedBy>37fbf041-056c-46b7-957f-e967ae4f6cbf</UpdatedBy>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
</SecurityGroup>

application/json, text/json

Sample
{
  "ID": "9d7ddfea-4b50-44d6-be70-4a1f729f57a0",
  "Group": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "639b2c8e-2360-410c-a88e-8d3367d860a4",
  "Created": "2024-10-24T15:50:15.6506837+00:00",
  "CreatedBy": "cae6a766-4d17-4558-9e1c-a4fcdba91326",
  "Updated": "2024-10-24T15:50:15.6506837+00:00",
  "UpdatedBy": "37fbf041-056c-46b7-957f-e967ae4f6cbf",
  "Deleted": true,
  "DeletedByRef": true
}