| Info |
|---|
| Info |
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | Get authentication factor |
Guideline ID | GUI-0011 |
Author | |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-005-010-006-0206 |
Microservices (namespace) | IL |
Component | Patient Cabinet |
Component ID | COM-005-010 |
Link на API-специфікацію | |
Resource | {{host}}/api/cabinet/authentication_factor |
Scope | person:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
Request data validation
Authorize
Request to process the request using a token in the headers.
Validate token
Check token existance
in case error return 404 - token was not found
Check expiration date tokens.expires_at
if tokens.expires_at < now() return 401 - access denied
Extract user_id from token
Check user scopes in order to perform this action (scope = ''person:read")
Return 403 in case invalid scope(s) - "Your scope does not allow to access this resource. Missing allowances: "person:read"
...
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Response | |||
| 3 | 401 | Access denied | |||
| 34 | 401 | User blocked |
| ||
| 45 | 403 | Your scope does not allow to access this resource. Missing allowances: "person:read" | Validation failed | ||
| 56 | 404 | Token was not found | Validation failed | ||
| 67 | 409 | Person is not active | Validation failed | ||
| 78 | Специфічні | ||||
| 89 | |||||
Post-processing processes
N/A
Technical modules where the method is used
...
modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||