Users
List users
List all the user in the user pool
get/users
Query parameters
activeboolean
filter on user active state.
sort'forename' | 'forename:asc' | 'forename:desc' | 'lastname' | 'lastname:asc' | 'lastname:desc' | 'email' | 'email:asc' | 'email:desc' | 'id' | 'id:asc' | 'id:desc'
If the key or direction are not in the enum list below, sort will default. The sort parameter allows multiple keys and direction, which should be supplied in a comma separated string.
Response
The list of users
Example response
{
"users": [
{
"status_notes": "User has been suspended",
"status": "CONFIRMED"
}
]
}