Skip to content

Get the list of Users

gerome12 edited this page May 28, 2021 · 16 revisions

Used to get the list of all users to an album. The calling user must be an admin or an user with "addUser" permission.

URL : /albums/{album_id}/users

Method : GET

Auth Required : Authorization with a JWT Bearer token with the user as the sub claim. The user must be an admin or an user with "addUser" permission of the {album}.

Headers

  • Accept : If present, require that this value be application/json

Query Param

  • limit={limit}
  • offset={offset}

Success Response

Header X-Total-Count contains the total number of users

  • Status : 200 OK
[
    {
        "email": "user@domain.com",
        "name": "user name",
        "sub": "3685d976-f1d6-443c-95d4-95ee4b749878",
        "is_admin": false
   },
   {"..."}
]

Error Response

If the user is not found.
If the album id does not exist.
If the user is not a member of the album.

  • Status : 404 Not Found
Clone this wiki locally