v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-23231323.7 KB
Groups

Get a list of users in a group

Returns a list of users in a given group in Cognito

get/groups/{id}/members

Path parameters

idstring required

the group's ID

Query parameters

sort'created' | 'forename:asc' | 'forename:desc'

The sort order of the returned set of users

Response

List of users in the group

countinteger

Example response

{
  "users": [
    {
      "status_notes": "User has been suspended",
      "status": "CONFIRMED"
    }
  ]
}