Tham số cấu hình SMS Auth

Tài liệu chi tiết tất cả tham số cấu hình của plugin @digiforce-nc/plugin-auth-sms.

Tham số chính

Tham số	Kiểu	Mặc định	Mô tả
public.verifier	string	—	Tên verifier sử dụng cho OTP. Phải khớp với tên verifier đã tạo trong plugin-verification. Đây là tham số bắt buộc
public.autoSignup	boolean	true	Tự động tạo tài khoản local nếu user chưa tồn tại. Khi false, chỉ user đã có tài khoản với số điện thoại khớp mới đăng nhập được

Tại sao tham số ít?

Plugin SMS Auth là thin wrapper — toàn bộ logic gửi/verify OTP nằm trong plugin-verification. Cấu hình SMS provider, template, TTL, rate limit... đều thuộc verifier.

Verifier scenes

Plugin sử dụng verifier với các scenes xác định loại OTP:

Scene	Mô tả
signIn	OTP cho đăng nhập
signUp	OTP cho đăng ký tài khoản mới
resetPassword	OTP cho đặt lại mật khẩu

Mỗi scene có thể sử dụng template SMS khác nhau tùy theo provider.

Cấu hình phụ thuộc (plugin-verification)

Tất cả cấu hình SMS nằm trong verifier, không thuộc plugin SMS Auth:

Twilio

Tham số	Kiểu	Mô tả
accountSid	string	Twilio Account SID
authToken	string	Twilio Auth Token
from	string	Số điện thoại gửi (Twilio phone number)

Aliyun SMS

Tham số	Kiểu	Mô tả
accessKeyId	string	Aliyun Access Key ID
accessKeySecret	string	Aliyun Access Key Secret
signName	string	Chữ ký SMS đã đăng ký
templateCode	string	Mã mẫu tin nhắn

Tencent SMS

Tham số	Kiểu	Mô tả
secretId	string	Tencent Secret ID
secretKey	string	Tencent Secret Key
appId	string	SMS App ID
signName	string	Chữ ký SMS
templateId	string	Mã mẫu tin nhắn

Migration notes

Từ verificator sang verifier

Các phiên bản cũ sử dụng tên tham số verificator. Phiên bản mới đã đổi thành verifier:

Phiên bản cũ	Phiên bản mới
public.verificator	public.verifier

Plugin tự động xử lý migration khi nâng cấp, nhưng nên cập nhật cấu hình thủ công nếu cấu hình qua API.

Từ smsAuthEnabled sang authenticators

Phiên bản cũ sử dụng cờ smsAuthEnabled trong system settings. Phiên bản mới sử dụng hệ thống authenticators:

• Plugin chạy migration tự động: tạo authenticator mới từ cấu hình smsAuthEnabled cũ
• Sau migration, quản lý qua Settings → Authentication

Ví dụ cấu hình

{
  "public": {
    "verifier": "twilio-sms",
    "autoSignup": true
  }
}