destroyGroup

Destroy a group in a domain. The users within the group no longer belong to the destroyed group. If the group’s domain is an EXTERNAL domain, only the read-only reference to the group is deleted. The group still exists within that domain, but it is not visible to the TDV Server.

Location

/services/webservices/system/admin/user/operations/

Request Elements

domainName: The domain name.

groupName: The name of the group to destroy.

Request Example

<user:destroyGroup xmlns:user="http://www.compositesw.com/services/system/admin/user">
  <user:domainName>composite</user:domainName>
  <user:groupName>backup_admins</user:groupName>
</user:destroyGroup>

Response Elements

N/A

Faults

NotAllowed: If the group cannot be destroyed. For example, the “all” group in the composite domain cannot be destroyed.

NotAllowed: If an attempt is made to use this operation with an insufficient license.

NotFound: If the group does not exist.

NotFound: If the domain does not exist.

Security: If the user does not have the ACCESS_TOOLS and MODIFY_ALL_USERS rights.