Purpose

This method allows to find all the active person's authentication methods of the person (data is taken from person_authnetication_method by person_id)

Specification

Apiary

Validate request

Validateperson_id in request:

• validate person.id is UUID

  • in case error return 422

• search person by person.id in MPI 

  • in case error return 422, "such person doesn't exist"

Authorize

• Verify the validity of access token

• Check user scope person:read in order to perform this action

Search person’s authentication methods

Search ACTIVE (ended_at > now) person auth methods using person_id in mpi.person_authentiocation_methods.

Don’t show info if auth_method.type = NA or auth_method.type = THIRD_PERSON and this THIRD_PERSON hasn't active auth method (type != NA and (ended_at > now or ended_at is NULL)). Any user with appropriate scope can read information about authentication method of the person.

Specification

Logic

Service returns primary authentication method for person or for confident person if type of authentication method = 'THIRD_PERSON':

• Get authentication method by person_id from person_authentication_methods where updated_at is the newest

Input parameters

Dictionaries

• AUTHENTICATION_METHOD

Request structure

See on Apiary

Authorize

• Verify the validity of access token

  • Return (401, 'Invalid access token') in case of validation fails

• Verify that token is not expired

  • in case of error - return (401, 'Invalid access token')

• Check user scopes in order to perform this action (scope = 'person:read')

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: person:read ') in case of invalid scope(s)

Headers

Content-Type:application/json

Authorization:Bearer {{access_token}}

Api-key:{{secret}}

Request data validation

Validate User

• Extract user_id from token.

Validate Patient

• Get person_id from URL

• Validate patient status is active (status = ‘active' & is_active = 'true’)

  • in case of error - return 404 ('not found')

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "b94893f5-b66b-4431-b023-d5b5c037caef",
      "type": "THIRD_PERSON",
      "phone_number": "+38093*****85",
      "value": "34d4aca0-ee15-4d2d-9ab8-336e5ba1f9c7",
      "alias": "husband",
      "ended_at": "2020-01-10 18:23:34.217335"
    }
  ]
}

{
  "meta": {
    "code": 403,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "error": {
    "type": "forbidden",
    "message": "Such person not found"
  }
}

HTTP status codes