Skip to main content

Retrieve Cloud Dynamic User Groups

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

Fetches dynamic user groups by domain or aggregationId with support for filtering and pagination.

Note: Set useNormalizedAttrs to "true" for external Application Programming Interface calls (SCM integration).

Usage Patterns​

1. List all groups in a domain (with pagination)​

GET /cloud-dug-definition/group?domain=okta-directory&useNormalizedAttrs=true&pageNum=1&pageSz=10

This returns all CDUG groups with pagination. From this response, you can extract:

  • defID - Category identifier for filtering groups by category
  • objectGUID - Unique group identifier for fetching/updating/deleting a specific group

2. Get a specific group by objectGUID​

After creating a group via POST, you receive an objectGUID in the response. Use it to fetch that specific group:

GET /cloud-dug-definition/group?domain=okta-directory&objectGUID=83a1cf1a-2709-11f1-b6ac-22edd0e18ff6&useNormalizedAttrs=true

3. Get all groups in a specific category​

First, call GET groups to see all groups and their defID values. Then filter by category:

GET /cloud-dug-definition/group?domain=okta-directory&defID=116c2d28-0cfb-11f1-a8d8-d2bbfe9d4496&useNormalizedAttrs=true

This returns only groups belonging to that category (e.g., "Attribute Based").

Request​

Responses​

Successfully retrieved dynamic groups with pagination information