MFAService
Update MFA Factor
Update mutable metadata for an enrolled MFA factor.
Method
PATCH
Path
/v1/auth/mfa/factors/{factor_id}
Visibility
Authentication
Session token
MFA Requirement
Not required
PATCH
/v1/auth/mfa/factors/{factor_id} Request
Testnet
curl --request PATCH \ \
--url 'https://api.testnet.polyester.com/v1/auth/mfa/factors/mfa_33333333333333333333333333333333' \
--header 'Accept: */*' \
--header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
--header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
--header 'X-API-SIGNATURE: YOUR_API_SIGNATURE' \
--header 'Content-Type: application/json' \
--data '{
"label": "Primary Authenticator"
}'Responses
{
"factor": {
"createdAt": "2025-01-01T00:00:00Z",
"factorId": "mfa_33333333333333333333333333333333",
"factorType": "TOTP",
"label": "Primary Authenticator",
"lastUsedAt": "2025-01-01T00:00:00Z"
}
} factor_id string
MFA factor identifier to update.
label string
New human-friendly label for the factor. Empty clears the label.
5 fields
factorId string
MFA factor identifier. Format: "mfa_" followed by 32 lowercase hex characters.
Example
mfa_33333333333333333333333333333333 factorType enum
Type of enrolled factor.
MFA_FACTOR_TYPE_TOTP MFA_FACTOR_TYPE_PASSKEY MFA_FACTOR_TYPE_RECOVERY_CODE
Example
TOTP label string
Human-friendly label for the factor. Empty when no label is set.
Example
Primary Authenticator createdAt string (date-time)
Time when the factor was enrolled.
Example
2025-01-01T00:00:00Z lastUsedAt string (date-time)
Time when the factor was last used. Empty if the factor has not been used.
Example
2025-01-01T00:00:00Z| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |