{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost:8000" } ], "info": { "name": "App Template API Documentation", "_postman_id": "c00ff819-60d3-4324-80b5-0c184190ba9b", "description": "Stateless REST API for tenant apps and the platform control plane: multi-tenant isolation, Sanctum tokens, RBAC, device registry, and multi-channel push.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Configuration & System Diagnostics", "description": "\nHealth checks and admin configuration. `GET \/health` is unauthenticated beyond API key (mobile bootstrap).", "item": [ { "name": "Health Check", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/health", "query": [], "raw": "{{baseUrl}}\/api\/v1\/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "30120d56-87ac-4795-99cd-ea6ca992af6b" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"status\":\"success\",\"message\":\"Service is healthy.\",\"data\":{\"status\":\"operational\",\"app\":\"App Template\",\"app_version\":\"1.0.0\",\"version\":\"1.0.0\",\"timestamp\":\"2026-09-04T13:56:45+00:00\",\"server_time\":\"2026-09-04T13:56:45+00:00\",\"services\":{\"database\":\"ok\",\"cache\":\"configured\",\"queue\":\"configured\"}}}", "name": "" } ] }, { "name": "Get Dashboard Telemetry & Stats", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/config\/dashboard-stats", "query": [], "raw": "{{baseUrl}}\/api\/v1\/config\/dashboard-stats" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "be14b1c4-15ee-4c50-a83f-8471b1f82a46" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Get Legal Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/config\/legal", "query": [], "raw": "{{baseUrl}}\/api\/v1\/config\/legal" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "0d713ff0-df5c-4e3f-9e8f-06ffc3a0b41b" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Update Legal Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/config\/legal", "query": [], "raw": "{{baseUrl}}\/api\/v1\/config\/legal" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"privacy_policy\":\"architecto\",\"terms_and_conditions\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "Get Login Branding", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/config\/login-branding", "query": [], "raw": "{{baseUrl}}\/api\/v1\/config\/login-branding" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "fccb884f-b3d0-4bf6-bda1-ea6c0cf54146" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Upload Login Background", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/config\/login-branding\/upload", "query": [], "raw": "{{baseUrl}}\/api\/v1\/config\/login-branding\/upload" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "Update Login Background URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/config\/login-branding", "query": [], "raw": "{{baseUrl}}\/api\/v1\/config\/login-branding" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"login_background_url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"}" }, "description": "" }, "response": [] }, { "name": "Remove Login Background", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/config\/login-branding", "query": [], "raw": "{{baseUrl}}\/api\/v1\/config\/login-branding" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Public \u2014 Organization Lookup", "description": "\nResolve tenant branding before login. API key only \u2014 no Bearer token or `X-Tenant` header.", "item": [ { "name": "Resolve Public Organization", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/public\/tenants\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/public\/tenants\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "acme", "description": "The slug of the tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "Returns the organization name for a slug or id. Used by tenant login screens.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "ce4866de-47aa-45d3-be53-658024a436dd" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] } ] }, { "name": "Central \u2014 Authentication", "description": "\nPlatform operator login for the control plane (`\/central` SPA). Tokens use the `central` Sanctum guard \u2014 do not send `X-Tenant`.", "item": [ { "name": "Central Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"password\":\"|]|{+-\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Central Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-store, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "167f3d54-d851-459d-9277-acf5282e7b5c" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Central Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Central \u2014 Dashboard & Activity", "description": "", "item": [ { "name": "Central Dashboard Snapshot", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/dashboard", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/dashboard" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "0f7151b6-59af-4a1b-8172-4124225e6891" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Central Activity Log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/activity", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/activity" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "5bff2f32-4556-490b-84e7-b8e2ce84d8a1" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] } ] }, { "name": "Central \u2014 Tenants & Hierarchy", "description": "\nProvision and manage tenant organizations from the platform control plane.", "item": [ { "name": "List Tenants", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"page\":16,\"per_page\":22,\"search\":\"g\",\"status\":\"active\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "66729f6d-d9be-4755-b2a6-8d053be2202a" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Create Tenant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"b\",\"name\":\"n\",\"parent\":\"g\",\"super_admin\":{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"password\":\"architecto\"},\"admin\":{\"name\":\"n\",\"email\":\"ashly64@example.com\"},\"user_license_limit\":1}" }, "description": "" }, "response": [] }, { "name": "Tenant Hierarchy Tree", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/tree", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/tree" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "92a7a801-c801-4b0b-950c-b70474d3503e" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Show Tenant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "a98845e7-6826-4321-b0a9-2246955d8406" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Set Tenant Parent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/parent", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/parent", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"parent\":\"b\"}" }, "description": "" }, "response": [] }, { "name": "Update Tenant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"b\",\"name\":\"n\",\"status\":\"active\",\"user_license_limit\":7,\"api_rate_limit\":16,\"allowed_ips\":[\"m\"]}" }, "description": "" }, "response": [] }, { "name": "Delete Tenant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"confirm_slug\":\"b\"}" }, "description": "" }, "response": [] }, { "name": "Update Tenant User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/users\/:userId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/users\/:userId", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." }, { "id": "userId", "key": "userId", "value": "564", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"is_active\":false,\"has_license\":true}" }, "description": "" }, "response": [] }, { "name": "Impersonate Tenant User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/users\/:userId\/impersonate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/users\/:userId\/impersonate", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." }, { "id": "userId", "key": "userId", "value": "564", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "Starts a support session and returns a short-lived tenant Sanctum token." }, "response": [] } ] }, { "name": "Central \u2014 Tenant Access", "description": "\nCross-tenant visibility policies and per-user grants.", "item": [ { "name": "Show Tenant Access", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/access", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/access", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "30a9e976-7007-4b34-9d62-becbd813eb42" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Upsert Tenant Access Policy", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/access\/policies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/access\/policies", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"source\":\"b\",\"level\":\"monitor\"}" }, "description": "" }, "response": [] }, { "name": "Upsert Tenant Access Grant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/access\/grants", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/access\/grants", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"source\":\"b\",\"user_id\":22,\"level\":\"monitor\"}" }, "description": "" }, "response": [] }, { "name": "Delete Tenant Access Grant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/access\/grants\/:grant", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/access\/grants\/:grant", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." }, { "id": "grant", "key": "grant", "value": "564", "description": "The grant." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Central \u2014 Tenant Backups", "description": "\nPer-tenant database dumps stored on the platform host.", "item": [ { "name": "List Tenant Backups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/backups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/backups", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "1eee393d-3768-446e-9ecb-b19829c7b816" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Create Tenant Backup", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/backups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/backups", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Download Tenant Backup", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/backups\/:filename", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/backups\/:filename", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." }, { "id": "filename", "key": "filename", "value": "db_backup_-.w.zip", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "392df036-74b6-4d1c-8fac-bb74ac98ffb5" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Delete Tenant Backup", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/backups\/:filename", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/backups\/:filename", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." }, { "id": "filename", "key": "filename", "value": "db_backup_-.w.zip", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Central \u2014 Platform Operators", "description": "", "item": [ { "name": "List Platform Operators", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/operators", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/operators" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "6e941665-ba00-4762-b7e0-f6fc19bdf6c8" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Create Platform Operator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/operators", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/operators" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"password\":\"architecto\",\"role\":\"platform-super\",\"is_active\":false}" }, "description": "" }, "response": [] }, { "name": "Update Platform Operator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/operators\/:operator", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/operators\/:operator", "variable": [ { "id": "operator", "key": "operator", "value": "564", "description": "The operator." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"role\":\"platform-admin\",\"is_active\":true}" }, "description": "" }, "response": [] }, { "name": "Delete Platform Operator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/operators\/:operator", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/operators\/:operator", "variable": [ { "id": "operator", "key": "operator", "value": "564", "description": "The operator." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Central \u2014 Host Operations", "description": "\nPlatform-wide cache operations and legacy API-key configuration status.", "item": [ { "name": "Flush Application Cache", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/cache\/flush", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/cache\/flush" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "API Key Configuration Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/config\/api-key", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/config\/api-key" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "a20b2dca-71ca-4971-bfb0-5d92834ac4a3" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] } ] }, { "name": "Central \u2014 Ops Dashboards", "description": "\nIssue short-lived access tickets for Telescope, Horizon, and Pulse.", "item": [ { "name": "Issue Telescope Access Ticket", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/telescope\/ticket", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/telescope\/ticket" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Issue Horizon Access Ticket", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/horizon\/ticket", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/horizon\/ticket" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Issue Pulse Access Ticket", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/pulse\/ticket", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/pulse\/ticket" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Authentication", "description": "\nEndpoints for managing user authentication and access tokens.", "item": [ { "name": "User Registration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/register", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"password\":\"architecto\",\"device_name\":\"n\",\"platform\":\"web\",\"provider\":\"webpush\",\"token\":\"g\",\"app_version\":\"z\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "User Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"password\":\"architecto\",\"device_name\":\"n\",\"platform\":\"ios\",\"provider\":\"apns\",\"token\":\"g\",\"app_version\":\"z\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"token\":\"architecto\",\"password\":\"architecto\",\"password_confirmation\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Verify Email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/email\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/email\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"id\":16,\"hash\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "User Details By Access Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/user-by-token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/user-by-token" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"token\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-store, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "1fbbaab1-9cc2-422c-8f66-e0c6677a31c8" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "User Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Get Current User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-store, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "86381cdc-efce-46f1-afaf-63820d0c47ee" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Update Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/profile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/profile" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\"}" }, "description": "" }, "response": [] }, { "name": "Resend Email Verification", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/email\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/email\/resend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Change Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/password" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"current_password\":\"architecto\",\"password\":\"architecto\",\"password_confirmation\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "List Access Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/tokens" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-store, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "c191b570-addf-4b5d-987f-803411fce00c" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Revoke Access Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/tokens\/:tokenId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/tokens\/:tokenId", "variable": [ { "id": "tokenId", "key": "tokenId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Device Registry", "description": "\nRegister mobile \/ web device tokens for multi-channel push (FCM, APNs, Web Push linkage).", "item": [ { "name": "List Devices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/devices" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "391a5c6c-3e46-4769-b0f2-5630697c2a79" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Register or Update Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/devices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"ios\",\"provider\":\"webpush\",\"token\":\"b\",\"device_name\":\"n\",\"app_version\":\"g\"}" }, "description": "" }, "response": [] }, { "name": "Revoke Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/devices" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"token\":\"b\",\"provider\":\"webpush\"}" }, "description": "" }, "response": [] } ] }, { "name": "Push Notifications", "description": "\nEndpoints for browser Web Push subscriptions and multi-channel notification dispatch.", "item": [ { "name": "Save Push Subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push\/subscribe", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push\/subscribe" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"endpoint\":\"b\",\"keys\":{\"p256dh\":\"architecto\",\"auth\":\"architecto\"},\"content_encoding\":\"aesgcm\"}" }, "description": "" }, "response": [] }, { "name": "Unsubscribe Push Notification", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push\/unsubscribe", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push\/unsubscribe" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"endpoint\":\"b\"}" }, "description": "" }, "response": [] }, { "name": "Send Push Notification (self)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push\/send" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"title\":\"b\",\"body\":\"n\",\"icon\":\"g\",\"url\":\"http:\\\/\\\/www.okuneva.com\\\/fugiat-sunt-nihil-accusantium-harum-mollitia.html\",\"providers\":[\"apns\"]}" }, "description": "" }, "response": [] }, { "name": "List Broadcast Recipients", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push\/recipients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push\/recipients" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "7e632972-db17-49c3-8b18-c2a2695726d5" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Broadcast Push Notification", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push\/broadcast", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push\/broadcast" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"title\":\"b\",\"body\":\"n\",\"icon\":\"g\",\"url\":\"http:\\\/\\\/www.okuneva.com\\\/fugiat-sunt-nihil-accusantium-harum-mollitia.html\",\"audience\":\"all_devices\",\"user_ids\":[16],\"device_keys\":[\"device_642\"]}" }, "description": "Requires tenant context (`X-Tenant`) and `notifications.send`. When `audience` is `users` or `devices`,\nthe supplied IDs must belong to the current tenant." }, "response": [] } ] }, { "name": "Notifications \u2014 Inbox", "description": "", "item": [ { "name": "List Inbox Notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"page\":16,\"per_page\":22,\"unread_only\":1,\"category\":\"broadcast\",\"simple\":0}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "60d9f587-3636-47e1-a1f2-432afccbc3dd" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Unread Notification Count", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/unread-count", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/unread-count" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "078b8901-adcf-47b0-a006-a46bf17d7bd6" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Mark All Notifications Read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/read-all", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/read-all" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "List Sent Broadcast Batches", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/sent-batches", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/sent-batches" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "Requires `notifications.send`." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "0d33d9a4-902b-44ac-a790-a79620eb3584" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Mark Notification Read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/:id\/read", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/:id\/read", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the notification." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "User Management", "description": "\nEndpoints for querying, managing, impersonating, and exporting users.", "item": [ { "name": "Export User Data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/export", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/export" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"format\":\"xls\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "2bbc99e6-ff2c-43ba-a9a2-4ed9e51a424b" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Impersonate User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/impersonate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/impersonate", "variable": [ { "id": "user_id", "key": "user_id", "value": 1, "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Stop Impersonating User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/stop-impersonating", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/stop-impersonating" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "List Users (Filtered & Sorted)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"per_page\":1,\"filter\":{\"name\":\"n\",\"email\":\"ashly64@example.com\"},\"sort\":\"v\",\"include\":\"d\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "7760a9e3-cbf7-4d5b-b5b3-5043586c91f3" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Get User Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": 1, "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "ae65eb79-994e-4d1b-8213-054a1e24f4a0" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Create User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"password\":\"architecto\",\"is_active\":true,\"has_license\":false,\"roles\":[\"architecto\"],\"email\":\"zbailey@example.net\",\"username\":\"i\"}" }, "description": "" }, "response": [] }, { "name": "Update User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": 1, "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"is_active\":false,\"has_license\":true,\"roles\":[\"architecto\"],\"email\":\"zbailey@example.net\",\"username\":\"i\"}" }, "description": "" }, "response": [] }, { "name": "Update User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": 1, "description": "The ID of the user." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"is_active\":false,\"has_license\":true,\"roles\":[\"architecto\"],\"email\":\"zbailey@example.net\",\"username\":\"i\"}" }, "description": "" }, "response": [] }, { "name": "Delete User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": 1, "description": "The ID of the user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Restore User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id\/restore", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id\/restore", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Role & Permission Management", "description": "\nEndpoints for managing RBAC Roles and Permissions.", "item": [ { "name": "List Permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/permissions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"filter\":{\"name\":\"b\"}}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "0423d3f2-f1c9-4675-86ce-2a6ce1697e98" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "List Roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "e50301d9-489d-47d0-a9a9-2e013ae06cbc" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Get Role Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role_id", "variable": [ { "id": "role_id", "key": "role_id", "value": 1, "description": "The ID of the role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "3b5842ed-4077-4513-ae66-c09d32d2b53b" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Create Role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"display_name\":\"n\",\"permissions\":[\"architecto\"]}" }, "description": "" }, "response": [] }, { "name": "Update Role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role_id", "variable": [ { "id": "role_id", "key": "role_id", "value": 1, "description": "The ID of the role." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"display_name\":\"n\",\"permissions\":[\"architecto\"]}" }, "description": "" }, "response": [] }, { "name": "Update Role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role_id", "variable": [ { "id": "role_id", "key": "role_id", "value": 1, "description": "The ID of the role." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"display_name\":\"n\",\"permissions\":[\"architecto\"]}" }, "description": "" }, "response": [] }, { "name": "Delete Role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role_id", "variable": [ { "id": "role_id", "key": "role_id", "value": 1, "description": "The ID of the role." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "Restore Role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:id\/restore", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:id\/restore", "variable": [ { "id": "id", "key": "id", "value": 1, "description": "The ID of the role." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Audit Trail & Activity Logs", "description": "\nEndpoints for monitoring administrator and user action audit logs.", "item": [ { "name": "Export Activity Logs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/activity-logs\/export", "query": [], "raw": "{{baseUrl}}\/api\/v1\/activity-logs\/export" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"format\":\"csv\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "1d3231b9-517b-4011-8f78-ee902a4a8245" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "List Activity Logs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/activity-logs", "query": [], "raw": "{{baseUrl}}\/api\/v1\/activity-logs" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"per_page\":1,\"filter\":{\"log_name\":\"n\",\"description\":\"Animi quos velit et fugiat.\",\"event\":\"d\",\"from\":\"2026-09-04T13:56:46\",\"to\":\"2026-09-04T13:56:46\"},\"sort\":\"l\",\"include\":\"j\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "9c9845bb-44f1-4311-b356-3b7d24aee0f3" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "POST api\/v1\/central\/auth\/two-factor\/verify", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/two-factor\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/two-factor\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"challenge_token\":\"bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnn\",\"code\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/central\/auth\/two-factor\/status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/two-factor\/status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/two-factor\/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-store, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "7ff149f4-3e75-4a37-accf-7aed4ecbf6a0" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "POST api\/v1\/central\/auth\/two-factor\/setup", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/two-factor\/setup", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/two-factor\/setup" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "POST api\/v1\/central\/auth\/two-factor\/confirm", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/two-factor\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/two-factor\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"code\":\"bngzmi\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/central\/auth\/two-factor\/disable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/two-factor\/disable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/two-factor\/disable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"code\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/central\/auth\/two-factor\/recovery-codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/auth\/two-factor\/recovery-codes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/auth\/two-factor\/recovery-codes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"code\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/central\/tenants\/{tenant}\/export", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/export", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/export", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "GET api\/v1\/central\/tenants\/{tenant}\/exports\/{filename}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/exports\/:filename", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/exports\/:filename", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." }, { "id": "filename", "key": "filename", "value": "tenant_export_--..zip", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "cd146292-8090-486f-9f83-367266af6c3f" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "GET api\/v1\/central\/tenants\/{tenant}\/api-keys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/api-keys", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/api-keys", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "4ba123a2-25e0-4421-b746-beb163f0e3c3" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "POST api\/v1\/central\/tenants\/{tenant}\/api-keys", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/api-keys", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/api-keys", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"abilities\":[\"z_e6zpjx\"],\"expires_at\":\"2052-09-28\"}" }, "description": "" }, "response": [] }, { "name": "DELETE api\/v1\/central\/tenants\/{tenant}\/api-keys\/{apiKey}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/central\/tenants\/:tenant\/api-keys\/:apiKey", "query": [], "raw": "{{baseUrl}}\/api\/v1\/central\/tenants\/:tenant\/api-keys\/:apiKey", "variable": [ { "id": "tenant", "key": "tenant", "value": "acme", "description": "The tenant." }, { "id": "apiKey", "key": "apiKey", "value": "564", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "GET api\/v1\/chat\/conversations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/chat\/conversations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/chat\/conversations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "25fb06bf-c125-4190-a3df-bccc0cb300fc" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "POST api\/v1\/chat\/conversations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/chat\/conversations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/chat\/conversations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"recipient_id\":16}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/chat\/conversations\/{conversation}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/chat\/conversations\/:conversation\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/chat\/conversations\/:conversation\/messages", "variable": [ { "id": "conversation", "key": "conversation", "value": "architecto", "description": "The conversation." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"before_id\":16,\"since_id\":39,\"limit\":7}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "b76a69fe-8dc8-4ed3-863b-c57df9ae79cb" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "POST api\/v1\/chat\/conversations\/{conversation}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/chat\/conversations\/:conversation\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/chat\/conversations\/:conversation\/messages", "variable": [ { "id": "conversation", "key": "conversation", "value": "architecto", "description": "The conversation." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"body\":\"b\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/chat\/conversations\/{conversation}\/read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/chat\/conversations\/:conversation\/read", "query": [], "raw": "{{baseUrl}}\/api\/v1\/chat\/conversations\/:conversation\/read", "variable": [ { "id": "conversation", "key": "conversation", "value": "architecto", "description": "The conversation." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "GET api\/v1\/chat\/unread-count", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/chat\/unread-count", "query": [], "raw": "{{baseUrl}}\/api\/v1\/chat\/unread-count" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "6957018d-7b20-4165-9958-70c8710e6098" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "GET api\/v1\/chat\/users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/chat\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/chat\/users" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"search\":\"b\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "3ed52c5a-9925-40ad-bac8-cd8db644cdf1" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "Example tenant resource", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/example", "query": [], "raw": "{{baseUrl}}\/api\/v1\/example" }, "method": "GET", "header": [ { "key": "X-Api-Key", "value": "tk_your_tenant_integration_secret Integration authentication alternative to Bearer." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "Accepts either a tenant user's Bearer token or a tenant integration key\nwith the `example.read` ability." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "3deebcb1-2cea-4cc5-8b8a-843f33f1c457" }, { "key": "vary", "value": "Origin" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "POST api\/v1\/auth\/two-factor\/verify", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/two-factor\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/two-factor\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"challenge_token\":\"bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnn\",\"code\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/auth\/two-factor\/status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/two-factor\/status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/two-factor\/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-store, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "SAMEORIGIN" }, { "key": "x-permitted-cross-domain-policies", "value": "none" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "x-request-id", "value": "5b6adb56-46fa-47c6-a1e4-f0ec4d6cd52d" }, { "key": "vary", "value": "Origin" } ], "code": 503, "body": "{\"status\":\"error\",\"message\":\"Tenant database is not provisioned.\",\"data\":null,\"errors\":null}", "name": "" } ] }, { "name": "POST api\/v1\/auth\/two-factor\/setup", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/two-factor\/setup", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/two-factor\/setup" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": null, "description": "" }, "response": [] }, { "name": "POST api\/v1\/auth\/two-factor\/confirm", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/two-factor\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/two-factor\/confirm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"code\":\"bngzmi\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/auth\/two-factor\/disable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/two-factor\/disable", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/two-factor\/disable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"code\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/auth\/two-factor\/recovery-codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/two-factor\/recovery-codes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/two-factor\/recovery-codes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Tenant", "value": "demo" } ], "body": { "mode": "raw", "raw": "{\"code\":\"architecto\"}" }, "description": "" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }