{ "opencollection": "1.0.0", "info": { "name": "FusionAuth Api Key Two Factor API", "version": "1.66.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Two Factor", "type": "folder" }, "items": [ { "info": { "name": "twoFactorLoginWithId", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9011/api/two-factor/login", "body": { "type": "json", "data": "{}" } }, "docs": "Complete login using a 2FA challenge" }, { "info": { "name": "generateTwoFactorSecretUsingJWTWithId", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9011/api/two-factor/secret", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication application such as Google Authenticator." }, { "info": { "name": "sendTwoFactorCodeForEnableDisableWithId", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9011/api/two-factor/send", "body": { "type": "json", "data": "{}" } }, "docs": "Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling." }, { "info": { "name": "sendTwoFactorCodeForLoginUsingMethodWithId", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9011/api/two-factor/send/:twoFactorId", "params": [ { "name": "twoFactorId", "value": "", "type": "path", "description": "The Id returned by the Login API necessary to complete Two Factor authentication." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send a Two Factor authentication code to allow the completion of Two Factor authentication." }, { "info": { "name": "startTwoFactorLoginWithId", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9011/api/two-factor/start", "body": { "type": "json", "data": "{}" } }, "docs": "Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code. This API is intended to allow you to begin a Two-Factor login" }, { "info": { "name": "retrieveTwoFactorStatusWithRequestWithId", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9011/api/two-factor/status", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve a user's two-factor status. This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust across various applications. This operation provides more payload options than retrieveTwoFactorStatus." }, { "info": { "name": "retrieveTwoFactorStatusWithId", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9011/api/two-factor/status/:twoFactorTrustId", "params": [ { "name": "userId", "value": "", "type": "query", "description": "The user Id to retrieve the Two-Factor status." }, { "name": "applicationId", "value": "", "type": "query", "description": "The optional applicationId to verify." }, { "name": "twoFactorTrustId", "value": "", "type": "path", "description": "The optional two-factor trust Id to verify." } ] }, "docs": "Retrieve a user's two-factor status. This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust across various applications." } ] } ], "bundled": true }