List Groups

Retrieve a list of groups.

To fetch all results, run repeatedly with the Offset parameter as long as the result metadata has a next_offset value.

Note: This action requires the Grant resource - Read API permission.

External Documentation

To learn more, visit the Duo documentation.

​

Parameters

Parameter	Description
Limit	The maximum number of groups to retrieve. Defaults to 100 with a maximum of 100.
Offset	The offset from 0 at which to start record retrieval. When used with Limit, the handler will return limit records starting at the n-th record, where n is the offset. Defaults to 0.

​

Example Output

{
  "metadata": {
    "total_objects": 2
  },
  "stat": "OK",
  "response": [
    {
    "desc": "This is group A",
    "group_id": "DGXXXXXXXXXXXXXXXXXX",
    "mobile_otp_enabled": false,    
    "name": "Group A",
    "push_enabled": false,
    "sms_enabled": false,
    "status": "Active",
    "voice_enabled": false
    },
    {
    "desc": "This is group B",
    "group_id": "DGXXXXXXXXXXXXXXXXXX",
    "mobile_otp_enabled": false,
    "name": "Group B (from Azure sync \"Acme Corp Azure AD\")"",
    "push_enabled": false,
    "sms_enabled": false,
    "status": "Active",
    "voice_enabled": false
    }
  ],
}