Group resource data model

/Group

Dictionary table

Attribute	Type	Required	Updatable	Description	Additional comment
id	Long	Yes	-	Primary key of the group
name	String	Yes	Yes	Name used to identify a group	Name must be unique
quota	String	-	Yes	Quota allocated to the shared folder
description	String	-	Yes	Description of the group
parentGroup	String	-	Yes	Name of the parent group	Only the root group doesn't have value. The groups have a tree structure.
type	String	-	Yes	ID of the organizational unit type	Organizational units type are managed in the IAM Console (Administration > Configure Soffid > Global Settings > Group Type)
driveLetter	String	-	Yes	Drive letter used to get access to this group's drive	This shared folder can be mounted on ESSO hosts by using a startup script Only one character are allowed
driveServerName	String	-	Yes	File server to store this group's drive	Only applies when used in combination with shared folder agents and script logons. If specified, a shared folder for this group will be created.
obsolete	Boolean	-	Yes
organizational	Boolean	-	Yes
section	String	-	Yes
meta	ScimMeta resourceType (String) created (Date) lastModified (Date) location (String)	-	-	Additional information recommended in SCIM definition: resourceType: Resource requested (in this case "Group") created: user creation date lastModified: last modification date of any user attributes location: URL tof the resource <domain>/webservice/scim/Group/<id>	These attributes are returned in the response These attributes are not updatable
attributes	Map<String, Object> "attribute" : "value"	-	Yes	Additional data assigned to the group	Attributes are defined in the IAM Console (Administration > Configure Soffid > Global Settings > Metadata) Values are managed in the IAM Console (Administration > Resources > Groups)

Full JSON example

{
  "organizational": true,
  "driveLetter": "G",
  "obsolete": true,
  "description": "Enterprise engineering team",
  "section": null,
  "type": null,
  "meta": {
    "location": "http://<domain>/webservice/scim2/v1/Group/11345",
    "resourceType": "Group"
  },
  "quota": "0",
  "name": "Engineering team",
  "parentGroup": "enterprise",
  "attributes": {},
  "id": 11345
}