Edit a report provider - OsiriX-Foundation/KheopsAuthorization GitHub Wiki

Used to edit a report provider for an album. The user must be an admin.

URL : /albums/{album_id}/reportproviders/{client_id}

Method : PATCH

Auth Required : Authorization with a JWT Bearer token with the user as the sub claim.

Headers

• Accept : If present, require that this value be application/json
• Content-Type : Must be : application/x-www-form-urlencoded

Parameters

• name={name} (Optional)
• url={url} (Optional)

Success Response

• Status : 200 OK

{
    "name": "a name",
    "url": "http://myreportprovider/.well-known/kheops-report-configuration",
    "client_id": "q9ZTMv3fW7ta0Npg1caGMF",
    "user": {
        "email": "[email protected]",
        "sub": "c2fd0b66-dac4-4b98-9341-d4f3b303bd4e"
    },
    "created_time": "2019-05-10T08:20:23.038"
}

Error Response

If the user is not found If the album is not found If the user is not an admin

• Status : 404 Not Found

If the url is not valid If the client id is not found

• Status : 400 Bad Request