Get User Group Users

GET /user-groups/{id}/users

Bearer auth

This API call is used to retrieve users for the specified user group.

Path parameters

id integer Required

User group ID.

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- id integer
  
  Unique identifier of the user.
- userName string
  
  Username of the user.
- displayName string
  
  Display name of the user.
401 application/json

Authentication Error. Invalid credentials.
Hide response attributes Show response attributes object
- code string
- message string
- description string
403

Authorization Error. Invalid role for request.
404 application/json

Failed Response

GET /user-groups/{id}/users

curl \
 --request GET 'https://localhost:8080/user-groups/1/users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "id": 3,
    "userName": "mmiller",
    "displayName": "Morris Miller"
  },
  {
    "id": 14,
    "userName": "jconchin",
    "displayName": "Jane Conchin"
  }
]

Response examples (401)

{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}

Response examples (404)

{
  "error": "User group not found",
  "status": 404
}