{ "info": { "_postman_id": "435fa050-854a-4bb4-a6c1-f5cd72b58d83", "name": "tinymfa Postman Collection", "description": "This is a postman collection for the tinymfa totp service (https://tinymfa.parzival.link)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "issuer handling", "item": [ { "name": "List Issuers", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer" ] }, "description": "List all Issuers" }, "response": [] }, { "name": "Get Issuer", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}" ] }, "description": "Gets an issuer" }, "response": [] }, { "name": "Create Issuer", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"{{tinymfa-issuer}}\",\n \"contact\": \"test@issuer.local\",\n \"token_length\": 6,\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer" ] }, "description": "Creates an Issuer" }, "response": [] }, { "name": "Update Issuer", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"contact\":\"test-address@issuer.local\",\n \"token_length\": 8,\n \"enabled\" : true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}" ] }, "description": "ATTENTION: When updating the token_length, your registered users MUST rescan the QRCode!" }, "response": [] }, { "name": "Delete Issuer", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}" ] } }, "response": [] }, { "name": "Get Issuer Tokens", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/token", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "token" ] } }, "response": [] }, { "name": "Create Issuer Token", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"description\" : \"my access token\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/token", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "token" ] } }, "response": [] }, { "name": "Delete Issuer Token", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/token/TOKEN_ID", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "token", "TOKEN_ID" ] } }, "response": [] } ] }, { "name": "user handling", "item": [ { "name": "List Users", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/users", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "users" ] } }, "response": [] }, { "name": "Get User", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/users/{{tinymfa-user}}", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "users", "{{tinymfa-user}}" ] } }, "response": [] }, { "name": "Create User", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\" : \"{{tinymfa-user}}\",\n \"email\": \"demo@issuer.local\",\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/users", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "users" ] } }, "response": [] }, { "name": "Update User", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"email\" : \"demo@issuer.net\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/users/{{tinymfa-user}}", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "users", "{{tinymfa-user}}" ] } }, "response": [] }, { "name": "Delete User", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/users/{{tinymfa-user}}", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "users", "{{tinymfa-user}}" ] } }, "response": [] }, { "name": "Get User QRCode", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/users/{{tinymfa-user}}/totp", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "users", "{{tinymfa-user}}", "totp" ] } }, "response": [] }, { "name": "Validate Token", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"token\" : \"7574352\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/issuer/{{tinymfa-issuer}}/users/{{tinymfa-user}}/totp", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "issuer", "{{tinymfa-issuer}}", "users", "{{tinymfa-user}}", "totp" ], "query": [ { "key": "", "value": "", "disabled": true } ] } }, "response": [] } ] }, { "name": "system handling", "item": [ { "name": "Get System Configuration", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/system/configuration", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "system", "configuration" ] } }, "response": [] }, { "name": "Update System Configuration", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"deny_limit\": 10\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/system/configuration", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "system", "configuration" ] } }, "response": [] }, { "name": "Get OIDC Configuration", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/system/oidc", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "system", "oidc" ] } }, "response": [] }, { "name": "Update OIDC Configuration", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"deny_limit\": 10\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/system/oidc", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "system", "oidc" ] } }, "response": [] }, { "name": "Get QRCode Configuration", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/system/qrcode", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "system", "qrcode" ] } }, "response": [] }, { "name": "Update QRCode Configuration", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"qrcode-bgcolor\": {\n \"red\": 255,\n \"green\": 255,\n \"blue\": 255,\n \"alpha\": 255\n },\n \"qrcode-fgcolor\": {\n \"red\": 0,\n \"green\": 0,\n \"blue\": 0,\n \"alpha\": 255\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/system/qrcode", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "system", "qrcode" ] } }, "response": [] }, { "name": "Get Audit", "request": { "method": "GET", "header": [], "url": { "raw": "{{tinymfa-protocol}}://{{tinymfa-host}}:{{tinymfa-port}}/api/v1/system/audit", "protocol": "{{tinymfa-protocol}}", "host": [ "{{tinymfa-host}}" ], "port": "{{tinymfa-port}}", "path": [ "api", "v1", "system", "audit" ] } }, "response": [] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "INSERT_TOKEN_HERE", "type": "string" }, { "key": "key", "value": "tiny-mfa-access-token", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "tinymfa-protocol", "value": "http" }, { "key": "tinymfa-host", "value": "localhost" }, { "key": "tinymfa-port", "value": "57687" }, { "key": "tinymfa-issuer", "value": "test" }, { "key": "tinymfa-user", "value": "demo" } ] }