Get User Group Details
Get details of a user-group based on id
Path Parameters
- userGroupId int32 required
Id of the user-group whose details have to be fetched
Header Parameters
- mode
Possible values: [
EdgeMode
]
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
- id string
- name string
- GUID string
- description string
- enabled boolean
Returns if the user group is enabled or disabled
- enforceFSQuota boolean
- quotaLimitInGB int32
- serviceType string
Possible 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)
- email string
Returns if there is a email ID associated with the usergroup.
- enableTwoFactorAuthentication string
Possible values: [
ON
,OFF
,DISABLED_AT_COMPANY
]Allows two-factor authentication to be enabled for the specific types of usergroups. it can be turned on or off based on user preferences. There will be usergroups that will not have this option.
- enableLocalAuthentication string
Possible values: [
ON
,OFF
,DISABLED_AT_COMPANY
]Allows two-factor authentication to be enabled for the specific types of usergroups. it can be turned on or off based on user preferences. There will be usergroups that will not have this option.
associatedExternalGroups object[]
id int32name string- laptopAdmins boolean
When set to true, users in this group cannot activate or be set as server owner
associatedLocalGroups object[]
id int32name stringplan object
id int32name stringcompany object
id int32name stringusers object[]
Returns list of users that are associated with this userGroup
id int32name stringassociatedEntities object[]
id int32name stringtype stringtype of entities associated.
role object
id int32name stringpermissionList object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES
,CATEGORY_ENTITY
,PERMISSION_ENTITY
]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
- eligibleToAllowMultipleCompanyMembers boolean
Read only property. Denotes if the group is eligible for allowMultipleCompanyMembers
- allowMultipleCompanyMembers boolean
Default value:
false
This property denotes that addition of users/groups from child companies is allowed. Only applicable for commcell and reseller company group.
restrictedConsoleTypes object[]
consoleType stringPossible values: [
COMMANDCENTER
,WEBCONSOLE
,COMMCELLCONSOLE
,API
,MOBILE
]This is console type
parent object
id int32name stringtype string- azureGUID string
Azure Object ID used to link this user group to Azure AD group and manage group membership of the user during SAML login
- showAzureGuidOption boolean
Read only property. Denotes if the group is eligible to have Azure Object ID property
{
"id": "string",
"name": "string",
"GUID": "string",
"description": "string",
"enabled": true,
"enforceFSQuota": true,
"quotaLimitInGB": 0,
"serviceType": "UNKNOWN",
"email": "string",
"enableTwoFactorAuthentication": "ON",
"enableLocalAuthentication": "ON",
"associatedExternalGroups": [
{
"id": 0,
"name": "string"
}
],
"laptopAdmins": true,
"associatedLocalGroups": [
{
"id": 0,
"name": "string"
}
],
"plan": {
"id": 0,
"name": "string"
},
"company": {
"id": 0,
"name": "string"
},
"users": [
{
"id": 0,
"name": "string"
}
],
"associatedEntities": [
{
"id": 0,
"name": "string",
"type": "string",
"role": {
"id": 0,
"name": "string"
},
"permissionList": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
}
],
"eligibleToAllowMultipleCompanyMembers": true,
"allowMultipleCompanyMembers": false,
"restrictedConsoleTypes": [
{
"consoleType": "COMMANDCENTER",
"parent": {
"id": 0,
"name": "string",
"type": "string"
}
}
],
"azureGUID": "string",
"showAzureGuidOption": true
}
Requested Details not found