Delete User Group

This endpoint allows you to permanently remove a user group from the system. This operation cannot be undone.

🔹 Endpoint Details

DELETE /api/v1/user-groups/{id}

🔒 Authentication

Header	Required	Description
Authorization	Yes	Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📝 Request Structure

Path Parameters

Parameter	Type	Required	Description	Example
id	string (UUID)	Yes	Unique identifier of the group to delete	550e8400-e29b-41d4-a716-446655440000

🧩 Request Example

curl -X DELETE "https://openapi.onlive.site/api/v1/user-groups/550e8400-e29b-41d4-a716-446655440000" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"

📤 Response Format

Successful Response (200 OK)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Global Sales Team",
  "description": "International sales team with product management access",
  "externalId": "SALES_TEAM_01",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "extraFields": {
    "department": "Sales",
    "location": "Global",
    "allowedFeatures": [
      "product_management",
      "sales_reports",
      "international_pricing"
    ]
  },
  "createdAt": "2025-05-22T10:30:00Z",
  "updatedAt": "2025-05-22T10:35:00Z",
  "deletedAt": "2025-05-22T11:00:00Z"
}

❌ Error Responses

401 Unauthorized

{
  "statusCode": 401,
  "message": "Invalid or missing authorization credentials"
}

403 Forbidden

{
  "statusCode": 403,
  "message": "Cannot delete user group with active members"
}

404 Not Found

{
  "statusCode": 404,
  "message": "User group not found"
}

📘 Notes

• This operation permanently removes the user group
• All members must be removed before deletion
• Associated data and permissions will be removed
• The deletion cannot be undone
• The response includes the final state of the group
• A deletedAt timestamp is included in the response
• You can only delete groups within your organization

✅ Pre-deletion Checklist

• 👥 Members: Remove all users from the group
• 🔗 Dependencies: Update systems that reference this group
• 📊 Data: Back up any important group data
• 🔐 Permissions: Review and update access controls
• 📱 Applications: Update any apps using this group

🔄 Post-deletion Actions

1. 💾 Update Local Cache

   • Remove group from local storage
   • Update UI to reflect deletion

2. 🌐 System Updates

   • Remove group references
   • Update integration mappings

3. 📢 Notifications

   • Inform affected systems
   • Update documentation

4. ✅ Verification

   • Confirm deletion success
   • Verify dependent systems

---