This process describes adding an additional authentication method to an existing person, update authentication method and delete it.

Specification

Apiary

Authorize

Verify the validity of access token
- Check user scope authentication_method:write in order to perform this action

Get global parameters

Invoke Global parameters to get following parameter:

phone_number_auth_limit

Check if in table person_authentication_methods with type = OTP > N, then error 422, such a phone already exists more N times

confidant_person_limit

In table person_auth_methods with type = third_person > N, then error 422

cURL example

curl -X GET \
  {:host}/prm/api/global_parameters

Validate request

if action = delete

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
  "action": "delete",
  "authentication_methods": {
    "id": "057413fb-2c2e-4f33-b2d6-433469212744"
    }
  }
}

if action = insert

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
  "action": "insert",
  "authentication_methods": {
    "type": "third_person",
    "value": "d12888c0-1159-4296-8f03-a592c136f673",
    "alias": "roksolana"
    }
  }
}

if action = update

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
  "action": "update",
  "authentication_methods": {
    "id": "057413fb-2c2e-4f33-b2d6-433469212744",
    "alias": "roksolana",
    "is_primary": "true"
    }
  }
}

Validate ids

Fiend value is person.id

validate person_id UUID
- in case error return 422
search person by person_id in MPI
- in case error return 422, "Such person doesn't exist"

Validate

Field type must be third_person.

Generate verification code

Invoke Initialize OTP to generate one time password and send it to third_person number (that is added as a new auth method). At this stage, the patients receive an SMS message.

Phone_numbers: mpi.person_auth_method.value, where person_id = $.third_person.id and type = OTP