Get UserGroups
Select
Get a list of existing user groups.
Header Parameters
- mode
Possible values: [
EdgeMode
]
- 200
- 404
Success
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
userGroups object[]
id int32User group id
name stringuser group name
GUID stringglobally unique identifier for user group
serviceType stringPossible values: [
UNKNOWN
,COMMSERVE
,ACTIVE_DIRECTORY
,DOMINO_DIRECTORTY_SERVICE
,HOSTED_EXCHANGE
,ORGANIZATIONS
,DUMMY_DOMAIN
]The values that are returned by serviceType are- 0(unknown),1(commserver users),2(Active directory users),3(domino directory service users),4(hosted exchange users),5(company users),12(dummy domain users)
description stringplan object
id int32name stringprovider object
id int32name stringenabled booleanreturns if the user group is enabled or disabled
allowMultipleCompanyMembers booleanThis property denotes that addition of users/groups from child companies is allowed. Only applicable for commcell and reseller company group.
company object
id int32name stringcommcell object
name stringName of the commcell the entity belongs to.
users object[]
id int32name stringglobalConfigInfo object
Only applicable on Global CommCells
id stringname stringcommcells object[]
List of Service CommCells where the global configuration is applied
id int32name stringguid stringscope stringThe entity level at which the config is applied.
scopeFilterQuery stringCommCellEntityCache filter query string used for filtering the scope
applyOnAllCommCells booleanDecides whether the global configuration should be applied to all the Service commcells, including the newly created ones
isMarkedForDeletion booleanIndicates whether global configuration deletion has been started.
status string
{
"userGroups": [
{
"id": 0,
"name": "string",
"GUID": "string",
"serviceType": "UNKNOWN",
"description": "string",
"plan": {
"id": 0,
"name": "string"
},
"provider": {
"id": 0,
"name": "string"
},
"enabled": true,
"allowMultipleCompanyMembers": true,
"company": {
"id": 0,
"name": "string"
},
"commcell": {
"name": "string"
},
"users": [
{
"id": 0,
"name": "string"
}
],
"globalConfigInfo": {
"id": "string",
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"isMarkedForDeletion": true,
"status": "string"
}
}
]
}
Requested Details not found