Skip to main content

Get User Group Details​

Select

SaaS
Customer Managed

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]

Responses

Success

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 int32
  • name string
  • laptopAdmins boolean

    When set to true, users in this group cannot activate or be set as server owner

  • associatedLocalGroups object[]
  • id int32
  • name string
  • plan object
  • id int32
  • name string
  • company object
  • id int32
  • name string
  • users object[]

    Returns list of users that are associated with this userGroup

  • id int32
  • name string
  • associatedEntities object[]
  • id int32
  • name string
  • type string

    type of entities associated.

  • role object
  • id int32
  • name string
  • permissionList 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 int32
  • permissionName string
  • categoryId int32
  • categoryName string
  • type string

    Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

    Returns the type of association.

  • exclude boolean

    Flag 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.

  • doNotInheritRestrictConsoleTypes boolean

    RestrictConsoleTypes are inherited from the parent or not.

  • restrictedConsoleTypes object[]
  • consoleType string

    Possible values: [COMMANDCENTER, WEBCONSOLE, COMMCELLCONSOLE, API, MOBILE]

    This is console type

  • parent object
  • id int32
  • name string
  • type 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

  • globalConfigInfo object

    Only applicable on Global CommCells

  • id string
  • name string
  • commcells object[]

    List of Service CommCells where the global configuration is applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config is applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string used for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • isMarkedForDeletion boolean

    Indicates whether global configuration deletion has been started.

  • status string
GET /v4/usergroup/:usergroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
userGroupId — path required
mode — header
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/UserGroup/:userGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'