Skip to main content

Get UserGroups

Get a list of existing user groups.

Header Parameters
  • mode

    Possible values: [EdgeMode]

Responses

Success

Response Headers

    Schema
    • userGroups object[]
    • id int32

      User group id

    • name string

      user group name

    • GUID string

      globally unique identifier for user group

    • 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)

    • description string
    • enabled boolean

      returns if the user group is enabled or disabled

    • allowMultipleCompanyMembers boolean

      This property denotes that addition of users/groups from child companies is allowed. Only applicable for commcell and reseller company group.

    • company object
    • id int32
    • name string
    • commcell object
    • name string

      Name of the commcell the entity belongs to.

    • users object[]
    • id int32
    • name string
    Loading...