GET role/{roleId}/members

Get the list of users with the given role. Note: this will not return sensible values for computed roles like "all". It's intended for roles to which users are assigned directly.

Example

GET /api/v1/role/admin/members HTTP/1.1
Accept: application/json
Authorization: Bearer ...
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "ac408889-be82-48b1-8622-abda2ab9b717",
    "username": "tcoles+admin",
    "avatar": "public/us-west-2:8b0c58cb-a8fe-4197-89a4-90521cb92a43/2e1b6eae-ff3f-46d3-8a7e-19fd8eebd2ca.png",
    "emblem": null
  },
  {
    "id": "d9e4cf5d-f12d-492e-bc67-af375936f6ec",
    "username": "JoeyGlattELine",
    "avatar": null,
    "emblem": "9e5097e0-cc43-48b3-9868-5276a7369e7f"
  }
]

Security

Authentication is required and access is limited to admins.

URL Parameters

NameDescriptionValue
roleIdthe identifier of the role whose members to getstring

Query Parameters

NONE

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

The response body is an Array of UserInfo objects.

UserInfo

NameDescriptionValue
idthe ID of the user as a GUID with dashesstring
usernamethe user's username, which is uniquestring
avatara media path to the user's avatar image file; will be null if no avatar has been setstring or null
emblemthe GUID of an emblem to display with the user's avatar, or null if none is selectedstring or null
profilea text description of this user, if public optionalstring