Self Appropriate Series - OsiriX-Foundation/KheopsAuthorization GitHub Wiki

This resource can be used by a user to claim access to a series UID that is unknown to the authorization server. The user will then be able to get an Access Token that can be used to do an STOW-RS to the DICOMweb server.

URL : /studies/{StudyInstanceUID}/series/{SeriesInstanceUID}

Method : PUT

Auth Required : Requires an Access Token with a sub claim of a user that has access to the specified series, or an Access Token with the user as the sub claim.

Headers

  • X-Authorization-Source : Bearer album_capability_token (Optional) Can be used for a self appropriate with an album capability token with Appropriate permission

Success Response

If the user bearer Access Token has a sub claim for a user with access to the series and the series was shared successfully.

  • Status : 204 No Content

If the bearer token belongs to the user to which the series is being added, and the SeriesInstanceUID is not known to the server.

  • Status : 201 Created

Error Response

If validation of the token fails:

  • Status : 400 Bad Request

If no authentication token is supplied: (Don't forget to return the WWW-authenticate header)

  • Status : 401 Unauthorized

If the bearer token does not give access to the SeriesInstanceUID, or if the user is trying to claim access to a SeriesInstanceUID that is already known to the Authentication Server.

  • Status : 403 Forbidden