Sign in

v1

latestOpenAPI 3.0.02026-07-14307078.8 KB
user auth

Response to user authentication initialization from HIP

If the patient's id is valid, CM will return a transactionId as initialization of user auth. If the request is valid, then 'auth.mode' will convey how the authentication should be done. The authentication can be mediated or direct. For mediated authentication modes, HIP or HIU is epected to send over relevant code (OTP/token) or demographic info via subsequent API call to /auth/confirm. for direct authentication case, CM will notify requester through/users/auth/notify API.

  1. auth.mode conveys whats the mode of authentication is, and what is expected from HIP/HIU in the subsequent /auth/confirm API call. Possible values
    1. MOBILE_OTP - auth via OTP to registered mobile. Mediated.
    2. AADHAAR_OTP - auth initiated with Aadhaar with OTP. Mediated.
    3. DEMOGRAPHICS - auth initiated with demographic verification
    4. DIRECT - for authentication directly with the patient. e.g. Mobile App, SMS. In this case, the HIP/HIU is not expected to call subsequent /auth/confirm call. CM will do direct authentication with the User (e.g. Mobile App, SMS etc) and will notify requester
  2. meta.expiry conveys the expiry time of the token and the authentication session
  3. NOTE, only one of X-HIP-ID or X-HIU-ID will be sent as part of header, not both.

The error section in the body, represents the potential errors that may have occurred. Possible reasons:

  1. Patient id is invalid
post/v0.5/users/auth/on-init

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": {
    "meta": {
      "expiry": "2019-12-30T12:01:55Z"
    }
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request accepted