Delete Cloud Dynamic User Groups
DELETE/directory-sync/v1/cloud-dug-definition/group
Deletes a specific Cloud Dynamic User Group by objectGUID or all groups in a category by defID.
How it Works
- Use
objectGUIDto delete a specific group (obtained from POST create or GET list responses) - Use
defIDto delete all groups in a category (obtained from GET list response) - Provide either
objectGUIDordefID, but not both
Important Behavior
The Application Programming Interface returns HTTP 200 even when deletion fails or is delayed.
Possible scenarios:
- Sync in progress: If a data sync is currently running for the tenant, the deletion request is saved but not immediately executed. You'll need to retry later or wait for the next sync.
- Successful deletion: The group is deleted immediately and sync is scheduled.
Always check the result.sync and result.detail fields to determine the actual outcome:
"sync": "success"- Deletion completed"sync": "Cloud Dynamic Group definition saved..."+"detail": "Data sync in-progress..."- Deletion pending, retry later.
Request
Responses
- 200
- 400
- 401
- 500
Delete request processed (does not guarantee immediate deletion).
Important: HTTP 200 does not mean the group was deleted. Check the response body:
- If
result.sync= "success", deletion completed - If
result.detailcontains "Data sync in-progress", deletion is pending and group was NOT deleted yet
Invalid request parameters
Unauthorized - Invalid or missing authentication
Internal service error