action ndhm_post_v0_5_users_auth_init {
  label: "Initialize authentication from HIP"
  description: "This API is called by HIPs to initiate authentication of users. A transactionId is retuned by the corresponding callback API for confirmation of user auth.\n"
  provider: ndhm
  method: POST
  path: "/v0.5/users/auth/init"
  encoding: json
  input: {
    type: "object"
    properties: {
      Authorization: {
        type: "string"
      }
      query: {
        type: "object"
        required: ["id", "purpose", "requester"]
        properties: {
          authMode: {
            type: "string"
            description: "Subjected to CM specific capability\n 1. MOBILE_OTP - for SMS OTP\n 2. DIRECT - for authentication directly with the patient. e.g. Mobile App, SMS\n 3. AADHAAR_OTP - for auth using OTP sent to Aadhaar number\n 4. DEMOGRAPHICS - for auth using demographic verification.\n"
            enum: ["MOBILE_OTP", "DIRECT", "DEMOGRAPHICS", "AADHAAR_OTP"]
          }
          id: {
            type: "string"
            description: "id  of the patient understood by the CM"
          }
          purpose: {
            type: "string"
            description: "what is the purpose of user auth"
            enum: ["LINK", "KYC", "KYC_AND_LINK"]
          }
          requester: {
            type: "object"
            description: "identification of requester"
            required: ["id", "type"]
            properties: {
              id: {
                type: "string"
              }
              type: {
                type: "string"
                enum: ["HIP", "HIU"]
              }
            }
          }
        }
      }
      requestId: {
        type: "string"
        format: "uuid"
        description: "a nonce, unique for each HTTP request"
      }
      timestamp: {
        type: "string"
        format: "date-time"
        description: "Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ"
      }
    }
    required: ["Authorization", "query", "requestId", "timestamp"]
    additionalProperties: false
  }
  output: {
    type: "object"
    additionalProperties: true
  }
}