Skip to main content

Get UserGroups​

Select

SaaS
Customer Managed

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
    • plan object
    • id int32
    • name string
    • provider object
    • id int32
    • name 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
    • 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

    Authorization

    type: apiKeyname: Authtokenin: header

    Request

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