Get users in a group

GET 
/groups/:groupName/users

Returns the list of users in a group

Request

Path Parameters

groupName stringrequired

Group Name

Query Parameters

limit string
Limit Results
Default value: 10
next string

Next page of results token

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

users

object[]

List of users

Array [

username string

Username of user

email string

Email of user

enabled boolean

whether the user is enabled

userStatus string

Status of user

insertedDate string

Inserted timestamp of user

lastModifiedDate string

Last nodified timestamp of user

attributes

object

address string

Address of user

birthdate string

Birthdate of user

familyName string

Family name of user

gender string

Gender of user

givenName string

Given name of user

locale string

Locale of user

middleName string

Middle name of user

name string

Name of user

nickname string

Nickname of user

phoneNumber string

Phone number of user

picture string

Picture of user

preferredUsername string

Preferred username of user

profile string

Profile of user

zoneinfo string

Zoneinfo of user

updatedAt string

Updated at date of user

website string

Website of user

]

Example (from schema)

{
  "next": "string",
  "users": [
    {
      "username": "string",
      "email": "string",
      "enabled": true,
      "userStatus": "string",
      "insertedDate": "string",
      "lastModifiedDate": "string",
      "attributes": {
        "address": "string",
        "birthdate": "string",
        "familyName": "string",
        "gender": "string",
        "givenName": "string",
        "locale": "string",
        "middleName": "string",
        "name": "string",
        "nickname": "string",
        "phoneNumber": "string",
        "picture": "string",
        "preferredUsername": "string",
        "profile": "string",
        "zoneinfo": "string",
        "updatedAt": "string",
        "website": "string"
      }
    }
  ]
}

Loading...