{ "opencollection": "1.0.0", "info": { "name": "Okta Application UserFactor API", "version": "2.16.0" }, "items": [ { "info": { "name": "UserFactor", "type": "folder" }, "items": [ { "info": { "name": "listFactors", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Enumerates all the enrolled factors for the specified user" }, { "info": { "name": "Okta Enroll Factor", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "updatePhone", "value": "", "type": "query" }, { "name": "templateId", "value": "", "type": "query", "description": "id of SMS template (only for SMS factor)" }, { "name": "tokenLifetimeSeconds", "value": "", "type": "query" }, { "name": "activate", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Enrolls a user with a supported factor." }, { "info": { "name": "listSupportedFactors", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors/catalog", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Enumerates all the supported factors that can be enrolled for the specified user" }, { "info": { "name": "listSupportedSecurityQuestions", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors/questions", "params": [ { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Enumerates all available security questions for a user's `question` factor" }, { "info": { "name": "getFactor", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors/:factorId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "factorId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Fetches a factor for the specified user" }, { "info": { "name": "deleteFactor", "type": "http" }, "http": { "method": "DELETE", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors/:factorId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "factorId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor." }, { "info": { "name": "Okta Activate Factor", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors/:factorId/lifecycle/activate", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "factorId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "The `sms` and `token:software:totp` factor types require activation to complete the enrollment process." }, { "info": { "name": "getFactorTransactionStatus", "type": "http" }, "http": { "method": "GET", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors/:factorId/transactions/:transactionId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "factorId", "value": "", "type": "path" }, { "name": "transactionId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Polls factors verification transaction for status." }, { "info": { "name": "Okta Verify MFA Factor", "type": "http" }, "http": { "method": "POST", "url": "https://your-subdomain.okta.com/api/v1/users/:userId/factors/:factorId/verify", "headers": [ { "name": "X-Forwarded-For", "value": "" }, { "name": "User-Agent", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "factorId", "value": "", "type": "path" }, { "name": "templateId", "value": "", "type": "query" }, { "name": "tokenLifetimeSeconds", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Verifies an OTP for a `token` or `token:hardware` factor" } ] } ], "bundled": true }