Specification
Apiary | |
PATCH | mithril/api/users/{user_id}/actions/create_otp |
Scope |
Purpose
Create & Send new OTP item for user via current 2FA factor
Request parameters
- user_id
- token
Logic WS
- Validate token (2fa_access_token) - ????
- If invalid - return error 4xx
- Validate user id & user status
Get active 2FA item for non-blocked user by $.user_id
SELECT * FROM authentication_factors AS 2FA WHERE 2FA.user_id = $.user_id AND 2FA.is_active = TRUE
- If not found - return 409 error "Not found 2FA data for user"
- Extract type & factor from 2FA item for user
- Invoke internal function `create OTP (key)`, for 2FA.type = SMS, with params:
- key = 2FA.faсtor
- Get result of call `create OTP()` as `OTP_value`
- Sending (delivery) OTP via channel communication
- for 2FA.type = SMS - via SMS gateway API
- mobile phone = 2FA.factor
- SMS text = OTP_value
- for 2FA.type = SMS - via SMS gateway API
- Return 200
Internal logic for `create OTP()`
- Processed OTP lists for $.key
- Deactivate all active OTP items (NEW → CANCELED)
- Create new OTP item
- status = NEW
- expired_at = now() + OTP_LIFETIME
- value = generate number according OTP_LENGTH
- updated_at = now()
Response
- 200 if OTP successful create & send + user_object_view
- 4xx in other case