Delete User Group By Name

This operation deletes a user group.

Path Parameters

UserGroupName string required
Name of the Usergroup

Query Parameters

newUserId string
Id of the user to which the properties be transferred. Also can give name of the user by "newUserId=byName(userName=''{NewUserName'')"
newUserGroupId string
Id of the user group to which the properties be transferred. Also can give name of the user group by "newUserId=byName(userGroupName=''{NewUserGroupName'')"

Responses

application/json

Schema
Example (from schema)
User Group Deletion without ownership transfer
User Group with ownership transfer to new user / User Group/383?new User Id=1

Schema

processinginstructioninfo object
attributes object[]
name string
value string
response object[]
errorString string
errorCode integer
entity object
GUID string
userGroupName string
userGroupId integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorString": "string",
      "errorCode": 0,
      "entity": {
        "GUID": "string",
        "userGroupName": "string",
        "userGroupId": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorString": "Success",
      "errorCode": 0,
      "entity": {
        "GUID": "65F0EAC3-170B-4903-B2F3-3E4EE85EAE3E",
        "userGroupName": "NewGroup",
        "userGroupId": 378
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorString": "Success",
      "errorCode": 0,
      "entity": {
        "GUID": "BA0A3FD7-C5BF-41A9-8688-79E50FFA4F79",
        "userGroupName": "testing",
        "userGroupId": 383
      }
    }
  ]
}

Delete User Group By Name​

Delete User Group By Name