Sign in

v1

latestOpenAPI 3.0.02026-07-14327580.4 KB
user auth

callback API for /auth/confirm (in case of MEDIATED auth) to confirm user authentication or not

This API is called by CM to confirm authentication of users.

  1. auth.accessToken - is specific to the purpose mentioned in the /auth/init. This token needs to be used for initiating the intended action. For example for HIP initiated linking of care-contexts
  2. NOTE, only one of X-HIP-ID or X-HIU-ID will be sent as part of header, not both.
post/v0.5/users/auth/on-confirm

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

{
  "auth": {
    "patient": {
      "id": "<patient-id>@<consent-manager-id>",
      "identifiers": [
        {
          "value": "+919800083232"
        }
      ],
      "name": "Hina Patel",
      "yearOfBirth": 2000
    }
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request accepted