GET securitygroups/{id}

Request Information

URI Parameters

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

Name	Description
id `globally unique identifier` Required Guid ID of the security group to be read.	`globally unique identifier` Required Guid ID of the security group to be 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>281a6e1c-c123-4b7d-871b-6a7e879a9bd4</ID>
  <Group>sample string 1</Group>
  <Description>sample string 2</Description>
  <SiteID>a5e1f946-3886-4c28-90c3-618f908a1c3b</SiteID>
  <Created>2025-02-15T16:07:09.0615148+00:00</Created>
  <CreatedBy>5753b590-617c-4fef-a7d2-cd103b32c848</CreatedBy>
  <Updated>2025-02-15T16:07:09.0615148+00:00</Updated>
  <UpdatedBy>611e0d6f-ba12-42f2-b2be-9a1711f21e85</UpdatedBy>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
</SecurityGroup>

application/json, text/json

Sample

{
  "ID": "281a6e1c-c123-4b7d-871b-6a7e879a9bd4",
  "Group": "sample string 1",
  "Description": "sample string 2",
  "SiteID": "a5e1f946-3886-4c28-90c3-618f908a1c3b",
  "Created": "2025-02-15T16:07:09.0615148+00:00",
  "CreatedBy": "5753b590-617c-4fef-a7d2-cd103b32c848",
  "Updated": "2025-02-15T16:07:09.0615148+00:00",
  "UpdatedBy": "611e0d6f-ba12-42f2-b2be-9a1711f21e85",
  "Deleted": true,
  "DeletedByRef": true
}