-
Notifications
You must be signed in to change notification settings - Fork 11
Capabilities Tokens List
gerome12 edited this page May 28, 2021
·
13 revisions
Used to get a list of capabilities token for a given user.
URL : /capabilities
Method : GET
Auth Required : Authorization with a JWT Bearer token with the user as the sub claim.
URL Parameters
-
valid={boolean}
(Optionnal) default value : false = show all token and only valid token if true -
album={albumID}
(Optionnal) Show all the capabilities token for an album -
user={sub or email}
(Optionnal) filter by created by -
limit={limit}
(Optionnal) -
offset={offset}
(Optionnal)
Success Response
Header X-Total-Count
contains the total number of capabilities token
-
Status :
200 OK
The results are sort by issued_at_time
descending
[
{
"id": "KbSVRVsa0r",
"title": "Twitter token",
"issued_at_time": "2018-10-22T14:20:59.790Z",
"not_before_time": "2018-10-22T14:20:59.734Z",
"expiration_time": "2019-01-22T14:20:59.734Z",
"revoked": false,
"scope_type": "user"
},
{
"id": "TCh6D5l9Jn",
"title": "Facebook token",
"issued_at_time": "2018-10-22T14:20:59.790Z",
"not_before_time": "2018-10-22T14:20:59.734Z",
"last_used": "2018-11-12T13:23:46.156Z",
"expiration_time": "2019-01-22T14:20:59.734Z",
"revoke_time": "2019-01-22T14:20:59.734Z",
"revoked": true,
"read_permission": true,
"write_permission": false,
"download_permission": true,
"appropriate_permission": false,
"scope_type": "album",
"album": {
"id": "hx7S6Q2nv0",
"name": "The album name"
},
"created_by": {
"email": "user@domain.com",
"sub": "c2fd0b66-dac4-4b98-9341-d4f3b303bd4e",
"name": "user name"
},
"revoked_by": {
"email": "user@domain.com",
"sub": "c2fd0b66-dac4-4b98-9341-d4f3b303bd4e",
"name": "user name"
}
},
{...}
]
Error Response
If the user is not found
-
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