Get Usergroup Details By Name

Select

SaaS

Customer Managed

This operation returns the properties associated with a user group.

Path Parameters

• UserGroupName string required

  Name of the Usergroup

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Get Usergroup Details

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• userGroups object[]

  description string

  allAssociations boolean

  enforceFSQuota boolean

  enabled boolean

  agePasswordDays integer

  email string

  edgeDriveQuotaLimitInGB integer

  enforceEdgeDriveQuota boolean

  quotaLimitInGB integer

  preferenceMachineCentricClient boolean

  allCapabilities boolean

  securityAssociations object

  associations object[]

  entities object

  entity object[]

  commCellName string

  commCellId integer

  _type_ integer

  properties object

  isCreatorAssociation boolean

  categoryPermission object

  categoriesPermissionList object[]

  permissionId integer

  permissionName string

  _type_ integer

  categoryId integer

  permissions object[]

  permissionId integer

  permissionName string

  role object

  _type_ integer

  roleId integer

  roleName string

  provider object

  providerId integer

  userGroupEntity object

  userGroupId integer

  userGroupName string

  plan object

  users object[]

  userName string

  userId integer

  vcloudGroupProp object

  groupSecurity object

  ownerAssociations object

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "userGroups": [
    {
      "description": "string",
      "allAssociations": true,
      "enforceFSQuota": true,
      "enabled": true,
      "agePasswordDays": 0,
      "email": "string",
      "edgeDriveQuotaLimitInGB": 0,
      "enforceEdgeDriveQuota": true,
      "quotaLimitInGB": 0,
      "preferenceMachineCentricClient": true,
      "allCapabilities": true,
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {
                  "commCellName": "string",
                  "commCellId": 0,
                  "_type_": 0
                }
              ]
            },
            "properties": {
              "isCreatorAssociation": true,
              "categoryPermission": {
                "categoriesPermissionList": [
                  {
                    "permissionId": 0,
                    "permissionName": "string",
                    "_type_": 0,
                    "categoryId": 0
                  }
                ]
              },
              "permissions": [
                {
                  "permissionId": 0,
                  "permissionName": "string"
                }
              ],
              "role": {
                "_type_": 0,
                "roleId": 0,
                "roleName": "string"
              }
            }
          }
        ]
      },
      "provider": {
        "providerId": 0
      },
      "userGroupEntity": {
        "userGroupId": 0,
        "userGroupName": "string"
      },
      "plan": {},
      "users": [
        {
          "userName": "string",
          "userId": 0
        }
      ],
      "vcloudGroupProp": {},
      "groupSecurity": {
        "ownerAssociations": {}
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "userGroups": [
    {
      "description": "Administrative Group",
      "allAssociations": true,
      "enforceFSQuota": false,
      "enabled": true,
      "agePasswordDays": 0,
      "email": "",
      "edgeDriveQuotaLimitInGB": 100,
      "enforceEdgeDriveQuota": false,
      "quotaLimitInGB": 100,
      "preferenceMachineCentricClient": true,
      "allCapabilities": true,
      "securityAssociations": {
        "associations": [
          {
            "entities": {
              "entity": [
                {
                  "commCellName": "firewalltestcs",
                  "commCellId": 2,
                  "_type_": 1
                }
              ]
            },
            "properties": {
              "isCreatorAssociation": true,
              "categoryPermission": {
                "categoriesPermissionList": [
                  {
                    "permissionId": 178,
                    "permissionName": "VPN Management",
                    "_type_": 122,
                    "categoryId": 102
                  }
                ]
              }
            }
          },
          {
            "entities": {
              "entity": [
                {
                  "commCellName": "firewalltestcs",
                  "commCellId": 2,
                  "_type_": 1
                }
              ]
            },
            "properties": {
              "isCreatorAssociation": false,
              "categoryPermission": {
                "categoriesPermissionList": [
                  {
                    "permissionId": 179,
                    "permissionName": "Create Client Group",
                    "_type_": 122,
                    "categoryId": 122
                  }
                ]
              }
            }
          },
          {
            "entities": {
              "entity": [
                {
                  "commCellName": "firewalltestcs",
                  "commCellId": 2,
                  "_type_": 1
                }
              ]
            },
            "properties": {
              "isCreatorAssociation": true,
              "permissions": [
                {
                  "permissionId": 178,
                  "permissionName": "VPN Management"
                }
              ]
            }
          },
          {
            "entities": {
              "entity": [
                {
                  "commCellName": "firewalltestcs",
                  "commCellId": 2,
                  "_type_": 1
                }
              ]
            },
            "properties": {
              "isCreatorAssociation": false,
              "permissions": [
                {
                  "permissionId": 179,
                  "permissionName": "Create Client Group"
                }
              ]
            }
          },
          {
            "entities": {
              "entity": [
                {
                  "commCellName": "firewalltestcs",
                  "commCellId": 2,
                  "_type_": 1
                }
              ]
            },
            "properties": {
              "isCreatorAssociation": true,
              "role": {
                "_type_": 120,
                "roleId": 1,
                "roleName": "Master"
              }
            }
          }
        ]
      },
      "provider": {
        "providerId": 0
      },
      "userGroupEntity": {
        "userGroupId": 1,
        "userGroupName": "master"
      },
      "plan": {},
      "users": [
        {
          "userName": "testadmin",
          "userId": 1
        }
      ],
      "vcloudGroupProp": {},
      "groupSecurity": {
        "ownerAssociations": {}
      }
    }
  ]
}

Loading...