Create Cloud Dynamic User Groups
POST/directory-sync/v1/cloud-dug-definition
Creates new dynamic user groups in a domain based on user attribute constraints.
This is the third Application Programming Interface in the workflow after getting categories and attribute values.
Workflow Context
- First, call GET
/cloud-dug-definition/category?domain=<domain>to get available categories and context attributes - Then, call GET
/user-attr-values?domain=<domain>&attrName=<attribute>for each context attribute to get valid values - Finally, use this POST endpoint to create groups using the category name and attribute values from steps 1 and 2
Request Body Details
- domain: The domain name (same as used in previous Application Programming Interface calls)
- useNormalizedAttrs: Must be set to
"true"for external Application Programming Interface calls (SCM integration) - value.category: Category name obtained from the GET category endpoint (e.g., "Attribute Based", "On Demand Assignment")
- value.groups: Array of groups to create
- Name: The base name for the group (system will append "_cdug" suffix automatically)
- description: Optional description for the group
- user_attribute_constrain: Defines the criteria for dynamic group membership
- Use
$andoperator when ALL conditions must be met - Use
$oroperator when ANY condition must be met - Attribute names must be from the context attributes list
- Attribute values must be from the values returned by
/user-attr-valuesendpoint
- Use
Note: The system automatically appends "_cdug" suffix to the group.
Request
Responses
- 200
- 400
- 401
- 500
Successfully created dynamic group(s)
Invalid request parameters
Unauthorized - Invalid or missing authentication
Internal service error