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 beapplication/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
- Authentication API
- Study List
- Studies/Series Favorites
- Working with the Inbox
- DICOMweb Capability Tokens
- Webhooks
-
Working with Albums
- Album List
- Get an Album
- Create an album
- Edit an album
- Delete an album
- Add a study
- Add a series
- Remove a study
- Remove a series
- Add a User
- Remove a User
- Get the list of Users
- Add and upgrade an user to Admin
- Downgrade an admin to User
- Add an album to favorites
- Remove an album from favorites
- Post a comment
- Get a list of events (comments and mutations)
- Others
- Report Providers