v1

latestOpenAPI 3.0.02026-07-14307078.8 KB
user auth

Identification result for a consent-manager user-id

If a patient is found then auth attribute contains the supported modes for the specified purpose. Otherwise, error is raised for invalid requests or for non-existent id. Note in addition to the "Authorization" header, one of the following headers must be specified

  1. X-HIU-ID if the requester is HIU (identified from /auth/fetch-modes requester.id)
  2. X-HIP-ID if the requester is HIP (identified from /auth/fetch-modes requester.id)
post/v0.5/users/auth/on-fetch-modes

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server, which will be sent by gateway to authenticate itself with API bridge.

X-HIP-IDstring required

Identifier of the health information provider to which the request was intended.

X-HIU-IDstring required

Identifier of the health information user to which the request was intended.

Request body

requestIdstring uuid required

a nonce, unique for each HTTP request

timestampstring date-time required

Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

Example request

{
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request Accepted