Skip to main content

Create User group

Select

SaaS
Customer Managed

Create a new user-group

Request Body
  • name string required

    To create an active directory usergroup, the domain name should be mentioned along with the usergroup name (domainName\usergroupName) and localUserGroup value must be given.

  • description string
  • enforceFSQuota boolean

    Used to determine if a backup data limit will be set for the user group being created

  • quotaLimitInGB int32

    if enforceFSQuota is set to true, the quota limit can be set in GBs

  • localUserGroups object[]

    This option is for AD user groups being created. Local user groups can be added to the active directory user groups.

  • id int32
  • name string
  • globalConfigInfo object

    Only applicable to Global CommCells. Not applicable for SaaS.

  • name string
  • commcells object[]

    List of Service CommCells where the global configuration should be applied

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

    The entity level at which the config has to be applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string using for filtering the scope

  • applyOnAllCommCells boolean

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

  • actionOnLocalEntity string

    Possible values: [CREATE_NEW, TAKE_OVER, FAIL_IF_EXIST]

    Action that will be taken on the local entity that has the same name as the global entity that needs to be created

Responses

Success


Schema
  • id int32
  • GUID string
  • name string
POST /v4/usergroup    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{
"name": "string",
"description": "string",
"enforceFSQuota": true,
"quotaLimitInGB": 0,
"localUserGroups": [
{
"id": 0,
"name": "string"
}
],
"globalConfigInfo": {
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"actionOnLocalEntity": "CREATE_NEW"
}
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/UserGroup' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"name": "string",
"description": "string",
"enforceFSQuota": true,
"quotaLimitInGB": 0,
"localUserGroups": [
{
"id": 0,
"name": "string"
}
],
"globalConfigInfo": {
"name": "string",
"commcells": [
{
"id": 0,
"name": "string",
"guid": "string"
}
],
"scope": "string",
"scopeFilterQuery": "string",
"applyOnAllCommCells": true,
"actionOnLocalEntity": "CREATE_NEW"
}
}'