Enroll a Factor

POST {{baseUrl}}/api/v1/users/:userId/factors

Enrolls a user with a supported factor

Request Params

KeyDatatypeRequiredDescription
updatePhoneboolean
templateIdstringid of SMS template (only for SMS factor)
tokenLifetimeSecondsnumber
activateboolean

Request Body

{"factorType"=>"web", "provider"=>"SYMANTEC", "status"=>"NOT_SETUP", "verify"=>{"activationToken"=>"fugiat ullamco consequat reprehenderit", "answer"=>"nulla minim cupidatat quis", "attestation"=>"consequat occ", "clientData"=>"aliqua eiusmod irure", "nextPassCode"=>"fugiat tempor culpa", "passCode"=>"officia", "registrationData"=>"elit consectetur do veniam", "stateToken"=>"laborum esse cupidatat"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"created":"2019-12-01T18:46:24.798Z","factorType":"hotp","id":"Duis aute ea","lastUpdated":"2017-09-22T19:17:21.504Z","provider":"YUBICO","status":"INACTIVE","verify":{"activationToken":"reprehenderit","answer":"laboris id","attestation":"dolore","clientData":"cupidatat nulla","nextPassCode":"Duis voluptate","passCode":"id laborum Duis nisi","registrationData":"ea ex","stateToken":"et consectetur proident"},"_embedded":{"sit51e":{}},"_links":{"incididunta":{}}}