Skip to main content

Update Cloud Dynamic User Groups

PUT 
/directory-sync/v1/cloud-dug-definition/group

Updates an existing Cloud Dynamic User Group. Use this endpoint to modify group attributes and constraints for an already created group.

This is used to edit an existing/created group.

How it Works​

  • The objectGUID in the request body identifies which group to update
  • The objectGUID is obtained from:
    • POST /cloud-dug-definition response when creating a group
    • GET /cloud-dug-definition/group response when listing groups
  • Only the fields you want to update need to be included in the request
  • Primary use case: updating user_attribute_constrain to modify group membership criteria

Important Behavior​

The Application Programming Interface returns HTTP 200 even when the objectGUID is not found. When the provided objectGUID doesn't exist, the response will be:

{
  "success": true,
  "result": {
    "sync": "Not found cloud dug def group guid <objectGUID>",
    "value": ""
  }
}

Always check the result.sync field for error messages when processing the response.

Note: Set useNormalizedAttrs to "true" for external Application Programming Interface calls (SCM integration). Also, we do not allow the update of name related attributes (Name, Common-Name, Distinguished Name). This is also to match behavior of UI.

Request​

Responses​

Response from update operation.

Note: The API returns HTTP 200 even when the objectGUID is not found. Check the result.sync field for error messages like "Not found cloud dug def group guid".