{ "item": [ { "id": "2df58b4c-70ae-484a-a2ac-3926d8d92f36", "name": "auth", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b9570bf4-b3b3-44e7-83f4-0307fa518bf8", "name": "Request a password reset link (public, rate limited)", "request": { "name": "Request a password reset link (public, rate limited)", "description": { "content": "Public — no authentication required, but limited per\n``PASSWORD_RESET_RATE_LIMIT`` (5/min/IP by default).\n\nBody shape: ``{\"email\": \"
\"}``. Always returns 204 + empty body\n(CWE-204). When the address matches a registered user we additionally\nenqueue an email via Celery. When the per-email cooldown is active we\nset ``Retry-After`` to the configured cooldown and STILL return 204.", "type": "text/plain" }, "url": { "path": [ "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"vkcehp@SUFZkarbNjVDJgp.agi\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4857c68f-7849-4b50-afab-f33b9fc3f80a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vkcehp@SUFZkarbNjVDJgp.agi\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3dfebbe4-74c1-4397-a56b-86563f659884", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vkcehp@SUFZkarbNjVDJgp.agi\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0fca6d0-65c5-4d0b-8817-892fd8858878", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vkcehp@SUFZkarbNjVDJgp.agi\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2291971d-ef38-468b-aae4-26d56117efa4", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vkcehp@SUFZkarbNjVDJgp.agi\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21fe0889-2975-4dd7-bed1-7ff019dade0b", "name": "Login (public, rate limited)", "request": { "name": "Login (public, rate limited)", "description": { "content": "Public — no authentication required, but limited to 5 attempts/minute/IP.\n\nOn success: 200 + access_token in the body, refresh as HttpOnly cookie.\nOn bad credentials: 401 problem+json.", "type": "text/plain" }, "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"email\": \"admin@demo.trustedoss.dev\",\n \"password\": \"DemoTest2026!\"\n}" } }, "response": [ { "id": "72e4652a-7d3a-4538-81b2-b183032c95c5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"46QW@GZDNdKLVopTYfTFUUJ.kq\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 2470,\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "679fcf7e-b570-47c7-8dc7-700ee80e0dd6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"46QW@GZDNdKLVopTYfTFUUJ.kq\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b20e689-a909-4ce0-a81b-5a4d4933c669", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"46QW@GZDNdKLVopTYfTFUUJ.kq\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Carries the access token into every later request in this", "// collection that authenticates with {{bearerToken}}.", "const body = pm.response.json();", "if (body.access_token) {", " pm.collectionVariables.set(\"bearerToken\", body.access_token);", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c217f5d-d78a-44ce-826f-248946f15b03", "name": "Logout (revoke refresh cookie)", "request": { "name": "Logout (revoke refresh cookie)", "description": { "content": "Revoke the refresh cookie. Idempotent — always returns 204 even if the\ncookie is absent or already revoked.", "type": "text/plain" }, "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "add5fca0-60d7-427e-94c9-df3ec098c6e2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02f1deba-2199-4b47-84bf-778ad56ccd2d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36663e22-aee1-4584-882e-baaff20c36b9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3964889-967e-4391-996c-da20bf484b3c", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2752fb5-1a06-4bc4-be1a-de2c24a9a97b", "name": "Return the currently authenticated user and their memberships", "request": { "name": "Return the currently authenticated user and their memberships", "description": { "content": "Authenticated. UserPublic + the caller's team memberships.\n\nThe frontend reads ``memberships`` to resolve a ``team_id`` for project\ncreation / write scoping. Ordered oldest-first so ``memberships[0]`` is a\nstable default team.", "type": "text/plain" }, "url": { "path": [ "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7211dd7b-a64a-4bcb-be5b-943756348f4d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8c20637e-068c-c3fb-d665-0c21aab90865\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1992-04-17T07:42:18.454Z\",\n \"full_name\": \"string\",\n \"memberships\": [\n {\n \"team_id\": \"826119c3-c2d8-add7-ce0c-d6d8938f5482\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"340c4585-81e2-60ea-ae5b-1984a3c9c696\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca76843c-6f9c-4a7e-984d-88cd86cf9cfb", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8344d844-3089-4ceb-918f-ae27e4986afe", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "auth", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "365be7d4-528c-4da3-936e-b734b86cc863", "name": "Finish a sign-in by supplying the second factor (public, rate limited)", "request": { "name": "Finish a sign-in by supplying the second factor (public, rate limited)", "description": { "content": "Public. The pending token from `POST /auth/login` is the credential, and it\nis worth nothing on its own.\n\nOn success: 200 + access_token, refresh as an HttpOnly cookie. This is the\nfirst point at which a session exists.", "type": "text/plain" }, "url": { "path": [ "auth", "mfa", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b1b0e8fb-ddf3-4987-9b3b-357735a7e322", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "mfa", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 2470,\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb94385e-cbbb-4b23-ac7e-8bbff92eab30", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "mfa", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54dd53ce-da39-4f28-9dc4-88053afdaaf4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "auth", "mfa", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20f29a2e-bc80-475a-8363-9888f1ab09ee", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "mfa", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19da872c-1953-4ac5-9c7c-a18fab40450b", "name": "List OAuth provider availability (public)", "request": { "name": "List OAuth provider availability (public)", "description": { "content": "Public — no authentication required (explicit exception to CLAUDE.md\ncore rule #12: the consumer is the anonymous /login page, which must\ndecide which OAuth sign-in buttons to render BEFORE any credential\nexists).\n\nAlways lists every supported provider with a bare ``configured``\nboolean. ``configured`` is ``True`` only when both the client id AND\nclient secret are set — the same condition under which\n``/{provider}/authorize`` actually works (M-15: a half-configured or\nunconfigured provider previously surfaced as a rendered button that\n503'd on click).\n\nSecurity: the response carries booleans only — never client ids,\nsecrets, or any other configuration detail.", "type": "text/plain" }, "url": { "path": [ "auth", "oauth", "providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1756fbcf-1fd1-457f-a2f5-1621f427e774", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "oauth", "providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"providers\": [\n {\n \"provider\": \"github\",\n \"configured\": false\n },\n {\n \"provider\": \"github\",\n \"configured\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77173d51-b1ef-49b1-9465-188c9e548ff0", "name": "Begin OAuth sign-in (public, rate limited)", "request": { "name": "Begin OAuth sign-in (public, rate limited)", "description": { "content": "Public — no authentication required.\n\n302 → provider's authorize URL with a signed state. Returns:\n - 503 + ``oauth_provider_disabled`` Problem Details when the\n provider's client id/secret is not configured.\n - 404 Problem Details when the provider name is unknown (FastAPI's\n Literal[] gate normally catches this; the explicit branch survives\n future enum widening).\n - 403 ``demo_read_only`` Problem Details when the deployment runs in\n read-only live-demo mode (OAuth sign-in is a write; see\n :func:`_demo_read_only_blocked`).\n - 429 when an IP exceeds ``OAUTH_AUTHORIZE_RATE_LIMIT``. Looser than\n the login limit on purpose: there is no credential to guess here, and\n an office behind one NAT address signs in together. The limit is a\n backstop; what actually bounds the cost of a cold discovery cache is\n the provider's own failure cache.", "type": "text/plain" }, "url": { "path": [ "auth", "oauth", ":provider", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "redirect_after", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9b0ebae8-99f8-45cb-9ccc-29980309a044", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "oauth", ":provider", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "redirect_after", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bc2124e-8440-4963-8472-b2fcad61275b", "name": "Not found", "originalRequest": { "url": { "path": [ "auth", "oauth", ":provider", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "redirect_after", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcc8e34d-7f9f-424a-ad8b-723f1767e67b", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "oauth", ":provider", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "redirect_after", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b68e201-714a-47f7-b0a0-9a9a279b842c", "name": "OAuth callback (public)", "request": { "name": "OAuth callback (public)", "description": { "content": "Public — the provider's redirect lands here after consent.\n\nSuccess path: 302 → ``redirect_after`` (or configured default) with the\nrefresh-token HttpOnly cookie attached.\n\nFailure path: 302 → configured failure URL with ``?error=``. The\nprovider's own ``?error=access_denied`` (user clicked \"Cancel\") falls\nthrough here too — we forward a normalised ``error=oauth_denied``.\n\nRead-only demo: if ``DEMO_READ_ONLY`` is enabled we 403 BEFORE any token\nexchange or DB write (see :func:`_demo_read_only_blocked`), so the callback\ncan never create/link a User or Team in the demo.", "type": "text/plain" }, "url": { "path": [ "auth", "oauth", ":provider", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "code", "value": "string" }, { "disabled": false, "key": "state", "value": "string" }, { "disabled": false, "key": "error", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8e448c8a-897e-4e33-b033-04f5e9ef6ef0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "oauth", ":provider", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "code", "value": "string" }, { "key": "state", "value": "string" }, { "key": "error", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d928a65d-e717-4014-b726-88de1eb4b9cd", "name": "Not found", "originalRequest": { "url": { "path": [ "auth", "oauth", ":provider", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "code", "value": "string" }, { "key": "state", "value": "string" }, { "key": "error", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ea2a8a7-d35c-4dec-8254-fda54e6d3a89", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "oauth", ":provider", "callback" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "code", "value": "string" }, { "key": "state", "value": "string" }, { "key": "error", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "oidc", "key": "provider", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a73e6ff9-0009-4cb1-99dd-d1c00909f50f", "name": "Rotate refresh token (public; refresh cookie is the credential, rate limited)", "request": { "name": "Rotate refresh token (public; refresh cookie is the credential, rate limited)", "description": { "content": "Public — the refresh cookie is the credential.\n\nSuccessful rotation: 200 + new access_token + new refresh cookie.\nReuse detected (cookie already rotated): 401, entire chain revoked.", "type": "text/plain" }, "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "f23d98b7-5bc1-442b-8481-c1e7e6e14f41", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 2470,\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3daf128d-ee01-495c-995f-ab6495ca4889", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3107c2d8-55c2-47fe-8afb-e4c9df96c1e9", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d582b700-2d74-4519-a3ef-9cc629de59fd", "name": "Register a new user (public, rate limited)", "request": { "name": "Register a new user (public, rate limited)", "description": { "content": "Public, no authentication required.\n\nLimited to ``REGISTRATION_RATE_LIMIT`` (5/min/IP by default): the bcrypt\npassword hash is CPU-bound, so an uncapped public endpoint could occupy\nthe worker's event loop with unauthenticated requests.\n\nReturns the new user (without password). 422 for validation errors, 409 if\nthe email is already registered, and 404 when the deployment maintains its\nroster itself (``AUTH_SELF_REGISTRATION=false``), which is the same answer\nan outsider gets for any route that is not there.", "type": "text/plain" }, "url": { "path": [ "auth", "register" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"email\": \"Id50@ukzdbGkGvburBRMQhgRYZEIlnNENRyaf.gdg\",\n \"password\": \"stringstring\",\n \"full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aa03db0f-0c5c-409f-b654-7c3a0ebe416a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "register" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"Id50@ukzdbGkGvburBRMQhgRYZEIlnNENRyaf.gdg\",\n \"password\": \"stringstring\",\n \"full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"59558717-7f5f-9276-a344-3edf46b77e1f\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"1973-01-06T23:36:53.844Z\",\n \"full_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425e6fbb-c5cf-4246-84f6-a63e6c73d708", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "register" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"Id50@ukzdbGkGvburBRMQhgRYZEIlnNENRyaf.gdg\",\n \"password\": \"stringstring\",\n \"full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9669ca5b-684b-4cf3-a75e-3af7075b6a6d", "name": "Confirm a password reset using a one-shot token (public, rate limited)", "request": { "name": "Confirm a password reset using a one-shot token (public, rate limited)", "description": { "content": "Public — the reset token is the credential.\n\nLimited to ``PASSWORD_RESET_CONFIRM_RATE_LIMIT`` (5/min/IP by default,\nsame as login): the token is guessable the same way a password is, and\nthe verify path costs a bcrypt call per live candidate, so this\nendpoint needs no less protection than login (F1,\nconcurrency-scaling-plan-2026-08-22.md).\n\nOn success: 204 + every refresh token for the user is revoked.\nOn bad / expired / used token: 422 problem+json.", "type": "text/plain" }, "url": { "path": [ "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstring\",\n \"new_password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8c7c0f30-8f9c-48b5-a391-9bd715e0eb4c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstring\",\n \"new_password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f70fed02-f555-4d17-b992-596e018b5376", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstring\",\n \"new_password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2fcfa9f-9055-45b7-9cbd-eac4b36e42d0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstring\",\n \"new_password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52812286-ebe3-4dde-bdd1-44bcda5bb3f1", "name": "Validation error", "originalRequest": { "url": { "path": [ "auth", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"token\": \"stringstring\",\n \"new_password\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1fa745e9-c8e2-424c-8fde-a2c57df8ed70", "name": "public", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "23d9c018-22be-470b-9f6e-040dbc9a332c", "name": "Liveness probe — PUBLIC, unauthenticated", "request": { "name": "Liveness probe — PUBLIC, unauthenticated", "description": { "content": "Cheap PURE-LIVENESS probe used by docker-compose / k8s liveness checks.\n\nPUBLIC / unauthenticated (CLAUDE.md rule #12 explicit exception). This proves\nonly that the uvicorn process is accepting requests — it does NOT touch the\ndatabase and says nothing about schema state. For \"is the schema migrated and\nsafe to serve traffic / start workers\", use GET /health/ready (api/v1/health.py).\n\nv2.1 Track B (B5): also surfaces ``demo_read_only`` so the SPA can render the\nread-only banner and disable write actions without needing a separate build.\nThe flag is resolved at request time (CLAUDE.md rule #11), so the same image\nbehaves correctly whether DEMO_READ_ONLY is set or not.\n\nAlso surfaces ``demo_sandbox_scans`` — only true when the read-only demo has\nthe opt-in sandbox carve-out enabled (both ``DEMO_READ_ONLY`` and\n``DEMO_ALLOW_SANDBOX_SCANS``). The SPA uses it to re-enable the bounded\nscan / SBOM-ingest affordances on the Demo Sandbox project while keeping\nevery other write disabled.", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "222c9791-6eda-48a3-ad4a-e7200b0f7d35", "name": "Successful Response", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9940.043104228913\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16ee5149-8030-4b39-a186-df3b17c2bbcb", "name": "Readiness probe (schema at Alembic HEAD) — PUBLIC, unauthenticated", "request": { "name": "Readiness probe (schema at Alembic HEAD) — PUBLIC, unauthenticated", "description": { "content": "Return 200 when the DB schema matches the Alembic HEAD, else 503.\n\nPUBLIC: no auth dependency by design (probe endpoint — see module docstring\nand CLAUDE.md core rule #12). The check is read-only (a single SELECT on\n``alembic_version`` plus an in-image read of the script tree).\n\nThe ``redis`` field is observational only (issue #399): it never changes\nthe status code, so a Redis outage does not pull the backend out of an\norchestrator's rotation for a dependency the request path already fails\nopen through. See ``core.readiness`` for the reasoning.", "type": "text/plain" }, "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "306fd3da-6552-4304-9520-f73bdaa61179", "name": "Schema is at the Alembic HEAD revision.", "originalRequest": { "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"redis\": \"ok\",\n \"status\": \"ready\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef3e0dfa-1d7c-4521-a52c-0ebb9524c890", "name": "Schema is not at HEAD, the alembic_version table is missing, or the database is unreachable. RFC 7807 problem+json.", "originalRequest": { "url": { "path": [ "health", "ready" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"detail\": \"database schema is not at the expected Alembic HEAD (expected: 0021_abc; current: 0020_def)\",\n \"instance\": \"/health/ready\",\n \"ready\": false,\n \"redis\": \"ok\",\n \"status\": 503,\n \"title\": \"Service Not Ready\",\n \"type\": \"urn:trustedoss:problem:schema-not-ready\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f84f48ec-5fcc-4a5c-8f88-70ae277ce94f", "name": "metrics", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2768d6d1-8cb5-4486-953e-f46b080f76bb", "name": "Operational metrics, in the Prometheus text format", "request": { "name": "Operational metrics, in the Prometheus text format", "description": {}, "url": { "path": [ "metrics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "auth": null }, "response": [ { "id": "88e1191a-af90-4521-9b08-1446169b2c87", "name": "Successful Response", "originalRequest": { "url": { "path": [ "metrics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e216493-89e3-4d9a-a164-7b256d6d5e36", "name": "The deployment does not publish metrics, or the scraper did not present the configured token. The same answer for both, so an endpoint that is switched off cannot be told from one that is guarded.", "originalRequest": { "url": { "path": [ "metrics" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e98e85f9-b631-45af-b0aa-26d69f20d10a", "name": "about", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7648d8da-bcb1-4a1e-bb7f-7dd7099f64f0", "name": "Product identity and the list of license notices", "request": { "name": "Product identity and the list of license notices", "description": { "content": "Return what this deployment is, and which notices it can show.", "type": "text/plain" }, "url": { "path": [ "v1", "about" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3e8508ea-98e1-4d42-b054-ad4f1a85197c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "about" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"built_at\": \"2026-09-06T02:11:00Z\",\n \"commit\": \"a0d2bab\",\n \"copyright\": \"Copyright 2026 TRUSCA contributors\",\n \"documents\": [],\n \"license_name\": \"Apache License, Version 2.0\",\n \"license_spdx_id\": \"Apache-2.0\",\n \"license_url\": \"https://www.apache.org/licenses/LICENSE-2.0\",\n \"product\": \"TRUSCA\",\n \"source_url\": \"https://github.com/trustedoss/trusca\",\n \"version\": \"2.3.0-dev\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b78c3611-0eb3-4b68-87e5-9c816cd0975c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "about" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "359a6aed-6858-499a-ac7a-051595415736", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "about" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "336a24fe-bbe8-4bba-86db-ae0ac44c497a", "name": "Read one license-notice document", "request": { "name": "Read one license-notice document", "description": { "content": "Return one notice document as ``text/plain``.\n\nVerbatim: a license text that has been reflowed, truncated or\nmarkdown-rendered is no longer the notice it is standing in for.", "type": "text/plain" }, "url": { "path": [ "v1", "about", "notices", ":document_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "document_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9515d268-8ace-4403-89d3-246801ea6e81", "name": "The document's text, verbatim.", "originalRequest": { "url": { "path": [ "v1", "about", "notices", ":document_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "document_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d73f9c2-7dc8-415f-a4af-7d99d4873c11", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "about", "notices", ":document_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "document_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fe72fc8-d2b3-440f-a3a6-fd2020c7fe6a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "about", "notices", ":document_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "document_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f13645a8-6f57-4438-b687-c0a42d25cbc3", "name": "Unknown document id, or absent from this deployment.", "originalRequest": { "url": { "path": [ "v1", "about", "notices", ":document_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "document_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82166645-3aea-4a86-a49d-c216b38ffd08", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "about", "notices", ":document_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "document_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1bdda118-4a1b-4835-99e1-ad249cd7fed1", "name": "admin", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "cc0d92fc-3d0d-453a-bab7-4e85812e4c66", "name": "Active API-key count by stored-hash format (bcrypt vs HMAC-SHA256, A5)", "request": { "name": "Active API-key count by stored-hash format (bcrypt vs HMAC-SHA256, A5)", "description": {}, "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b00ce5db-ac12-4330-ba9f-d736991cc088", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"legacy_bcrypt_count\": 6745,\n \"hmac_sha256_count\": 3970,\n \"active_total\": 940\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a0e2667-1c11-413d-9fe8-4d6b13994aba", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00472c03-0d1d-4193-8164-f494cde53717", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e9ad2f8-18ad-47cf-9823-ffd9d60d798b", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a53247a-f972-43d5-96e6-5bedd9654c76", "name": "Active API-key count by stored-hash format (bcrypt vs HMAC-SHA256, A5)", "request": { "name": "Active API-key count by stored-hash format (bcrypt vs HMAC-SHA256, A5)", "description": {}, "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "09be443c-f78b-4f32-9b81-952c3c92438e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"legacy_bcrypt_count\": 6745,\n \"hmac_sha256_count\": 3970,\n \"active_total\": 940\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c52f1d71-a51c-4dc7-a59b-bece215dd73e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06326e25-eb5b-44f4-a64f-d0bca3110ac7", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "521c469d-523e-4d18-bfa9-6543c34588fc", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "api-keys", "hash-migration" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0fe40682-dc72-4f1a-a8d8-ca36344f1ec7", "name": "Search audit log (admin) — paginated, filterable", "request": { "name": "Search audit log (admin) — paginated, filterable", "description": {}, "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "target_table", "value": "organizations" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "209f04d0-e287-46f9-9202-90ef09c96204", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"3cff0f39-7b21-4f77-8bb0-b4264608406a\",\n \"created_at\": \"1986-04-22T07:20:42.339Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"bfe32301-979d-e3cd-0b8b-fdeec92485ca\",\n \"diff\": {\n \"key_0\": 1689.1192252720489,\n \"key_1\": true,\n \"key_2\": false,\n \"key_3\": false\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"1bb7a16f-bed7-cb1a-4606-344d229bb923\"\n },\n {\n \"id\": \"c5b03388-00b4-937b-0bc3-2845e3ee0192\",\n \"created_at\": \"1969-01-24T07:08:13.008Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"a75379ef-85b4-2571-fc71-f054758444c8\",\n \"diff\": {\n \"key_0\": 6718.376523506548\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"c5591294-2329-bff2-fd81-de6c71c6dee9\"\n }\n ],\n \"total\": 6154,\n \"page\": 7492,\n \"page_size\": 6236,\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ce2ad32-e5da-4289-8695-a0358ee56dff", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ff877ed-c742-4fa6-9ff1-8a94404aa92a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21b10ac5-241f-45e2-a854-9973058508d7", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84ce1769-aa25-480a-bc9d-0e66bd461959", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b15ddc9-c70b-45d8-9d8a-1f4c6ef00fdb", "name": "Search audit log (admin) — paginated, filterable", "request": { "name": "Search audit log (admin) — paginated, filterable", "description": {}, "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "target_table", "value": "organizations" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "45993a4b-1d52-4fe5-8814-dbd8d9c7f71b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"72cac132-2467-905b-f8ac-a1e717bb6891\",\n \"created_at\": \"2001-10-10T11:14:42.071Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"53d10247-05fb-d8bc-7582-b3e4d4c005b0\",\n \"diff\": {\n \"key_0\": true\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"c7ac035c-f498-c05c-cdfc-4505bf41ff47\"\n },\n {\n \"id\": \"ed16f6a7-9f82-b23b-f5b5-5cbfc9246654\",\n \"created_at\": \"1993-01-14T08:29:54.033Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"60eac1aa-4004-ac7e-fcf9-63bf19178a5c\",\n \"diff\": {\n \"key_0\": 8777.122792682521,\n \"key_1\": \"string\"\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"226e5670-0678-c618-9b15-cf3899e4641f\"\n }\n ],\n \"total\": 1151,\n \"page\": 2746,\n \"page_size\": 2155,\n \"has_more\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be69b175-6d46-4666-8ebc-b9374b75edc9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fc88bfd-ed15-4902-bb22-f33c21b97669", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fff04a9-6cb5-408b-8beb-4ab07904750b", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a167dc26-1bf9-457f-8b94-cd944571c411", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "302f1562-f7a8-49e2-8c49-91c12806eabb", "name": "Export audit log to CSV (admin) — streaming, capped at 100k rows", "request": { "name": "Export audit log to CSV (admin) — streaming, capped at 100k rows", "description": {}, "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "target_table", "value": "organizations" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7494a46d-72f8-4cca-8701-6cff7e5ac39f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85c07748-7e6b-405d-aacd-9148c132d485", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dff3549d-62f5-4500-bf55-0a37eb6783a2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb14826a-516b-49c0-9e94-7906c91c08ee", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db958222-5a54-46b5-88af-3e3e02898c30", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8ad6be9-e577-4efb-b0d9-aef6b68ef2fa", "name": "Export audit log to CSV (admin) — streaming, capped at 100k rows", "request": { "name": "Export audit log to CSV (admin) — streaming, capped at 100k rows", "description": {}, "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "target_table", "value": "organizations" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "11b5d535-40a8-4042-8ee4-441f7d5aeef2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b760e49-ad9b-42af-99f7-1d771b1894ce", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12451b3b-687c-4726-b30e-95fc5a6c6765", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20e20924-7739-4e68-9edc-954d9889045e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfc4a23c-360f-4f1d-8297-d646d22e252e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b7a7945-d159-410d-80fb-61d40b8fa168", "name": "List all backups (admin) — auto + manual, newest first", "request": { "name": "List all backups (admin) — auto + manual, newest first", "description": {}, "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "26e95d4b-6ff5-450b-aec6-7a61841803fa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"name\": \"string\",\n \"kind\": \"manual\",\n \"created_at\": \"1956-02-19T07:49:51.822Z\",\n \"size_bytes\": 1974,\n \"complete\": true,\n \"db_revision\": \"string\"\n },\n {\n \"name\": \"string\",\n \"kind\": \"manual\",\n \"created_at\": \"1970-08-01T09:18:02.215Z\",\n \"size_bytes\": 7961,\n \"complete\": true,\n \"db_revision\": \"string\"\n }\n ],\n \"total\": 5940\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d92eb29-f33e-4089-a6bc-aeecf0473420", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43fd22ff-82ca-4662-b4f8-aaba0fc8e1db", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "246224b4-aa18-4323-90d0-c953a3358ea5", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd7a9ae8-f849-460b-bf79-1d78da70b366", "name": "List all backups (admin) — auto + manual, newest first", "request": { "name": "List all backups (admin) — auto + manual, newest first", "description": {}, "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "caee75b8-fcc6-4cff-8c80-059e7dbffccc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"name\": \"string\",\n \"kind\": \"manual\",\n \"created_at\": \"2005-06-12T05:05:44.722Z\",\n \"size_bytes\": 5918,\n \"complete\": true,\n \"db_revision\": \"string\"\n },\n {\n \"name\": \"string\",\n \"kind\": \"manual\",\n \"created_at\": \"2020-06-15T08:51:16.023Z\",\n \"size_bytes\": 7339,\n \"complete\": true,\n \"db_revision\": \"string\"\n }\n ],\n \"total\": 5840\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71dacb2e-c7a2-4183-aba0-261dea197922", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef33ed39-fb79-44a7-b65a-d40c2c9f213e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4e3831c-fe13-4fa0-aa4a-aa529d884d7c", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1aed070-11bd-4569-8696-296c1fd88f77", "name": "Trigger a manual backup (admin) — enqueues the Celery task", "request": { "name": "Trigger a manual backup (admin) — enqueues the Celery task", "description": {}, "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "05c061aa-508a-479f-b3e3-c76667288b3f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"task_id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01f82c4f-9933-41b7-b1dd-bc67dff6ad6b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d14b457e-36d5-4b49-8a7d-c353fc6331c8", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbdd3c92-bcdf-4a95-a6c3-5e84c60231a2", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "011d4947-2d2d-483e-ad01-9f0da9301874", "name": "Trigger a manual backup (admin) — enqueues the Celery task", "request": { "name": "Trigger a manual backup (admin) — enqueues the Celery task", "description": {}, "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "43808750-27b1-40f4-ac5f-ee66cb643da6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"task_id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f3ecec7-2529-4409-8269-5f0497b0146b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d89a7fec-d14f-4636-95ee-0a0a83c67307", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fe276b1-f098-414c-b05f-28231ae8a8a0", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6927e7f6-1d19-4f8a-9123-75816a40350b", "name": "Restore from an uploaded backup archive (admin) — destructive", "request": { "name": "Restore from an uploaded backup archive (admin) — destructive", "description": {}, "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "archive", "value": "string", "type": "text", "description": "(Required) tar.gz produced by GET /download." } ] } }, "response": [ { "id": "111f7151-5e90-4a45-91f3-43be75022dea", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"task_id\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca7a94c7-d64c-4b54-a2fd-b1f2ca39b2a7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b242dcc-7457-4582-aa4c-ab68e7cb549c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af41bb73-8988-40e2-8499-92338200b63a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7e1b2cd-ec3f-4a0b-97d7-0b28bef052e1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6653d09a-3754-4b33-871e-f3607d3e5ac6", "name": "Restore from an uploaded backup archive (admin) — destructive", "request": { "name": "Restore from an uploaded backup archive (admin) — destructive", "description": {}, "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "archive", "value": "string", "type": "text", "description": "(Required) tar.gz produced by GET /download." } ] } }, "response": [ { "id": "6e49a49a-6cd3-4866-894c-1f86b1f5c96e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"task_id\": \"string\",\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9020d271-ce94-40ed-818e-f60b923bcfc1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e408bc58-3687-49d6-98f3-f9b2c8c85df2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e034b5dd-e0d9-43e4-b01a-a27e9ada1c24", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed0d05d-ac91-467e-b6b7-16bf2dee70f5", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Confirm-Restore", "value": "string", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "391", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) tar.gz produced by GET /download.", "type": "text/plain" }, "key": "archive", "value": "string", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ca4bfee-415a-43eb-85d4-54b9dc988634", "name": "Delete a manual backup (admin) — auto backups are protected", "request": { "name": "Delete a manual backup (admin) — auto backups are protected", "description": {}, "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a2748c41-293e-41f7-a0e3-6f370a57dd9f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31a1d27a-aae1-4c69-ad26-a045659cebdb", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deea6d7f-c014-4a2a-975e-ef6a7b74dfbc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "639215ce-2e67-45f4-b3e0-1fb7981336ad", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d997ae58-5b8a-4156-ad85-d8d76780fb44", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1032960-8081-4cb3-b62c-506606f4b6c3", "name": "Delete a manual backup (admin) — auto backups are protected", "request": { "name": "Delete a manual backup (admin) — auto backups are protected", "description": {}, "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "72b769f5-d887-4150-8e68-33daacc9eb71", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b49b6fc2-42af-4f4d-bdda-0f4e2e771a59", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db44af9e-8822-4a38-8c4e-e627603e9eb1", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7996023a-eb72-4c48-9b67-f4b1a3194124", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d98d2fb3-8699-45eb-93d9-2807176fb94a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4d41f51-7eb6-4a3f-ab4d-5666070438e9", "name": "Download a backup archive (admin) — streams a tar.gz of the directory", "request": { "name": "Download a backup archive (admin) — streams a tar.gz of the directory", "description": {}, "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "47c9a16f-2dc9-499e-8ce3-a176a88c84a7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36f0fe95-427b-4edb-a90b-fc33d25a83fa", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc85ae68-7302-4385-ae28-d53c1c9154d2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1258b424-cf59-4199-9622-5c5119d9632d", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2ca858-a369-417c-bc50-357b63b9dc79", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "581be875-3770-401c-b5b0-89cc4ef414a8", "name": "Download a backup archive (admin) — streams a tar.gz of the directory", "request": { "name": "Download a backup archive (admin) — streams a tar.gz of the directory", "description": {}, "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2dacb748-25a5-4432-b8ac-82f92375f8a3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0575d8fb-15fa-4cc9-8832-c4321225ad5f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6160dbff-d1b2-46e4-98fe-267c5f9d0e45", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "643a0c5b-8b1e-4061-b825-5d879e818234", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74766aa7-33d9-4844-8293-44b9b28c34c7", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "backup", ":name", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "name", "description": "(Required) Backup directory name." } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4d73a43-e69a-4efd-98c5-ec940a06c4a8", "name": "Disk usage telemetry (admin) — workspace / DT volume / Postgres / Redis", "request": { "name": "Disk usage telemetry (admin) — workspace / DT volume / Postgres / Redis", "description": {}, "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2274c4ec-8640-42d8-bd50-6ec4fd3d72f0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"name\": \"root_fs\",\n \"used_bytes\": 7097,\n \"status\": \"ok\",\n \"error\": \"string\",\n \"free_bytes\": 161,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 4397,\n \"used_pct\": 44.567939049410434\n },\n {\n \"name\": \"workspace\",\n \"used_bytes\": 5423,\n \"status\": \"degraded\",\n \"error\": \"string\",\n \"free_bytes\": 1000,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 9238,\n \"used_pct\": 64.6748832426183\n }\n ],\n \"collected_at\": \"1972-09-02T11:59:12.767Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e75e9bc7-8a46-4e72-afe7-89406d8bd9c3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c066add-0049-4eca-b435-3cb0078b001e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54bf0b9a-3d12-4151-a4a7-3e3c733c29eb", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3c42cb9-4393-4535-917e-d079fec7fb0f", "name": "Disk usage telemetry (admin) — workspace / DT volume / Postgres / Redis", "request": { "name": "Disk usage telemetry (admin) — workspace / DT volume / Postgres / Redis", "description": {}, "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bce4b180-4ec0-4ae6-af57-5c2bfe1a597e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"name\": \"redis\",\n \"used_bytes\": 1474,\n \"status\": \"down\",\n \"error\": \"string\",\n \"free_bytes\": 9555,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 8163,\n \"used_pct\": 43.235189631948565\n },\n {\n \"name\": \"redis\",\n \"used_bytes\": 7179,\n \"status\": \"ok\",\n \"error\": \"string\",\n \"free_bytes\": 3544,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 3883,\n \"used_pct\": 24.64059780516381\n }\n ],\n \"collected_at\": \"2026-06-14T08:15:32.067Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66d0e60b-ac7b-4b5d-9380-e24b7b78065e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27ac5271-c009-4be4-a62e-d2ab2ffb1d59", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "971c0a19-a21f-437d-8fba-f1219d6f2e1c", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "disk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd3cc601-beae-4be8-824a-792ba28cff9f", "name": "endoflife.date snapshot status (admin) — dataset age / counters / next beat", "request": { "name": "endoflife.date snapshot status (admin) — dataset age / counters / next beat", "description": {}, "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c803caad-1f20-4463-94dc-421bffca4890", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"enabled\": false,\n \"refresh_enabled\": true,\n \"cleared\": 557,\n \"duration_ms\": 8188,\n \"eol_flagged_total\": 5605,\n \"feed_host\": \"string\",\n \"last_attempt_at\": \"1966-10-25T13:01:25.047Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1968-11-06T12:41:13.899Z\",\n \"next_refresh_at\": \"1976-10-22T14:02:55.262Z\",\n \"product_count\": 0,\n \"rule_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"1999-05-27\",\n \"snapshot_origin\": \"feed\",\n \"stamped\": 3024\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed465d04-4e52-4312-a3bf-425256f42ba9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16e7c187-6a6e-42c0-b735-c8ff9f0027bc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "480e6177-8e96-4b67-9934-76dca87dc4a6", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f7c3643-6f5b-4600-9865-46725c71c959", "name": "endoflife.date snapshot status (admin) — dataset age / counters / next beat", "request": { "name": "endoflife.date snapshot status (admin) — dataset age / counters / next beat", "description": {}, "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "84955e13-76cb-463d-9e0c-2b34c0c583fa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"enabled\": false,\n \"refresh_enabled\": true,\n \"cleared\": 557,\n \"duration_ms\": 8188,\n \"eol_flagged_total\": 5605,\n \"feed_host\": \"string\",\n \"last_attempt_at\": \"1966-10-25T13:01:25.047Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1968-11-06T12:41:13.899Z\",\n \"next_refresh_at\": \"1976-10-22T14:02:55.262Z\",\n \"product_count\": 0,\n \"rule_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"1999-05-27\",\n \"snapshot_origin\": \"feed\",\n \"stamped\": 3024\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d5741cd-5a58-4819-870f-d24cfbe2d9ed", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b81c4c9-dc74-4946-b3ff-9424ebebebb9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cdbfb5c-f8ad-4526-8200-52e4d5d0d6a4", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "eol", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44f4cd1c-cad6-404b-bd62-2b3772a71888", "name": "System health summary (admin) — postgres / redis / celery / DT / disk", "request": { "name": "System health summary (admin) — postgres / redis / celery / DT / disk", "description": {}, "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "37cef2d7-a509-4a11-bf8d-4422fcee4911", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"components\": [\n {\n \"name\": \"redis\",\n \"status\": \"ok\",\n \"detail\": \"string\",\n \"detail_code\": \"string\",\n \"detail_params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"value\": 7642.288577601502\n },\n {\n \"name\": \"active_scans\",\n \"status\": \"degraded\",\n \"detail\": \"string\",\n \"detail_code\": \"string\",\n \"detail_params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"value\": 5855.716772979374\n }\n ],\n \"updated_at\": \"1951-07-27T15:45:06.299Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aaa6ec0-2109-4989-9aff-d89a98b2ee0f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "345fcf1b-b8b5-4320-b5fc-dde58b797075", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a97b0c7a-1575-483e-8614-8065601f55c3", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31408b15-49cc-4a8a-922a-89f31279821b", "name": "System health summary (admin) — postgres / redis / celery / DT / disk", "request": { "name": "System health summary (admin) — postgres / redis / celery / DT / disk", "description": {}, "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a221d860-b423-4a3e-aeb3-67d3d3dc2d9e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"components\": [\n {\n \"name\": \"postgres\",\n \"status\": \"down\",\n \"detail\": \"string\",\n \"detail_code\": \"string\",\n \"detail_params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"value\": 336.8978877751339\n },\n {\n \"name\": \"celery\",\n \"status\": \"down\",\n \"detail\": \"string\",\n \"detail_code\": \"string\",\n \"detail_params\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n }\n },\n \"value\": 6965.070372391227\n }\n ],\n \"updated_at\": \"2024-08-18T07:38:15.360Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2a7fa8-041e-4b1d-a242-66b9f9fd17ac", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea4567dc-36b7-4d9c-b8fe-e8003051e2e2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "405ee293-f486-4c32-ba9f-1303ef8e22f1", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "781cf1ee-f74e-4ad8-9a15-559e04dbd198", "name": "CISA KEV feed sync status (admin) — last sync / counters / next beat", "request": { "name": "CISA KEV feed sync status (admin) — last sync / counters / next beat", "description": {}, "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "551a58b2-7032-4162-9949-9e24de50f0df", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"enabled\": true,\n \"delisted\": 2008,\n \"duration_ms\": 1815,\n \"feed_count\": 304,\n \"feed_host\": \"string\",\n \"kev_flagged_total\": 3848,\n \"last_attempt_at\": \"2017-08-10T20:19:06.749Z\",\n \"last_result\": \"skipped\",\n \"last_synced_at\": \"2013-11-04T04:27:16.507Z\",\n \"listed\": 3534,\n \"next_refresh_at\": \"1986-06-29T16:45:17.932Z\",\n \"skipped_reason\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0c80c52-e9b7-49eb-9307-3e85d58360f8", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac68dc9-65ae-4154-92f0-5c2fa0f1882f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5cc07b4-6fd6-45eb-9710-98bd65f42ddb", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1556ac6-4ff2-45f3-a85b-a751794b88dc", "name": "CISA KEV feed sync status (admin) — last sync / counters / next beat", "request": { "name": "CISA KEV feed sync status (admin) — last sync / counters / next beat", "description": {}, "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "751f275e-988f-44b1-886a-3f12e250d35a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"enabled\": true,\n \"delisted\": 2008,\n \"duration_ms\": 1815,\n \"feed_count\": 304,\n \"feed_host\": \"string\",\n \"kev_flagged_total\": 3848,\n \"last_attempt_at\": \"2017-08-10T20:19:06.749Z\",\n \"last_result\": \"skipped\",\n \"last_synced_at\": \"2013-11-04T04:27:16.507Z\",\n \"listed\": 3534,\n \"next_refresh_at\": \"1986-06-29T16:45:17.932Z\",\n \"skipped_reason\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82defc98-933d-4c2e-909e-3861573973bf", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2252fa39-eb5b-4655-b463-ee227ef6ee8f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59f46bad-e0f5-4d02-a4ce-997ad5c93335", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "kev", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a35c9358-bb04-4c2f-b731-881ecd678c70", "name": "Malicious-package snapshot status (admin) — age / counters / next beat", "request": { "name": "Malicious-package snapshot status (admin) — age / counters / next beat", "description": {}, "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f557f04-3412-4b41-94d3-e918addbcf1b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"enabled\": true,\n \"refresh_enabled\": true,\n \"ecosystems\": [\n \"string\",\n \"string\"\n ],\n \"flagged_total\": 362,\n \"last_attempt_at\": \"1996-09-14T09:02:13.250Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1989-01-03T15:40:14.921Z\",\n \"newly_flagged\": 8314,\n \"next_refresh_at\": \"1970-07-24T02:49:02.534Z\",\n \"purl_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"1980-04-03\",\n \"snapshot_stale\": false,\n \"stamped\": 5788\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc124e3b-f879-42a2-8aea-0883d1c6955d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d8c5925-4297-4cc0-8102-d19a1ed7b86b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eee7f901-9c51-44cc-8604-f99fac47c495", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1cfa1411-e523-4f64-89ce-005fdcb12ad0", "name": "Malicious-package snapshot status (admin) — age / counters / next beat", "request": { "name": "Malicious-package snapshot status (admin) — age / counters / next beat", "description": {}, "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ac61f5a7-5be8-41f7-b07c-c508c9a7528e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"enabled\": false,\n \"refresh_enabled\": false,\n \"ecosystems\": [\n \"string\",\n \"string\"\n ],\n \"flagged_total\": 2565,\n \"last_attempt_at\": \"1986-07-24T03:13:07.249Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1981-03-26T13:50:50.492Z\",\n \"newly_flagged\": 2408,\n \"next_refresh_at\": \"1993-12-06T21:30:52.739Z\",\n \"purl_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"2016-12-24\",\n \"snapshot_stale\": false,\n \"stamped\": 8900\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec53dd4b-cda3-4f13-b989-67ca6a435b71", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cad65d82-b740-45b0-8315-7a41ea62efd0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0221179-cf16-4988-85f1-2b4331fa1aac", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "malicious", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f4a2b2f-29b0-4d32-9854-6f3b0085015c", "name": "List organizations (admin), paginated", "request": { "name": "List organizations (admin), paginated", "description": {}, "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fa7aa1d7-47a6-445b-96d3-1f7d2030bab9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"161292af-e446-1e19-3045-298e1cff35f9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": false,\n \"created_at\": \"1949-07-12T03:53:49.052Z\",\n \"team_count\": 0\n },\n {\n \"id\": \"48eeb4a7-cbaf-3894-9ebe-284441cfd1fe\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": false,\n \"created_at\": \"2004-08-22T10:55:20.028Z\",\n \"team_count\": 0\n }\n ],\n \"total\": 3167,\n \"page\": 5026,\n \"page_size\": 467\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e4d5fd5-7e29-418b-ad49-a45ce38ac12e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df94b90f-5836-41bb-b321-c12433d93f84", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f1a9012-da6e-4585-a7d7-d9bf0297cb67", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5617f9f0-ea94-4b49-b44c-04e140c57f94", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aea9eec-dad7-49f6-a925-62e636fb97db", "name": "List organizations (admin), paginated", "request": { "name": "List organizations (admin), paginated", "description": {}, "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0e2293bd-d733-4b3e-a36b-72fafa7d1b0f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"76725e28-4b8b-a77e-4618-7a23d9003d08\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": true,\n \"created_at\": \"1966-01-28T05:41:57.645Z\",\n \"team_count\": 0\n },\n {\n \"id\": \"884740b9-cd62-3f53-4176-ef17a9378c7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": true,\n \"created_at\": \"1994-06-24T18:36:42.353Z\",\n \"team_count\": 0\n }\n ],\n \"total\": 3314,\n \"page\": 2970,\n \"page_size\": 7923\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5b2e231-94cf-4035-a5b7-baa8c907dee1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27f84218-cd39-4cf9-b347-3273c1d63c49", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "021990f7-e710-494e-a523-0472bc238f8e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43b6e51f-d0ed-483b-a969-c305dd38a693", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d23f4673-1fe4-441b-9961-f189626a0d00", "name": "List an organization's registry logins (admin), never the passwords", "request": { "name": "List an organization's registry logins (admin), never the passwords", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c6b539ef-5178-418e-8e33-4fc600aa1e92", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"1012dc8d-6f2d-d4dc-8ad8-788895e1148c\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": true\n },\n {\n \"id\": \"eda81d52-6311-e577-7c21-f0f28a1810ec\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7703369-bd98-41e1-8694-3801a2b0b137", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c20bb21-08fa-4ce1-9f4b-3c98848a9469", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78c087b3-4d86-4c19-b027-baa9e337c482", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86b4e3a-77f7-4de6-ac8d-3a2192c836a3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30ebf903-f033-4af8-8184-3027d22e16a8", "name": "List an organization's registry logins (admin), never the passwords", "request": { "name": "List an organization's registry logins (admin), never the passwords", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b628029d-3cfb-4df5-a1db-f0da03e368c5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"f38c6d1e-c6a6-add0-f6d4-f313a4e1082c\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": false\n },\n {\n \"id\": \"667fb897-eb4a-73b7-a43d-4549e9f66d91\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "badc9189-654c-4cec-a41e-7934abc9771d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56ad3116-a503-4254-8700-088c750cc6e6", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b25b7a2a-9e5a-4e9e-9817-8ff420b1f7e9", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae53b746-5343-447e-ae1f-12595aa1dd1c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb9eb02f-f07a-4f24-8b40-85448fe2adf6", "name": "Create or replace an organization's login for one registry (admin)", "request": { "name": "Create or replace an organization's login for one registry (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6dce0d4b-9412-4ac3-83e2-27bfec51aaca", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2b8a617c-e8d5-9bfe-5d29-b43a2468049d\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f903febf-3ced-4b8e-ad18-271f72a3bd01", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "779e0911-9881-4d4d-ab1d-885cfe50d734", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "781c84e9-4ef1-48a3-87a5-7ccdcab1e7fd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41da8272-ea5f-4550-85fe-32e541837b2d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44be3d7a-a2eb-452e-850f-b66113418199", "name": "Create or replace an organization's login for one registry (admin)", "request": { "name": "Create or replace an organization's login for one registry (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1eb4b7f4-f579-44f5-96c0-5f4add623dd8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2b8a617c-e8d5-9bfe-5d29-b43a2468049d\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5309f014-dcbb-49aa-904d-22db598a57f2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9edb06f1-4b0a-443b-8814-d5e60db19d64", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b55bc5-d53e-40bb-b5d0-7609aac35100", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26247b2c-709a-4899-9893-cdd9380d6749", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d926b17c-8552-4961-b9e4-67534ba3f93d", "name": "Remove an organization's login for one registry (admin)", "request": { "name": "Remove an organization's login for one registry (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "79ca9895-30ec-4cc9-8944-f3732216b511", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8233ee9e-ad4a-4373-ad01-c94578e1bc47", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d743608-ac3b-4507-8161-8b39c1d63e0c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "275ba647-729b-4851-93d9-669130022fa1", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02cdbb17-efdc-40be-bcf9-40fac339a31c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14559708-ed85-4142-b98a-6dd75739eb90", "name": "Remove an organization's login for one registry (admin)", "request": { "name": "Remove an organization's login for one registry (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "251e4d75-3a45-49a3-bdef-7f3a4c1a192b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8832fa85-5c81-4611-9599-7717bc009efc", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7c83183-4726-42ca-91eb-f922fb5ce309", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "003f7179-0717-4fc2-aa00-ea7a284eef59", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59a57def-7b27-4414-824f-490689d62002", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64808c19-a8c5-423c-8be1-2e3b766d6d0a", "name": "List an organization's ticket-tracker logins (admin), never the tokens", "request": { "name": "List an organization's ticket-tracker logins (admin), never the tokens", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "58b59a33-000d-4d67-b853-755895e77a2a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"98830250-a6b6-3994-96bd-ed74200391f6\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n },\n {\n \"id\": \"6bc089fe-0b64-af87-1b28-fa91d01505c6\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a751e76-ec8b-49ef-b196-8b40ef21a25c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc84f32-aabf-4fec-ac0f-c174928f906d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b67bc61d-99ce-4444-8f1d-babb993663db", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86926a8b-43c1-4f88-b1d5-25890fea402a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59276bb9-9db0-475c-a859-d0d74cfdce6b", "name": "List an organization's ticket-tracker logins (admin), never the tokens", "request": { "name": "List an organization's ticket-tracker logins (admin), never the tokens", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "312472b4-9790-424c-a542-521280c62c9a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"fb653dfa-1d6e-24a8-aef1-1d5df7b4eae2\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n },\n {\n \"id\": \"fa7281f1-7506-8945-d876-32246771d408\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e9faf17-e2bb-4c9f-9833-409fc10ef5ad", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d53093d-ba87-4ff3-8468-96bf53bab66b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60492207-91d6-42b2-bf1d-6e3dff7a8eaf", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "244499fe-d888-4d03-838c-39473d372c12", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b76c61c-d2ba-4cf3-9bdf-0e943aee019f", "name": "Create or replace an organization's login for one ticket tracker (admin)", "request": { "name": "Create or replace an organization's login for one ticket tracker (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4c662892-9d69-489d-9fd2-81110306141e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1bbe2ae2-c3c7-dc30-9389-b199fbfeae8b\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c197d053-d6c5-43a4-b9c9-30aa3d8cea2e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92a69544-be80-4b38-888a-4460f37c62b1", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7685377-8fdc-464c-8e4e-68d28b649f02", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fab02d1-884c-4f8e-b6b5-51d97725c0c0", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af16e504-20ba-400f-a64a-1a7d24ccba5a", "name": "Create or replace an organization's login for one ticket tracker (admin)", "request": { "name": "Create or replace an organization's login for one ticket tracker (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "80ed1cd7-5f7f-488e-8f09-6aa0906d5752", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1bbe2ae2-c3c7-dc30-9389-b199fbfeae8b\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbfc9851-99d4-4ff6-a23a-00182a4dfc4f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36b3bb21-65e0-4bbd-9328-b5f4e691e0b0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c33f605b-7520-49b8-beda-0a7a5ab62b5f", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b06277-9c4d-4d2c-b85d-fb908103e163", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"host\": \"string\",\n \"api_token\": \"string\",\n \"auth_scheme\": \"jira_basic\",\n \"username\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d4e7ffa-ba2f-42ef-a7ca-a1aeff204ac4", "name": "Remove an organization's login for one ticket tracker (admin)", "request": { "name": "Remove an organization's login for one ticket tracker (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "df5c630f-3448-42ce-9659-cde721d0d885", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "02e85c0b-2cd8-4606-82ac-4d58274b537c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9895f5ac-611d-48bd-a358-8d9717d1ca33", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0167c3a-5d33-4898-9975-733080edcc67", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d4a0d38-16aa-4872-8d4b-4f2631e80ebc", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12e8d0ad-b453-4edf-a658-a583e6942329", "name": "Remove an organization's login for one ticket tracker (admin)", "request": { "name": "Remove an organization's login for one ticket tracker (admin)", "description": {}, "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "31e89432-39eb-456a-b684-3c343bb7c57a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36203bdc-e486-4255-a223-eee01aba1e59", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70eb90ea-b7cf-47fa-ac7b-18853b446a68", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdd98bb2-587a-4e8a-8b83-8fc4b7ca4dc5", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc2b9ff3-ac2e-4b30-9d84-9ba049054cbe", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee98c6b1-9900-4c5f-9b71-0409aaf69414", "name": "List scans (admin) — cross-team queue with optional status/kind/project filters", "request": { "name": "List scans (admin) — cross-team queue with optional status/kind/project filters", "description": {}, "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "status", "value": "running" }, { "disabled": false, "key": "kind", "value": "sbom" }, { "disabled": false, "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f8a2b424-a1a1-415d-9882-e8eca8d7e947", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"1984970a-651e-1a37-09c3-d9b99c3734ca\",\n \"project_id\": \"e0d5fae4-9c13-2a24-c13e-70eca9d20cf4\",\n \"project_name\": \"string\",\n \"team_id\": \"93a2ecff-c64a-374e-437c-92fc0fae65f0\",\n \"team_name\": \"string\",\n \"status\": \"succeeded\",\n \"kind\": \"string\",\n \"created_at\": \"2016-10-14T18:47:22.622Z\",\n \"duration_seconds\": 2858.3632296475894,\n \"error_message\": \"string\",\n \"finished_at\": \"2001-12-22T22:38:00.467Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"98e65634-8be2-c259-a85d-b1a329638dc6\",\n \"started_at\": \"2003-04-18T23:03:12.720Z\"\n },\n {\n \"id\": \"8b13d2db-3a8b-fa3b-0637-158d3393f338\",\n \"project_id\": \"bc010a01-48cc-e971-9466-7546b3db77b2\",\n \"project_name\": \"string\",\n \"team_id\": \"a02ccbdb-c259-dda3-84a9-8a07281e16f7\",\n \"team_name\": \"string\",\n \"status\": \"queued\",\n \"kind\": \"string\",\n \"created_at\": \"1951-12-30T05:26:13.012Z\",\n \"duration_seconds\": 2273.522393250138,\n \"error_message\": \"string\",\n \"finished_at\": \"1965-02-22T14:24:28.967Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"1e434837-2f9b-51ab-2f96-5c73356ae77a\",\n \"started_at\": \"1991-07-29T11:27:45.034Z\"\n }\n ],\n \"total\": 3377,\n \"page\": 8947,\n \"page_size\": 123\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8763b155-6892-4374-8e82-bfc3a457e929", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70693286-1c25-4412-b982-b6cc64976673", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28012d4f-afcb-48f5-bd0c-ec175ecb63b3", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "882b649f-c9b2-4bff-bfb8-0c5a194de38e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3313abb5-7571-4118-8a38-c82751fe5052", "name": "List scans (admin) — cross-team queue with optional status/kind/project filters", "request": { "name": "List scans (admin) — cross-team queue with optional status/kind/project filters", "description": {}, "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "status", "value": "running" }, { "disabled": false, "key": "kind", "value": "sbom" }, { "disabled": false, "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c269ec0d-ff96-4f4b-86d4-44b1ac91e3d3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"2e9cede8-a5ab-2242-3a71-8eb9338e16be\",\n \"project_id\": \"94a731fd-befd-9c2f-bd33-c4cdbbae773f\",\n \"project_name\": \"string\",\n \"team_id\": \"78ee6ff0-f003-47c9-cbff-eae617679a9e\",\n \"team_name\": \"string\",\n \"status\": \"cancelled\",\n \"kind\": \"string\",\n \"created_at\": \"2018-10-19T22:10:44.282Z\",\n \"duration_seconds\": 8803.022211760383,\n \"error_message\": \"string\",\n \"finished_at\": \"1992-05-23T21:45:38.733Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"668f2a16-ea5d-67bf-6701-7d59f22d723a\",\n \"started_at\": \"1997-02-06T12:58:14.549Z\"\n },\n {\n \"id\": \"e114668f-524a-3a6f-b15a-2b2bd309374a\",\n \"project_id\": \"6d457b1e-3eee-ffbd-b6be-12b7889cace0\",\n \"project_name\": \"string\",\n \"team_id\": \"23051e0a-cecc-f252-6946-dfd62084f340\",\n \"team_name\": \"string\",\n \"status\": \"cancelled\",\n \"kind\": \"string\",\n \"created_at\": \"2000-09-27T10:12:17.545Z\",\n \"duration_seconds\": 7594.9429677909275,\n \"error_message\": \"string\",\n \"finished_at\": \"1981-08-03T04:06:01.289Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"cd52acf0-9ae7-a000-27f8-c621a3fdd63d\",\n \"started_at\": \"1948-03-18T20:19:20.584Z\"\n }\n ],\n \"total\": 702,\n \"page\": 5426,\n \"page_size\": 7811\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78b32ed1-4532-43ba-b085-a144f32b2997", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8c68b1e-a513-40e5-bcca-230335a2529b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cda31107-d4eb-4208-addc-a84c24068ffe", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df6e705f-2d96-4903-a55b-e2be387b84cb", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "running" }, { "key": "kind", "value": "sbom" }, { "key": "project", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dafe379-59bf-45f5-8e67-111fe90f6b40", "name": "Force-cancel a scan (admin) — Celery revoke + status='cancelled'", "request": { "name": "Force-cancel a scan (admin) — Celery revoke + status='cancelled'", "description": {}, "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d1305b54-b040-4f06-a7c1-73063aa10345", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68401a32-2ebc-4d1c-9321-e8546a16818e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fdb3774-19c4-4a3d-87b6-7e8844ec55d0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f97f239e-92ff-4995-b23c-65fa684a03a0", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bd1b91e-7a78-48c8-8aab-e2d18bc1f022", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f45b890b-52fd-4409-9920-c92563273b00", "name": "Force-cancel a scan (admin) — Celery revoke + status='cancelled'", "request": { "name": "Force-cancel a scan (admin) — Celery revoke + status='cancelled'", "description": {}, "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ea8aedab-4630-41be-8180-931f94b435d7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b18a2d9-f95b-4daa-9f5b-36da3ab16e17", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a06159-ad06-4d00-9bcc-b0f965c7e036", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65cbbeb-a51f-4d89-a4b1-b81d97a91e7f", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "201c1d5e-11fd-443e-bb5d-03011cdbc0e3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb4d70fd-3f82-4d3d-8fb2-10910c7a517d", "name": "List teams (admin) — paginated, name search", "request": { "name": "List teams (admin) — paginated, name search", "description": {}, "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b41eb097-0a21-439d-80e3-3008bc5f7ab0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"c219b637-f7a2-c932-32ca-93d0391864ac\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"46743d3e-19e8-2a80-b4c9-95b05012c469\",\n \"created_at\": \"2016-02-01T09:06:50.405Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"6e06e92f-3e00-f604-8122-274e15e1c40e\",\n \"project_count\": 0\n },\n {\n \"id\": \"06880be8-fe8a-647e-6551-96d3aceb161f\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"6416b206-8088-92a0-3194-ea8454ed3047\",\n \"created_at\": \"2016-05-07T19:14:37.341Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"c2198f19-8cb1-48d4-3e04-ee340af7b503\",\n \"project_count\": 0\n }\n ],\n \"total\": 5786,\n \"page\": 5711,\n \"page_size\": 7638\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3c382af-ca6b-4e4f-b0ce-86f147d0d914", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b57d679d-2235-4f47-a1f2-322657e6a5d0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47052092-8718-4fef-b45d-0c817b5cb19a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4683bbf6-ab31-41be-bb7d-d160829e5230", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9cc9d8b-8fad-4b7c-bddc-1ef56a35e07c", "name": "List teams (admin) — paginated, name search", "request": { "name": "List teams (admin) — paginated, name search", "description": {}, "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "936d9f41-d815-41f4-951c-9c71ed4c8a8e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"5ea3075c-8848-39a7-49ad-7b45cda02d55\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"e8022c5a-424d-3f3e-2cb4-a56e538521bd\",\n \"created_at\": \"1975-12-23T09:57:08.142Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"f8e887a6-afc2-6276-c985-879de19ced73\",\n \"project_count\": 0\n },\n {\n \"id\": \"cf26be1c-60fa-0f4c-fd6d-f0607c33e617\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"025b4248-4e92-20e3-43dc-fbe3444b3205\",\n \"created_at\": \"1988-06-07T06:06:28.352Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"9b8d1368-b265-c031-52a0-d2de939b6d85\",\n \"project_count\": 0\n }\n ],\n \"total\": 7453,\n \"page\": 2240,\n \"page_size\": 6268\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43723f89-bfa9-4e4c-a35f-70cfcc397a12", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08248f1b-37de-4aea-88ca-e62347a75490", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edc0066b-84ba-4caf-9686-12ec6f33a408", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12fd71f9-f1b2-45cf-abb6-2dfd42f51c66", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83db4998-3dc4-4551-a987-1496e2ce2696", "name": "Create a team (admin)", "request": { "name": "Create a team (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ebfe8211-7cb3-4c57-92af-014e59961a42", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f366d37d-907c-a8bb-3449-1085931adbd9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"53c7796f-12b7-488e-c8dd-890dbb178ec4\",\n \"created_at\": \"1953-03-23T07:22:27.228Z\",\n \"updated_at\": \"1951-06-15T06:14:07.496Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"cc731b29-3a10-4ec0-de92-37ef300d877a\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"9938a234-7b27-d0bc-94af-171b4b294301\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"bc2154d9-b606-2b63-e8e0-8bca279ca85c\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cba0647-772d-4d33-894b-ef9d00464aef", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c936959b-c5d0-46b1-9e39-758bd5698304", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c594387-da34-447f-a1a9-594f1e837fb4", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b60caca9-2ecc-4cf8-9bd4-c0b45bfb4832", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2cb83a2-be5d-4b10-930b-490b4f40d731", "name": "Create a team (admin)", "request": { "name": "Create a team (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "48d8bf55-df04-476a-be12-a193602b763a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2e06119b-f743-f706-52e2-d6a1dc9c04d0\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"3c0f2e3e-9066-af56-f9e8-2a65f284206a\",\n \"created_at\": \"2014-11-30T12:38:50.493Z\",\n \"updated_at\": \"1981-11-25T08:55:00.473Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"53256616-3a33-feea-fb57-b28e8e99e0c7\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"ccb3c01f-8f79-db95-1ccc-d28f3ed47753\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"76aea900-d45f-44b8-962e-363c8f16505f\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57eea3c4-e6d2-4767-9fec-33b1f14fb564", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2878ff5b-c718-453c-abbf-974a3c730fed", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da7629e-34d7-4550-a6fa-b7d25a399f5e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1229206-4ada-407d-ae9c-dfc20f18ef4a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"organization_id\": \"1a7a5a38-f88f-5f5e-7513-440cb66e40e9\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "affecdd2-76b9-49d0-b3da-729e8d3ad8ef", "name": "Move a group (and its subtree) under a new parent, or to root (admin)", "request": { "name": "Move a group (and its subtree) under a new parent, or to root (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d249fa6-800f-4872-b60c-8e2694e44adc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f366d37d-907c-a8bb-3449-1085931adbd9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"53c7796f-12b7-488e-c8dd-890dbb178ec4\",\n \"created_at\": \"1953-03-23T07:22:27.228Z\",\n \"updated_at\": \"1951-06-15T06:14:07.496Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"cc731b29-3a10-4ec0-de92-37ef300d877a\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"9938a234-7b27-d0bc-94af-171b4b294301\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"bc2154d9-b606-2b63-e8e0-8bca279ca85c\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af1dea17-9ec1-48b0-88a7-32871a59f1b5", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7538985-e2c9-4d71-9e9e-1738ce1f07c0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cd9605f-8793-4921-9a52-1c223d1a7bb6", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a994b286-5fc5-4d78-9907-8f2136d27b00", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ab4cac9-0958-47aa-8410-ed1bffa99938", "name": "Move a group (and its subtree) under a new parent, or to root (admin)", "request": { "name": "Move a group (and its subtree) under a new parent, or to root (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cf020bc7-cdc9-4664-b7db-ebbe1475c33e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2e06119b-f743-f706-52e2-d6a1dc9c04d0\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"3c0f2e3e-9066-af56-f9e8-2a65f284206a\",\n \"created_at\": \"2014-11-30T12:38:50.493Z\",\n \"updated_at\": \"1981-11-25T08:55:00.473Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"53256616-3a33-feea-fb57-b28e8e99e0c7\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"ccb3c01f-8f79-db95-1ccc-d28f3ed47753\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"76aea900-d45f-44b8-962e-363c8f16505f\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c902c68-0495-4b4e-a81a-0db6ee9a334a", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c280bbf-2d92-4d57-be41-6733fa81ed32", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c470c902-6337-4f88-ac44-da0a13c68976", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c293ca02-eaa8-4999-97e7-7c9e20f33710", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"18829178-1e01-8f97-4882-33e2bc0d3da4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0bb89c7b-9cf5-441c-b6dc-24d8446f2be2", "name": "Create a group nested directly under parent_group_id (admin)", "request": { "name": "Create a group nested directly under parent_group_id (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3adea6c9-91a3-4747-a04e-1038886faf59", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f366d37d-907c-a8bb-3449-1085931adbd9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"53c7796f-12b7-488e-c8dd-890dbb178ec4\",\n \"created_at\": \"1953-03-23T07:22:27.228Z\",\n \"updated_at\": \"1951-06-15T06:14:07.496Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"cc731b29-3a10-4ec0-de92-37ef300d877a\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"9938a234-7b27-d0bc-94af-171b4b294301\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"bc2154d9-b606-2b63-e8e0-8bca279ca85c\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f447deb9-2c09-46a1-ba49-b398e99226c2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1dc8064-6885-48e1-93ca-9cae3145b75c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3ffca7e-5b81-42fb-94cf-1e85e7348f1b", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "083d7f21-dced-484d-84d1-6be2d52de5a3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06ecd485-2e72-4632-a894-2fdc4fbabe9d", "name": "Create a group nested directly under parent_group_id (admin)", "request": { "name": "Create a group nested directly under parent_group_id (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ac04aa84-e17d-42e7-902c-a6ef6370d4a6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2e06119b-f743-f706-52e2-d6a1dc9c04d0\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"3c0f2e3e-9066-af56-f9e8-2a65f284206a\",\n \"created_at\": \"2014-11-30T12:38:50.493Z\",\n \"updated_at\": \"1981-11-25T08:55:00.473Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"53256616-3a33-feea-fb57-b28e8e99e0c7\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"ccb3c01f-8f79-db95-1ccc-d28f3ed47753\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"76aea900-d45f-44b8-962e-363c8f16505f\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2a8a6b3-5636-4319-8340-9f78f4622bdf", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5e88db2-dcf4-42a2-8dfd-c2d91c4d1c1b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c5cd748-ffa1-43b0-9553-cbff759e8605", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "981e0a07-2fb3-43d4-9046-83b392e1dd38", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a51c507e-410f-af98-9cbb-299ce7f120d4", "key": "parent_group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d618b1b-b9b0-438f-ba6f-bd194b1d8d2d", "name": "Delete a team (admin) — archives projects, refuses on active scans", "request": { "name": "Delete a team (admin) — archives projects, refuses on active scans", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d3912048-5a17-464c-b49b-b2a6923b85af", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ebe1ca6a-1acf-494b-92d7-d88fa763846b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bad7cc1c-3b2f-461c-99f1-fe7b4e8d6654", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "406f3884-c12c-4f39-80a5-b325306bf303", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "951e7783-64a6-46ba-83e1-a0875c8e3879", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5cf6a23-01c5-4715-abf1-9da10e70e28a", "name": "Delete a team (admin) — archives projects, refuses on active scans", "request": { "name": "Delete a team (admin) — archives projects, refuses on active scans", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "40c3275f-b59f-4859-afcb-e03b407511d5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0d31fd0-5105-45d5-ac88-207e349c0a94", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13573fb7-9a75-4cd4-8647-1249f6e1c4db", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a9401fc-815e-4674-8683-aeec7cdf26d8", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c25276d-0ddf-4ea5-88c5-d07fec89a820", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fef49e4f-d0c5-4f39-8a75-49ee3fc6f2b5", "name": "Get one team (admin) — detail with members and project count", "request": { "name": "Get one team (admin) — detail with members and project count", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c1d21196-0f20-4782-95d5-7b04a4122c7f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f366d37d-907c-a8bb-3449-1085931adbd9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"53c7796f-12b7-488e-c8dd-890dbb178ec4\",\n \"created_at\": \"1953-03-23T07:22:27.228Z\",\n \"updated_at\": \"1951-06-15T06:14:07.496Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"cc731b29-3a10-4ec0-de92-37ef300d877a\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"9938a234-7b27-d0bc-94af-171b4b294301\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"bc2154d9-b606-2b63-e8e0-8bca279ca85c\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca0af8ac-3f3b-4378-a4a7-39e2de50a6b0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf982b65-aa2d-4b24-ae61-db0805c09cb1", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d2cd68-1c61-4bf0-9bd4-060786fd7ad7", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20cff2d6-c7f5-4633-8688-c7df5c3cc7df", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eaf0f031-f30e-46c1-91a4-7e32e000ae0e", "name": "Get one team (admin) — detail with members and project count", "request": { "name": "Get one team (admin) — detail with members and project count", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f8a06ca-d8d4-4e07-818c-3847678ac429", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2e06119b-f743-f706-52e2-d6a1dc9c04d0\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"3c0f2e3e-9066-af56-f9e8-2a65f284206a\",\n \"created_at\": \"2014-11-30T12:38:50.493Z\",\n \"updated_at\": \"1981-11-25T08:55:00.473Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"53256616-3a33-feea-fb57-b28e8e99e0c7\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"ccb3c01f-8f79-db95-1ccc-d28f3ed47753\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"76aea900-d45f-44b8-962e-363c8f16505f\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59130b21-df74-488a-8e1c-ad48bc5a52fe", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a9b7df-3cfc-48c0-b203-d158c6c2c5aa", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27f8cd9b-320b-43b4-b3d4-2a92d2e4958f", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bb2fda3-d145-4d53-903c-0c9cb8c13e40", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8f1a181-9685-4721-b922-21bedf505607", "name": "Update a team (admin)", "request": { "name": "Update a team (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6e6d02b-baf3-48b7-b304-9eb564a6522b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f366d37d-907c-a8bb-3449-1085931adbd9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"53c7796f-12b7-488e-c8dd-890dbb178ec4\",\n \"created_at\": \"1953-03-23T07:22:27.228Z\",\n \"updated_at\": \"1951-06-15T06:14:07.496Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"cc731b29-3a10-4ec0-de92-37ef300d877a\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"9938a234-7b27-d0bc-94af-171b4b294301\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"bc2154d9-b606-2b63-e8e0-8bca279ca85c\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abe41e04-9ea5-49a7-8830-6f08cea5dfd7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ba3f758-ddb8-4dee-8b8c-3d9b81d713c9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a819070-7792-46cc-8aa5-a7f76642df43", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5eab9929-52cd-4f8c-bc5a-9edfde2e8ec7", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8208076c-6508-4ffe-a28f-2c5bea621a2e", "name": "Update a team (admin)", "request": { "name": "Update a team (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e3760918-d5b8-48b0-acc4-9143ef700d45", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2e06119b-f743-f706-52e2-d6a1dc9c04d0\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"3c0f2e3e-9066-af56-f9e8-2a65f284206a\",\n \"created_at\": \"2014-11-30T12:38:50.493Z\",\n \"updated_at\": \"1981-11-25T08:55:00.473Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"53256616-3a33-feea-fb57-b28e8e99e0c7\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"ccb3c01f-8f79-db95-1ccc-d28f3ed47753\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"76aea900-d45f-44b8-962e-363c8f16505f\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8384a9cf-997f-46e0-8284-d596dd666a61", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a5890d-0ff3-451e-9681-aa927820e0ce", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb128065-817c-4a32-b305-cd79ce35ff7a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9246b604-6584-47d9-abda-853cfb50f337", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee30097b-6282-44e7-89c1-4688ab4be620", "name": "Add (or update) a team member (admin)", "request": { "name": "Add (or update) a team member (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7f56bbed-6e64-4206-8358-f8d44ebb879d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f366d37d-907c-a8bb-3449-1085931adbd9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"53c7796f-12b7-488e-c8dd-890dbb178ec4\",\n \"created_at\": \"1953-03-23T07:22:27.228Z\",\n \"updated_at\": \"1951-06-15T06:14:07.496Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"cc731b29-3a10-4ec0-de92-37ef300d877a\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"9938a234-7b27-d0bc-94af-171b4b294301\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"bc2154d9-b606-2b63-e8e0-8bca279ca85c\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5aaf11a-0ca8-4769-90af-f3b5400da93c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70ac350e-bd25-4cbd-a2b9-10b686498751", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3cf065e-c3fd-466d-9d6e-853c24856c54", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "388cfb99-5bba-4333-ab40-05bff81cbe49", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5254975-5bae-4b42-8af4-4caf1f3937ad", "name": "Add (or update) a team member (admin)", "request": { "name": "Add (or update) a team member (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f8023689-454d-4258-ae94-6861086eb406", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2e06119b-f743-f706-52e2-d6a1dc9c04d0\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"3c0f2e3e-9066-af56-f9e8-2a65f284206a\",\n \"created_at\": \"2014-11-30T12:38:50.493Z\",\n \"updated_at\": \"1981-11-25T08:55:00.473Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"53256616-3a33-feea-fb57-b28e8e99e0c7\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"ccb3c01f-8f79-db95-1ccc-d28f3ed47753\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"76aea900-d45f-44b8-962e-363c8f16505f\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e46b590-45c6-4c70-8189-964cf3166e62", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d3bae79-2f5f-4bb3-b9a3-2bc0b6d7a47c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d8085a5-d61f-4d88-a3b7-e4b8bf9d353b", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3131dd-5188-419d-94ae-9fc6b15e28c4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"855140ce-f044-e636-e8de-272adfb3190f\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "741dbde6-3fb0-43fe-920d-10852744292e", "name": "Remove a team member (admin)", "request": { "name": "Remove a team member (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6898f5b9-0460-4775-813e-c5e4b9770468", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f366d37d-907c-a8bb-3449-1085931adbd9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"53c7796f-12b7-488e-c8dd-890dbb178ec4\",\n \"created_at\": \"1953-03-23T07:22:27.228Z\",\n \"updated_at\": \"1951-06-15T06:14:07.496Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"cc731b29-3a10-4ec0-de92-37ef300d877a\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"9938a234-7b27-d0bc-94af-171b4b294301\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"bc2154d9-b606-2b63-e8e0-8bca279ca85c\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a75c9d9-ba79-45a3-8536-4fa3aa0451f9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27cfae1b-40d8-43fd-af2f-4712dcb36048", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3db80288-ff59-4262-8578-bbb5502678e3", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ea13418-818d-41e0-a369-9c955a4e291d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "325112c6-7cbb-412a-9daa-f635c960c91f", "name": "Remove a team member (admin)", "request": { "name": "Remove a team member (admin)", "description": {}, "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b0311558-9ab4-4b68-aeb1-4db9285cf372", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2e06119b-f743-f706-52e2-d6a1dc9c04d0\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"3c0f2e3e-9066-af56-f9e8-2a65f284206a\",\n \"created_at\": \"2014-11-30T12:38:50.493Z\",\n \"updated_at\": \"1981-11-25T08:55:00.473Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"53256616-3a33-feea-fb57-b28e8e99e0c7\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"ccb3c01f-8f79-db95-1ccc-d28f3ed47753\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"76aea900-d45f-44b8-962e-363c8f16505f\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbb729fa-77a7-45d4-88bf-6f18cac51803", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a6a24e7-6430-4513-82b5-474be587f241", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f13ac3ae-140d-482d-b637-0e9954c0d2b1", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86e26051-ad45-4ba8-8425-f40111249084", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "057b28cf-5c66-4f3e-9cde-52206f631941", "name": "Trivy vulnerability DB status (admin) — last_update / freshness / vuln_count", "request": { "name": "Trivy vulnerability DB status (admin) — last_update / freshness / vuln_count", "description": {}, "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2bf607c5-834e-4ab7-b41b-6f1b52ac373d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"refresh_interval_hours\": 6268,\n \"freshness\": \"very_stale\",\n \"cache_dir\": \"string\",\n \"repository\": \"string\",\n \"db_size_bytes\": 6058,\n \"db_version\": \"string\",\n \"last_update\": \"2018-05-17T18:31:04.682Z\",\n \"next_refresh_at\": \"1995-04-23T23:25:49.332Z\",\n \"vuln_count\": 416\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eca26a5-2972-4e9d-9d5e-7abda2edde3e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3095466-c2b6-4eca-b080-a7f99da07f49", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa097abf-a3c0-4e21-a7b0-3b3583003325", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1e8f4a5-a3c1-496d-8f0e-f0ce4a060ef4", "name": "Trivy vulnerability DB status (admin) — last_update / freshness / vuln_count", "request": { "name": "Trivy vulnerability DB status (admin) — last_update / freshness / vuln_count", "description": {}, "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b8020b60-1b52-4ef1-8432-6c0b316c3585", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"refresh_interval_hours\": 6268,\n \"freshness\": \"very_stale\",\n \"cache_dir\": \"string\",\n \"repository\": \"string\",\n \"db_size_bytes\": 6058,\n \"db_version\": \"string\",\n \"last_update\": \"2018-05-17T18:31:04.682Z\",\n \"next_refresh_at\": \"1995-04-23T23:25:49.332Z\",\n \"vuln_count\": 416\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c1c3c9e-5dc2-4d04-a76e-9f55aa322b6d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ed324b8-f4de-4c5a-8ac0-4025fd40069d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fdc98db-4895-4cf7-ac98-53b7419abe5e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "trivy", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e71dd65f-7667-4fd3-8619-e9749a0622da", "name": "List users (admin) — paginated, filterable", "request": { "name": "List users (admin) — paginated, filterable", "description": {}, "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "role", "value": "developer" }, { "disabled": false, "key": "active", "value": "true" }, { "disabled": false, "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f6493ab-3c0d-4999-b04d-a07e4ff145d5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"baea53cf-c848-84d0-1bfb-e9b5362189f0\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"1995-09-28T07:44:44.097Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2012-08-13T16:11:03.019Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n },\n {\n \"id\": \"6f1cd8f3-cacd-64ac-5631-e32f7cd81d6e\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"1982-10-03T18:40:34.805Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2001-04-20T07:25:19.773Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n }\n ],\n \"total\": 6130,\n \"page\": 7945,\n \"page_size\": 3253\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a3cecb-fb25-42fd-83ec-4238e9468609", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6b35001-b3bc-4644-bee0-01fdd49ee997", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e43f331-f5cb-4fc0-b4b5-5b9830b3c7c7", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3915b7cf-1437-47d6-bbfb-f6f207462df9", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b9b3e55-83a9-4aa2-a9b0-9a7517f6096e", "name": "List users (admin) — paginated, filterable", "request": { "name": "List users (admin) — paginated, filterable", "description": {}, "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" }, { "disabled": false, "key": "role", "value": "developer" }, { "disabled": false, "key": "active", "value": "true" }, { "disabled": false, "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6d3c1018-703e-4ac0-9362-2a48343d3a73", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"3c7112c2-841d-a368-d1e8-8cfed56733a7\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1978-02-09T07:19:31.828Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1987-07-15T07:38:32.951Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n },\n {\n \"id\": \"807e8252-9233-af4c-d4e8-f8ca37065b34\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"2011-01-24T00:04:54.869Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2006-02-28T17:26:24.313Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n }\n ],\n \"total\": 2046,\n \"page\": 2903,\n \"page_size\": 2092\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bbe5057-24ed-4379-84c3-84a15ff68279", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0780a8ab-0f50-45ce-9a7c-ce2bfeb853c6", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d624f8be-8b32-47f3-8ce3-0122199323cb", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "035e0c42-12d3-43ac-b8b3-34ba6c6870b9", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "role", "value": "developer" }, { "key": "active", "value": "true" }, { "key": "search", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7af51560-6d06-4756-a3a3-49a794c00d00", "name": "Add one person", "request": { "name": "Add one person", "description": {}, "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "046636b4-104f-40d0-a58c-328b255e2ae6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"40c356f7-bf6e-5e02-89c0-0c4b55198a13\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": false,\n \"created_at\": \"1956-10-25T06:43:21.481Z\",\n \"updated_at\": \"1968-12-21T16:16:35.694Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1999-02-05T04:54:46.761Z\",\n \"memberships\": [\n {\n \"team_id\": \"e259e60c-ebe4-a703-8aa7-c6af59379840\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"4c3a6e9d-aa5c-e3b9-aefd-de0552ac5da0\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe230c8-4aa3-440e-aa9a-9e1b074410b4", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "200afe1d-a0e1-46db-9af5-d3df2203d0bb", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a85e3a69-815b-4aaf-9cc4-92446189e550", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c039a68-3965-432e-9c6e-36c58094c0d2", "name": "That address already has an account.", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1cfda36-10ba-48f8-97ee-74f783e4b941", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa6d3578-a2e6-44c2-bf2f-b8e6785195d7", "name": "Add one person", "request": { "name": "Add one person", "description": {}, "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "176f6264-1683-47d4-9ad8-778fb789afb6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1ccc29f0-bffb-91d6-ddbd-33ffb5b3ef59\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"1979-08-21T11:22:18.287Z\",\n \"updated_at\": \"1963-04-25T14:30:18.167Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1994-12-07T20:27:24.194Z\",\n \"memberships\": [\n {\n \"team_id\": \"3efe3c3c-2959-3545-ec69-c473e8ad0e0d\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"f0a72be8-51aa-d6a4-6296-0eebb6a27a39\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d4d843b-3614-4c78-974e-4c6bcb70f2ba", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c814bbb3-ec61-49ad-a497-ca3e8b69e017", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6515b662-1129-4dbb-ae44-eff9984dd792", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eb51ce2-c18c-45b7-967a-9cd66d32c647", "name": "That address already has an account.", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d85ac5f6-2a01-438b-9cc8-73bbb742e3a3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"vNXjx1Jwi@EvOKnNzQuWC.ccax\",\n \"full_name\": \"string\",\n \"password\": \"stringstri\",\n \"role\": \"group_admin\",\n \"team_id\": \"95c9e8ad-2538-af31-c5af-2fca0cdb675e\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac60b377-4565-43ab-862e-4a7081185cb3", "name": "Add many people, reporting each row", "request": { "name": "Add many people, reporting each row", "description": {}, "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9d60c39a-cbb4-4270-bd6b-e1e5ca51cd18", "name": "Every row is reported, including the ones that worked. 200 even when rows failed: a batch is not all-or-nothing, and a 4xx would say the request was malformed when it was understood exactly.", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 6576,\n \"succeeded\": 6366,\n \"failed\": 4204,\n \"results\": [\n {\n \"index\": 2676,\n \"identifier\": \"string\",\n \"status\": \"deactivated\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"4fc3860c-7cfc-1bc9-e4e3-5b105fc9b461\"\n },\n {\n \"index\": 9429,\n \"identifier\": \"string\",\n \"status\": \"skipped\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"3a85792d-513f-f420-f350-799c02669999\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2be8f0-042b-4e7d-a73f-e8dbac4eb8b1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629d8cd5-b89e-4070-bdcc-5683e1f68b17", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7811a16-91bb-4eb4-856c-6889ce3834fd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a47f9de-b960-437d-87f3-dad2bbfa1586", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e113751-b934-414e-8239-a9e6e8238cee", "name": "Add many people, reporting each row", "request": { "name": "Add many people, reporting each row", "description": {}, "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "990f7975-ebb7-4a2f-a4dd-e8dd5fbfd736", "name": "Every row is reported, including the ones that worked. 200 even when rows failed: a batch is not all-or-nothing, and a 4xx would say the request was malformed when it was understood exactly.", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 3223,\n \"succeeded\": 2698,\n \"failed\": 6250,\n \"results\": [\n {\n \"index\": 9179,\n \"identifier\": \"string\",\n \"status\": \"deactivated\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"5a90ab14-70b1-82a2-361e-548d0d776ffa\"\n },\n {\n \"index\": 6572,\n \"identifier\": \"string\",\n \"status\": \"created\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"f7cf4fac-9a5b-8009-9d85-780537ca9d40\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebd3e547-5f65-47b3-9a3b-92d86b05fe98", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83d0e857-a9b7-4d63-8c58-468e566c3c77", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4daadb47-b1aa-4070-9638-2f231c5e7bc8", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfb3325f-fada-4db0-a56b-08c4dd01cccc", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"email\": \"8lMb@NlvBoxYjvEmxtVQoL.guc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"2ba6b918-2d68-00ed-f6b3-a604890b3735\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bc51ef7-83e5-4010-9217-770065277812", "name": "Deactivate many people, reporting each row", "request": { "name": "Deactivate many people, reporting each row", "description": {}, "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3f6f94b8-e886-4be8-ac9a-fee8110f48ad", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 6576,\n \"succeeded\": 6366,\n \"failed\": 4204,\n \"results\": [\n {\n \"index\": 2676,\n \"identifier\": \"string\",\n \"status\": \"deactivated\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"4fc3860c-7cfc-1bc9-e4e3-5b105fc9b461\"\n },\n {\n \"index\": 9429,\n \"identifier\": \"string\",\n \"status\": \"skipped\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"3a85792d-513f-f420-f350-799c02669999\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cfca1aa-d2db-4b92-881b-88971bfef623", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8336a6c1-59a3-4b94-a485-5435a3757a8a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b201c592-92e3-45d9-b36d-f481f1b7c67c", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61931550-497a-4868-8d7f-fa2345323f0d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fc2b778-eb78-4872-ac0c-aec300c636ad", "name": "Deactivate many people, reporting each row", "request": { "name": "Deactivate many people, reporting each row", "description": {}, "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d50a88a3-c714-4aea-b773-7cbbe39f676d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 3223,\n \"succeeded\": 2698,\n \"failed\": 6250,\n \"results\": [\n {\n \"index\": 9179,\n \"identifier\": \"string\",\n \"status\": \"deactivated\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"5a90ab14-70b1-82a2-361e-548d0d776ffa\"\n },\n {\n \"index\": 6572,\n \"identifier\": \"string\",\n \"status\": \"created\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"f7cf4fac-9a5b-8009-9d85-780537ca9d40\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a81ffe9a-345a-41f2-a088-e4ff4ef9297a", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71e5f989-baa7-4534-addc-4c60c2743d98", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a11dd47-fc0d-4a34-96e7-fd35e2be81d8", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4b41347-f8e7-476e-8777-98291804b708", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "bulk-deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"daf14eb9-614c-6223-0a34-2e5f7bd7caa8\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2b14c3e-8611-4433-a5f0-047aa91b8f95", "name": "The roster as CSV, in the shape the bulk import accepts back", "request": { "name": "The roster as CSV, in the shape the bulk import accepts back", "description": {}, "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ddd1c044-b621-4876-86b0-31047f9aca76", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d51225e-1a5e-460f-97bf-dde389ea77b3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1e242e7-2d3b-45dc-9b45-6ee81537811c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ceb90ea5-d109-43ed-97a8-04efab6a6462", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d937eac2-05f2-4145-b819-27b129b3f013", "name": "More people than one export will build; page the API instead.", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1588b10-25ea-4c9d-b5d8-9be0ce6725cd", "name": "The roster as CSV, in the shape the bulk import accepts back", "request": { "name": "The roster as CSV, in the shape the bulk import accepts back", "description": {}, "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "45d31151-c556-4f0c-ab27-36e30b6e78de", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb0e75a3-5788-41c1-aa60-060c672ae876", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae471690-d3a4-4238-b4ff-bafab01791fe", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61bad989-9abf-4b59-807e-a68cb90d361d", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "506647d1-11f2-4f75-9c39-aeede5f547b0", "name": "More people than one export will build; page the API instead.", "originalRequest": { "url": { "path": [ "v1", "admin", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "356d63cb-39b4-46a4-9c8d-1700abbab60b", "name": "Get one user (admin) — detail with memberships + scan count", "request": { "name": "Get one user (admin) — detail with memberships + scan count", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ff3c9141-b1eb-465e-9767-43bbd820e874", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"40c356f7-bf6e-5e02-89c0-0c4b55198a13\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": false,\n \"created_at\": \"1956-10-25T06:43:21.481Z\",\n \"updated_at\": \"1968-12-21T16:16:35.694Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1999-02-05T04:54:46.761Z\",\n \"memberships\": [\n {\n \"team_id\": \"e259e60c-ebe4-a703-8aa7-c6af59379840\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"4c3a6e9d-aa5c-e3b9-aefd-de0552ac5da0\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ca0f873-7051-4769-9244-f79dfedee44d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dfad64f-b58f-4bdc-9d80-a918036b1664", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0b77b63-00f9-48ce-b1da-1f1d48b49dad", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb0f3b59-1b41-43c2-a23f-1e7769444e34", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b84b4b5b-aff5-4c9d-9c47-62d159579dc5", "name": "Get one user (admin) — detail with memberships + scan count", "request": { "name": "Get one user (admin) — detail with memberships + scan count", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bed7d961-bf17-4cad-8449-28b2634c29e0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1ccc29f0-bffb-91d6-ddbd-33ffb5b3ef59\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"1979-08-21T11:22:18.287Z\",\n \"updated_at\": \"1963-04-25T14:30:18.167Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1994-12-07T20:27:24.194Z\",\n \"memberships\": [\n {\n \"team_id\": \"3efe3c3c-2959-3545-ec69-c473e8ad0e0d\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"f0a72be8-51aa-d6a4-6296-0eebb6a27a39\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c180795-a547-4961-a7c2-63501443d147", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b01a9ac-365d-437b-bd29-c4c1863cb12e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c928474-63fe-4a64-ba0f-ea1259344ef3", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a34bb4e-98f9-414e-984f-baf80e51ea89", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a34c460f-7bf1-4e59-a468-ed0967820f1b", "name": "Re-activate a user (admin)", "request": { "name": "Re-activate a user (admin)", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3c91906d-a076-45cc-9e2e-a54cc55765a1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"40c356f7-bf6e-5e02-89c0-0c4b55198a13\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": false,\n \"created_at\": \"1956-10-25T06:43:21.481Z\",\n \"updated_at\": \"1968-12-21T16:16:35.694Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1999-02-05T04:54:46.761Z\",\n \"memberships\": [\n {\n \"team_id\": \"e259e60c-ebe4-a703-8aa7-c6af59379840\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"4c3a6e9d-aa5c-e3b9-aefd-de0552ac5da0\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e33834af-0000-46bc-a601-99b6803f2038", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "340f67bf-207e-42b9-ac6c-f365e3e465d5", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4685144-53f2-49c9-851f-811ea2bfee02", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07b3f37d-b0e1-4f3a-8593-01312f84725f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2785121-7c0d-4813-81f4-b3e3136fc15c", "name": "Re-activate a user (admin)", "request": { "name": "Re-activate a user (admin)", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8ae350f0-066a-403b-8d47-0d3d24a16d8a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1ccc29f0-bffb-91d6-ddbd-33ffb5b3ef59\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"1979-08-21T11:22:18.287Z\",\n \"updated_at\": \"1963-04-25T14:30:18.167Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1994-12-07T20:27:24.194Z\",\n \"memberships\": [\n {\n \"team_id\": \"3efe3c3c-2959-3545-ec69-c473e8ad0e0d\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"f0a72be8-51aa-d6a4-6296-0eebb6a27a39\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae2ab2e2-601f-415f-b75a-3520d0429fb0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3edc9541-7a06-41bf-b9a3-25afe995cfbe", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23c10860-5580-4ece-80a8-464aed26e4bd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7515d86-08d0-47ea-94f0-e3ee2f60ef1a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea98d01a-9b5c-4bf6-b312-fb707d96864b", "name": "Clear a person's second factor", "request": { "name": "Clear a person's second factor", "description": { "content": "Undoes somebody's second-factor enrolment: the flag, the secret, the replay\ncounter and every unused recovery code, with existing sessions ended.\n\nThis exists because losing an authenticator is the ordinary failure of a\nsecond factor, and the alternatives do not cover it. A password reset\ncannot: unlocking the factor by mailbox would reduce it to owning the\nmailbox, which is what the first factor already proves. Recovery codes do,\nfor anybody who kept them.\n\n-- What this does not protect against ------------------------------------\n\nA compromised super admin. That is not new, and it is not created here:\nthe same account can already change roles and create users, so it can mint\nitself a fresh super admin with no second factor. What this adds is the\nability to impersonate one *specific* existing person, and the notification\nbelow is what narrows that: somebody who did not ask for their factor to be\ncleared finds out that it was.\n\nDeliberately not two-person: an unlock is reversible, since the owner can\nenrol again, and making somebody who is locked out wait for a second\napprover costs more than it buys.", "type": "text/plain" }, "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0bd8e530-fd83-42c8-8ea8-71c7cf300214", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5da9f474-60b6-4497-bb5d-1e28af9a8566", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ddc8a74-5617-4e88-b6df-75586e924741", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d06fb5e-fb95-492d-9910-1237d06e4e1b", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707fa740-a851-44bb-b3ae-b10d9406c9cb", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "483c84c2-6aad-4080-8019-b4a20531155b", "name": "Clear a person's second factor", "request": { "name": "Clear a person's second factor", "description": { "content": "Undoes somebody's second-factor enrolment: the flag, the secret, the replay\ncounter and every unused recovery code, with existing sessions ended.\n\nThis exists because losing an authenticator is the ordinary failure of a\nsecond factor, and the alternatives do not cover it. A password reset\ncannot: unlocking the factor by mailbox would reduce it to owning the\nmailbox, which is what the first factor already proves. Recovery codes do,\nfor anybody who kept them.\n\n-- What this does not protect against ------------------------------------\n\nA compromised super admin. That is not new, and it is not created here:\nthe same account can already change roles and create users, so it can mint\nitself a fresh super admin with no second factor. What this adds is the\nability to impersonate one *specific* existing person, and the notification\nbelow is what narrows that: somebody who did not ask for their factor to be\ncleared finds out that it was.\n\nDeliberately not two-person: an unlock is reversible, since the owner can\nenrol again, and making somebody who is locked out wait for a second\napprover costs more than it buys.", "type": "text/plain" }, "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "46e87e76-bb3d-44af-9bde-0839abe4625f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4de744d2-ff68-449f-a20c-08c583ef14f5", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca26cda6-8dbb-4ba3-9718-887a549c145b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2be4d522-73d2-4e50-9289-78d5919e5508", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec30d439-9cbc-4bf9-9c84-a3bbb19cb86b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "512f2bac-66f0-4a2b-9852-a7072a8f17ae", "name": "Deactivate a user (admin) — revokes refresh tokens", "request": { "name": "Deactivate a user (admin) — revokes refresh tokens", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "297db2bc-26b4-4401-9c77-69a56b6c8c06", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"40c356f7-bf6e-5e02-89c0-0c4b55198a13\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": false,\n \"created_at\": \"1956-10-25T06:43:21.481Z\",\n \"updated_at\": \"1968-12-21T16:16:35.694Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1999-02-05T04:54:46.761Z\",\n \"memberships\": [\n {\n \"team_id\": \"e259e60c-ebe4-a703-8aa7-c6af59379840\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"4c3a6e9d-aa5c-e3b9-aefd-de0552ac5da0\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98e4d3d7-699b-4cdc-9cec-f6308977ad1f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aa32a5e-dd76-4317-8230-70538f81373e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff1e0b14-e355-4046-bbf5-b4734980cb94", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ff893cd-35ae-4919-807d-ce06fb4fcf20", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8982510-c71f-4de3-a67c-f2be71cd651d", "name": "Deactivate a user (admin) — revokes refresh tokens", "request": { "name": "Deactivate a user (admin) — revokes refresh tokens", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f3e58b7e-f9fe-4288-8441-09c8f16dbd0b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1ccc29f0-bffb-91d6-ddbd-33ffb5b3ef59\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"1979-08-21T11:22:18.287Z\",\n \"updated_at\": \"1963-04-25T14:30:18.167Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1994-12-07T20:27:24.194Z\",\n \"memberships\": [\n {\n \"team_id\": \"3efe3c3c-2959-3545-ec69-c473e8ad0e0d\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"f0a72be8-51aa-d6a4-6296-0eebb6a27a39\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5cffafa-c413-4efc-b6a6-c765895b2d42", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2bdf78b-729b-45fb-b1f9-bdc445f490f2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "550093cb-ab4a-46cd-a69c-eec969224f21", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "210d60ba-b017-4501-9af3-ab176ce9df45", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "944a97c4-960a-4fcc-ac95-6f2f6f0320e1", "name": "Initiate a password reset (admin) — email delivery is wired separately", "request": { "name": "Initiate a password reset (admin) — email delivery is wired separately", "description": { "content": "Issues a one-shot reset token (bcrypt-hashed in storage) and returns 204.\n\nA follow-up change wires the SMTP / Slack delivery channel. Until then\nthe plaintext token is generated, persisted as a hash, audit-logged via\nthe listener (which masks the hash to ``***``), and discarded.\n\n-- Account-enumeration semantics ------------------------------------------\n\nThis endpoint returns 404 when ``user_id`` does not exist. That IS an\nenumeration oracle in isolation, but it is acceptable HERE because the\nroute is super-admin-gated by ``require_super_admin_or_404`` — any\ncaller who can reach this code path is already authorised to read the\nfull user list (``GET /v1/admin/users``), so the 404 leaks no\ninformation they did not already have. The trust boundary is ABOVE this\nendpoint, not at it.\n\nThe PUBLIC password-reset flow (\"forgot password\") MUST NOT copy this\n404-on-miss pattern. That endpoint is unauthenticated, so\na 404 vs. 204 split there would let an attacker enumerate registered\nemails (CWE-204 Observable Response Discrepancy). The public flow\nreturns a uniform 204 regardless of whether the email exists, with the\nactual reset email sent only when a match is found.", "type": "text/plain" }, "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db07bda2-cbf0-4c42-89bb-a4ab1fb7f523", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b5ca0dd-e255-4762-bc75-8ec3cb6b4711", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ddce11f-5287-40ca-af99-4a48c05a6c94", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea7ff01-2482-45fa-b1af-11b0efbb1649", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf48e1fa-b3a1-47c1-ae9c-c48b349e6cbe", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ac6b2b0-dc08-44b3-93dc-6fbebbbdacb7", "name": "Initiate a password reset (admin) — email delivery is wired separately", "request": { "name": "Initiate a password reset (admin) — email delivery is wired separately", "description": { "content": "Issues a one-shot reset token (bcrypt-hashed in storage) and returns 204.\n\nA follow-up change wires the SMTP / Slack delivery channel. Until then\nthe plaintext token is generated, persisted as a hash, audit-logged via\nthe listener (which masks the hash to ``***``), and discarded.\n\n-- Account-enumeration semantics ------------------------------------------\n\nThis endpoint returns 404 when ``user_id`` does not exist. That IS an\nenumeration oracle in isolation, but it is acceptable HERE because the\nroute is super-admin-gated by ``require_super_admin_or_404`` — any\ncaller who can reach this code path is already authorised to read the\nfull user list (``GET /v1/admin/users``), so the 404 leaks no\ninformation they did not already have. The trust boundary is ABOVE this\nendpoint, not at it.\n\nThe PUBLIC password-reset flow (\"forgot password\") MUST NOT copy this\n404-on-miss pattern. That endpoint is unauthenticated, so\na 404 vs. 204 split there would let an attacker enumerate registered\nemails (CWE-204 Observable Response Discrepancy). The public flow\nreturns a uniform 204 regardless of whether the email exists, with the\nactual reset email sent only when a match is found.", "type": "text/plain" }, "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9c01bd57-edd3-45a8-a1a3-ec8b31a16c2f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af9b0911-1fdd-4aa5-b16d-32ca3ebe2906", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78ff83fc-2df0-4fd1-bcf4-1ba2ca92f6ed", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "255b7290-a50c-4db2-96b0-da0106e3cfbd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4be675f8-1a0d-445c-825b-54cab6ad3129", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fbd28cd-3abd-4e49-a344-fd0d229ec581", "name": "Change a user's role (admin)", "request": { "name": "Change a user's role (admin)", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1a1a27e6-c750-43fc-9221-d73ab5d1a4a1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"40c356f7-bf6e-5e02-89c0-0c4b55198a13\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": false,\n \"created_at\": \"1956-10-25T06:43:21.481Z\",\n \"updated_at\": \"1968-12-21T16:16:35.694Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1999-02-05T04:54:46.761Z\",\n \"memberships\": [\n {\n \"team_id\": \"e259e60c-ebe4-a703-8aa7-c6af59379840\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"4c3a6e9d-aa5c-e3b9-aefd-de0552ac5da0\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06aeab97-6c95-4562-849b-8d77a9a6e3e9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c752cb9-efc5-41f5-b210-1c20f8a0cfdc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5d2d879-88ca-47f0-a7fe-4764fd94a86a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afcdb756-b7b8-456e-985d-b486f3aebd92", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e8b616b-6dfe-4ca2-a4ab-e9832511a5cf", "name": "Change a user's role (admin)", "request": { "name": "Change a user's role (admin)", "description": {}, "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fadb1533-81b6-4506-a2c4-88e38676a6d5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1ccc29f0-bffb-91d6-ddbd-33ffb5b3ef59\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"1979-08-21T11:22:18.287Z\",\n \"updated_at\": \"1963-04-25T14:30:18.167Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1994-12-07T20:27:24.194Z\",\n \"memberships\": [\n {\n \"team_id\": \"3efe3c3c-2959-3545-ec69-c473e8ad0e0d\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"f0a72be8-51aa-d6a4-6296-0eebb6a27a39\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba3b1e5d-2005-4ebf-9d83-872d0419c3b6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7784875-2b83-44ce-b2eb-a132dbfa6320", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c010116-c593-4876-87d6-19495af74490", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0daf478-0840-4ed2-98d6-4f456574fb61", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"3a84c7ee-de1a-6390-8af8-7885bab619bf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a53ca3b8-84fa-4fd1-8617-c935abd25e55", "name": "Clear a person's failed sign-in count", "request": { "name": "Clear a person's failed sign-in count", "description": { "content": "Clears the per-address failed sign-in count so the person can try again.\n\nFailed sign-ins are counted per address, and a refusal lasts until its\nwindow runs out. That is a slowdown for somebody guessing and an\ninconvenience for somebody who mistyped, but it is also a way to keep an\naccount's owner out on purpose: anybody who knows an email can supply\nfailures for it. Two things answer that. Completing a password reset\nclears the count, which needs the inbox and so cannot be blocked by the\nperson doing the guessing. This is the other, for somebody who has lost\naccess to that inbox.\n\nIt is not otherwise recoverable by hand. The counter is keyed by an HMAC\nof the address, which is deliberate -- Redis then holds no list of who has\ntried to sign in -- and the cost is that an operator cannot find or delete\none person's key without the deployment secret and a script.\n\nSuper-admin only, and audited: this acts on somebody else's account, and\nclearing a count during an attack is a decision somebody should be able to\nreview afterwards.\n\nReturns 404 for an unknown user, on the same reasoning as the sibling\npassword-reset route: the caller can already list every user, so the 404\ntells them nothing new. The public sign-in path must not copy it.", "type": "text/plain" }, "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dd67e5fa-bea9-41a1-a6d2-44f1b7a4dadd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4c38b4fd-939c-4350-85f2-65163e41fedc", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc5ce44e-0496-44bc-a3fe-621218432513", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b75b4e8-bff3-4a94-9d5c-044c60cdc155", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df9023aa-8378-4ebc-b813-7f484c758076", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb5ea9c9-2a12-4873-b70c-21910e21b016", "name": "Clear a person's failed sign-in count", "request": { "name": "Clear a person's failed sign-in count", "description": { "content": "Clears the per-address failed sign-in count so the person can try again.\n\nFailed sign-ins are counted per address, and a refusal lasts until its\nwindow runs out. That is a slowdown for somebody guessing and an\ninconvenience for somebody who mistyped, but it is also a way to keep an\naccount's owner out on purpose: anybody who knows an email can supply\nfailures for it. Two things answer that. Completing a password reset\nclears the count, which needs the inbox and so cannot be blocked by the\nperson doing the guessing. This is the other, for somebody who has lost\naccess to that inbox.\n\nIt is not otherwise recoverable by hand. The counter is keyed by an HMAC\nof the address, which is deliberate -- Redis then holds no list of who has\ntried to sign in -- and the cost is that an operator cannot find or delete\none person's key without the deployment secret and a script.\n\nSuper-admin only, and audited: this acts on somebody else's account, and\nclearing a count during an attack is a decision somebody should be able to\nreview afterwards.\n\nReturns 404 for an unknown user, on the same reasoning as the sibling\npassword-reset route: the caller can already list every user, so the 404\ntells them nothing new. The public sign-in path must not copy it.", "type": "text/plain" }, "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bdde1d16-0705-4257-98c1-281a12b53cff", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "67a531f6-ef98-41c1-b64d-44e424cd901f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd7129d-4392-4690-b3aa-152639f2d142", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "803db8a3-e361-4fbd-93b1-f5d8548850e0", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed2dee5c-ba0f-41fb-b316-3ee1f42943a4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d309f488-c425-2593-c98e-fc1b7bc6f6ad", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "017e71df-aad2-4302-afa4-2750be986b36", "name": "api-keys", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e27154a9-cdfa-4a38-aa66-c24f13b18f1d", "name": "Paginated list of API keys visible to the caller", "request": { "name": "Paginated list of API keys visible to the caller", "description": {}, "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "scope", "value": "project" }, { "disabled": false, "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "include_revoked", "value": "false" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5d4541c2-462c-4435-958f-321c988f7aed", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"2976ce7c-bcb1-347a-3247-5b2eaf91e711\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"project\",\n \"team_id\": \"937aea12-e4a4-cbf1-db48-491278e21f57\",\n \"project_id\": \"e208d4c1-310f-3798-7e38-13676ff923e1\",\n \"created_by_user_id\": \"762ece89-d3e7-9945-0295-770c187cf392\",\n \"created_at\": \"2019-02-24T22:47:48.782Z\",\n \"revoked_at\": \"2006-10-08T21:30:35.808Z\",\n \"created_by_email\": \"string\",\n \"expires_at\": \"1964-05-31T13:01:23.702Z\",\n \"last_used_at\": \"1967-06-30T10:48:25.391Z\",\n \"permission_breadth\": \"read_write\"\n },\n {\n \"id\": \"e7219778-0a50-42aa-92da-24942c8227f3\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"team\",\n \"team_id\": \"9d4658fa-a36a-82cc-1133-eb9f2522254b\",\n \"project_id\": \"0af5155b-ab73-005a-2e7d-5bfb4d2e9942\",\n \"created_by_user_id\": \"96d6ba07-0c42-b651-a35e-ceed543a7091\",\n \"created_at\": \"2019-05-16T23:53:56.291Z\",\n \"revoked_at\": \"1974-02-06T14:03:29.034Z\",\n \"created_by_email\": \"string\",\n \"expires_at\": \"1967-04-26T06:13:34.422Z\",\n \"last_used_at\": \"2025-04-21T06:14:49.532Z\",\n \"permission_breadth\": \"read_write\"\n }\n ],\n \"total\": 6504,\n \"page\": 636,\n \"page_size\": 8355\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d2325b1-4215-4a18-aaf1-d9549ad90588", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "633e28c6-c20a-4d71-90db-5cf44b1e9e6d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a0d08e4-391a-47d0-8c0e-08a9b890e916", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31496b0d-6ecf-4f48-9109-aaecdba6c9e7", "name": "Issue a new API key (plaintext returned ONCE in raw_key)", "request": { "name": "Issue a new API key (plaintext returned ONCE in raw_key)", "description": {}, "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scope\": \"team\",\n \"expires_in_days\": 1452,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"1b8cc0c2-64c6-1b94-b784-0eff05ed300f\",\n \"service_account_id\": \"3d503b08-e9dd-7305-f1d1-279b678f1ee5\",\n \"team_id\": \"a71c7305-8817-df51-5aad-b77a3c5427a4\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3320cc6c-197f-4cb9-99d7-659778dbf471", "name": "Key created. ``raw_key`` is the wire bearer string — capture it; subsequent reads only return metadata.", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scope\": \"team\",\n \"expires_in_days\": 1452,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"1b8cc0c2-64c6-1b94-b784-0eff05ed300f\",\n \"service_account_id\": \"3d503b08-e9dd-7305-f1d1-279b678f1ee5\",\n \"team_id\": \"a71c7305-8817-df51-5aad-b77a3c5427a4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a823b51c-c525-63e9-f3db-a0df1986b432\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"org\",\n \"permission_breadth\": \"read_only\",\n \"team_id\": \"e0773443-107b-b8ef-e93b-722e6ed967fb\",\n \"project_id\": \"e46da553-cb87-742d-f5b2-2c5ef65687bf\",\n \"created_by_user_id\": \"4126f5a6-63f8-c197-4921-8259f4205c98\",\n \"created_at\": \"1971-05-03T19:31:19.053Z\",\n \"raw_key\": \"string\",\n \"expires_at\": \"2022-05-26T22:15:36.228Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb079a8b-3d4a-4265-885d-f8444b9a1aac", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scope\": \"team\",\n \"expires_in_days\": 1452,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"1b8cc0c2-64c6-1b94-b784-0eff05ed300f\",\n \"service_account_id\": \"3d503b08-e9dd-7305-f1d1-279b678f1ee5\",\n \"team_id\": \"a71c7305-8817-df51-5aad-b77a3c5427a4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8afb2a26-7bc2-47cc-8db6-e22e99dd59ff", "name": "Caller may not issue at the requested scope.", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scope\": \"team\",\n \"expires_in_days\": 1452,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"1b8cc0c2-64c6-1b94-b784-0eff05ed300f\",\n \"service_account_id\": \"3d503b08-e9dd-7305-f1d1-279b678f1ee5\",\n \"team_id\": \"a71c7305-8817-df51-5aad-b77a3c5427a4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5a8c09ea-c2b9-433a-8746-0ae2acf28d99", "name": "Project not found (when scope='project').", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scope\": \"team\",\n \"expires_in_days\": 1452,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"1b8cc0c2-64c6-1b94-b784-0eff05ed300f\",\n \"service_account_id\": \"3d503b08-e9dd-7305-f1d1-279b678f1ee5\",\n \"team_id\": \"a71c7305-8817-df51-5aad-b77a3c5427a4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9f41cdc7-0ce3-4e01-8e0d-d348fec714ec", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scope\": \"team\",\n \"expires_in_days\": 1452,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"1b8cc0c2-64c6-1b94-b784-0eff05ed300f\",\n \"service_account_id\": \"3d503b08-e9dd-7305-f1d1-279b678f1ee5\",\n \"team_id\": \"a71c7305-8817-df51-5aad-b77a3c5427a4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58ee980a-ddec-493c-ba95-cc005c656089", "name": "Could not allocate a unique key prefix after retries — transient and retryable.", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"scope\": \"team\",\n \"expires_in_days\": 1452,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"1b8cc0c2-64c6-1b94-b784-0eff05ed300f\",\n \"service_account_id\": \"3d503b08-e9dd-7305-f1d1-279b678f1ee5\",\n \"team_id\": \"a71c7305-8817-df51-5aad-b77a3c5427a4\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75c0cca7-c256-49ab-94e5-93541bf8033b", "name": "Revoke (soft-delete) an API key", "request": { "name": "Revoke (soft-delete) an API key", "description": {}, "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8501ea48-1a57-495b-a096-2c2ea2f7e5ed", "name": "Key revoked (or was already revoked — idempotent).", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7de68e7-2451-4a09-ba03-d56b26ac643b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5228fda-f953-4d3f-bfc0-6825916cb595", "name": "Caller can see the key but lacks permission to revoke it (needs to be the issuer, a team_admin of the key's team, or super_admin).", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a71fd53f-66c8-4067-ab8d-bd56c1f5263a", "name": "Key not found, or not visible to the caller.", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb7e0353-a44f-4715-ae8a-dee35bae6b57", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "251f088d-1c5a-4e00-8eeb-f786da373bf1", "name": "Narrow a key to read-only (one-way)", "request": { "name": "Narrow a key to read-only (one-way)", "description": {}, "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"permission_breadth\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7659c9e7-2fc8-44f2-96bd-efbe0fec50b7", "name": "Key is read-only. Idempotent: a key that was already read-only returns unchanged.", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"permission_breadth\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f6a8cceb-cd23-f6ec-4749-d9a85eb9ad32\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"team\",\n \"team_id\": \"c4d5c76e-898f-db9b-2301-c16d077b1f05\",\n \"project_id\": \"2a99ea06-c220-08f2-d25d-d9edb8d8bb3b\",\n \"created_by_user_id\": \"d87e03d3-a6c6-5057-139c-49e17f763e16\",\n \"created_at\": \"1952-10-20T01:18:35.715Z\",\n \"revoked_at\": \"1985-08-04T01:23:27.909Z\",\n \"created_by_email\": \"string\",\n \"expires_at\": \"1985-05-27T03:25:49.155Z\",\n \"last_used_at\": \"1980-06-14T01:51:16.571Z\",\n \"permission_breadth\": \"read_write\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71d40a59-01d9-453f-acc4-3a8587a86d0d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"permission_breadth\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfc7b185-7901-4196-a078-9281383e54b0", "name": "Caller can see the key but may not change it.", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"permission_breadth\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4c249508-63e2-43b6-83ad-d091ddd8cb83", "name": "Key not found, or not visible to the caller.", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"permission_breadth\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39e833f0-930f-47c4-86b0-0b90d1df5810", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2ecafe54-567f-8dea-8831-e690cbc94f82", "key": "api_key_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"permission_breadth\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "986fc634-9625-4165-9558-5db3098905db", "name": "approvals", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "03909240-02f4-4157-9e28-f8be25a7b3f3", "name": "Paginated list of approval requests (team-scoped; super_admin sees all)", "request": { "name": "Paginated list of approval requests (team-scoped; super_admin sees all)", "description": {}, "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "rejected,approved,rejected,rejected,rejected,under_review,pending,approved,pending,rejected,under_review", "description": "Single status or a comma-separated list of statuses (e.g. ``pending,under_review``)." }, { "disabled": false, "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Narrow the queue to one project. Applied after the team gate, so a project outside the caller's teams returns an empty page rather than an error, exactly as an unknown id does." }, { "disabled": false, "key": "requested_by_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "from_dt", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "to_dt", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2c0b96c0-6ab2-4da7-9a5f-53fe74132a1a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "rejected,approved,rejected,rejected,rejected,under_review,pending,approved,pending,rejected,under_review" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "requested_by_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "from_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"c6f76f11-dfa6-26d2-c6e5-bf1d0e0d5958\",\n \"component_id\": \"7e2c9920-9c5e-6283-1053-3234646ca2b5\",\n \"project_id\": \"c93bd0d0-47a3-e0e4-aa8c-d8075559980c\",\n \"team_id\": \"93b937a7-928b-b918-9613-81d3115268f1\",\n \"requested_by_user_id\": \"22987a6b-dc05-c4f4-e5d8-1fa601161411\",\n \"requested_at\": \"2026-09-09T08:31:35.735Z\",\n \"status\": \"pending\",\n \"decided_by_user_id\": \"6e5df04d-5fc0-f528-f5e2-086c26482c16\",\n \"decided_at\": \"1990-08-13T07:10:06.104Z\",\n \"decision_note\": \"string\",\n \"version\": 6982,\n \"component_name\": \"string\",\n \"component_purl\": \"string\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"requested_by_name\": \"string\"\n },\n {\n \"id\": \"d7050dcb-92ef-33a0-06b5-13e9295c42a5\",\n \"component_id\": \"e8f809fc-8385-3636-57f5-e5847ec6c40d\",\n \"project_id\": \"06ef5778-326d-9d1c-6a25-8a4c77481a1b\",\n \"team_id\": \"01ca2fc7-02e3-1042-a82a-ac654125860f\",\n \"requested_by_user_id\": \"b488e9dc-e88b-c7d6-7d2e-c8bd40ab74e6\",\n \"requested_at\": \"1981-04-21T08:56:19.515Z\",\n \"status\": \"rejected\",\n \"decided_by_user_id\": \"67fd5cc4-a53e-de61-44d3-52612f680135\",\n \"decided_at\": \"1995-02-20T04:34:05.641Z\",\n \"decision_note\": \"string\",\n \"version\": 5459,\n \"component_name\": \"string\",\n \"component_purl\": \"string\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"requested_by_name\": \"string\"\n }\n ],\n \"total\": 1350,\n \"page\": 3170,\n \"page_size\": 7648\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a6b7125-9978-42ae-a2cc-7ddfdf55258b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "rejected,approved,rejected,rejected,rejected,under_review,pending,approved,pending,rejected,under_review" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "requested_by_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "from_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b670de7-b8cc-404f-a192-d82abf25e024", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "rejected,approved,rejected,rejected,rejected,under_review,pending,approved,pending,rejected,under_review" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "requested_by_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "from_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3e65483-e881-4258-8423-14a81e620ff4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "rejected,approved,rejected,rejected,rejected,under_review,pending,approved,pending,rejected,under_review" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "requested_by_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "from_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to_dt", "value": "1954-10-23T14:19:28.988Z" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28fe17b8-5783-4bef-9635-97a571643d97", "name": "Open a new approval request for a component in a project", "request": { "name": "Open a new approval request for a component in a project", "description": {}, "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"component_id\": \"88b192fa-91aa-e021-b85c-b05365644282\",\n \"project_id\": \"e364dd72-af6b-2212-d79a-69ecf48c96b6\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5b4f6cac-8926-4709-b6bf-3fded2b3a52b", "name": "Approval created.", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"88b192fa-91aa-e021-b85c-b05365644282\",\n \"project_id\": \"e364dd72-af6b-2212-d79a-69ecf48c96b6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2a0d2b98-e83f-feb0-a91a-286174d6c86b\",\n \"component_id\": \"0dd7331b-f4b2-2b8e-218d-b0654b59cb5b\",\n \"project_id\": \"c93ee551-ce60-5dd8-6c57-dd9240da1ed5\",\n \"team_id\": \"65e68cf3-6c4f-bc98-2a03-0bca6ce69271\",\n \"requested_by_user_id\": \"33570f7a-3382-0592-9b0a-dc143ad26cc1\",\n \"requested_at\": \"1955-12-30T07:39:09.905Z\",\n \"status\": \"rejected\",\n \"decided_by_user_id\": \"1222aad1-8593-1c3f-2062-afc4c4501514\",\n \"decided_at\": \"2013-03-03T07:08:24.635Z\",\n \"decision_note\": \"string\",\n \"version\": 6124,\n \"component_name\": \"string\",\n \"component_purl\": \"string\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"requested_by_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5da7863b-79cc-445a-9e83-938da5772481", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"88b192fa-91aa-e021-b85c-b05365644282\",\n \"project_id\": \"e364dd72-af6b-2212-d79a-69ecf48c96b6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef5f7ccc-f3d0-4ba3-97f7-30879405f414", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"88b192fa-91aa-e021-b85c-b05365644282\",\n \"project_id\": \"e364dd72-af6b-2212-d79a-69ecf48c96b6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "674c41a2-500e-45de-bf49-5ffe31f2c063", "name": "Project or component not found, or caller lacks team access.", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"88b192fa-91aa-e021-b85c-b05365644282\",\n \"project_id\": \"e364dd72-af6b-2212-d79a-69ecf48c96b6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ba141aed-80a6-453e-afb5-f8452e93542f", "name": "An open approval already exists for this component + project. ``approval_already_open = true`` extension in the Problem Details body.", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"88b192fa-91aa-e021-b85c-b05365644282\",\n \"project_id\": \"e364dd72-af6b-2212-d79a-69ecf48c96b6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c48922a6-9bfe-484b-ac50-49fb17d0e0f2", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"88b192fa-91aa-e021-b85c-b05365644282\",\n \"project_id\": \"e364dd72-af6b-2212-d79a-69ecf48c96b6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ec831eb-97a2-4914-8895-0b568c93625a", "name": "Delete a non-terminal approval (original requester, team_admin, or super_admin)", "request": { "name": "Delete a non-terminal approval (original requester, team_admin, or super_admin)", "description": {}, "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5f76a684-831e-4acd-ba61-314eb1bb81bc", "name": "Approval deleted.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51021c37-280e-46e5-add1-a26de9be91c5", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78364083-44a2-47dd-9cb2-a143707f00d7", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d584ab80-da3b-42ed-a018-b3a7851d61b2", "name": "Approval not found, or not visible / deletable by the caller.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f247fb57-b688-43c2-aa45-c7057e5a4899", "name": "Approval is in a terminal state (approved / rejected) and cannot be deleted. ``approval_terminal_state = true`` extension.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c790801e-c0e3-4900-ab41-7905b5ee5ebd", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a55a1ce-68b3-4bde-bd9d-ef389d6714c9", "name": "Single approval detail — includes ETag header for optimistic concurrency", "request": { "name": "Single approval detail — includes ETag header for optimistic concurrency", "description": {}, "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "731b3341-f6c6-48f7-9bc5-81cc5767bd69", "name": "Approval found. ETag header contains the current version.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Current version as quoted string", "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2a0d2b98-e83f-feb0-a91a-286174d6c86b\",\n \"component_id\": \"0dd7331b-f4b2-2b8e-218d-b0654b59cb5b\",\n \"project_id\": \"c93ee551-ce60-5dd8-6c57-dd9240da1ed5\",\n \"team_id\": \"65e68cf3-6c4f-bc98-2a03-0bca6ce69271\",\n \"requested_by_user_id\": \"33570f7a-3382-0592-9b0a-dc143ad26cc1\",\n \"requested_at\": \"1955-12-30T07:39:09.905Z\",\n \"status\": \"rejected\",\n \"decided_by_user_id\": \"1222aad1-8593-1c3f-2062-afc4c4501514\",\n \"decided_at\": \"2013-03-03T07:08:24.635Z\",\n \"decision_note\": \"string\",\n \"version\": 6124,\n \"component_name\": \"string\",\n \"component_purl\": \"string\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"requested_by_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daf0d5e8-f413-46e4-846e-7c57d2414ca9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69542f4d-065d-48ee-9caf-db5d046b9bdc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5da88e10-0365-44f7-aa9f-ea8223a6a17a", "name": "Approval not found, or not visible to the caller.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5a904e6-9566-40f6-9db0-733a10857634", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a20bdfb-75f2-4a8c-8f2f-d14eed193fc3", "name": "Transition an approval's status (requires If-Match header)", "request": { "name": "Transition an approval's status (requires If-Match header)", "description": {}, "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2be556d0-8766-4f71-be67-6286ac4a9689", "name": "Approval transitioned. Body is the post-commit approval.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2a0d2b98-e83f-feb0-a91a-286174d6c86b\",\n \"component_id\": \"0dd7331b-f4b2-2b8e-218d-b0654b59cb5b\",\n \"project_id\": \"c93ee551-ce60-5dd8-6c57-dd9240da1ed5\",\n \"team_id\": \"65e68cf3-6c4f-bc98-2a03-0bca6ce69271\",\n \"requested_by_user_id\": \"33570f7a-3382-0592-9b0a-dc143ad26cc1\",\n \"requested_at\": \"1955-12-30T07:39:09.905Z\",\n \"status\": \"rejected\",\n \"decided_by_user_id\": \"1222aad1-8593-1c3f-2062-afc4c4501514\",\n \"decided_at\": \"2013-03-03T07:08:24.635Z\",\n \"decision_note\": \"string\",\n \"version\": 6124,\n \"component_name\": \"string\",\n \"component_purl\": \"string\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"requested_by_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5f0a133-5953-4da1-b8ee-b0948d68fea4", "name": "If-Match header is missing or cannot be parsed.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94dd7951-60d3-45ae-b376-3a5ddd44ad6f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ed0051e-eeb6-4c61-a8e8-d912790bf8c6", "name": "Caller's role is insufficient for the requested transition (under_review / approved / rejected require team_admin or super_admin).", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0f764b5-011c-4233-96c6-9955c267f938", "name": "Approval not found, or not visible to the caller.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3481654b-680b-40fc-886b-e38045594c62", "name": "Transition is not permitted by the state machine. ``approval_invalid_transition = true`` + ``allowed_to`` extension lists the valid next states.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b2a8c79-5315-4e83-a9b8-a6d72c0255c1", "name": "If-Match version did not match the row's current version. Re-fetch the approval and retry.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9bc6e859-dfb2-4d81-a017-3e903cce9c5f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"under_review\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4af58b43-592a-472a-a03b-f20a836b6fe7", "name": "audit", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fcfa949a-7e04-4c6a-a66b-6293ed9b4fbf", "name": "Search audit log scoped to the caller's teams (team_admin+)", "request": { "name": "Search audit log scoped to the caller's teams (team_admin+)", "description": {}, "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "target_table", "value": "organizations" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4bde8f0c-de4c-4259-9b47-3a41fc7839c5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"3cff0f39-7b21-4f77-8bb0-b4264608406a\",\n \"created_at\": \"1986-04-22T07:20:42.339Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"bfe32301-979d-e3cd-0b8b-fdeec92485ca\",\n \"diff\": {\n \"key_0\": 1689.1192252720489,\n \"key_1\": true,\n \"key_2\": false,\n \"key_3\": false\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"1bb7a16f-bed7-cb1a-4606-344d229bb923\"\n },\n {\n \"id\": \"c5b03388-00b4-937b-0bc3-2845e3ee0192\",\n \"created_at\": \"1969-01-24T07:08:13.008Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"a75379ef-85b4-2571-fc71-f054758444c8\",\n \"diff\": {\n \"key_0\": 6718.376523506548\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"c5591294-2329-bff2-fd81-de6c71c6dee9\"\n }\n ],\n \"total\": 6154,\n \"page\": 7492,\n \"page_size\": 6236,\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a75bfd54-dd91-4e83-81b5-31ae7dd4bd00", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "149aba87-e924-4221-87b8-7f426675609b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c8e634-7538-4b09-bf34-1f65bd4ab581", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "target_table", "value": "organizations" }, { "key": "action", "value": "string" }, { "key": "from", "value": "1954-10-23T14:19:28.988Z" }, { "key": "to", "value": "1954-10-23T14:19:28.988Z" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "36c8018a-fa42-49cb-8a60-70225b43ade8", "name": "client-errors", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7b241d9a-d13c-49ae-b9cb-eaed93cff549", "name": "Report a frontend render crash", "request": { "name": "Report a frontend render crash", "description": {}, "url": { "path": [ "v1", "client-errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"message\": \"string\",\n \"url\": \"string\",\n \"component_stack\": \"string\",\n \"stack\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "656de92a-bd90-4683-ab63-377901bbd18c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "client-errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"string\",\n \"url\": \"string\",\n \"component_stack\": \"string\",\n \"stack\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c27f9e08-4bcf-4db0-a9fd-281ae63a986e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "client-errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"string\",\n \"url\": \"string\",\n \"component_stack\": \"string\",\n \"stack\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b636ca6-3c7a-4780-bd64-d7e5f97a7d13", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "client-errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"string\",\n \"url\": \"string\",\n \"component_stack\": \"string\",\n \"stack\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abd800c3-7a53-406c-8a44-53d73abbcdeb", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "client-errors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"string\",\n \"url\": \"string\",\n \"component_stack\": \"string\",\n \"stack\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "98591d7c-2eda-492e-ad19-873780ed364e", "name": "components", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "dc357df2-7128-492b-9dbe-1459cba67138", "name": "Component detail (drawer payload). 404 if component is invisible to caller.", "request": { "name": "Component detail (drawer payload). 404 if component is invisible to caller.", "description": {}, "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "152b997e-5cdf-481d-ac6c-ca289eb0b629", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"07df1c09-6816-20ce-1d64-3c586e3ee91d\",\n \"component_id\": \"d6b4775c-7d9e-df7b-c545-0eea902fff42\",\n \"project_id\": \"436cf963-3b84-86e0-6d0a-25b6d677cb41\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"license_category\": \"forbidden\",\n \"severity_max\": \"critical\",\n \"created_at\": \"2025-07-28T06:45:37.228Z\",\n \"updated_at\": \"2019-09-28T03:23:58.575Z\",\n \"currency_latest\": \"string\",\n \"currency_latest_release_date\": \"1963-02-07\",\n \"currency_state\": \"outdated\",\n \"dependency_scope\": \"required\",\n \"depth\": 2358,\n \"direct\": false,\n \"eol_cycle\": \"string\",\n \"eol_date\": \"1982-02-08\",\n \"eol_product\": \"string\",\n \"eol_source\": \"string\",\n \"eol_state\": \"eol\",\n \"license\": \"string\",\n \"malicious_id\": \"string\",\n \"malicious_source\": \"string\",\n \"malicious_state\": \"clear\",\n \"obligations\": [\n {\n \"id\": \"8ab9ccb9-8e0a-bc28-4aa5-8f3d381c021c\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"license\": \"string\",\n \"link\": \"string\"\n },\n {\n \"id\": \"6235d4be-42b7-73eb-34d3-aeb39dd1a7bc\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"license\": \"string\",\n \"link\": \"string\"\n }\n ],\n \"purl\": \"string\",\n \"raw_data\": {\n \"key_0\": 2541.659956876903,\n \"key_1\": 1478.824933495424\n },\n \"vulnerabilities\": [\n {\n \"cve_id\": \"string\",\n \"severity\": \"string\",\n \"title\": \"string\",\n \"cvss\": 4804.519450874771,\n \"description\": \"string\",\n \"epss_percentile\": 0.5877671519507235,\n \"epss_score\": 0.005622416600708613,\n \"fixed_version\": \"string\"\n },\n {\n \"cve_id\": \"string\",\n \"severity\": \"string\",\n \"title\": \"string\",\n \"cvss\": 4393.1813131126355,\n \"description\": \"string\",\n \"epss_percentile\": 0.760879734389013,\n \"epss_score\": 0.5213802718295515,\n \"fixed_version\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91d39677-31f3-4416-af87-fb2bf1725f30", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cc0962a-d66c-4b97-bd35-5b28a0fdd4a9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfcff09b-556d-48b7-92fb-9e08f3328456", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35da9c48-e351-41db-9ab7-8e8145ab518b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "906e6e98-62e3-4b47-98aa-3fa70c78bd82", "name": "dashboard", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b0cdb02c-ad8b-4f91-950b-b976fcd0ddff", "name": "Work waiting on a person, across the caller's projects (auth required)", "request": { "name": "Work waiting on a person, across the caller's projects (auth required)", "description": { "content": "Pending approvals, KEV findings against their CISA deadline, projects the\nbuild gate would block, and projects nothing has scanned recently.\n\nSame scoping contract as ``/summary``: the caller's identity is the scope,\nenforced in the service through the shared accessible-projects helper. The\ngate bucket aggregates the gate's inputs rather than calling\n``evaluate_gate`` per project — see ``services.action_queue_service`` for\nwhy, and for the parity test that keeps the two in agreement.\n\nRate limited per actor. ``BUCKET_LIMIT`` caps the rows returned but not\nthe work done: the aggregates scan every open finding across the caller's\naccessible projects, so cost grows with portfolio size even though query\ncount does not. Without a limit, one token could hold the connection pool\non a large deployment.", "type": "text/plain" }, "url": { "path": [ "v1", "dashboard", "action-queue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7bde78a-3df7-4ac0-b24e-0c05e7686039", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dashboard", "action-queue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pending_approvals\": 3543,\n \"kev_sla\": {\n \"overdue\": 4054,\n \"due_soon\": 4028\n },\n \"gate_blocked\": [\n {\n \"project_id\": \"55f6bbe2-9b54-1c3c-2395-335c19d347db\",\n \"project_name\": \"string\",\n \"scan_id\": \"ca8b46cc-2ab4-a76d-92e0-a2642fc7aba8\",\n \"critical_cve_count\": 4032,\n \"forbidden_license_count\": 8723,\n \"epss_gate_count\": 0,\n \"malicious_component_count\": 0\n },\n {\n \"project_id\": \"110c04c4-2a82-3f91-13cb-865cd6e8bc37\",\n \"project_name\": \"string\",\n \"scan_id\": \"517b1143-da3c-96cb-cebd-916269bd1492\",\n \"critical_cve_count\": 2879,\n \"forbidden_license_count\": 6005,\n \"epss_gate_count\": 0,\n \"malicious_component_count\": 0\n }\n ],\n \"stale_projects\": [\n {\n \"project_id\": \"6a3dc077-5b0e-3b2a-e958-dfcd14ebcff9\",\n \"project_name\": \"string\",\n \"last_succeeded_at\": \"2004-03-23T22:17:32.892Z\"\n },\n {\n \"project_id\": \"eec1e19a-a7a9-50cb-494d-77b2a57dbc93\",\n \"project_name\": \"string\",\n \"last_succeeded_at\": \"1986-02-01T13:56:15.779Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7621dedc-2976-4781-a458-8e6bc621bd94", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "dashboard", "action-queue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "538c3728-b1f7-4340-8e05-a4e3ac183227", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "dashboard", "action-queue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc0922eb-079d-4931-b746-dc05c80f7c92", "name": "Teams and their projects, by risk (auth required)", "request": { "name": "Teams and their projects, by risk (auth required)", "description": { "content": "Every project the caller can see, grouped by the team that owns it.\n\nThe grouping is the point: a list answers \"which project is worst\", this\nanswers \"which team is carrying the risk\". Same scoping contract as the\nother three — the caller's identity is the scope, and team names are read\nonly for teams that own a visible project, so a caller cannot enumerate\nthe organisation's teams through an empty row.\n\nBoth the per-team and the overall project caps are display limits, and the\nresponse reports what they cut: a grid that silently showed a subset would\ninvite the reader to conclude the rest is clean.", "type": "text/plain" }, "url": { "path": [ "v1", "dashboard", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9d99e6b7-417a-403b-b90b-be78c051b479", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dashboard", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"team_count\": 4330,\n \"shown_team_count\": 4672,\n \"project_count\": 3952,\n \"shown_project_count\": 3171,\n \"truncated\": false,\n \"teams\": [\n {\n \"team_id\": \"4984e35d-9443-a677-015b-1ed4f81b32b1\",\n \"team_name\": \"string\",\n \"project_count\": 4420,\n \"projects\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"team_id\": \"01e093df-88f8-aa6c-63ac-9cd2bc2b8673\",\n \"team_name\": \"string\",\n \"project_count\": 4786,\n \"projects\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d771fce1-e31b-44b8-83b9-222f196d7c5f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "dashboard", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae0ef380-e0f5-4baf-aea0-eca4b0eb52c9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "dashboard", "portfolio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bda410f8-7bfb-49e7-94bd-a575022fdd83", "name": "Portfolio overview for the caller's accessible projects (auth required)", "request": { "name": "Portfolio overview for the caller's accessible projects (auth required)", "description": { "content": "Aggregate counts (projects, scans, severities, licenses, approvals) plus\nthe 10 most recent scans, scoped to the caller's accessible projects.\n\nRate limited per actor on the same bucket and budget as the other three\ndashboard routes (``/action-queue``, ``/trends``, ``/portfolio``): this\nroute used to be the one dashboard endpoint without a limiter, which made\nit the cheapest way to repeatedly re-run the portfolio-wide aggregate.", "type": "text/plain" }, "url": { "path": [ "v1", "dashboard", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b9016a1c-5c26-4ecf-8862-cb252f28cc80", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dashboard", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"license_category_counts\": {\n \"conditional\": 4,\n \"permissive\": 180,\n \"prohibited\": 1,\n \"unknown\": 12\n },\n \"pending_approvals_count\": 2,\n \"project_count\": 7,\n \"recent_scans\": [\n {\n \"finished_at\": \"2026-05-25T09:14:00Z\",\n \"kind\": \"source\",\n \"project_id\": \"9a2b7e10-0000-0000-0000-000000000002\",\n \"project_name\": \"payments-api\",\n \"scan_id\": \"3f1d8c2a-0000-0000-0000-000000000001\",\n \"status\": \"succeeded\"\n }\n ],\n \"scan_status_counts\": {\n \"failed\": 2,\n \"queued\": 1,\n \"running\": 0,\n \"succeeded\": 12\n },\n \"vulnerability_severity_counts\": {\n \"critical\": 3,\n \"high\": 9,\n \"info\": 5,\n \"low\": 41,\n \"medium\": 22\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6d4c431-328d-44ac-86d1-d5a147fbf1f5", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "dashboard", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ad5f3f8-4f1f-4a9a-9dae-f60f8ece6b58", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "dashboard", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ea08ee8-54e9-41ef-a4bb-1f629bfe63d5", "name": "Daily risk series for the caller's accessible projects (auth required)", "request": { "name": "Daily risk series for the caller's accessible projects (auth required)", "description": { "content": "New and resolved exposures per day, plus the standing critical / KEV\ncounts, over the caller's accessible projects.\n\n``days`` is a closed set rather than a free integer: an arbitrary window\nwould let one request walk years of scan history, and the service raises\non anything outside it, so a widened query parameter cannot quietly become\nan unbounded scan. It is an ``IntEnum`` rather than a literal of ints\nbecause a query string arrives as ``\"7\"`` and a literal refuses to coerce\nit — the literal spelling rejected every window a caller asked for while\nstill honouring the default, which is a shape no test of the default can\nsee.\n\nSame scoping contract as ``/summary`` — the caller's identity is the\nscope, enforced in the service through the shared accessible-projects\nhelper. Rate limited per actor for the same reason as the action queue:\nquery count is fixed but the exposure sets read grow with the portfolio.", "type": "text/plain" }, "url": { "path": [ "v1", "dashboard", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "days", "value": "30", "description": "Window length in days, inclusive of today." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "744ec30a-8a66-4c13-ba98-c0d6980a01a6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "dashboard", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"period_days\": 3905,\n \"start_date\": \"1983-08-26\",\n \"end_date\": \"1970-07-18\",\n \"totals\": {\n \"new_findings\": 6936,\n \"resolved_findings\": 4020\n },\n \"project_count\": 538,\n \"points\": [\n {\n \"date\": \"1967-07-26\",\n \"new_findings\": 1487,\n \"resolved_findings\": 6854,\n \"critical_open\": 2455,\n \"kev_open\": 4029,\n \"scan_count\": 8750\n },\n {\n \"date\": \"2020-03-24\",\n \"new_findings\": 1078,\n \"resolved_findings\": 9124,\n \"critical_open\": 2688,\n \"kev_open\": 273,\n \"scan_count\": 5859\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f825878-9c20-4de3-b4da-5e125cc4defd", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "dashboard", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ed1c763-29c8-46a1-a255-6347164289a3", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "dashboard", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3132df63-b03c-4754-9741-7fb41eef1a84", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "dashboard", "trends" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9de3d887-b8b2-4dc6-b5a0-50d774b9e23b", "name": "external-packages", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "627a073a-9695-4ccb-9214-18ce47f897fc", "name": "Look up advisory metadata on deps.dev by CVE or GHSA id", "request": { "name": "Look up advisory metadata on deps.dev by CVE or GHSA id", "description": {}, "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "advisory_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7f91789f-e7ef-415a-86f3-9a8b6eb64c4f", "name": "Lookup result. `found=false` means deps.dev has no such advisory -- not an error.", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "advisory_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"advisory_id\": \"GHSA-f23m-r3pf-42rh\",\n \"aliases\": [\n \"CVE-2025-13465\"\n ],\n \"cvss3_score\": 6.5,\n \"cvss3_vector\": \"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:L/A:L\",\n \"found\": true,\n \"title\": \"lodash vulnerable to Prototype Pollution\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f2d33a-d441-4c37-aca9-3eda20c511bf", "name": "No / invalid bearer token.", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "advisory_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e00f7f5-768f-4569-a74c-d4ce932dc54d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "advisory_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76513be6-0f77-42f1-89d8-f58166609d10", "name": "The lookup is disabled on this deployment.", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "advisory_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c305b78d-446c-4fb5-9e5a-f553cb8ed0b2", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "advisory_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6895cf1-198d-4f7e-9fbf-7b897b9eefe4", "name": "deps.dev did not answer cleanly.", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "advisory_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "642995ba-cf05-42d5-a02f-7aaeffc236c8", "name": "Look up a package on deps.dev by exact ecosystem and name", "request": { "name": "Look up a package on deps.dev by exact ecosystem and name", "description": {}, "url": { "path": [ "v1", "external-packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ecosystem", "value": "string", "description": "(Required) One of: cargo, go, maven, npm, nuget, pypi." }, { "disabled": false, "key": "name", "value": "string", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a57fe06c-1eb0-425b-b817-699a0a30d7f2", "name": "Lookup result. `found=false` means deps.dev has no such package -- not an error.", "originalRequest": { "url": { "path": [ "v1", "external-packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ecosystem", "value": "string" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"advisory_count\": 0,\n \"advisory_ids\": [],\n \"ecosystem\": \"npm\",\n \"found\": true,\n \"homepage_url\": \"https://lodash.com/\",\n \"internal_projects\": [],\n \"licenses\": [\n \"MIT\"\n ],\n \"name\": \"lodash\",\n \"purl\": \"pkg:npm/lodash\",\n \"source_repo_url\": \"git+https://github.com/lodash/lodash.git\",\n \"version\": \"4.18.1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c0d7137-40ad-4061-b691-8e69fc001524", "name": "No / invalid bearer token.", "originalRequest": { "url": { "path": [ "v1", "external-packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ecosystem", "value": "string" }, { "key": "name", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29b5fdee-898d-4b6f-8134-667063f25272", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "external-packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ecosystem", "value": "string" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dca87f1-3b51-4671-b564-77b6d84e581c", "name": "The lookup is disabled on this deployment.", "originalRequest": { "url": { "path": [ "v1", "external-packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ecosystem", "value": "string" }, { "key": "name", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39dd0bd9-a5dd-4a26-b63c-6673f43aefde", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "external-packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ecosystem", "value": "string" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "399b28ee-ded6-48e5-944b-71e7eac0bcb3", "name": "deps.dev did not answer cleanly.", "originalRequest": { "url": { "path": [ "v1", "external-packages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ecosystem", "value": "string" }, { "key": "name", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4c9f2f22-3d9c-45a9-a491-d914f363adb4", "name": "gate-policies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "690d9a60-1154-48b3-9285-552eecc9b248", "name": "What this project's build gate actually applies", "request": { "name": "What this project's build gate actually applies", "description": { "content": "Resolve the policy, then fill the gaps the way the gate itself does.\n\nA value shown here without saying where it came from invites the wrong\nedit: an operator who sees a threshold and assumes their group set it will\nlook for a row that does not exist. ``sources`` names the group(s) or\norganization that supplied each value, with ``deployment`` for the ones\nno policy decided. ``sources_legacy`` is the deprecated pre-group-hierarchy\nstring form of the same information (see its own docstring).\n\nThis endpoint used to resolve and return a project's policy with no\nteam/group membership check at all -- ``require_role(\"viewer\")`` is a\ncoarse, route-level floor, not a project-scoped one. Once ``sources``\nstarted naming the actual contributing groups, that gap widened from\nleaking \"a threshold is team-set\" to leaking real group names and the\nancestor chain to any authenticated stranger. Hidden rather than\nrefused, same as ``get_team_policy``'s own scope check below: existence\nof another organization's project/group is not this caller's business\neither.", "type": "text/plain" }, "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8cdfba18-b225-4b13-afa2-0266e8d76cf3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"2afd1888-d35b-da2e-bc83-79091535b4f9\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_data_available\": true,\n \"epss_last_synced_at\": \"1979-06-15T16:54:44.044Z\",\n \"epss_refresh_enabled\": false,\n \"epss_scored_cves\": 0,\n \"epss_threshold\": 2247.3138435370997,\n \"malicious_blocks\": true,\n \"reachable_critical_only\": true,\n \"sources\": {\n \"key_0\": {\n \"scope\": \"group\",\n \"group_ids\": [\n \"c688247f-3f11-3d0d-dfa3-602d1370eed2\",\n \"fc130b13-beac-ba21-a9b6-354b9549646d\"\n ],\n \"group_paths\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"organization_contributed\": false\n },\n \"key_1\": {\n \"scope\": \"organization\",\n \"group_ids\": [\n \"ab927c29-92ba-f262-e49b-06c4353120a9\",\n \"880f7b1d-08da-0e0a-a5b3-d5b8622a6263\"\n ],\n \"group_paths\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"organization_contributed\": false\n }\n },\n \"sources_legacy\": {\n \"key_0\": \"team+organization\",\n \"key_1\": \"deployment\",\n \"key_2\": \"deployment\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c9a80b-068a-4acc-a638-32fd6c329cb2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b637a4a3-7ca7-4ba0-a0ba-399f855aadb5", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd1b9f42-511d-442e-8af8-acba7add2c88", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704b59dc-e18e-4ba2-91b5-ac18f17ee5d4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f340802-e926-428a-b106-e09a817e3f6b", "name": "Whether this deployment has EPSS data behind its thresholds", "request": { "name": "Whether this deployment has EPSS data behind its thresholds", "description": { "content": "Deployment-scoped, so the policy editor can qualify a threshold it shows.\n\nNot derived from a project or a scan: the question an administrator has\nwhile setting a threshold is whether this deployment collects EPSS, and\nthat has one answer regardless of which project they came from. The\nper-scan version of the question rides on the gate result instead.\n\nNo path parameter, so nothing to authorize beyond being a signed-in\nreader: the response describes the deployment's own configuration and\ncarries no project, team or finding data.", "type": "text/plain" }, "url": { "path": [ "v1", "gate-policies", "epss-availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "81e102b3-de1e-442b-bce8-89dd75a57abe", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "epss-availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"available\": false,\n \"refresh_enabled\": false,\n \"scored_cves\": 3840,\n \"last_synced_at\": \"2023-02-05T09:50:50.752Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df8ad30b-9ee6-4367-ad59-6e0e8ae71c26", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "epss-availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68212a01-b948-4fcc-96e6-c0081724131d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "epss-availability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15487e2a-35bf-45bf-b7f9-94413231887d", "name": "Create or replace the organization default", "request": { "name": "Create or replace the organization default", "description": {}, "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.8596518507534996,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "874fc5f9-5335-4399-8988-77f6852795bd", "name": "Organization default created or replaced.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Entity tag of the row. Send it back as If-Match on the next PUT so a save made in between is not overwritten.", "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"be788fe6-4b52-fb39-f074-f7230f6758e8\",\n \"organization_id\": \"32f5e80c-9ef2-e844-31e6-ddde9fe05685\",\n \"created_at\": \"1997-11-28T13:39:26.615Z\",\n \"updated_at\": \"1969-12-19T03:12:41.885Z\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 3062.6833215874226,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false,\n \"team_id\": \"0d34a7a3-2a1b-7598-7d92-e4f0b26cd7e6\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aae12202-a68c-47ef-8e90-701be26dee21", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0698e916-e7ed-40f1-a560-8b71c514dcc1", "name": "Only a super admin may set the organization default.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94652887-ddcd-4a9c-97fb-9d5ee81f4118", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70d4c8a9-680e-4093-a596-3a8b4074592c", "name": "If-Match no longer matches the row (somebody saved in between, or the row was removed), or If-None-Match: * was sent and a row already exists. Problem type https://docs.trustedoss.io/errors/gate-policy-conflict. Read the policy again and reapply the edit.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"detail\": \"the gate policy changed after it was read; read it again and reapply the edit\",\n \"instance\": \"/v1/gate-policies/teams/00000000-0000-0000-0000-000000000000\",\n \"status\": 409,\n \"title\": \"Gate policy changed\",\n \"type\": \"https://docs.trustedoss.io/errors/gate-policy-conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00e460eb-f79b-4613-9882-9e9718f2b41f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5cda6266-6aab-4ab4-9d30-437a98978528", "name": "Drop a team's policy so it follows its organization again", "request": { "name": "Drop a team's policy so it follows its organization again", "description": {}, "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bfd583dd-962c-4167-bf3a-829ce4223e1f", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0e5e6a9-3c5b-412a-8e6b-71a070de2e6b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b11a2cf-aa46-4979-a037-2c5407c7f7ca", "name": "Caller does not administer this team.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79c9d2ec-8c36-4653-9722-57f2702e5214", "name": "Team not found (a plain Not Found), or the team you administer has no policy of its own to remove (problem type https://docs.trustedoss.io/errors/gate-policy-not-set).", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"detail\": \"team 00000000-0000-0000-0000-000000000000 has no gate policy of its own\",\n \"instance\": \"/v1/gate-policies/teams/00000000-0000-0000-0000-000000000000\",\n \"status\": 404,\n \"title\": \"Gate policy not set\",\n \"type\": \"https://docs.trustedoss.io/errors/gate-policy-not-set\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629834e0-af6e-436b-8718-a470ed8bdd67", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e40a6a0e-1914-402f-bb2b-2efb56359a70", "name": "Read a team's own policy row", "request": { "name": "Read a team's own policy row", "description": {}, "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "74141d7b-bcc8-4b99-8e24-cb85434eef18", "name": "The team's own row.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Entity tag of the row. Send it back as If-Match on the next PUT so a save made in between is not overwritten.", "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"be788fe6-4b52-fb39-f074-f7230f6758e8\",\n \"organization_id\": \"32f5e80c-9ef2-e844-31e6-ddde9fe05685\",\n \"created_at\": \"1997-11-28T13:39:26.615Z\",\n \"updated_at\": \"1969-12-19T03:12:41.885Z\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 3062.6833215874226,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false,\n \"team_id\": \"0d34a7a3-2a1b-7598-7d92-e4f0b26cd7e6\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67a3ad3e-390a-4f80-b881-4e583079cfaa", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47151d5a-3f46-4b64-892e-d4277a1dd1cd", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34013ae5-8c89-4986-91d2-615ebdd140c0", "name": "Team not found or hidden from the caller (a plain Not Found), or the team has written no policy of its own (problem type https://docs.trustedoss.io/errors/gate-policy-not-set). Only the second means the team follows its organization.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"detail\": \"team 00000000-0000-0000-0000-000000000000 has no gate policy of its own\",\n \"instance\": \"/v1/gate-policies/teams/00000000-0000-0000-0000-000000000000\",\n \"status\": 404,\n \"title\": \"Gate policy not set\",\n \"type\": \"https://docs.trustedoss.io/errors/gate-policy-not-set\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edad22d5-818d-44d5-b948-17d43f827da6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e21bb01-8842-4c90-a09e-159fde0f68fc", "name": "Create or replace a team's build-gate policy", "request": { "name": "Create or replace a team's build-gate policy", "description": {}, "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.8596518507534996,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4452ce9f-2a85-4c76-8808-e9168a13a2f7", "name": "Policy created or replaced (idempotent on the scope).", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Entity tag of the row. Send it back as If-Match on the next PUT so a save made in between is not overwritten.", "key": "ETag", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"be788fe6-4b52-fb39-f074-f7230f6758e8\",\n \"organization_id\": \"32f5e80c-9ef2-e844-31e6-ddde9fe05685\",\n \"created_at\": \"1997-11-28T13:39:26.615Z\",\n \"updated_at\": \"1969-12-19T03:12:41.885Z\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 3062.6833215874226,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false,\n \"team_id\": \"0d34a7a3-2a1b-7598-7d92-e4f0b26cd7e6\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fc8ec34-ad81-4061-8586-19415daa132e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a733d55-bf63-4a00-a39d-5f325f26339d", "name": "Caller does not administer this team.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "862db0c6-5fe4-4aec-b75f-e603d0081efc", "name": "Team not found.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7ba0c350-a935-46b1-947f-36e47b01fc8e", "name": "If-Match no longer matches the row (somebody saved in between, or the row was removed), or If-None-Match: * was sent and a row already exists. Problem type https://docs.trustedoss.io/errors/gate-policy-conflict. Read the policy again and reapply the edit.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"detail\": \"the gate policy changed after it was read; read it again and reapply the edit\",\n \"instance\": \"/v1/gate-policies/teams/00000000-0000-0000-0000-000000000000\",\n \"status\": 409,\n \"title\": \"Gate policy changed\",\n \"type\": \"https://docs.trustedoss.io/errors/gate-policy-conflict\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a4b1467-fe8f-4578-9e51-022c80f7b019", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Entity tag from the last GET or PUT. When present and stale the write is refused with 409. When absent the write replaces the row unconditionally, as it did before the header was supported.", "key": "if-match", "value": "string" }, { "disabled": false, "description": "Send `*` to create the row only if none exists yet; a row that already exists answers 409.", "key": "if-none-match", "value": "string" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.4478011626833118,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8d6bd974-c107-4a27-8132-e5be93d9bcec", "name": "github-app", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1d3e62e6-e012-48f7-8edd-41dd11d26af0", "name": "Paginated list of GitHub App credentials visible to the caller", "request": { "name": "Paginated list of GitHub App credentials visible to the caller", "description": {}, "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "include_revoked", "value": "false" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6cb5d8aa-f634-4618-adff-66c0f18d33c2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"548f7eb4-5d42-085e-e356-de79b1e39841\",\n \"team_id\": \"ee92f6f2-c16b-aea9-d449-6fb2b42b7a6d\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": true,\n \"has_webhook_secret\": false,\n \"created_by_user_id\": \"64484104-e3a5-fd83-f923-2eab0c094bd0\",\n \"created_at\": \"2016-10-26T12:27:22.148Z\",\n \"updated_at\": \"1986-11-23T10:35:00.631Z\",\n \"revoked_at\": \"2008-02-28T09:39:03.861Z\"\n },\n {\n \"id\": \"a42ee9c8-e316-a687-5662-6851ed9cbacb\",\n \"team_id\": \"f9cc09e3-6de7-9ca0-032f-21a43f2aa31a\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": true,\n \"has_webhook_secret\": false,\n \"created_by_user_id\": \"a4696e9d-f8cb-d587-37f4-c6da3df42345\",\n \"created_at\": \"2020-06-11T06:33:18.361Z\",\n \"updated_at\": \"2003-09-02T21:36:36.957Z\",\n \"revoked_at\": \"2026-07-21T07:28:36.003Z\"\n }\n ],\n \"total\": 3942,\n \"page\": 9762,\n \"page_size\": 14\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc1226ab-2ce1-4cec-9216-73de84f1fe16", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4dda6eb-96c7-4996-bcc8-12707c530208", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a8ee330-2ab2-4920-b233-4e3125d7899a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_revoked", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3ed5abb-2aef-45ae-998c-e05caa44f9e4", "name": "Register a GitHub App credential (private key encrypted at rest)", "request": { "name": "Register a GitHub App credential (private key encrypted at rest)", "description": {}, "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "team_id", "value": "96781420-b56d-ebb4-e194-477449df2873", "description": "(Required) The team that owns this credential." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"app_id\": \"string\",\n \"private_key\": \"string\",\n \"app_slug\": \"string\",\n \"webhook_secret\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b1893fda-4602-4e60-bb61-08a68f1fd8bc", "name": "Credential registered. Private key is never returned.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "96781420-b56d-ebb4-e194-477449df2873" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"string\",\n \"private_key\": \"string\",\n \"app_slug\": \"string\",\n \"webhook_secret\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"375b7010-3023-5bec-fcc2-381f0063651e\",\n \"team_id\": \"65a96110-06e4-668a-ee5e-e69e788b7305\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": false,\n \"has_webhook_secret\": true,\n \"created_by_user_id\": \"be069125-9a94-cbc7-e236-b3ea44f01ca4\",\n \"created_at\": \"1959-12-13T23:28:23.251Z\",\n \"updated_at\": \"1976-12-13T15:51:42.365Z\",\n \"revoked_at\": \"2013-12-25T23:40:03.883Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "171dbf52-8334-4d41-b255-d201980ed8c2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "96781420-b56d-ebb4-e194-477449df2873" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"string\",\n \"private_key\": \"string\",\n \"app_slug\": \"string\",\n \"webhook_secret\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b515645-4912-4235-a6f8-cbaa92e2f884", "name": "Caller is not a team admin of the target team.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "96781420-b56d-ebb4-e194-477449df2873" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"string\",\n \"private_key\": \"string\",\n \"app_slug\": \"string\",\n \"webhook_secret\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61258a09-8d7f-4b64-8ee8-515a5fd0ccec", "name": "A credential for this (team, app_id) already exists.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "96781420-b56d-ebb4-e194-477449df2873" } ], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"string\",\n \"private_key\": \"string\",\n \"app_slug\": \"string\",\n \"webhook_secret\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4ad30de-b26b-45b2-8335-5c000c7c465f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "96781420-b56d-ebb4-e194-477449df2873" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"string\",\n \"private_key\": \"string\",\n \"app_slug\": \"string\",\n \"webhook_secret\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17a90fda-6326-4878-ae41-34601d5b0ff3", "name": "Revoke (soft-delete) a GitHub App credential", "request": { "name": "Revoke (soft-delete) a GitHub App credential", "description": {}, "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "37b57f06-8ca8-47e0-9742-bc665c444445", "name": "Revoked (or already revoked — idempotent).", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c15c707-ba6f-4520-9029-8f3d8214ce8b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f65a49-7640-4dae-b598-ae5d835e46ac", "name": "Caller is not a team admin of the credential's team.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d76388dd-4bb6-4a1d-9172-26ad333f7a81", "name": "Not found, or not visible to the caller.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f73d43fb-1179-4092-8064-98bc651e2e52", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0837698-b56f-4027-93cf-ee4fdd67d61b", "name": "Fetch one GitHub App credential's metadata", "request": { "name": "Fetch one GitHub App credential's metadata", "description": {}, "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "61ce3ad6-d609-4cea-adee-88616b6ff8ba", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"375b7010-3023-5bec-fcc2-381f0063651e\",\n \"team_id\": \"65a96110-06e4-668a-ee5e-e69e788b7305\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": false,\n \"has_webhook_secret\": true,\n \"created_by_user_id\": \"be069125-9a94-cbc7-e236-b3ea44f01ca4\",\n \"created_at\": \"1959-12-13T23:28:23.251Z\",\n \"updated_at\": \"1976-12-13T15:51:42.365Z\",\n \"revoked_at\": \"2013-12-25T23:40:03.883Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83362e8b-ad55-4933-8875-108a1ce89bfc", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f18c518-9a89-4108-9a80-996cf4fecd91", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82ae5c8d-f704-4cdd-81b0-5af6fdafdf2b", "name": "Not found, or not visible to the caller.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26fb23a5-5221-43c8-93a7-b8d824f266bd", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8840e40-4734-4c04-97cc-2d1bd059944f", "name": "List installations under a credential", "request": { "name": "List installations under a credential", "description": {}, "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cf294d30-b8d6-45f0-8401-e3cc983baea9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"bd76e4c1-8d0d-d050-b78b-d8425290f56b\",\n \"credential_id\": \"89829e58-809f-4a24-3518-8be601245b3f\",\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"repository_full_name\": \"string\",\n \"project_id\": \"42effa0e-443e-6316-4233-ff2878ed509d\",\n \"created_by_user_id\": \"de6314a9-7236-9df4-7fb2-73801166fd85\",\n \"created_at\": \"1950-03-22T06:00:19.266Z\",\n \"updated_at\": \"2021-01-27T07:14:37.127Z\"\n },\n {\n \"id\": \"f49387b4-a495-7303-088a-65df25885edc\",\n \"credential_id\": \"83111b0f-c532-2b8a-fdca-95b98454107b\",\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"repository_full_name\": \"string\",\n \"project_id\": \"37cab677-708c-4cb6-f44c-7f4f499786b5\",\n \"created_by_user_id\": \"fa0e93b2-d41e-47be-1204-6ba342692985\",\n \"created_at\": \"1964-06-02T22:16:59.728Z\",\n \"updated_at\": \"1992-03-16T12:16:10.653Z\"\n }\n ],\n \"total\": 6489,\n \"page\": 4152,\n \"page_size\": 1513\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4ed062e-6a61-4d61-8446-2095d409d254", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6032213-24f5-4258-9320-edf6a3181d4c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2e9fb6-0991-499c-99f6-b47da39d1654", "name": "Credential not found / not visible.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8912219-36ef-4b6f-bb27-125bad17a273", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71bf90c2-6ce8-4738-84cd-5fb5718bf841", "name": "Link (opt-in) an installation under a credential", "request": { "name": "Link (opt-in) an installation under a credential", "description": {}, "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"0d465e60-0eac-de0c-6793-35bfa322e69f\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b8aad609-2f4e-414e-9619-ff0167500561", "name": "Installation linked (idempotent on re-link).", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"0d465e60-0eac-de0c-6793-35bfa322e69f\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"63e3e7d2-2c5c-8c5f-75a7-088127d058c1\",\n \"credential_id\": \"78845b9e-598e-22e3-e262-aa0ad6da75dc\",\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"repository_full_name\": \"string\",\n \"project_id\": \"038046f9-8d6c-66e3-5605-ad28b374190f\",\n \"created_by_user_id\": \"aa5f5343-8499-481f-d528-ec6ea5b2bfec\",\n \"created_at\": \"1958-07-14T20:00:20.540Z\",\n \"updated_at\": \"2016-10-07T20:57:10.271Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40826396-13f6-4950-8abe-f8258b0610c9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"0d465e60-0eac-de0c-6793-35bfa322e69f\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac3b1705-7046-4b59-b31a-0a3980ed8de5", "name": "Caller is not a team admin, or the project belongs to another team.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"0d465e60-0eac-de0c-6793-35bfa322e69f\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b94b9fb-5e40-4f43-a7a4-a0588e48862d", "name": "Credential or project not found / not visible.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"0d465e60-0eac-de0c-6793-35bfa322e69f\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "20599476-80e0-4100-ab68-3ea021db8ab6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"0d465e60-0eac-de0c-6793-35bfa322e69f\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdc30213-4585-4fb2-99c3-ad4ac2185517", "name": "Unlink an installation from a credential", "request": { "name": "Unlink an installation from a credential", "description": {}, "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations", ":installation_row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "87624a68-e9d5-0c45-d090-78f8dbad14c9", "key": "installation_row_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e342ffa0-fd2a-4ef8-b6a9-09572e0c0ea7", "name": "Unlinked (idempotent — absent link is a no-op).", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations", ":installation_row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "87624a68-e9d5-0c45-d090-78f8dbad14c9", "key": "installation_row_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0843bf45-2aea-42ef-825e-f4573855ec0f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations", ":installation_row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "87624a68-e9d5-0c45-d090-78f8dbad14c9", "key": "installation_row_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33fbb6c8-fee9-4df4-9a2f-59d0b4878454", "name": "Caller is not a team admin of the credential's team.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations", ":installation_row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "87624a68-e9d5-0c45-d090-78f8dbad14c9", "key": "installation_row_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f95d369d-a6d4-46b8-be16-d325b9cd1a48", "name": "Credential not found / not visible.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations", ":installation_row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "87624a68-e9d5-0c45-d090-78f8dbad14c9", "key": "installation_row_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7dd13c5-1de1-4fba-a261-d5b602b88a53", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations", ":installation_row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "0d46bbd4-ebda-cad9-13a0-e1b8299a6418", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "87624a68-e9d5-0c45-d090-78f8dbad14c9", "key": "installation_row_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3c075223-200e-49a5-ba4a-aaae852a707c", "name": "groups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b00bf1a2-4255-4e44-96bb-5c31b0efd14d", "name": "List groups visible to the caller (flat search or one-level drill-down)", "request": { "name": "List groups visible to the caller (flat search or one-level drill-down)", "description": {}, "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "string", "description": "Flat, whole-tree name search. When set, `parent_id` is ignored, a match is returned regardless of which branch it lives under." }, { "disabled": false, "key": "parent_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Drill-down mode (only consulted when `q` is unset). Omitted returns root groups; set, returns that group's direct children. An inaccessible or nonexistent parent_id returns an empty page, not a 404, the list surface never confirms a hidden group's existence." }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "eee77277-81da-4b28-b1cc-c8fa34dcc978", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"ee060e18-33ae-59f5-34cc-7152a189d393\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"updated_at\": \"1997-09-02T14:17:32.853Z\",\n \"child_group_count\": 0,\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"5cba47c8-d5b8-204e-de16-934b05342dde\",\n \"project_count\": 0\n },\n {\n \"id\": \"bf528fa9-0d2c-6ab8-4c0a-60bba47ca6b1\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"updated_at\": \"2012-02-25T20:13:16.358Z\",\n \"child_group_count\": 0,\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"8e3e72ac-1d44-8cf9-a49b-ce1fb54e8685\",\n \"project_count\": 0\n }\n ],\n \"total\": 3229,\n \"page\": 8963,\n \"page_size\": 5254\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d953871b-d295-4167-9f3f-cbe888c5a60b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2b24218-1780-4316-8e8c-47dcc80a74a1", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f17dd2b-dbbc-484a-84cd-e34c02ebcef9", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9461275-b4de-4f31-a7af-9f4f675c954c", "name": "Group detail: ancestors + 30-day subtree activity summary", "request": { "name": "Group detail: ancestors + 30-day subtree activity summary", "description": {}, "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e4dc92dc-5019-4fcc-8579-584bad3a764d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"49923996-8148-dc3a-38b5-4ff55f60b702\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"stats\": {\n \"subtree_scan_count\": 7858,\n \"subtree_approvals_processed_count\": 3771,\n \"subtree_new_member_count\": 151,\n \"window_days\": 30\n },\n \"created_at\": \"2021-09-17T02:46:35.734Z\",\n \"updated_at\": \"2008-09-10T19:38:48.652Z\",\n \"ancestors\": [\n {\n \"id\": \"3ea374ab-e901-ec5d-5302-524cff119cc8\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"8cd5314a-d8c3-6db3-012b-98bc2263b353\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"child_group_count\": 0,\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"e8d7b814-6787-7883-8b01-8a00bf31cc50\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99ad5aa7-a55e-40bf-a7dd-e11a89f36a47", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a45069f-125d-4812-91b1-1e9b9e11b44e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e052b39f-47f4-4816-80ef-575ff300d5ba", "name": "The group does not exist, or the caller cannot reach it (existence-hidden, both cases return the same body).", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc6d3f1-2930-41c0-a182-86478bce0d86", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9484b419-377c-4663-9944-612f632e9ef0", "name": "Group members: direct memberships vs. cascade-inherited ones", "request": { "name": "Group members: direct memberships vs. cascade-inherited ones", "description": {}, "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a37ff426-029c-4fb1-89cf-69fa0a04cb76", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"direct\": [\n {\n \"user_id\": \"29d51a1b-f86a-0144-db5e-0ffa5195c67d\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"cbdd175e-6d32-06f4-00e9-0dee982c20d5\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"inherited\": [\n {\n \"user_id\": \"fb5fd904-3423-961b-6ff7-50ec7526a520\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"source_group_id\": \"28e503f6-0db8-2e19-1873-1658da5ebfcb\",\n \"source_group_name\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"637741ac-f5b0-b0d2-0d50-4fd4d471e291\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"source_group_id\": \"3f304d63-f41a-f3b4-fe46-69df069de83c\",\n \"source_group_name\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62d8906a-0d5a-4dfb-a237-7250107b238f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1098b0d-c223-47b6-9292-43f4ffd8f0d0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d87714ba-6c6f-48d3-ab12-8d2831f39492", "name": "The group does not exist, or the caller cannot reach it (existence-hidden, same body as the detail endpoint's 404).", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dcebeab-b2b1-4d1a-a31e-130025bbff99", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d994ac63-2e7b-e474-4f30-905421806c88", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "43e15939-91bd-4071-ba6d-325c787e1394", "name": "intake-requests", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fe491c62-6f0a-4603-b6d4-7298e3c71447", "name": "Requests in the caller's teams, oldest first", "request": { "name": "Requests in the caller's teams, oldest first", "description": {}, "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "status", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ab547964-02d3-4fb8-ba35-fc3ea43fddee", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"db442408-a97a-15ed-1425-d1a22a8395e8\",\n \"project_id\": \"b9227a70-2dda-746a-478c-7de4e661ff82\",\n \"team_id\": \"39187b0b-c134-8463-d5ac-4471bbb623e3\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"821c08d9-7d6e-be55-2e42-4e0cc4695279\",\n \"decided_by_user_id\": \"3db9c9bc-f7db-021a-d42b-4fe573a8fe67\",\n \"decision_note\": \"string\",\n \"decided_at\": \"2019-04-10T10:52:04.169Z\",\n \"version\": 5387,\n \"created_at\": \"2015-05-29T10:04:39.931Z\",\n \"updated_at\": \"2007-05-13T11:02:44.526Z\"\n },\n {\n \"id\": \"3810f26e-1c59-0aa5-9ca0-59ff7f7a8879\",\n \"project_id\": \"9fba288c-3712-090a-ace3-b832883de6dd\",\n \"team_id\": \"61ff3d3a-6a6f-faa0-be45-6d8a8e84f6a7\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"1ce24806-8902-4b1d-ed57-4f287e24ed94\",\n \"decided_by_user_id\": \"6136d0b3-74b1-69ab-602f-f2aa68a1d845\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1978-07-26T14:48:30.895Z\",\n \"version\": 813,\n \"created_at\": \"1960-04-18T07:20:12.996Z\",\n \"updated_at\": \"1977-01-03T05:15:20.954Z\"\n }\n ],\n \"total\": 267\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44e51efa-e791-4f42-a33b-9bafec223174", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3fd3d59-4cf6-4a76-b3a7-269738fc15b8", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "351d2a8e-06ae-4e6d-b4b8-f5e8f1c1a6ca", "name": "This deployment does not use an intake queue.", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23654aa2-fe9b-4117-be77-85b9484005a8", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e70087d-de77-4058-a010-c34c24e8a02d", "name": "Ask to use a package", "request": { "name": "Ask to use a package", "description": {}, "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"project_id\": \"3dde4fd1-e902-3df6-4f76-a6458a95f4f1\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d88a9c37-d543-42ed-b4ca-769af05c6657", "name": "Recorded. Nothing about the project changes yet.", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_id\": \"3dde4fd1-e902-3df6-4f76-a6458a95f4f1\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"31ff2e29-2118-b4b9-98ac-0bc498bb7b79\",\n \"project_id\": \"69502b16-ef60-175f-f7ff-3274b3a4120a\",\n \"team_id\": \"05a0171c-ec23-e1c7-3923-036c3a7d0831\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"72b49362-f1c0-f2b1-b8a8-06f865b541cd\",\n \"decided_by_user_id\": \"f9ac5136-8dda-c865-5baf-550378e8eaa9\",\n \"decision_note\": \"string\",\n \"decided_at\": \"2008-06-06T07:34:04.295Z\",\n \"version\": 4996,\n \"created_at\": \"1993-02-21T18:03:16.415Z\",\n \"updated_at\": \"1982-02-15T12:13:49.350Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7a66bb7-22b9-4003-b796-acd76e06179e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_id\": \"3dde4fd1-e902-3df6-4f76-a6458a95f4f1\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a879d4a-9a5b-41ff-8e91-aa510c020953", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_id\": \"3dde4fd1-e902-3df6-4f76-a6458a95f4f1\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cb4ae4f-e52f-446e-b9fa-3db97691ef41", "name": "This deployment does not use an intake queue, or the project is not the caller's to see. One code for both: whether the feature is on is not worth telling somebody who cannot use it.", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_id\": \"3dde4fd1-e902-3df6-4f76-a6458a95f4f1\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e142c08-2978-4164-b18a-1090f8bf9900", "name": "Somebody is already asking about this package here.", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_id\": \"3dde4fd1-e902-3df6-4f76-a6458a95f4f1\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "143019fb-d7dd-4bf9-8b5e-8a71ae472f9d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_id\": \"3dde4fd1-e902-3df6-4f76-a6458a95f4f1\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c696fba5-714d-4767-9692-4ef91fbae0fe", "name": "Answer a request, or move it along", "request": { "name": "Answer a request, or move it along", "description": {}, "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c2aa24fa-6623-402b-955f-d12f9ea34ad3", "name": "Moved. The new version is returned as the ETag.", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"31ff2e29-2118-b4b9-98ac-0bc498bb7b79\",\n \"project_id\": \"69502b16-ef60-175f-f7ff-3274b3a4120a\",\n \"team_id\": \"05a0171c-ec23-e1c7-3923-036c3a7d0831\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"72b49362-f1c0-f2b1-b8a8-06f865b541cd\",\n \"decided_by_user_id\": \"f9ac5136-8dda-c865-5baf-550378e8eaa9\",\n \"decision_note\": \"string\",\n \"decided_at\": \"2008-06-06T07:34:04.295Z\",\n \"version\": 4996,\n \"created_at\": \"1993-02-21T18:03:16.415Z\",\n \"updated_at\": \"1982-02-15T12:13:49.350Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50b30982-8b19-4fc4-93ec-275e6b939880", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cec6643e-7373-45ea-a7b6-51c108d18873", "name": "Caller does not administer the project's team.", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9af3aca-2af8-4ebb-a743-6a26763bcd36", "name": "Not on in this deployment, or no such request.", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b12274f-508b-4a5f-9a20-f0f8ff35ae65", "name": "Already answered; open a new request instead.", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a15c6c54-d6ee-47c8-8c92-bcf2e33e3f0c", "name": "The If-Match version is stale; reload and retry.", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "881690f8-c180-49fa-9a32-94f4821cf807", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "15bd05c2-ce12-4c03-8d73-070fa7f12037", "name": "inventory", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e6d36ee6-4214-401a-9b54-a6f340336ea0", "name": "Organization-wide component inventory", "request": { "name": "Organization-wide component inventory", "description": {}, "url": { "path": [ "v1", "inventory", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" }, { "disabled": false, "key": "q", "value": "string", "description": "Substring match on package name or purl. LIKE metacharacters are escaped and matched literally." }, { "disabled": false, "key": "package_type", "value": "string" }, { "disabled": false, "key": "package_type", "value": "string" }, { "disabled": false, "key": "severity", "value": "string", "description": "Worst-severity buckets to keep. Unknown tokens are ignored." }, { "disabled": false, "key": "severity", "value": "string", "description": "Worst-severity buckets to keep. Unknown tokens are ignored." }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "eol", "value": "true" }, { "disabled": false, "key": "outdated", "value": "true" }, { "disabled": false, "key": "sort", "value": "project_count" }, { "disabled": false, "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7b1c591e-91d0-48d7-86e5-8193b0ee5e24", "name": "One page of packages in use across every project the caller can read. 'In use' means present in a project's latest succeeded scan; a project whose newest scan attempt failed still contributes its last succeeded one.", "originalRequest": { "url": { "path": [ "v1", "inventory", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"component_id\": \"fad7b3f0-1716-2ce1-b0f6-264aff68b619\",\n \"name\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\",\n \"project_count\": 4463,\n \"version_count\": 8612,\n \"severity_max\": \"high\",\n \"vulnerability_count\": 3400,\n \"license_category_max\": \"conditional\",\n \"eol\": true,\n \"outdated\": true,\n \"versions\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"component_id\": \"f49659a2-0260-3fcc-359e-2f58d9cb8c98\",\n \"name\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\",\n \"project_count\": 9328,\n \"version_count\": 4093,\n \"severity_max\": \"info\",\n \"vulnerability_count\": 2381,\n \"license_category_max\": \"unknown\",\n \"eol\": true,\n \"outdated\": true,\n \"versions\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"total\": 4884,\n \"limit\": 9860,\n \"offset\": 986\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60960a01-2959-4f4c-a496-a9ed862f6097", "name": "No / invalid bearer token.", "originalRequest": { "url": { "path": [ "v1", "inventory", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97b8b448-892c-4f23-94e8-2d88a91fd026", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "inventory", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d62cd1b0-6de6-41da-ac6b-26cba579ec3f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "inventory", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7201aeb9-4ea8-4398-8093-4ff9207aa4c4", "name": "The filtered inventory as CSV", "request": { "name": "The filtered inventory as CSV", "description": { "content": "The same rows the list endpoint would return, without the paging.\n\nThe scope is the caller's own: the list service resolves which teams the\nactor can read and the export calls that same service, so a member of one\nteam never receives another team's packages.\n\n``sort``/``order`` are still accepted and validated but no longer decide\nthe exported rows' order (#463): the export walks a fixed key (the\ncomponent id) instead, since this is the org-wide rollup, the export\nmost likely to reach a depth where ``OFFSET``'s cost matters.", "type": "text/plain" }, "url": { "path": [ "v1", "inventory", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "package_type", "value": "string" }, { "disabled": false, "key": "package_type", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "eol", "value": "true" }, { "disabled": false, "key": "outdated", "value": "true" }, { "disabled": false, "key": "sort", "value": "project_count" }, { "disabled": false, "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "951c9272-ebfd-4609-8ead-c807aef02682", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43faa81d-29c2-4cd1-81e0-c6ab1e79c663", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ad1aa08-7e8d-43d0-b449-4d4fd9144321", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16816583-7e4d-4682-a3ed-27392c4a3a04", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "sort", "value": "project_count" }, { "key": "order", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25ce2e34-39be-412d-b16c-ec140026f2ca", "name": "Projects using a component", "request": { "name": "Projects using a component", "description": {}, "url": { "path": [ "v1", "inventory", "components", ":component_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ae13716e-d662-4012-9314-5eb987ac47a3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", ":component_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"project_id\": \"68cb262f-cd27-99fa-f63e-6c70145b092a\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"version\": \"string\",\n \"direct\": false,\n \"scan_id\": \"bffee3a8-bf6a-ade9-fd84-16301de156a7\",\n \"scanned_at\": \"1980-02-13T23:11:31.301Z\"\n },\n {\n \"project_id\": \"4020250d-2320-2684-07ff-4abb35240e99\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"version\": \"string\",\n \"direct\": false,\n \"scan_id\": \"0b656d10-1c32-3b88-c1bb-cdbb9309e9f4\",\n \"scanned_at\": \"1991-12-15T12:22:09.189Z\"\n }\n ],\n \"total\": 3979,\n \"limit\": 6254,\n \"offset\": 1296\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52a30870-9a50-4d4d-84a4-2a6e0c4d82ee", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", ":component_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c9d5a46-43ff-4f36-9b8f-85a5cc15eebc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", ":component_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2deb60ab-4981-448d-8460-4e754ed68e87", "name": "The component does not exist, or none of the caller's projects use it. The two are deliberately indistinguishable.", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", ":component_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36a54763-e133-409a-922e-b71da30c1c34", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "inventory", "components", ":component_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f3b1b91-0123-4822-aecb-6411fce3d1fd", "name": "Projects affected by a CVE", "request": { "name": "Projects affected by a CVE", "description": {}, "url": { "path": [ "v1", "inventory", "vulnerabilities", ":external_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9d6ce9ee-fdd1-4778-9410-694af89e72e3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "inventory", "vulnerabilities", ":external_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"external_id\": \"string\",\n \"severity\": \"info\",\n \"items\": [\n {\n \"project_id\": \"b9f4e4fd-50b6-6412-7ff9-fdb62396ede1\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_name\": \"string\",\n \"purl\": \"string\",\n \"version\": \"string\",\n \"finding_id\": \"c8d6a4ca-a836-80c9-6754-7e3477172121\",\n \"status\": \"string\",\n \"severity\": \"none\"\n },\n {\n \"project_id\": \"8b122ac4-e170-3329-36e7-82f88fae55f7\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_name\": \"string\",\n \"purl\": \"string\",\n \"version\": \"string\",\n \"finding_id\": \"64463e45-f29e-8900-5d9e-cbef3582ec8e\",\n \"status\": \"string\",\n \"severity\": \"critical\"\n }\n ],\n \"total\": 2221,\n \"limit\": 3120,\n \"offset\": 6445\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e046e25d-316d-4233-a006-7cd215efec71", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "inventory", "vulnerabilities", ":external_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7f54d19-9757-4dc5-bc50-8db26b1b9919", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "inventory", "vulnerabilities", ":external_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf8ca3b6-a887-41b8-a93b-b8260e444c23", "name": "The CVE does not exist, or affects none of the caller's projects. The two are deliberately indistinguishable.", "originalRequest": { "url": { "path": [ "v1", "inventory", "vulnerabilities", ":external_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ef9f295-6455-4a7e-a694-7f109b0a6b5e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "inventory", "vulnerabilities", ":external_id", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "external_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "60066de4-ae5e-421a-a8d8-1d70b5a55db0", "name": "license-policies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0ea01e83-c936-41ce-a6cd-aed9084d6d00", "name": "Paginated list of license policies visible to the caller", "request": { "name": "Paginated list of license policies visible to the caller", "description": {}, "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "organization_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c3f2ee6b-171c-4cc2-9ba1-8bced7769df6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"3596705a-ac7e-f3b0-8f86-b6cee76b8c1c\",\n \"organization_id\": \"99c7d0b2-c950-264b-6f63-a514f8095da3\",\n \"team_id\": \"99ec8626-63cd-8525-58d0-09805683daed\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": false,\n \"key_1\": 1345.4123659943095\n },\n {\n \"key_0\": 2225\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"enabled\": true,\n \"created_by_user_id\": \"53141aa4-9b49-c7db-8b59-16d0197a294c\",\n \"created_at\": \"1957-09-20T03:46:27.482Z\",\n \"updated_at\": \"1998-12-12T11:36:33.494Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": 18.140861078104198\n },\n {\n \"key_0\": true,\n \"key_1\": \"string\"\n }\n ]\n },\n {\n \"id\": \"40d48091-cf86-0c0a-4235-b16fe9312726\",\n \"organization_id\": \"edc41a4a-3bcc-9794-d1d9-e0d11626e7ea\",\n \"team_id\": \"5c9056ab-4317-35d9-c162-1feefbe61234\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 1211\n },\n {\n \"key_0\": true\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\"\n },\n \"enabled\": true,\n \"created_by_user_id\": \"ca27a12c-6ae8-ef4b-84e9-e1584cce7788\",\n \"created_at\": \"1951-11-27T03:03:10.611Z\",\n \"updated_at\": \"1971-01-02T00:55:38.582Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": 1109,\n \"key_2\": 1595.1199733761734\n },\n {\n \"key_0\": false\n }\n ]\n }\n ],\n \"total\": 4892,\n \"page\": 6776,\n \"page_size\": 2360\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "516f7226-781c-4e64-ae91-f6e3e83fe799", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "322b20c0-c6a3-4ee2-bc6c-f02a69972083", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bc45d8d-0bf6-4b5b-9391-5622e287e864", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "588bb6c3-8dbe-4540-aa4f-47894f57a087", "name": "Read the org-default license policy (super_admin)", "request": { "name": "Read the org-default license policy (super_admin)", "description": {}, "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "755cb766-0058-4005-8bbc-0aa50917dfd5", "name": "The org-default policy.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f1d1f063-99a5-9b0b-c081-f85a58f99b14\",\n \"organization_id\": \"261290c5-a864-f1ce-9140-258808c38ac4\",\n \"team_id\": \"21e4b55d-cb58-0b0e-a150-4039fc632248\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 5092.835247611556,\n \"key_1\": \"string\"\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\"\n },\n \"enabled\": false,\n \"created_by_user_id\": \"cdcbfe45-4a76-734c-a5ec-3cb070971a4c\",\n \"created_at\": \"1984-05-04T01:30:14.677Z\",\n \"updated_at\": \"1968-07-10T01:23:03.067Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": false,\n \"key_1\": true\n },\n {\n \"key_0\": 7105.979160144091,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "183dbfd5-e614-44dd-a9af-e38ccb9bc957", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b7f2416-4c45-475d-9b80-d6e2557a597d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c3ab9a9-f6a9-4c11-a605-ca57efd74cf5", "name": "No org default, or non-super-admin existence-hide.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2483a44d-b5c6-4859-a00f-8f8bcdbc8390", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79a279b1-92ba-4184-95a3-423b59881909", "name": "Create or update the org-default license policy (super_admin)", "request": { "name": "Create or update the org-default license policy (super_admin)", "description": {}, "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\",\n \"key_1\": \"least_restrictive\",\n \"key_2\": \"most_restrictive\",\n \"key_3\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"2008-02-06T10:40:54.929Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1988-11-02T10:04:10.260Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1978-07-16T17:22:20.183Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2022-11-18T03:30:02.194Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7d387e2f-6721-449b-b443-09bed3dcdb42", "name": "Org-default policy created or updated.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f1d1f063-99a5-9b0b-c081-f85a58f99b14\",\n \"organization_id\": \"261290c5-a864-f1ce-9140-258808c38ac4\",\n \"team_id\": \"21e4b55d-cb58-0b0e-a150-4039fc632248\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 5092.835247611556,\n \"key_1\": \"string\"\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\"\n },\n \"enabled\": false,\n \"created_by_user_id\": \"cdcbfe45-4a76-734c-a5ec-3cb070971a4c\",\n \"created_at\": \"1984-05-04T01:30:14.677Z\",\n \"updated_at\": \"1968-07-10T01:23:03.067Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": false,\n \"key_1\": true\n },\n {\n \"key_0\": 7105.979160144091,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3312134-8f0b-4dff-ac35-80d1cb6cd93c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "619933d6-ca5a-4647-975d-53578d2e1419", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1b16def-755d-46e3-afca-ec9715682e62", "name": "Not found (non-super-admin existence-hide).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87a6baa4-a26e-46e0-af89-22e7e78a15d3", "name": "An org-default policy already exists (race).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "864d4c38-8bae-4ecb-b765-d18a00ae06f9", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e61a146-d5bf-4e56-9fa8-f7be4c721e13", "name": "Reset (delete) a team's license policy", "request": { "name": "Reset (delete) a team's license policy", "description": {}, "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "25144a24-dd9f-479b-9854-36fce34a0a4b", "name": "Policy deleted; team falls back to org default / static.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b377abd9-503a-41a4-9e18-d383d27f1b58", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8583793-34b4-46a8-b4a1-1d0ca58a70c5", "name": "Caller is not a team_admin of this team.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33a83e8b-ab5c-4aef-8dcd-577fec1dfff5", "name": "Team or policy not found (existence-hidden).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0df3daed-da76-43bb-9cd3-070770f110a4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "570c2c57-2b64-43e5-89fd-15fd08f01df3", "name": "Read the effective license policy for a team", "request": { "name": "Read the effective license policy for a team", "description": {}, "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db0557df-d1cc-4bd5-8e15-63a0253682f2", "name": "The effective policy (team override, else org default).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f1d1f063-99a5-9b0b-c081-f85a58f99b14\",\n \"organization_id\": \"261290c5-a864-f1ce-9140-258808c38ac4\",\n \"team_id\": \"21e4b55d-cb58-0b0e-a150-4039fc632248\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 5092.835247611556,\n \"key_1\": \"string\"\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\"\n },\n \"enabled\": false,\n \"created_by_user_id\": \"cdcbfe45-4a76-734c-a5ec-3cb070971a4c\",\n \"created_at\": \"1984-05-04T01:30:14.677Z\",\n \"updated_at\": \"1968-07-10T01:23:03.067Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": false,\n \"key_1\": true\n },\n {\n \"key_0\": 7105.979160144091,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39b0c8e-8673-4a35-aa96-f95c8bc1d28a", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf10b1fd-8506-45bd-b372-638bd6e17caa", "name": "Caller is not a member of this team.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e72c539-dd9b-4dba-92dc-de4af5cac6c8", "name": "No enabled policy applies (the team falls back to the static catalog).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b9e92f8-a4cd-4a2b-bf42-b2f6c3fe93f3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86b238cb-b0c9-4525-aed1-c2ede6d3def6", "name": "Create or update a team's license policy", "request": { "name": "Create or update a team's license policy", "description": {}, "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\",\n \"key_1\": \"least_restrictive\",\n \"key_2\": \"most_restrictive\",\n \"key_3\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"2008-02-06T10:40:54.929Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1988-11-02T10:04:10.260Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1978-07-16T17:22:20.183Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2022-11-18T03:30:02.194Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23acb13d-29ae-45b4-9fa9-907ab13fe5e1", "name": "Policy created or updated (idempotent upsert).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f1d1f063-99a5-9b0b-c081-f85a58f99b14\",\n \"organization_id\": \"261290c5-a864-f1ce-9140-258808c38ac4\",\n \"team_id\": \"21e4b55d-cb58-0b0e-a150-4039fc632248\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 5092.835247611556,\n \"key_1\": \"string\"\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\"\n },\n \"enabled\": false,\n \"created_by_user_id\": \"cdcbfe45-4a76-734c-a5ec-3cb070971a4c\",\n \"created_at\": \"1984-05-04T01:30:14.677Z\",\n \"updated_at\": \"1968-07-10T01:23:03.067Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": false,\n \"key_1\": true\n },\n {\n \"key_0\": 7105.979160144091,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5de649e-1b6f-49f8-a82e-de2e3443ba9b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0398f028-6908-492c-8c35-190545e32c58", "name": "Caller is not a team_admin of this team.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15a1c6c3-76c2-4c65-830e-993100799c66", "name": "Team not found (existence-hidden).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7cd2e15f-5f1a-45f0-9b68-221e8ec7a12c", "name": "Uniqueness conflict on the (org, team) scope.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8d2f3d1-99bd-4338-8d54-abeb00f218d1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category_overrides\": {\n \"key_0\": \"conditional\",\n \"key_1\": \"forbidden\",\n \"key_2\": \"allowed\",\n \"key_3\": \"conditional\",\n \"key_4\": \"allowed\"\n },\n \"compound_operator_strategy\": {\n \"key_0\": \"most_restrictive\"\n },\n \"enabled\": true,\n \"license_exceptions\": [\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1987-06-20T03:21:38.694Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1986-03-21T08:55:45.280Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-22T07:53:34.578Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-04-04T17:46:42.243Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7594a062-a045-4b1f-a6dd-26814b0c8bcc", "name": "Un-waive (remove a license_exceptions entry from the team policy)", "request": { "name": "Un-waive (remove a license_exceptions entry from the team policy)", "description": {}, "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "spdx_id", "value": "string", "description": "(Required) " }, { "disabled": false, "key": "component_purl", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1e89fc01-9d62-4992-abf2-3281a6b48577", "name": "Exception removed (idempotent — no-op if absent).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spdx_id", "value": "string" }, { "key": "component_purl", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f1d1f063-99a5-9b0b-c081-f85a58f99b14\",\n \"organization_id\": \"261290c5-a864-f1ce-9140-258808c38ac4\",\n \"team_id\": \"21e4b55d-cb58-0b0e-a150-4039fc632248\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 5092.835247611556,\n \"key_1\": \"string\"\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\"\n },\n \"enabled\": false,\n \"created_by_user_id\": \"cdcbfe45-4a76-734c-a5ec-3cb070971a4c\",\n \"created_at\": \"1984-05-04T01:30:14.677Z\",\n \"updated_at\": \"1968-07-10T01:23:03.067Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": false,\n \"key_1\": true\n },\n {\n \"key_0\": 7105.979160144091,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05779184-69f0-4d7b-a38f-18e31be3cb4f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spdx_id", "value": "string" }, { "key": "component_purl", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08fd1a23-a005-42dc-968e-7f0a95c409fa", "name": "Caller is not a team_admin of this team.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spdx_id", "value": "string" }, { "key": "component_purl", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6e3a855-762a-45da-91f3-76e39b6225bc", "name": "Team or policy not found.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spdx_id", "value": "string" }, { "key": "component_purl", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "943addc7-c5fc-476a-b7b6-8bdbe2c6a14f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "spdx_id", "value": "string" }, { "key": "component_purl", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e852365-7a3f-4c97-b783-88eb7d0242a0", "name": "Waive a license (add a license_exceptions entry to the team policy)", "request": { "name": "Waive a license (add a license_exceptions entry to the team policy)", "description": {}, "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1947-02-22T06:56:48.230Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f5c91b0f-51dd-4fd3-9eb1-56e53c368d99", "name": "Exception added/updated (idempotent on spdx_id+purl).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1947-02-22T06:56:48.230Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f1d1f063-99a5-9b0b-c081-f85a58f99b14\",\n \"organization_id\": \"261290c5-a864-f1ce-9140-258808c38ac4\",\n \"team_id\": \"21e4b55d-cb58-0b0e-a150-4039fc632248\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": 5092.835247611556,\n \"key_1\": \"string\"\n }\n ],\n \"unknown_license_category\": \"string\",\n \"compound_operator_strategy\": {\n \"key_0\": \"string\"\n },\n \"enabled\": false,\n \"created_by_user_id\": \"cdcbfe45-4a76-734c-a5ec-3cb070971a4c\",\n \"created_at\": \"1984-05-04T01:30:14.677Z\",\n \"updated_at\": \"1968-07-10T01:23:03.067Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": false,\n \"key_1\": true\n },\n {\n \"key_0\": 7105.979160144091,\n \"key_1\": \"string\",\n \"key_2\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "799bffea-7fde-404d-9fdd-151d4355d93c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1947-02-22T06:56:48.230Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d15d8774-855d-4589-9e27-0bb733037dfe", "name": "Caller is not a team_admin of this team.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1947-02-22T06:56:48.230Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "583e20b6-f361-4e4c-bb9c-c522c7ac8444", "name": "Team not found (existence-hidden).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1947-02-22T06:56:48.230Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7624624-65ea-44cb-84b0-ce80dd792b5f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1947-02-22T06:56:48.230Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a6ca2408-01c1-40cd-89f1-6dd0d7a9f4a0", "name": "licenses", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5063580e-bc14-4f2a-8e94-25cd81e8e2a6", "name": "License finding drawer payload (404 if invisible to caller)", "request": { "name": "License finding drawer payload (404 if invisible to caller)", "description": {}, "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f2c1d13a-950a-4867-9b2b-f5f04d49e526", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"6529436c-341b-1990-d1bc-a68307610392\",\n \"license_id\": \"b8bfce6c-4e0d-5955-c1f2-64ce1deca651\",\n \"name\": \"string\",\n \"category\": \"unknown\",\n \"finding_kind\": \"declared\",\n \"created_at\": \"1990-07-31T18:55:57.873Z\",\n \"updated_at\": \"2011-04-02T06:50:07.409Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"4dfec7c0-1fe5-41e7-3c61-90b6c67f07e4\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"kind\": \"detected\",\n \"source_path\": \"string\"\n },\n {\n \"component_version_id\": \"9cc40ae4-5e8a-04cb-f8ed-a311fd37677a\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"kind\": \"declared\",\n \"source_path\": \"string\"\n }\n ],\n \"affected_components_total\": 0,\n \"affected_components_truncated\": false,\n \"is_deprecated_license_id\": false,\n \"is_fsf_libre\": false,\n \"is_osi_approved\": false,\n \"ort_match\": {\n \"key_0\": true\n },\n \"osori\": {\n \"name\": \"string\",\n \"notification_required\": true,\n \"restrictions\": [\n \"string\",\n \"string\"\n ],\n \"source\": \"OSORI (olis.or.kr), ODC-By 1.0\",\n \"source_disclosure\": \"string\"\n },\n \"reference_url\": \"string\",\n \"review_flag\": \"behavioral_use\",\n \"spdx_id\": \"string\",\n \"summary\": \"string\",\n \"summary_ko\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52b0dec1-5050-4cd0-a42a-c1bf631c82a9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f2616c3-bed6-4e12-aba3-2bf45a11d7a2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "576c211b-1f76-4243-a670-7202acf43d04", "name": "Finding does not exist, or exists in a team the caller cannot access. Returned in lieu of 403 to avoid leaking existence.", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f5b5270-95e4-4010-932a-c35affed7a88", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e208e7f5-2654-4f9f-be80-f2ea865a9520", "name": "Per-license rows + category distribution for the project's latest scan", "request": { "name": "Per-license rows + category distribution for the project's latest scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "licenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" }, { "disabled": false, "key": "category", "value": "string" }, { "disabled": false, "key": "category", "value": "string" }, { "disabled": false, "key": "kind", "value": "string" }, { "disabled": false, "key": "kind", "value": "string" }, { "disabled": false, "key": "search", "value": "string" }, { "disabled": false, "key": "sort", "value": "category" }, { "disabled": false, "key": "order", "value": "desc" }, { "disabled": false, "key": "review_flag", "value": "behavioral_use", "description": "Filter to licenses carrying an AI review flag (Phase D). behavioral_use = RAIL/Llama/Gemma/Falcon community licenses; non_commercial = CC-BY-NC…. Omit to list all licenses." }, { "disabled": false, "key": "conflict", "value": "conditional", "description": "Filter to licenses carrying this outbound-conflict verdict (gap #27). Matches nothing when the project declares no outbound license, since nothing is assessed without one. Omit to list all." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b8ad0940-c5bc-441e-a17a-4e40bf3ffb94", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"952b7cf3-19f9-8a9c-77c9-219be8f2f227\",\n \"license_id\": \"22e4b1bb-8c27-9782-9060-2fe9b2f5bd84\",\n \"name\": \"string\",\n \"category\": \"forbidden\",\n \"kind\": \"concluded\",\n \"affected_count\": 8531,\n \"sample_finding_id\": \"cf8ba200-fc32-9d4f-81ec-11e97b8c22fa\",\n \"conflict\": {\n \"value\": \"\"\n },\n \"is_fsf_libre\": false,\n \"is_osi_approved\": false,\n \"review_flag\": \"non_commercial\",\n \"spdx_id\": \"string\",\n \"summary\": \"string\",\n \"summary_ko\": \"string\"\n },\n {\n \"id\": \"9465d57f-c9db-9ac7-ce4d-e96e279889c9\",\n \"license_id\": \"073c4aa2-b395-088b-3cea-7b2cd0cc7b87\",\n \"name\": \"string\",\n \"category\": \"allowed\",\n \"kind\": \"concluded\",\n \"affected_count\": 2987,\n \"sample_finding_id\": \"8af86328-5c91-2b2f-6f48-56e6cd385df0\",\n \"conflict\": {\n \"value\": \"\"\n },\n \"is_fsf_libre\": false,\n \"is_osi_approved\": false,\n \"review_flag\": \"behavioral_use\",\n \"spdx_id\": \"string\",\n \"summary\": \"string\",\n \"summary_ko\": \"string\"\n }\n ],\n \"distribution\": {\n \"allowed\": 0,\n \"conditional\": 0,\n \"forbidden\": 0,\n \"unknown\": 0\n },\n \"total\": 5744,\n \"conflict_summary\": {\n \"compatible\": 0,\n \"conditional\": 0,\n \"incompatible\": 0,\n \"unknown\": 0\n },\n \"declared_license\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44fae626-a794-4f93-8231-8689d5cf590e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b12c6daa-75fc-439d-8bd4-81cea998ffce", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b028ee8-0d74-47b6-861e-6f5384ca1af4", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4a6684f-7545-4bf6-afa7-8b5b59f3a573", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a370d887-9740-4d05-b400-de3956d2131d", "name": "The filtered license list as CSV", "request": { "name": "The filtered license list as CSV", "description": { "content": "The same rows the list endpoint would return, without the paging.\n\nFilters are applied by the list service itself rather than by a second\nquery, so the file and the screen cannot disagree, and the cross-team\ncheck the list performs is the one this performs.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "licenses", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "category", "value": "string" }, { "disabled": false, "key": "category", "value": "string" }, { "disabled": false, "key": "kind", "value": "string" }, { "disabled": false, "key": "kind", "value": "string" }, { "disabled": false, "key": "search", "value": "string" }, { "disabled": false, "key": "sort", "value": "category" }, { "disabled": false, "key": "order", "value": "desc" }, { "disabled": false, "key": "review_flag", "value": "behavioral_use" }, { "disabled": false, "key": "conflict", "value": "conditional" }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "76fca5bd-18b6-44bb-abbe-1b4c7a46f751", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bda30980-73ec-4d91-83f1-1f86da62ad2c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45e7579b-9688-4a6a-918b-45daf470e3be", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3762dbf-f36c-4ee6-a156-286eed9c1cc5", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a8483c5-b724-44e9-975e-411ad09b58e7", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "licenses", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "review_flag", "value": "behavioral_use" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4cdf0da4-4d6a-4e0b-a7c9-19fe690fa269", "name": "notice-templates", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2d97c7f6-1a30-4e72-99e5-313fb431e3ce", "name": "Remove the organization's NOTICE template for one format", "request": { "name": "Remove the organization's NOTICE template for one format", "description": {}, "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8e4bd3b3-e7a3-4ce9-8429-cb6930afdfce", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7e46273-a770-4324-bd71-fcf14dad10af", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cf872ac-e631-438d-8852-20cd7a8ce686", "name": "Only a super admin may write NOTICE templates.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8c1c22d-5117-4d18-8e35-8219ac970857", "name": "The organization has written no template for this format.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "939ce258-6218-4850-97b2-c6e25f88401d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1142fa3a-effa-4bb2-be67-09875f7419d6", "name": "Read the organization's NOTICE template for one format", "request": { "name": "Read the organization's NOTICE template for one format", "description": {}, "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "19185b46-84fe-4a4e-acc5-44f86c5af5b1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"d8dc1721-e671-4237-e81e-5498ee20f15d\",\n \"organization_id\": \"fb4ebcc0-4ea6-1394-7578-de2bb12c462b\",\n \"format\": \"string\",\n \"created_at\": \"2006-10-07T08:46:48.595Z\",\n \"updated_at\": \"1986-07-29T14:36:14.610Z\",\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73a11ab7-a9c9-476c-b222-5adb6ea856c9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08150d74-5490-4149-88e5-324c15f73548", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af1c8db-9bd3-46cd-b4b1-92def895d668", "name": "The organization has written no template for this format.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45453640-9d3c-4a14-b178-e01080046a32", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fedd923c-bd07-4d12-807c-add339c16cda", "name": "Create or replace the organization's NOTICE template for one format", "request": { "name": "Create or replace the organization's NOTICE template for one format", "description": {}, "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b94e816f-a0f4-4982-8893-3ae340bdb3a2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"d8dc1721-e671-4237-e81e-5498ee20f15d\",\n \"organization_id\": \"fb4ebcc0-4ea6-1394-7578-de2bb12c462b\",\n \"format\": \"string\",\n \"created_at\": \"2006-10-07T08:46:48.595Z\",\n \"updated_at\": \"1986-07-29T14:36:14.610Z\",\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67b31e3a-880d-4bf9-a1ce-2b13aa0b56a1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3fbb9fc-66fc-412d-9bc2-7e04f889641a", "name": "Only a super admin may write NOTICE templates.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "beec386d-9ca4-467f-b3aa-d28f427b2f81", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8d2b357-7f0c-4fe4-a5d9-65d4e5944cdb", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "text", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8ebb394d-ab2f-4b6f-be4e-b3bf84ce501c", "name": "notifications", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d1aac1cf-a628-4b6a-9f88-7cee3d385a0d", "name": "Organization-wide rules", "request": { "name": "Organization-wide rules", "description": {}, "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3d8a17d5-c60c-4244-ba8f-ac474988657f", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"3eb23f8b-187b-0ec9-a493-ab3c183a4023\",\n \"organization_id\": \"66d81063-6d40-e044-5002-cde0c6adfca7\",\n \"team_id\": \"5e8825de-3245-77dc-3755-9e9416d02956\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"ac419c3c-894e-4bc0-0d14-2425663747a8\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": false,\n \"created_at\": \"1986-11-06T08:24:50.968Z\",\n \"updated_at\": \"1953-12-26T20:01:06.069Z\"\n },\n {\n \"id\": \"e2e101fa-0bc6-3516-f50c-c8cbe5fa2a28\",\n \"organization_id\": \"7f2d598e-6ee1-ce30-22a4-929f1625e960\",\n \"team_id\": \"3e3b0f10-1842-a027-a02f-48503b32f2fe\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d29a211d-d31b-fb51-bbf0-7304d8ed3f64\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"1959-12-09T08:40:26.689Z\",\n \"updated_at\": \"1980-12-20T09:37:56.828Z\"\n }\n ],\n \"total\": 940\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ee572b4-441a-4e46-bf85-4e1123e128f3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd8a111f-3315-427e-977d-9f844f777e86", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77cc6e6d-aac8-4ebb-a327-738285e1e651", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e62d4e5f-ae67-4efa-9929-a64b1720db4f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90796a86-41da-474c-9471-af319e95f1b3", "name": "Add an organization-wide rule", "request": { "name": "Add an organization-wide rule", "description": {}, "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"oL6ViLpHvHzmC@sKlsUTBSLWRkZjrqmRbiXCxpaa.zcvw\",\n \"KFGfssNsP4BzmIy@dVQWPvsraBQzimV.obew\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"32fbee20-9afd-9fbc-becd-414dbe0be6bc\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7987dc5d-bc75-43b0-aea3-43526e25dbd4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"97600d18-544c-1c68-4b77-e367cd0ddcac\",\n \"organization_id\": \"5f46926b-eb4f-1fa3-7e67-033d81de3869\",\n \"team_id\": \"a5da23af-3cfd-dc38-3172-5eaf97dc2902\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"e927346d-2679-b4aa-2406-2703fae762e5\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"2020-01-23T08:26:25.281Z\",\n \"updated_at\": \"1992-01-23T19:26:17.666Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5662973-ac8e-451d-993c-c99b594371ef", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6fe6c88-9409-47c5-bb55-d376eeef2911", "name": "Only a super admin writes at this scope.", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "85f5d39b-70e5-471f-b25c-6784383cbc26", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55a4a231-7d7f-4d57-afd7-bdcc063a7e9e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a14842d-1b1b-40f8-80e9-d9de06fd4f93", "name": "Rules that reach one team, including the organization's own", "request": { "name": "Rules that reach one team, including the organization's own", "description": {}, "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4238725f-57f3-487f-b451-395e6618221a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"3eb23f8b-187b-0ec9-a493-ab3c183a4023\",\n \"organization_id\": \"66d81063-6d40-e044-5002-cde0c6adfca7\",\n \"team_id\": \"5e8825de-3245-77dc-3755-9e9416d02956\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"ac419c3c-894e-4bc0-0d14-2425663747a8\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": false,\n \"created_at\": \"1986-11-06T08:24:50.968Z\",\n \"updated_at\": \"1953-12-26T20:01:06.069Z\"\n },\n {\n \"id\": \"e2e101fa-0bc6-3516-f50c-c8cbe5fa2a28\",\n \"organization_id\": \"7f2d598e-6ee1-ce30-22a4-929f1625e960\",\n \"team_id\": \"3e3b0f10-1842-a027-a02f-48503b32f2fe\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d29a211d-d31b-fb51-bbf0-7304d8ed3f64\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"1959-12-09T08:40:26.689Z\",\n \"updated_at\": \"1980-12-20T09:37:56.828Z\"\n }\n ],\n \"total\": 940\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ca7dc52-daa1-4a38-ae50-0383a1bce996", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da86b6d4-5a0f-4d0f-bd9b-e5635d5528d7", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13fadbff-ccf4-4d28-8bfb-629a071444fd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c8d1cf-77dd-41c4-8e94-36f9254a4740", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b09d207a-c404-4095-aca0-fe8b50a41841", "name": "Add a rule for one team", "request": { "name": "Add a rule for one team", "description": {}, "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"oL6ViLpHvHzmC@sKlsUTBSLWRkZjrqmRbiXCxpaa.zcvw\",\n \"KFGfssNsP4BzmIy@dVQWPvsraBQzimV.obew\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"32fbee20-9afd-9fbc-becd-414dbe0be6bc\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b28a2d2f-571a-4642-b09d-bd50fb27c4e6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"97600d18-544c-1c68-4b77-e367cd0ddcac\",\n \"organization_id\": \"5f46926b-eb4f-1fa3-7e67-033d81de3869\",\n \"team_id\": \"a5da23af-3cfd-dc38-3172-5eaf97dc2902\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"e927346d-2679-b4aa-2406-2703fae762e5\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"2020-01-23T08:26:25.281Z\",\n \"updated_at\": \"1992-01-23T19:26:17.666Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8a5aa6f-e92c-46e7-9e4e-a56a80ccb2ae", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe3d3610-b839-4933-9065-d15ea956c5b2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb9a5694-ed91-43c0-8b55-d058f81926d1", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9121b6c3-f28e-4dc2-a5be-f614dd245484", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"str\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"sxra@kZSfwQyg.tr\",\n \"Pf-ZiN-qG02@gPzFJYLVeRQqibiuZQMSIBOFTqAstBssq.aqmu\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"d3129730-ba7b-ea59-fef5-5f624bfdf574\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd5c9b89-1cc4-4fa2-b6d5-ad5d57bfbfe7", "name": "Remove a rule", "request": { "name": "Remove a rule", "description": {}, "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "31a9f428-dac1-b960-8359-0024d5e646f6", "key": "rule_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bbe5fde4-513e-437a-89e4-dab112427add", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "31a9f428-dac1-b960-8359-0024d5e646f6", "key": "rule_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6de9000d-b54f-44cf-9234-65333382bbc2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "31a9f428-dac1-b960-8359-0024d5e646f6", "key": "rule_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c86b1086-be23-4462-81a4-4643058551e8", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "31a9f428-dac1-b960-8359-0024d5e646f6", "key": "rule_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2307496-9059-4c3a-904c-f17b0ff46d47", "name": "No such rule, or not the caller's to remove.", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "31a9f428-dac1-b960-8359-0024d5e646f6", "key": "rule_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbc386de-0536-40fe-8f5d-a423c389137e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "31a9f428-dac1-b960-8359-0024d5e646f6", "key": "rule_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77ab4f1d-42d1-4722-8b78-ac2b3188f69c", "name": "Paginated list of notifications for the authenticated user", "request": { "name": "Paginated list of notifications for the authenticated user", "description": {}, "url": { "path": [ "v1", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unread_only", "value": "false" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "86046932-3981-4bec-bab3-5d1ccb491cf1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unread_only", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"3a85d2de-b2a4-e7c0-dd7a-c15ab561d169\",\n \"kind\": \"scan_failed\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"link\": \"string\",\n \"target_table\": \"string\",\n \"target_id\": \"a744c50e-6cf0-c454-f1f0-43f7d068ae3e\",\n \"read_at\": \"1984-10-27T06:14:25.085Z\",\n \"created_at\": \"1970-05-25T16:38:10.783Z\"\n },\n {\n \"id\": \"64bd3521-6ba5-e7c6-55e3-dceda3e217a8\",\n \"kind\": \"scan_completed\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"link\": \"string\",\n \"target_table\": \"string\",\n \"target_id\": \"94092e23-6efa-8514-6802-6962f44e5bd7\",\n \"read_at\": \"1960-04-01T02:53:47.633Z\",\n \"created_at\": \"1955-07-18T09:04:58.707Z\"\n }\n ],\n \"total\": 955,\n \"unread_count\": 4437,\n \"page\": 771,\n \"page_size\": 6181\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0bfaa7e-1330-4fd9-aca8-1f787fb1b61f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unread_only", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bb8faa1-4ef2-4f84-82c6-e419efac0a1a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unread_only", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64cb7652-a9ad-453f-838a-043f0ddf4187", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unread_only", "value": "false" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "926597d1-076d-4a05-a8a5-ec79e2b7a603", "name": "Mark all of the caller's unread notifications as read", "request": { "name": "Mark all of the caller's unread notifications as read", "description": {}, "url": { "path": [ "v1", "notifications", "read-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3fd22e9d-8f1e-4f25-a684-bbe587af4e78", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notifications", "read-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "PATCH", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "775a9628-56a6-4309-bea1-bbf3fe5f650d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notifications", "read-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcdf37fc-60d2-48aa-a194-b9ff4d17cf99", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notifications", "read-all" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bcb0c66-fc02-4696-86e2-ad10e42cb5fe", "name": "Unread notification count for the authenticated user (bell badge)", "request": { "name": "Unread notification count for the authenticated user (bell badge)", "description": {}, "url": { "path": [ "v1", "notifications", "unread-count" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3ae42b70-f120-4384-af00-bbaadc4a1111", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notifications", "unread-count" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 4425\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0bc0188-9678-4591-8750-682f4377b03f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notifications", "unread-count" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a8622f1-68ef-4dcd-aa99-455ef2d9d149", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notifications", "unread-count" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88782802-c818-4efd-ab34-62597ef95e78", "name": "Mark a single notification as read (idempotent)", "request": { "name": "Mark a single notification as read (idempotent)", "description": {}, "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1ec34092-49c2-a77c-e35e-aef6bfde416d", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a28a99f7-65de-431a-ae21-c0bc06e81336", "name": "Marked as read (or was already read — idempotent).", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1ec34092-49c2-a77c-e35e-aef6bfde416d", "key": "notification_id", "description": "(Required) " } ] }, "method": "PATCH", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55c9d4e5-3a13-44ff-927e-0938333ec442", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1ec34092-49c2-a77c-e35e-aef6bfde416d", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c12d60-da35-43e7-9df2-6b1c15be25de", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1ec34092-49c2-a77c-e35e-aef6bfde416d", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4652722e-1822-45c9-a3ad-33b47857956d", "name": "Notification does not exist OR belongs to a different user (existence-hide).", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1ec34092-49c2-a77c-e35e-aef6bfde416d", "key": "notification_id", "description": "(Required) " } ] }, "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa80d1df-258b-4b7e-b1ec-63bc010453f6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1ec34092-49c2-a77c-e35e-aef6bfde416d", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f12e4cf9-b55f-4fed-aad8-1dafedcc23b6", "name": "organization-verdicts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4a8b9e2e-9deb-4831-8ccd-52d664fcda79", "name": "What this project is judged by for this component", "request": { "name": "What this project is judged by for this component", "description": {}, "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "10f45875-1938-4020-82b2-a042ce878473", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"5c2d175b-6de9-5294-f29d-246e15007575\",\n \"component_id\": \"98504cf9-3341-4dbb-c50a-facd1f80fffd\",\n \"scope\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59371101-9e0b-4730-91a4-734f2d7f3e67", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84c47b1b-35b0-48ee-83e0-31ee8e010110", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72660e9-bde0-4dba-9dc7-0c827c1dc038", "name": "The project does not exist, or the caller is not a member of its team. Returned in lieu of 403 so membership does not leak.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bad5f528-0611-4966-b4ec-0322a6282a81", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "0151bb35-f189-a8e5-104e-a03289cc64f5", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "108e1d7c-9274-428d-aba7-e904cb8169ba", "name": "The organization's rulings, newest first", "request": { "name": "The organization's rulings, newest first", "description": { "content": "Rulings for one organization, readable by anybody inside it.\n\nWhat each caller sees is not the same. The published reason goes to\neverybody, because it is what explains an inherited status on their own\nscreen. The deliberation around it, and the names of the people involved,\ngo only to callers who could have written them: a note an administrator\nmade while deciding is not part of explaining the outcome.", "type": "text/plain" }, "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8516112c-2ec2-4619-9c58-dfaf66c4201e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"e32a6d23-3233-6c15-9c07-9529f17464f1\",\n \"organization_id\": \"9b942d01-3c2a-c776-06bb-051de2bf083a\",\n \"component_id\": \"db12735a-3b6e-8ef7-91da-b40a2fc13ae1\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"1963-07-29T08:53:29.563Z\",\n \"version\": 6594,\n \"created_at\": \"2019-07-08T21:29:31.193Z\",\n \"updated_at\": \"1983-11-06T18:15:59.870Z\"\n },\n {\n \"id\": \"ddbaa197-370d-6ca3-2393-2bbe8750f354\",\n \"organization_id\": \"2c387279-b2d7-b34c-c841-3f72bd834f71\",\n \"component_id\": \"7918305f-0a76-286d-648e-c67f1b9a71c0\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"1981-03-21T19:31:13.192Z\",\n \"version\": 1908,\n \"created_at\": \"2004-05-11T01:01:03.483Z\",\n \"updated_at\": \"1961-10-13T02:11:36.007Z\"\n }\n ],\n \"total\": 4754,\n \"page\": 1,\n \"page_size\": 50\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90c7e75f-6c2a-44cb-afd9-99f7d6868ee3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd857c9-4d3b-4eba-b27c-1248cfb0635e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "066c7688-b8ff-436b-9300-5df110236efa", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d4eaa5c-a1e9-4874-815d-9f5542625cc1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ea10438-3b97-4ffc-ad6d-855353787176", "name": "Start an organization-wide ruling on a component", "request": { "name": "Start an organization-wide ruling on a component", "description": {}, "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"component_id\": \"8ad363fe-a98b-410f-accb-a1f16b4763e5\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "95541c38-71f2-4c4b-aa06-c338f8c56564", "name": "Ruling opened. No project changes until it is decided.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"8ad363fe-a98b-410f-accb-a1f16b4763e5\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8f5693ab-5045-bc3c-60a1-4ca317a2bc0b\",\n \"organization_id\": \"d3fa5a47-f957-8251-2958-855128789a9b\",\n \"component_id\": \"f6473351-c6a6-4dee-99ba-4ff124915766\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"2013-08-18T07:27:07.280Z\",\n \"version\": 4462,\n \"created_at\": \"1978-08-05T22:05:45.107Z\",\n \"updated_at\": \"1953-08-05T00:49:58.116Z\",\n \"decided_by_user_id\": \"5921d996-e011-fd97-2c05-e9ce66034157\",\n \"decision_note\": \"string\",\n \"requested_by_user_id\": \"a7898172-1fec-5116-e4f8-9d543eeda8ef\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001f1086-d5e3-4f5f-9b8d-5b1d847877e0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"8ad363fe-a98b-410f-accb-a1f16b4763e5\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b31804c-6919-42e5-bf00-28caea5dc9a3", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"8ad363fe-a98b-410f-accb-a1f16b4763e5\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62ba71a5-11d3-4151-b52c-1e27357c5fe8", "name": "The caller is not a deployment administrator. 404 rather than 403, matching the other administrator surfaces: whether the route exists is not something to confirm by status code.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"8ad363fe-a98b-410f-accb-a1f16b4763e5\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "173e2f94-e95c-4705-b57b-54a5f972c216", "name": "A ruling on this component is already being worked on.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"8ad363fe-a98b-410f-accb-a1f16b4763e5\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6b13fbb-33cd-4a66-adfa-3e8c20fbe13b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"8ad363fe-a98b-410f-accb-a1f16b4763e5\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b141ea3-aa17-433b-83e0-e951602c6170", "name": "Move an organization ruling along", "request": { "name": "Move an organization ruling along", "description": {}, "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "98d0f990-668c-40b3-9179-66086c60f626", "name": "Ruling moved. The new version is returned as the ETag.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8f5693ab-5045-bc3c-60a1-4ca317a2bc0b\",\n \"organization_id\": \"d3fa5a47-f957-8251-2958-855128789a9b\",\n \"component_id\": \"f6473351-c6a6-4dee-99ba-4ff124915766\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"2013-08-18T07:27:07.280Z\",\n \"version\": 4462,\n \"created_at\": \"1978-08-05T22:05:45.107Z\",\n \"updated_at\": \"1953-08-05T00:49:58.116Z\",\n \"decided_by_user_id\": \"5921d996-e011-fd97-2c05-e9ce66034157\",\n \"decision_note\": \"string\",\n \"requested_by_user_id\": \"a7898172-1fec-5116-e4f8-9d543eeda8ef\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66c082b0-1c7d-4aac-a87f-a6f94da14861", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da6831bd-c584-4f10-aa0a-5c2842018524", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0b166c3-810a-45ca-b294-be88c0dcf0c6", "name": "No such ruling, or the caller does not administer the deployment.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "43949890-5c25-4e95-8af8-ce2825526a4e", "name": "The ruling is decided; open a new one to change it.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1b52c5b-e1f7-4fbc-bfe5-9b50dd37bff8", "name": "The If-Match version is stale; reload and retry.", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af379e09-b206-48df-a2de-3e4b0ba849e6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bc71a875-02fc-a06a-d4f6-f395657b7468", "key": "verdict_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "249a22b6-4953-4a85-8bd3-b00ee40b00a2", "name": "projects", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "359ccccf-fc2e-482a-b10b-286b2f17cfce", "name": "List projects visible to the caller", "request": { "name": "List projects visible to the caller", "description": {}, "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "include_archived", "value": "false" }, { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "business_unit", "value": "string", "description": "Narrow to one owning part of the organization. Omitted or blank leaves every project in, including the ones that have not set it." }, { "disabled": false, "key": "distribution_model", "value": "string", "description": "Narrow to one distribution model, or 'unset' for the projects that have not said how they ship. Omitted leaves every project in." }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6ba180d8-9351-4db5-a1cb-386cf0447f82", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"26f90f5b-efa6-5080-958f-967381129154\",\n \"team_id\": \"3971fc40-0e68-1f45-1bf1-972fdf5ddabb\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"organization\",\n \"archived_at\": \"2025-08-25T12:51:23.629Z\",\n \"created_by_user_id\": \"fb941383-765f-a46e-464e-ce3f92a01f6a\",\n \"latest_scan_id\": \"e4235aa0-0498-bca5-f5c5-2c176209984c\",\n \"created_at\": \"1997-12-01T00:42:25.237Z\",\n \"updated_at\": \"1967-11-23T13:26:14.973Z\",\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"created_by_user_name\": \"string\",\n \"declared_license\": \"string\",\n \"distribution_model\": \"embedded\",\n \"group_path\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"1981-02-11T22:17:15.151Z\",\n \"latest_scan_status\": \"cancelled\",\n \"license_category_summary\": {\n \"value\": \"\"\n },\n \"owner_contact\": \"string\",\n \"release_count\": 0,\n \"scan_count\": 0,\n \"severity_summary\": {\n \"value\": \"\"\n },\n \"team_name\": \"string\"\n },\n {\n \"id\": \"5fdae093-f41d-6f7c-0815-5b6149e4e769\",\n \"team_id\": \"a62a6fc6-56bf-aa80-6b63-ce4e8047a996\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"organization\",\n \"archived_at\": \"1962-07-02T10:08:37.440Z\",\n \"created_by_user_id\": \"12b7612c-9afa-d210-25f8-cac372b5fbae\",\n \"latest_scan_id\": \"8fb0b060-cf21-7cd5-0461-0c4ec82f98b9\",\n \"created_at\": \"1993-02-07T15:33:42.643Z\",\n \"updated_at\": \"1965-08-06T12:02:27.592Z\",\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"created_by_user_name\": \"string\",\n \"declared_license\": \"string\",\n \"distribution_model\": \"binary\",\n \"group_path\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"2003-03-31T15:34:24.049Z\",\n \"latest_scan_status\": \"running\",\n \"license_category_summary\": {\n \"value\": \"\"\n },\n \"owner_contact\": \"string\",\n \"release_count\": 0,\n \"scan_count\": 0,\n \"severity_summary\": {\n \"value\": \"\"\n },\n \"team_name\": \"string\"\n }\n ],\n \"total\": 6395,\n \"page\": 4206,\n \"size\": 1736\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a10c6a-4ec8-4aad-a109-79ed163d1238", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3770bf7c-f251-485b-bf57-f4908b7c4a30", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7440faea-8edf-4287-b372-299ac4133b27", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95962dec-547b-43f9-8705-5c46a6db81a4", "name": "Create a project (auth required, role >= developer)", "request": { "name": "Create a project (auth required, role >= developer)", "description": {}, "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"team_id\": \"8f0c1e2a-...your team UUID...\",\n \"name\": \"checkout-service\",\n \"slug\": \"checkout-service\",\n \"description\": \"Storefront checkout service\",\n \"git_url\": \"https://github.com/acme/checkout-service.git\"\n}" } }, "response": [ { "id": "a85e195e-5d18-4feb-a0c0-27e2ff0d48c2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"7794cb14-aa1b-199b-3584-66066a5d2cb9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"redistribute\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"internal\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a43beb3f-3c6c-badc-47a4-3ea050ead29d\",\n \"team_id\": \"1484c5a8-2d9a-e58f-7966-91aa53013744\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"team\",\n \"archived_at\": \"1986-01-04T08:17:42.918Z\",\n \"created_by_user_id\": \"c2229fde-8137-0360-a889-0bb30c8cc42b\",\n \"latest_scan_id\": \"9d8d1a0e-6b65-3237-82dd-056720a40ec2\",\n \"created_at\": \"1980-10-17T05:45:36.937Z\",\n \"updated_at\": \"1996-02-13T13:32:45.441Z\",\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"created_by_user_name\": \"string\",\n \"declared_license\": \"string\",\n \"distribution_model\": \"embedded\",\n \"group_path\": [\n {\n \"id\": \"e8dd90cc-c642-ea13-b1a0-f00997d35ccb\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"8d1e87f3-6dab-0803-9b44-5f86cabe5e98\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"1978-04-12T03:28:02.262Z\",\n \"latest_scan_status\": \"cancelled\",\n \"license_category_summary\": {\n \"allowed\": 0,\n \"conditional\": 0,\n \"forbidden\": 0,\n \"unknown\": 0\n },\n \"owner_contact\": \"string\",\n \"release_count\": 0,\n \"scan_count\": 0,\n \"severity_summary\": {\n \"critical\": 0,\n \"high\": 0,\n \"low\": 0,\n \"medium\": 0\n },\n \"team_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "339e1a43-788b-4d88-b2b7-599b293004f2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"7794cb14-aa1b-199b-3584-66066a5d2cb9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"redistribute\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"internal\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d3d659b-85a9-40b6-a875-d11863997232", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"7794cb14-aa1b-199b-3584-66066a5d2cb9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"redistribute\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"internal\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8343598-153a-49af-97b7-9a8f993731c0", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"7794cb14-aa1b-199b-3584-66066a5d2cb9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"redistribute\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"internal\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Carries the new project's id into the scan-trigger and", "// SBOM-download requests below.", "const body = pm.response.json();", "if (body.id) {", " pm.collectionVariables.set(\"projectId\", body.id);", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3c5a194-ed7c-46bd-ac28-066e23a28e9b", "name": "The filtered project portfolio list as CSV", "request": { "name": "The filtered project portfolio list as CSV", "description": { "content": "The same rows the list endpoint would return, without the paging.\n\nFilters and team-scoping are applied by ``list_projects`` itself rather\nthan by a second query, so the file and the screen cannot disagree.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "disabled": false, "key": "include_archived", "value": "false" }, { "disabled": false, "key": "q", "value": "string" }, { "disabled": false, "key": "business_unit", "value": "string" }, { "disabled": false, "key": "distribution_model", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c366986b-b188-4292-a680-ce1e0c74caa0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "10918186-9f34-4463-9c61-689eb0719a48", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4032dae9-a513-44f0-8112-8a46a069dbcf", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e75b9488-3b4b-4f76-8879-fc5152b098c5", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "include_archived", "value": "false" }, { "key": "q", "value": "string" }, { "key": "business_unit", "value": "string" }, { "key": "distribution_model", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f537cf97-d026-4161-ba9c-45559690feb1", "name": "Archive (soft-delete) the project (developer and above)", "request": { "name": "Archive (soft-delete) the project (developer and above)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "913f4d36-b83d-4b1f-b8a9-a3a794147cdc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "891a784a-667b-4149-9f03-82cb9b89d286", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9692e5a0-5cd2-4419-a698-a611cb5d7d54", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60f2581a-c015-4575-a9ab-a5b98b40e853", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16bafacc-6a0b-4db3-9e94-2e9d2f063935", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c770271-c21d-43ac-a0a6-8a675e459c06", "name": "Read one project (IDOR-safe; 403 if not a team member)", "request": { "name": "Read one project (IDOR-safe; 403 if not a team member)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "03e02e5e-1b98-44af-b11d-bd9448711e1d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a43beb3f-3c6c-badc-47a4-3ea050ead29d\",\n \"team_id\": \"1484c5a8-2d9a-e58f-7966-91aa53013744\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"team\",\n \"archived_at\": \"1986-01-04T08:17:42.918Z\",\n \"created_by_user_id\": \"c2229fde-8137-0360-a889-0bb30c8cc42b\",\n \"latest_scan_id\": \"9d8d1a0e-6b65-3237-82dd-056720a40ec2\",\n \"created_at\": \"1980-10-17T05:45:36.937Z\",\n \"updated_at\": \"1996-02-13T13:32:45.441Z\",\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"created_by_user_name\": \"string\",\n \"declared_license\": \"string\",\n \"distribution_model\": \"embedded\",\n \"group_path\": [\n {\n \"id\": \"e8dd90cc-c642-ea13-b1a0-f00997d35ccb\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"8d1e87f3-6dab-0803-9b44-5f86cabe5e98\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"1978-04-12T03:28:02.262Z\",\n \"latest_scan_status\": \"cancelled\",\n \"license_category_summary\": {\n \"allowed\": 0,\n \"conditional\": 0,\n \"forbidden\": 0,\n \"unknown\": 0\n },\n \"owner_contact\": \"string\",\n \"release_count\": 0,\n \"scan_count\": 0,\n \"severity_summary\": {\n \"critical\": 0,\n \"high\": 0,\n \"low\": 0,\n \"medium\": 0\n },\n \"team_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f682464-d21e-4ad8-b2da-8a669f6b818b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bdeac9e-c024-44bc-9358-1067d40a6ac5", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f9a3a6b-3052-4fd8-a76f-28e4655d6d77", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6175e6b-777d-474e-a96f-627d4787ec8e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3a76702-088b-41aa-a649-5f83bf89322e", "name": "Update mutable project fields (role >= team_admin)", "request": { "name": "Update mutable project fields (role >= team_admin)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"saas\",\n \"git_credential\": \"string\",\n \"git_url\": \"string\",\n \"name\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"organization\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f8c74012-a711-4536-ab93-4b481e6c603d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"saas\",\n \"git_credential\": \"string\",\n \"git_url\": \"string\",\n \"name\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"organization\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a43beb3f-3c6c-badc-47a4-3ea050ead29d\",\n \"team_id\": \"1484c5a8-2d9a-e58f-7966-91aa53013744\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"team\",\n \"archived_at\": \"1986-01-04T08:17:42.918Z\",\n \"created_by_user_id\": \"c2229fde-8137-0360-a889-0bb30c8cc42b\",\n \"latest_scan_id\": \"9d8d1a0e-6b65-3237-82dd-056720a40ec2\",\n \"created_at\": \"1980-10-17T05:45:36.937Z\",\n \"updated_at\": \"1996-02-13T13:32:45.441Z\",\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"created_by_user_name\": \"string\",\n \"declared_license\": \"string\",\n \"distribution_model\": \"embedded\",\n \"group_path\": [\n {\n \"id\": \"e8dd90cc-c642-ea13-b1a0-f00997d35ccb\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"8d1e87f3-6dab-0803-9b44-5f86cabe5e98\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"1978-04-12T03:28:02.262Z\",\n \"latest_scan_status\": \"cancelled\",\n \"license_category_summary\": {\n \"allowed\": 0,\n \"conditional\": 0,\n \"forbidden\": 0,\n \"unknown\": 0\n },\n \"owner_contact\": \"string\",\n \"release_count\": 0,\n \"scan_count\": 0,\n \"severity_summary\": {\n \"critical\": 0,\n \"high\": 0,\n \"low\": 0,\n \"medium\": 0\n },\n \"team_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f84ad3-907f-4f81-afb0-3ce65b066b20", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"saas\",\n \"git_credential\": \"string\",\n \"git_url\": \"string\",\n \"name\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"organization\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b36d3341-faac-4744-a252-bdbe12340922", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"saas\",\n \"git_credential\": \"string\",\n \"git_url\": \"string\",\n \"name\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"organization\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbd28cd0-720f-4c3a-aa0c-452bf8c07eed", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"saas\",\n \"git_credential\": \"string\",\n \"git_url\": \"string\",\n \"name\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"organization\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a237a20-4922-447b-a1f4-cf841f85e494", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"saas\",\n \"git_credential\": \"string\",\n \"git_url\": \"string\",\n \"name\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"organization\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "330f3cbc-779d-4fda-9707-40bdc62e2cc2", "name": "People this project's work may be assigned to", "request": { "name": "People this project's work may be assigned to", "description": { "content": "Who may be named as the owner of a finding or an obligation here.\n\nAddressed by project rather than by team because that is what a caller\nholds: the screen is a project's finding list, and asking it for a team id\nwould mean handing out team ids to look work up by. The team is derived\nhere, and access is the project's own rule.\n\n``developer`` for the same reason the assignment PATCH is: a caller who may\nperform an assignment has to be able to compose one, and a list gated\nhigher would leave the write reachable only by somebody who already knew\nthe id.\n\nThe set is exactly what ``services.assignee`` will accept, because both go\nthrough one predicate rather than two copies of three conditions.\n\nA premise the group-hierarchy cascade broke, and this PR closed\n------------------------------------------------------------------------\nDeriving the team from the project used to be safe because reaching a\nproject meant being on its team, full stop. A later change made\n``get_project`` above cascade-aware (it now runs its team gate through\n``core.authz.assert_team_access`` / ``can_access_group``, same as every\nother single-resource surface), so that premise no longer holds\nunconditionally: with the cascade flag on, an actor can reach\n``get_project`` through an ANCESTOR group's direct membership, without\nbeing a direct member of ``project.team_id`` itself.\n\n``services.assignee`` (the picker below, and the write-time eligibility\ncheck the assignment PATCH uses) already anticipated this: PR 2-C widened\nit to the project's team's ancestors when\n:func:`core.config.group_cascade_enabled` is on, specifically so this\nroute would not need a second, coordinated change once ``get_project``\nitself was cascaded. It was. So this route's set stays exactly what\n``services.assignee`` accepts, in both flag states, with no change needed\nhere.\n\nOrganization-wide visibility (a *different* widening, not the group\ncascade) would still end the \"reaching a project means being on its\nteam\" premise for ``get_project`` itself. Somebody on another team could\nthen read the project, and this route would hand them its members,\nwhich is the enumeration the tests here refuse. Whoever enables it has\nto decide what this endpoint does: most likely keep it on team\nmembership rather than on project access, since being allowed to read a\nproject's findings is not the same as being allowed to list the people\non it.\n\n``core.authz.team_scope_filter`` carries a pointer back here, because\nthat is the file the change lands in.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "20f488f5-36d3-4a84-a277-838366689f0a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"members\": [\n {\n \"user_id\": \"b92ed47b-e2b2-7313-7c16-afb66236252d\",\n \"full_name\": \"string\"\n },\n {\n \"user_id\": \"e0bc1326-596e-7f01-8219-ad1ffb4345e4\",\n \"full_name\": \"string\"\n }\n ],\n \"total\": 5416\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89004873-0ff0-4ff7-9328-1fcaf498c6fa", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18950050-b8f5-4eff-8dc0-2c0b48e90d84", "name": "Caller is not on the team that owns the project. Matches the project read above rather than the finding PATCH's 404: reaching this needs a project id the caller already has.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81c8c0bc-6f7b-4680-ac41-c7a42a1bba0a", "name": "No such project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f3ea238-bd88-44b1-831b-2cb16d32341c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a6b2932-0d5c-4dca-8d5f-bf55e9013af1", "name": "Paginated component list for the project's latest scan", "request": { "name": "Paginated component list for the project's latest scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" }, { "disabled": false, "key": "search", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "direct", "value": "true", "description": "W2 #31 — Direct/Transitive toggle. ``true`` keeps only direct deps (graph depth 1), ``false`` only transitive (or graph-less) deps. Omit to include both. commercial-SCA equivalent of the 'Dependency type' facet." }, { "disabled": false, "key": "dependency_scope", "value": "string", "description": "W2 #31 — commercial-SCA-style 'Usage' facet. Repeatable; accepted values: ``required``, ``optional``, ``unspecified`` (the NULL-scope bucket — common for SBOMs that don't encode scope). Unknown values are dropped, so a query that filters only by unknown values returns an empty page (not a 422). Omit to include all." }, { "disabled": false, "key": "dependency_scope", "value": "string", "description": "W2 #31 — commercial-SCA-style 'Usage' facet. Repeatable; accepted values: ``required``, ``optional``, ``unspecified`` (the NULL-scope bucket — common for SBOMs that don't encode scope). Unknown values are dropped, so a query that filters only by unknown values returns an empty page (not a 422). Omit to include all." }, { "disabled": false, "key": "eol", "value": "true", "description": "Phase M — end-of-life facet. ``true`` keeps only components whose release cycle is past its published end-of-life (endoflife.date); ``false`` keeps everything else, including untracked components. Omit to include both. Boolean mirrors the KEV filter UX." }, { "disabled": false, "key": "outdated", "value": "true", "description": "Version-currency facet (sibling of the EOL filter). ``true`` keeps only components behind the newest patch of their release line (endoflife.date); ``false`` keeps everything else, including current, unknown and untracked components. Omit to include both. Boolean mirrors the KEV filter UX." }, { "disabled": false, "key": "malicious", "value": "true", "description": "Known-malicious facet (#26). ``true`` keeps only components the vendored OSV MAL- snapshot lists as published-to-attack; ``false`` keeps everything else, INCLUDING components that were never assessed. Omit to include both. Note the asymmetry with ``eol``: this axis is not a vulnerability — a flagged package is removed and its reachable credentials rotated, not upgraded — so it creates no finding and never enters severity counts." }, { "disabled": false, "key": "sort", "value": "name" }, { "disabled": false, "key": "order", "value": "asc" }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0a6909b6-f8cc-4dcc-8185-955be29d624d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"f4543814-0474-0bc8-0d31-2e93853cc76f\",\n \"component_id\": \"6045046e-0012-599e-877b-2d237418681b\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"license_category\": \"allowed\",\n \"severity_max\": \"critical\",\n \"vulnerability_count\": 6959,\n \"currency_latest\": \"string\",\n \"currency_state\": \"unknown\",\n \"dependency_scope\": \"required\",\n \"depth\": 3067,\n \"direct\": false,\n \"eol_date\": \"1952-08-08\",\n \"eol_state\": \"unknown\",\n \"license\": \"string\",\n \"malicious_id\": \"string\",\n \"malicious_source\": \"string\",\n \"malicious_state\": \"flagged\",\n \"purl\": \"string\"\n },\n {\n \"id\": \"c9d3d3dd-8371-816d-9095-e4d15b222cb6\",\n \"component_id\": \"38184df4-2979-f507-3fa9-8606a1e7a7ad\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"license_category\": \"allowed\",\n \"severity_max\": \"none\",\n \"vulnerability_count\": 592,\n \"currency_latest\": \"string\",\n \"currency_state\": \"unknown\",\n \"dependency_scope\": \"required\",\n \"depth\": 494,\n \"direct\": false,\n \"eol_date\": \"2016-08-09\",\n \"eol_state\": \"eol\",\n \"license\": \"string\",\n \"malicious_id\": \"string\",\n \"malicious_source\": \"string\",\n \"malicious_state\": \"flagged\",\n \"purl\": \"string\"\n }\n ],\n \"total\": 8735,\n \"limit\": 9038,\n \"offset\": 3217\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "109b13e6-e771-42c9-b289-8a9f184335c7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "824885e3-edcf-4312-8683-f9be0639ba55", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0227d8e3-686e-47c6-b91d-c925a132a79a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c94b7a5-0367-4025-ab6d-9b94ed2a0f84", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f26384e3-1207-46f5-b1cd-820b0779c5f4", "name": "The filtered component list as CSV", "request": { "name": "The filtered component list as CSV", "description": { "content": "The same rows the list endpoint would return, without the paging.\n\nFilters are applied by the list service itself rather than by a second\nquery, so the file and the screen cannot disagree, and the cross-team\ncheck the list performs is the one this performs.\n\n``sort``/``order`` are still accepted and validated but no longer decide\nthe exported rows' order (#463): the export walks a fixed key (the\ncomponent_version id) instead, so a bill of materials that reaches real\ndepth does not pay for ``OFFSET``'s cost growing with it.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "direct", "value": "true" }, { "disabled": false, "key": "dependency_scope", "value": "string" }, { "disabled": false, "key": "dependency_scope", "value": "string" }, { "disabled": false, "key": "eol", "value": "true" }, { "disabled": false, "key": "outdated", "value": "true" }, { "disabled": false, "key": "malicious", "value": "true" }, { "disabled": false, "key": "sort", "value": "name" }, { "disabled": false, "key": "order", "value": "asc" }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a5058a65-3d0e-417c-8fb6-07ea66cc4f31", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bab12e8e-b3b5-4c0c-a288-d5fc2ff256be", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b90c6b-700e-43b5-a27c-876c69ff078e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22fedcf3-29df-4bb7-bd06-d65df532e6ec", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be5ab0a5-9a64-4d46-8244-5e6164e0ef18", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "components", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "direct", "value": "true" }, { "key": "dependency_scope", "value": "string" }, { "key": "dependency_scope", "value": "string" }, { "key": "eol", "value": "true" }, { "key": "outdated", "value": "true" }, { "key": "malicious", "value": "true" }, { "key": "sort", "value": "name" }, { "key": "order", "value": "asc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d1784d8-ec86-4455-9505-01f820a7b1be", "name": "Resolved dependency graph (nodes + edges) of a scan snapshot", "request": { "name": "Resolved dependency graph (nodes + edges) of a scan snapshot", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8045f683-c5a1-42c5-85ea-16034d4bf182", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scan_id\": \"d420d452-a6a8-2a44-60a6-bf2c7ef9368c\",\n \"node_count\": 4301,\n \"edge_count\": 2992,\n \"node_cap\": 8366,\n \"edges\": [\n {\n \"source\": \"string\",\n \"target\": \"string\"\n },\n {\n \"source\": \"string\",\n \"target\": \"string\"\n }\n ],\n \"nodes\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"purl\": \"string\",\n \"direct\": false,\n \"depth\": 7573,\n \"max_severity\": \"none\",\n \"namespace\": \"string\",\n \"vulnerability_count\": 0\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"purl\": \"string\",\n \"direct\": true,\n \"depth\": 4803,\n \"max_severity\": \"none\",\n \"namespace\": \"string\",\n \"vulnerability_count\": 0\n }\n ],\n \"truncated\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64f1edd9-56ad-4f8a-b5e7-b63e5b45b1e8", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ce92f1e-f9ee-42e1-a54d-1fcdc044d8d2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab88c2c5-64b3-4054-915c-2f332785b9af", "name": "Project does not exist, the caller is not a member of its owning team, or the pinned `scan_id` is not a succeeded scan of THIS project (nonexistent / another project's scan / non-succeeded — all existence-hidden behind one 404). Also returned when the project has no succeeded scan to read. RFC 7807 problem+json.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c335902-fcbf-49bd-bb01-3517b26a1840", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "797714bc-5db2-45ba-a42c-c64f96e43603", "name": "Diff two release snapshots (succeeded scans) of the project", "request": { "name": "Diff two release snapshots (succeeded scans) of the project", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "base", "value": "55393a3e-9799-85f3-bcc2-4577aa2abc14", "description": "(Required) Base snapshot scan id (typically the OLDER release, e.g. v0.1). Must belong to this project and be succeeded, else 404 (existence-hide)." }, { "disabled": false, "key": "target", "value": "d680596c-ab37-cde8-a69e-2fb1ba477eb5", "description": "(Required) Target snapshot scan id (typically the NEWER release, e.g. v0.2). Must belong to this project and be succeeded, else 404. `base == target` is allowed and yields an all-empty diff." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "817ddf7d-8e04-4196-aaa5-f0199cd42257", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "55393a3e-9799-85f3-bcc2-4577aa2abc14" }, { "key": "target", "value": "d680596c-ab37-cde8-a69e-2fb1ba477eb5" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"base\": {\n \"scan_id\": \"5e1fc9d3-1e38-bab1-5963-e841be115ded\",\n \"created_at\": \"1970-09-24T04:26:38.701Z\",\n \"release\": \"string\"\n },\n \"target\": {\n \"scan_id\": \"1f7c6aa6-1f1e-ff33-71a2-c589c7b93958\",\n \"created_at\": \"1959-07-26T13:54:09.357Z\",\n \"release\": \"string\"\n },\n \"components\": {\n \"added\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n },\n \"namespace\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n },\n \"namespace\": {\n \"value\": \"\"\n }\n }\n ],\n \"changed\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n },\n \"base_version\": {\n \"value\": \"\"\n },\n \"target_version\": {\n \"value\": \"\"\n },\n \"namespace\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n },\n \"base_version\": {\n \"value\": \"\"\n },\n \"target_version\": {\n \"value\": \"\"\n },\n \"namespace\": {\n \"value\": \"\"\n }\n }\n ],\n \"removed\": [\n {\n \"name\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n },\n \"namespace\": {\n \"value\": \"\"\n }\n },\n {\n \"name\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n },\n \"namespace\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"licenses\": {\n \"category_delta\": {\n \"conditional\": {\n \"value\": \"\"\n },\n \"permissive\": {\n \"value\": \"\"\n },\n \"prohibited\": {\n \"value\": \"\"\n },\n \"unknown\": {\n \"value\": \"\"\n }\n }\n },\n \"summary\": {\n \"component_count\": {\n \"base\": 0,\n \"target\": 0\n },\n \"gate\": {\n \"base\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n }\n },\n \"risk_score\": {\n \"base\": {\n \"value\": \"\"\n },\n \"target\": {\n \"value\": \"\"\n }\n },\n \"severity\": {\n \"critical\": {\n \"value\": \"\"\n },\n \"high\": {\n \"value\": \"\"\n },\n \"low\": {\n \"value\": \"\"\n },\n \"medium\": {\n \"value\": \"\"\n }\n }\n },\n \"truncated\": false,\n \"vulnerabilities\": {\n \"introduced\": [\n {\n \"cve_id\": {\n \"value\": \"\"\n },\n \"severity\": {\n \"value\": \"\"\n },\n \"component_name\": {\n \"value\": \"\"\n },\n \"component_version\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n }\n },\n {\n \"cve_id\": {\n \"value\": \"\"\n },\n \"severity\": {\n \"value\": \"\"\n },\n \"component_name\": {\n \"value\": \"\"\n },\n \"component_version\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n }\n }\n ],\n \"resolved\": [\n {\n \"cve_id\": {\n \"value\": \"\"\n },\n \"severity\": {\n \"value\": \"\"\n },\n \"component_name\": {\n \"value\": \"\"\n },\n \"component_version\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n }\n },\n {\n \"cve_id\": {\n \"value\": \"\"\n },\n \"severity\": {\n \"value\": \"\"\n },\n \"component_name\": {\n \"value\": \"\"\n },\n \"component_version\": {\n \"value\": \"\"\n },\n \"purl\": {\n \"value\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62826807-5e7e-4041-9c2f-9b7aecbcd805", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "55393a3e-9799-85f3-bcc2-4577aa2abc14" }, { "key": "target", "value": "d680596c-ab37-cde8-a69e-2fb1ba477eb5" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1006ee69-76bf-45c6-97c2-95d7c698e2a3", "name": "Caller is not a member of the project's owning team (super_admin bypasses). RFC 7807 problem+json.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "55393a3e-9799-85f3-bcc2-4577aa2abc14" }, { "key": "target", "value": "d680596c-ab37-cde8-a69e-2fb1ba477eb5" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3b0ab61-c95b-4812-a3a2-4dd1d582c313", "name": "Project does not exist, or one of `base`/`target` is not a succeeded scan of THIS project (existence-hidden: nonexistent / another project's scan / non-succeeded all collapse to the same 404). RFC 7807 problem+json.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "55393a3e-9799-85f3-bcc2-4577aa2abc14" }, { "key": "target", "value": "d680596c-ab37-cde8-a69e-2fb1ba477eb5" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "441de8fc-08ac-4a92-9834-15a4106f26c2", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "55393a3e-9799-85f3-bcc2-4577aa2abc14" }, { "key": "target", "value": "d680596c-ab37-cde8-a69e-2fb1ba477eb5" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66216bb9-a80e-4a78-b3b0-0f1874c982db", "name": "Risk score, gate verdict, KEV deadlines, approvals and trend (W17 band)", "request": { "name": "Risk score, gate verdict, KEV deadlines, approvals and trend (W17 band)", "description": { "content": "The governance band's payload — five signals the page already owns.\n\nEvery number is produced by the service that owns it elsewhere in the\nproduct (risk score, ``evaluate_gate``, the KEV bucket, the approvals\ncount), so the band cannot disagree with the tab below it. See\n``services.project_governance_service``.\n\nSame access contract as ``/overview``: a project on a team the caller does\nnot belong to is a 403 and a missing one a 404, both as problem+json.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "343bfa19-49e4-4401-a13c-5d72c8ce1295", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"bc9d3830-594c-fbea-5e7b-2bc1b04fc50f\",\n \"scanned\": false,\n \"risk_score\": 58.26072056275322,\n \"gate\": {\n \"critical_cve_count\": 321,\n \"forbidden_license_count\": 441,\n \"epss_gate_count\": 263,\n \"malicious_component_count\": 0,\n \"scan_id\": \"4a96fa18-cbab-f7ba-c2d2-7bcc65fc8fca\",\n \"status\": \"string\"\n },\n \"kev_sla\": {\n \"overdue\": 1209,\n \"due_soon\": 1053\n },\n \"pending_approvals\": 4873,\n \"trend\": [\n {\n \"scan_id\": \"f65f3a37-f72a-3963-aa89-b644cd35f4ab\",\n \"scanned_at\": \"2011-06-23T01:28:57.932Z\",\n \"critical\": 1212\n },\n {\n \"scan_id\": \"2d83ea4b-6f0d-632f-bf87-90d8f0846819\",\n \"scanned_at\": \"2025-09-02T12:46:18.604Z\",\n \"critical\": 800\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0af71f51-69a2-4d6b-9845-ff4dca034fd7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "885c2fb3-d7cd-4625-ad64-82045f1feeb9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "104c45b6-92ce-42e5-8344-768ff91cc560", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0da4c420-cfaa-41ed-88d5-63f14d2996e0", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f4011d5-6a88-4d2b-ab33-1c733e466320", "name": "Aggregated risk / scan picture for the project (Overview tab)", "request": { "name": "Aggregated risk / scan picture for the project (Overview tab)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a25e5eb6-7c01-4535-8b80-d2448529c7f4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"4101ab2a-5751-43a9-6594-67869c819c1c\",\n \"project_name\": \"string\",\n \"total_components\": 1016,\n \"risk_score\": 23.749145477892508,\n \"security_score\": 77.20091431002511,\n \"license_score\": 13.2996702993601,\n \"current_user_role\": \"viewer\",\n \"component_outcome\": \"string\",\n \"degraded_stages\": [\n {\n \"stage\": \"reachability\",\n \"reason\": \"no_components\",\n \"engine_detail\": \"string\"\n },\n {\n \"stage\": \"scancode\",\n \"reason\": \"unavailable\",\n \"engine_detail\": \"string\"\n }\n ],\n \"eol_count\": 0,\n \"has_git_credential\": false,\n \"last_scan_at\": \"2012-06-02T00:42:19.598Z\",\n \"last_succeeded_scan_at\": \"1990-01-03T03:27:40.317Z\",\n \"license_distribution\": {\n \"key_0\": 7657,\n \"key_1\": 173,\n \"key_2\": 198\n },\n \"license_lookup_gap\": {\n \"not_looked_up\": 4008,\n \"reason\": \"budget_exhausted\"\n },\n \"malicious_count\": 0,\n \"outdated_count\": 0,\n \"recent_scans\": [\n {\n \"id\": \"41b23486-55ae-46ab-fe1e-5e36c36a2bea\",\n \"kind\": \"string\",\n \"status\": \"string\",\n \"progress_percent\": 2855,\n \"started_at\": \"1948-01-14T06:00:31.966Z\",\n \"completed_at\": \"1982-12-04T13:00:05.006Z\",\n \"created_at\": \"1974-11-05T03:59:32.189Z\",\n \"ref\": \"string\",\n \"release\": \"string\"\n },\n {\n \"id\": \"ffa229b0-25a2-5be8-774e-3a6faf1f3aa4\",\n \"kind\": \"string\",\n \"status\": \"string\",\n \"progress_percent\": 4177,\n \"started_at\": \"2000-01-12T19:43:09.809Z\",\n \"completed_at\": \"2012-05-16T12:13:38.526Z\",\n \"created_at\": \"1977-05-05T03:19:33.648Z\",\n \"ref\": \"string\",\n \"release\": \"string\"\n }\n ],\n \"scancode_skipped_reason\": \"failed\",\n \"severity_distribution\": {\n \"key_0\": 3172,\n \"key_1\": 9745\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bca1524-c315-4b36-b91f-5809ed2e441d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4bad624-d08e-4106-a1dc-1fe97e6665f4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "091ef72d-828c-48aa-b60c-fb22701cf7cd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34f35821-028b-462c-b384-5b3346bc8f6b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7fbb0b8-feac-4f2f-9907-b3dfb3be2a5f", "name": "List the project's release snapshots (succeeded scans, newest-first)", "request": { "name": "List the project's release snapshots (succeeded scans, newest-first)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "size", "value": "20" }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version label filter (e.g. '4.0'), matched exactly against the scan's ``metadata.release`` with surrounding whitespace trimmed. This is the lookup for \"which snapshot is version 4.0?\": a label identifies at most one live snapshot, so the filtered list carries one row whose ``scan_id`` you then pin on the detail endpoints via ``?scan_id=``. An unknown label returns an empty list, not a 404." }, { "disabled": false, "key": "ref", "value": "string", "description": "Optional branch filter. Accepts a bare branch (``main``) or a fully-qualified ref (``refs/heads/main``, ``refs/pull/12/merge``), normalized the same way scan triggers normalize it, so a branch reaches its own snapshots either way." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ec5774bd-ea21-49e6-98b8-0195f4e9c421", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "release", "value": "string" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"component_count\": 42,\n \"created_at\": \"2026-05-22T10:00:00Z\",\n \"gate_status\": \"fail\",\n \"ref\": \"v1.2.3\",\n \"release\": \"v1.2.3\",\n \"risk_score\": 92.9,\n \"scan_id\": \"7822b62d-9156-423d-9df6-5e51f546fbe8\",\n \"severity_summary\": {\n \"critical\": 10,\n \"high\": 4,\n \"low\": 1,\n \"medium\": 2\n }\n }\n ],\n \"page\": 1,\n \"size\": 20,\n \"total\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e8450ab-cb7a-4480-8e82-13abb6d60037", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "release", "value": "string" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca25f174-2977-44da-b994-30bc6b5855fb", "name": "Caller is not a member of the project's owning team (super_admin bypasses). RFC 7807 problem+json.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "release", "value": "string" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62c820d1-ce11-4733-b343-61966a8c3b29", "name": "Project does not exist. RFC 7807 problem+json.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "release", "value": "string" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1abc406-a0ed-4f45-beba-b2aa42cf565b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "releases" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "release", "value": "string" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "225e1d41-6d2a-4fea-8644-e36330c6ca60", "name": "Trigger a scan for the project (queues a Celery task; returns 202 Accepted)", "request": { "name": "Trigger a scan for the project (queues a Celery task; returns 202 Accepted)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{projectId}}", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "options": { "raw": { "language": "json" } }, "raw": "{\n \"kind\": \"source\"\n}" } }, "response": [ { "id": "1ce260f5-9d40-40b5-a213-c949993dd5b3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"source\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"71d389b9-d220-9b3c-4322-dc670d4d5c61\",\n \"project_id\": \"e415d9ad-efb9-28d7-d98d-0678d770b3a2\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 2509,\n \"current_step\": \"string\",\n \"started_at\": \"2012-07-01T21:51:55.001Z\",\n \"completed_at\": \"2009-08-04T21:40:02.964Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"42c7c0bf-afaa-5b12-33ed-523a85612cbe\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2010-04-05T06:49:10.828Z\",\n \"updated_at\": \"1992-08-14T00:47:52.435Z\",\n \"metadata\": {\n \"key_0\": false\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1949-08-14T22:55:36.747Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d604a19-a9dd-4b6d-998d-f97bbb584242", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"source\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0d0f288-8bf0-4f31-8f74-6fad20290232", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"source\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b56968b8-1c7d-4317-b895-c7694e399ccb", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"source\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3211e253-fcae-4939-ace7-9cca5926ed39", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"source\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cc2eddd-12e7-4246-a99f-ad70777017be", "name": "Rate limited (too many triggers from this user) or the team's concurrent-scan cap is reached. RFC 7807 problem+json with a Retry-After header; the concurrency-cap variant adds a `limit` extension field and, when the deployment has queue-backlog metrics on, an `estimated_wait_seconds` extension field (S7). (The live per-team active-scan count is intentionally not exposed - see M1.)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"source\",\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Carries the scan id into whatever polls it next (not wired", "// to a request here: a scan runs for minutes, not something", "// this one-shot chain should block on).", "const body = pm.response.json();", "if (body.id) {", " pm.collectionVariables.set(\"scanId\", body.id);", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dbd077e7-8b80-49a7-81ec-5af2d9236e4e", "name": "Upload a .zip of local source for scanning (auth required, role >= developer)", "request": { "name": "Upload a .zip of local source for scanning (auth required, role >= developer)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "upload", "value": "string", "type": "text", "description": "(Required) A .zip archive of the project source tree." } ] } }, "response": [ { "id": "9bcc8902-ffc2-4b27-861e-f7220114c677", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A .zip archive of the project source tree.", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"archive_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68156917-870b-4cc1-9b62-e9997e4544d1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A .zip archive of the project source tree.", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a07dbace-bf76-49ae-87cc-84b1fee6dd1f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A .zip archive of the project source tree.", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "699ae150-3fdd-49a7-baab-ac4f69d0eccf", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A .zip archive of the project source tree.", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a9a75c-9d9a-416d-a776-14943911101d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A .zip archive of the project source tree.", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e21e881d-0568-4dfb-9ff7-12d204c365db", "name": "Whether this project's webhook is active (role >= team_admin)", "request": { "name": "Whether this project's webhook is active (role >= team_admin)", "description": { "content": "Configured or not, and for which provider. Never the secret.\n\nSplit from the issue route so the question a screen asks has an answer\nthat carries no credential bytes. There is no route that returns the\nsecret after issuance, and this is the one somebody would be tempted to\nadd it to.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1275a7cd-f6cc-47bd-a700-f7f1c5e5ea24", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"f2749975-d336-8441-89e6-a5ffe0906c2f\",\n \"configured\": true,\n \"provider\": \"gitlab\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b9090e8-a278-469e-820c-af80019c280f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5782ff0-3991-4aa7-985f-dddfaffcbf4c", "name": "Caller is not a team admin on the owning team.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd8dd3b6-f878-4e56-85c9-50d127105f17", "name": "No such project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b2832148-d9f4-4b35-bf55-83c5f8a7d293", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1c2eceb-c917-4f18-b045-42ad29cd47f3", "name": "Issue this project's webhook shared secret (role >= team_admin)", "request": { "name": "Issue this project's webhook shared secret (role >= team_admin)", "description": { "content": "Turn the webhook on, and hand back the secret once.\n\nThis replaced an operator running an UPDATE by hand. The column holds\nciphertext now and SQL cannot produce it, so the procedure had to move\ninto the product; having moved, it gets what the SQL never had, which is\na permission check, an audit row, and one path that sets both fields.\n\n``team_admin`` rather than ``developer``: this decides whether a repository\ncan make this deployment start scans, and it is the same level that edits\nthe project's other settings.\n\nCalling it again replaces the secret. The response says so in\n``replaced_existing``, because the old value stops being accepted the\nmoment this returns and the deliveries that were working will fail until\nthe new one reaches the SCM. Somebody who meant to read the current value\nand found there is no such route would otherwise learn this by breaking\ntheir own integration.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"provider\": \"gitlab\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "11cad6e2-eca4-4a20-ab04-bd7d6b343e21", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"gitlab\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"0d33d549-c7af-3032-c5c0-c34517c13c55\",\n \"provider\": \"gitlab\",\n \"issued_at\": \"1997-04-29T23:23:43.178Z\",\n \"replaced_existing\": false,\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3622eef0-b7db-424b-b538-6770fbefc5ab", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"gitlab\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d2e13b4-c614-4257-ab6d-71c9c86fd4ca", "name": "Caller is not a team admin on the owning team.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"gitlab\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d4c099b0-3af7-4562-871e-403ad049c1ac", "name": "No such project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"gitlab\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "86043a0a-997f-4581-b6ba-2a7c213f83b1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"gitlab\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b17ac59-61d5-48ac-91f2-b8371ebd06fe", "name": "The deployment's credential encryption key is unset or malformed, so no secret can be stored.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"gitlab\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99b78cb5-5878-47f0-8098-8c008d297131", "name": "Create many projects in one request (auth required, role >= developer)", "request": { "name": "Create many projects in one request (auth required, role >= developer)", "description": { "content": "Register a set of repositories as projects.\n\nRows are independent: one the caller may not create, or one whose slug the\nteam already uses, is reported and the rest still land. Onboarding an\norganization means creating a project per repository, and failing the whole\nrequest over a single repository would make that unusable.\n\nStatus is 201 when every row succeeded and 207 when any did not, so a\nscript can branch on the status line alone. A row whose project already\nexists counts as success: re-running to finish an interrupted onboarding is\nthe normal path, and reporting that as failure would make every re-run look\nbroken.", "type": "text/plain" }, "url": { "path": [ "v1", "projects:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"projects\": [\n {\n \"team_id\": \"7d53ce05-f5e9-368d-7855-3bebc79b6c25\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"internal\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "01f627b7-4d0f-4990-9ba9-acff4f83dad8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"projects\": [\n {\n \"team_id\": \"7d53ce05-f5e9-368d-7855-3bebc79b6c25\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"internal\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"all_succeeded\": true,\n \"total\": 3838,\n \"created\": 6570,\n \"already_existed\": 1602,\n \"failed\": 2384,\n \"rows\": [\n {\n \"index\": 8898,\n \"status\": \"forbidden\",\n \"detail\": \"string\",\n \"project_id\": \"0fcf484f-ec22-009e-06ca-efee16924aa1\",\n \"retry_after_seconds\": 6221,\n \"scan_id\": \"f15042f0-3046-c190-433e-a2ef91f3ffc0\"\n },\n {\n \"index\": 7436,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"f74262f5-5724-7e81-02f6-16cd31e26604\",\n \"retry_after_seconds\": 6958,\n \"scan_id\": \"66f537ef-f8ea-e9d2-f210-cfcc5d46e256\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 9871,\n \"key_1\": 3184,\n \"key_2\": 3651\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc171554-3fcf-461b-81d8-ddd0e5df8bb7", "name": "Some rows did not succeed. The body is the same shape; read `all_succeeded` and `failed_by_status`.", "originalRequest": { "url": { "path": [ "v1", "projects:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"projects\": [\n {\n \"team_id\": \"7d53ce05-f5e9-368d-7855-3bebc79b6c25\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"internal\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"all_succeeded\": true,\n \"total\": 3838,\n \"created\": 6570,\n \"already_existed\": 1602,\n \"failed\": 2384,\n \"rows\": [\n {\n \"index\": 8898,\n \"status\": \"forbidden\",\n \"detail\": \"string\",\n \"project_id\": \"0fcf484f-ec22-009e-06ca-efee16924aa1\",\n \"retry_after_seconds\": 6221,\n \"scan_id\": \"f15042f0-3046-c190-433e-a2ef91f3ffc0\"\n },\n {\n \"index\": 7436,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"f74262f5-5724-7e81-02f6-16cd31e26604\",\n \"retry_after_seconds\": 6958,\n \"scan_id\": \"66f537ef-f8ea-e9d2-f210-cfcc5d46e256\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 9871,\n \"key_1\": 3184,\n \"key_2\": 3651\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddebab6c-c667-48bd-b8f0-a9382264745b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"projects\": [\n {\n \"team_id\": \"7d53ce05-f5e9-368d-7855-3bebc79b6c25\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"internal\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cf06c98-2b97-4ad4-8ca5-23bfa6b68901", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"projects\": [\n {\n \"team_id\": \"7d53ce05-f5e9-368d-7855-3bebc79b6c25\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"internal\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0b234b3-0225-447f-9cba-9bba141a2360", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"projects\": [\n {\n \"team_id\": \"7d53ce05-f5e9-368d-7855-3bebc79b6c25\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"ai_usage_context\": \"internal\",\n \"business_unit\": \"string\",\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\n \"git_url\": \"string\",\n \"owner_contact\": \"string\",\n \"visibility\": \"team\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dae3fbca-6096-49a0-8737-31aa275b3524", "name": "compliance", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "336ce65a-cbcb-475e-871d-edffac5a1cd1", "name": "Unified Compliance grid (licenses × obligations) for the project's latest succeeded scan", "request": { "name": "Unified Compliance grid (licenses × obligations) for the project's latest succeeded scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" }, { "disabled": false, "key": "category", "value": "string", "description": "Filter rows by license category. Repeat the parameter to OR-join multiple values (e.g. ?category=forbidden&category=conditional)." }, { "disabled": false, "key": "category", "value": "string", "description": "Filter rows by license category. Repeat the parameter to OR-join multiple values (e.g. ?category=forbidden&category=conditional)." }, { "disabled": false, "key": "kind", "value": "string", "description": "Filter rows to licenses that carry at least one obligation of the given kind. Repeat to OR-join." }, { "disabled": false, "key": "kind", "value": "string", "description": "Filter rows to licenses that carry at least one obligation of the given kind. Repeat to OR-join." }, { "disabled": false, "key": "search", "value": "string", "description": "Substring match against SPDX id and license name. LIKE metacharacters are escaped server-side." }, { "disabled": false, "key": "has_obligations", "value": "true", "description": "When true, return only licenses that carry at least one obligation row. When false, return only licenses with NONE. Ignored when ``kind`` is also given." }, { "disabled": false, "key": "sort", "value": "category" }, { "disabled": false, "key": "order", "value": "desc" }, { "disabled": false, "key": "conflict", "value": "conditional", "description": "Filter to licenses carrying this outbound-conflict verdict (gap #27). Matches nothing when the project declares no outbound license, since nothing is assessed without one. Omit to list all." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "743d23e8-15bf-42ed-9638-5dfa19f7bf1d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "has_obligations", "value": "true" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"license_finding_id\": \"dc46dfb9-90b2-5ca1-d079-aeaa5e15bcfe\",\n \"license_id\": \"6c0f1f17-8f2c-e049-8f08-c55859c4f684\",\n \"license_name\": \"string\",\n \"category\": \"unknown\",\n \"kind\": \"declared\",\n \"affected_component_count\": 1731,\n \"affected_components\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"category_override_source\": \"string\",\n \"category_source\": \"static\",\n \"conflict\": {\n \"value\": \"\"\n },\n \"notice_required\": false,\n \"obligations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"spdx_id\": \"string\"\n },\n {\n \"license_finding_id\": \"e92ac946-55fb-a04f-7e24-eb8a5e2a6594\",\n \"license_id\": \"fc052e37-8367-db65-3e5e-2a4995e60bee\",\n \"license_name\": \"string\",\n \"category\": \"allowed\",\n \"kind\": \"concluded\",\n \"affected_component_count\": 2201,\n \"affected_components\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"category_override_source\": \"string\",\n \"category_source\": \"static\",\n \"conflict\": {\n \"value\": \"\"\n },\n \"notice_required\": false,\n \"obligations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"spdx_id\": \"string\"\n }\n ],\n \"distribution\": {\n \"allowed\": 0,\n \"conditional\": 0,\n \"forbidden\": 0,\n \"unknown\": 0\n },\n \"total\": 5558,\n \"limit\": 240,\n \"offset\": 6250,\n \"generated_at\": \"2016-07-25T03:54:15.646Z\",\n \"conflict_summary\": {\n \"compatible\": 0,\n \"conditional\": 0,\n \"incompatible\": 0,\n \"unknown\": 0\n },\n \"declared_license\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fa735cd-13fc-4092-a89e-59957d9f9779", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "has_obligations", "value": "true" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fb4f8cf-429c-4af7-8a7b-44bb1a2c9f33", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "has_obligations", "value": "true" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb29b7d9-a5c4-4ead-b779-b1a18f6b631a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "has_obligations", "value": "true" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f8721c1-89b8-49c5-b7a2-3df37d528c0f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "compliance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "search", "value": "string" }, { "key": "has_obligations", "value": "true" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "conflict", "value": "conditional" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2a35e36b-e867-44e1-9670-15b9c81829af", "name": "policy-gate", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0b3310d4-a552-4237-a1d3-643135adf300", "name": "Evaluate the build-gate verdict for the project's current-state scan", "request": { "name": "Evaluate the build-gate verdict for the project's current-state scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ref", "value": "string", "description": "Optional branch anchor: evaluate against the newest succeeded scan of this normalized git ref (``main``, ``pr-12``) instead of the project's main line. A CI job should pass its own ref so its verdict cannot be decided by a scan of a different branch. Exact: a ref with no succeeded scan yields the no-signal pass, never another branch's findings. Ignored when ``scan_id`` is given, which is more specific." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "74393f2a-0dee-463b-9da8-1f855c0b5a0e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"gate\": \"pass\",\n \"critical_cve_count\": 358,\n \"forbidden_license_count\": 395,\n \"project_id\": \"8cace4e1-6e85-874f-9d85-a3fd0fee78e6\",\n \"evaluated_at\": \"2023-09-09T08:16:21.115Z\",\n \"component_outcome\": \"string\",\n \"eol_gate_count\": 0,\n \"eol_gate_enabled\": false,\n \"eol_on_missing_data\": \"allow\",\n \"eol_outcome\": \"not_configured\",\n \"epss_gate_count\": 0,\n \"epss_on_missing_data\": \"allow\",\n \"epss_outcome\": \"not_configured\",\n \"epss_threshold\": 0.934620024584891,\n \"incomplete_scan_basis\": \"string\",\n \"incomplete_scan_gate_enabled\": false,\n \"incomplete_scan_on_unknown\": \"allow\",\n \"incomplete_scan_outcome\": \"not_configured\",\n \"kev_gate_count\": 0,\n \"kev_gate_enabled\": false,\n \"kev_on_missing_data\": \"allow\",\n \"kev_outcome\": \"not_configured\",\n \"malicious_component_count\": 0,\n \"malicious_gate_enforced\": true,\n \"malicious_scan_assessed\": false,\n \"reachable_critical_cve_count\": 0,\n \"reachable_gate_enforced\": false,\n \"reason\": \"string\",\n \"scan_id\": \"8958dc69-d24c-ca12-13de-3b7d0844bb47\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e47af16e-135f-4f60-8e7d-3f1b856aa26e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2e6cb4c-a6de-4638-b8ec-02873d77f75a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0551c35-6581-4748-b519-0f3017f68b6e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a6007a0-f905-4428-ba03-68aecc2d3af2", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98199624-8beb-40a3-978a-f217de33c470", "name": "The project's open findings as a SARIF 2.1.0 document", "request": { "name": "The project's open findings as a SARIF 2.1.0 document", "description": { "content": "Emit the scan's open findings in the format code-scanning tools ingest.\n\nAccess control, snapshot anchoring and ref normalisation are the gate\nendpoint's, deliberately: this is the same data in another representation,\nso a caller who may read the verdict may read this, and a caller who may\nnot gets the same existence-hiding 404.\n\nA project with no succeeded scan returns an empty-but-valid document rather\nthan a 404. That is what a CI job must be able to upload: an empty run is\nhow code scanning learns that previously-reported alerts are gone, and a\n404 here would either fail the job or leave stale alerts standing forever.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "ref", "value": "string", "description": "Optional branch anchor, resolved exactly as for the gate verdict: a CI job should pass its own ref so the document it uploads describes its own branch rather than the project's main line." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/sarif+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "05e720cb-c606-481d-b6b4-3a31c7c19965", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/sarif+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/sarif+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e81ec712-5224-4922-b723-41993339c402", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9330fee8-6833-430d-ab9b-2b6f357a41f0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bc4dbbc-9fd2-4592-ad71-bd8a11a1a836", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac32df5a-b661-4719-9e83-36551f2b453f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01d7a41d-c4ea-45b6-8f03-d66bd23896af", "name": "Render an SCA Markdown report and (optionally) post it to a GitHub PR", "request": { "name": "Render an SCA Markdown report and (optionally) post it to a GitHub PR", "description": {}, "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"repo_full_name\": \"string\",\n \"pr_number\": 3262232,\n \"dry_run\": false,\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2168b6b0-ce19-406d-b306-8a0c9e49a47b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"repo_full_name\": \"string\",\n \"pr_number\": 3262232,\n \"dry_run\": false,\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"updated\",\n \"body_preview\": \"string\",\n \"gate\": \"fail\",\n \"comment_id\": 8945,\n \"comment_url\": \"string\",\n \"provider\": \"github\",\n \"provider_assumed\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9b1d4ec-6c42-4df2-8bc8-8a0a73f6a3e4", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"repo_full_name\": \"string\",\n \"pr_number\": 3262232,\n \"dry_run\": false,\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8ee8001-f112-4345-b355-0558c92690df", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"repo_full_name\": \"string\",\n \"pr_number\": 3262232,\n \"dry_run\": false,\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc9ab957-3eb9-45c0-a951-c2751732ac8e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"repo_full_name\": \"string\",\n \"pr_number\": 3262232,\n \"dry_run\": false,\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b2d8cf-da12-46e2-87cf-e015a9a8ed65", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"repo_full_name\": \"string\",\n \"pr_number\": 3262232,\n \"dry_run\": false,\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ea2b846e-c94a-40ef-a462-6e9a9231178e", "name": "obligations", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a8568ea8-f200-4013-8c73-804c6b0d206a", "name": "Compose a NOTICE attribution body for the project's latest scan (or a pinned one)", "request": { "name": "Compose a NOTICE attribution body for the project's latest scan (or a pinned one)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "notice" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "text", "description": "Output format. ``text`` returns text/plain, ``markdown`` returns text/markdown, ``html`` returns a self-contained text/html document." }, { "disabled": false, "key": "download", "value": "false", "description": "When true, set ``Content-Disposition: attachment`` so browsers save the body as a file. Default is inline." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db4ed793-0a6b-4c2b-b3c7-a049206142d0", "name": "NOTICE body in the requested format (plain text, markdown, or a self-contained HTML document). ``Content-Disposition`` is set to ``attachment`` when ``download=true``; otherwise the body streams inline.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "notice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "text" }, { "key": "download", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8212d74f-cb8e-4ac9-b94e-d07100c91000", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "notice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "text" }, { "key": "download", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecbeecb3-aa09-427c-9e2d-a2e0aca74032", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "notice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "text" }, { "key": "download", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69c57abc-4829-4229-a8f9-e4917f887ee6", "name": "Project does not exist, the caller is not a member of the project's team (existence-hidden), or a pinned ``scan_id`` is not a succeeded scan of this project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "notice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "text" }, { "key": "download", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3330e8cf-6059-48bd-b20c-723ca45c3ce5", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "notice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "text" }, { "key": "download", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "974af89b-da15-42d1-bef2-a624b62e758a", "name": "Rate limit exceeded for this client IP.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "notice" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "text" }, { "key": "download", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea776e5c-125f-4c43-a0b3-2ba2810f4e3d", "name": "Everything this project has recorded about its obligations", "request": { "name": "Everything this project has recorded about its obligations", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9bd2c816-c7d0-41e3-8245-fcba88ddd4a4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"e6b808aa-4ab6-810c-a072-eec5df5fd6ae\",\n \"project_id\": \"d40e7250-b909-18c6-e18b-6e584052dcce\",\n \"obligation_id\": \"3a169f1b-e84c-7ba8-6ccf-d98f68aaeb36\",\n \"status\": \"string\",\n \"assignee_user_id\": \"52945627-b76e-353e-2ded-a6432e93b1b7\",\n \"due_on\": \"1966-06-03\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\",\n \"completed_at\": \"1956-07-14T09:26:59.196Z\",\n \"completed_by_user_id\": \"48274218-15b5-c5e3-e59e-8e7b3e639dff\",\n \"version\": 543,\n \"created_at\": \"1975-03-18T05:15:12.007Z\",\n \"updated_at\": \"2007-04-14T06:14:46.652Z\"\n },\n {\n \"id\": \"cec04144-d36b-d3ae-fbc5-d77d2562c7fb\",\n \"project_id\": \"a6d0f844-23c5-c16b-e1a5-031091ccca86\",\n \"obligation_id\": \"135ece6b-cf60-1ee2-6773-88eb50de423d\",\n \"status\": \"string\",\n \"assignee_user_id\": \"73724789-79e2-d110-6542-dc278dd0a8a6\",\n \"due_on\": \"1953-10-01\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\",\n \"completed_at\": \"2011-03-08T13:49:39.290Z\",\n \"completed_by_user_id\": \"d1b762f3-b651-6b13-3d00-096532660bbd\",\n \"version\": 2430,\n \"created_at\": \"2018-11-16T23:17:55.033Z\",\n \"updated_at\": \"1993-04-07T09:55:52.851Z\"\n }\n ],\n \"total\": 17\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62b6db2d-3dd2-45d0-8582-5462737e6f15", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f799c77-e662-4022-9b2c-fae51028a84b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f315009c-606e-4bd6-9e7a-3ded1e93c8f9", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53e968b4-2b82-433a-a2cd-674a55f920fe", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f78fd30-5770-43b3-92cf-61e2b47c0089", "name": "Per-(license, kind) obligation rows + distribution for the project's latest scan", "request": { "name": "Per-(license, kind) obligation rows + distribution for the project's latest scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "obligations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" }, { "disabled": false, "key": "kind", "value": "string" }, { "disabled": false, "key": "kind", "value": "string" }, { "disabled": false, "key": "category", "value": "string" }, { "disabled": false, "key": "category", "value": "string" }, { "disabled": false, "key": "search", "value": "string" }, { "disabled": false, "key": "sort", "value": "category" }, { "disabled": false, "key": "order", "value": "desc" }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a432f83b-9802-48ba-a02d-1939851080d5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"ddda0209-2a1e-a410-aec4-a2aeb68d60f9\",\n \"license_id\": \"356a2a26-913b-7487-8e75-544d15fed22e\",\n \"license_name\": \"string\",\n \"license_category\": \"allowed\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"affected_count\": 4997,\n \"updated_at\": \"1969-10-22T01:51:06.798Z\",\n \"fulfilment\": {\n \"value\": \"\"\n },\n \"license_spdx_id\": \"string\",\n \"link\": \"string\",\n \"text_ko\": \"string\"\n },\n {\n \"id\": \"e6130b08-041a-5a84-2955-9e3d67a47540\",\n \"license_id\": \"247674eb-83aa-cbf2-120f-a7cb8337de38\",\n \"license_name\": \"string\",\n \"license_category\": \"allowed\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"affected_count\": 7364,\n \"updated_at\": \"1987-06-26T15:02:19.401Z\",\n \"fulfilment\": {\n \"value\": \"\"\n },\n \"license_spdx_id\": \"string\",\n \"link\": \"string\",\n \"text_ko\": \"string\"\n }\n ],\n \"distribution\": {\n \"key_0\": 3780,\n \"key_1\": 5545\n },\n \"total\": 6821\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cbd892e-72b5-42a2-a4d8-d984a076a0ed", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f95c529-5506-4f3a-ac6a-bc46dd92cb83", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b71d8423-3950-4eda-9c5d-d699e3ef664e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19107aff-fcc3-49c7-8402-7d4e3f4f6479", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "kind", "value": "string" }, { "key": "kind", "value": "string" }, { "key": "category", "value": "string" }, { "key": "category", "value": "string" }, { "key": "search", "value": "string" }, { "key": "sort", "value": "category" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "670b91cc-b94a-45b3-a4f3-dea64dacb9c6", "name": "Obligation drawer payload (404 if invisible to caller within this project)", "request": { "name": "Obligation drawer payload (404 if invisible to caller within this project)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d00de940-3c6f-4ab7-9fd9-cf36f8a7e2b7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"13e786c3-0c68-aff0-7876-9171af9d7220\",\n \"license_id\": \"756ed024-5963-b6c0-d558-c90ddb249467\",\n \"license_name\": \"string\",\n \"license_category\": \"forbidden\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1962-07-27T11:53:47.463Z\",\n \"updated_at\": \"2006-06-18T18:13:37.526Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"8695e73e-3228-a69e-0bcd-8edb609e3e2b\",\n \"component_name\": \"string\",\n \"version\": \"string\"\n },\n {\n \"component_version_id\": \"ef4f44f9-4cc2-d411-80a5-66c6f419adf4\",\n \"component_name\": \"string\",\n \"version\": \"string\"\n }\n ],\n \"affected_components_total\": 0,\n \"affected_components_truncated\": false,\n \"fulfilment\": {\n \"id\": \"2369dc23-ed9a-6a22-c296-8490b0f2db7f\",\n \"status\": \"string\",\n \"version\": 4633,\n \"updated_at\": \"2017-02-08T04:40:51.696Z\",\n \"assignee_user_id\": \"c643a121-b232-21f7-cafd-8df7b1965954\",\n \"completed_at\": \"1976-05-13T05:49:10.388Z\",\n \"completed_by_user_id\": \"01e11893-8a44-3ce7-6619-bf65401ba125\",\n \"due_on\": \"2010-03-03\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n },\n \"license_reference_url\": \"string\",\n \"license_spdx_id\": \"string\",\n \"link\": \"string\",\n \"text_ko\": \"string\",\n \"text_truncated\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45f8beb2-e707-42ba-89f3-7448eb56ca96", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6b4faab-0f9d-4f6f-828c-6a6eabb5c89b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c95052-0349-452b-a38b-4ed591127a22", "name": "Obligation does not exist, exists in a team the caller cannot access, or is not surfaced by the project's latest scan. Returned in lieu of 403 to avoid leaking existence.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "233e1755-91ec-41e0-8a36-8dd9fa97c57d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3a7ca09-f15d-46b1-8e48-a11265771703", "name": "Remove the record, putting the obligation back to nothing recorded", "request": { "name": "Remove the record, putting the obligation back to nothing recorded", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e18eadb6-9fce-42b8-b404-ee0c5fe2a4d0", "name": "Removed, or there was nothing to remove. Distinct from marking it not-applicable: that is a judgement worth keeping, this is for a row created by mistake.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b351cb1-4a18-4a55-9478-f17257b04e8b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07bedc3d-db89-4207-afd1-24f3456a913d", "name": "Caller is not a member of the project's team.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6dd1ce3f-6f36-42a1-9293-020399f4b1c9", "name": "No such project, or not the caller's to see.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2bc8a295-931b-4f9b-abb3-4d5d1d0b84f8", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d12056e-99e8-4ad1-94ca-a98bf5c29550", "name": "Record what has been done about an obligation", "request": { "name": "Record what has been done about an obligation", "description": { "content": "Create or replace the record. One call either way.\n\nThe caller is saying what the state is now; making them find out first\nwhether a row exists would be a round trip that answers a question about\nour schema rather than about their work.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"94616ade-85b6-035e-defb-f4cae8c2891e\",\n \"due_on\": \"1964-05-06\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "910f566b-1e06-41bc-aaed-4a342d6d58fd", "name": "Recorded. The notice this obligation feeds is unchanged.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"94616ade-85b6-035e-defb-f4cae8c2891e\",\n \"due_on\": \"1964-05-06\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"5f52c2f9-4fe3-ce82-b825-67d71c4e7e21\",\n \"project_id\": \"5f484edd-7250-f4ca-e8fb-af61bc28cb5e\",\n \"obligation_id\": \"2e2e7ce3-e69d-6929-11ec-10cd58987672\",\n \"status\": \"string\",\n \"assignee_user_id\": \"a008516b-42c9-8955-e6f1-c535604678b7\",\n \"due_on\": \"2008-01-13\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\",\n \"completed_at\": \"1963-12-25T06:45:59.750Z\",\n \"completed_by_user_id\": \"de2cb674-8180-f479-9600-94af1903b525\",\n \"version\": 6260,\n \"created_at\": \"2024-02-24T20:33:07.319Z\",\n \"updated_at\": \"1966-02-01T08:29:26.348Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38f557c6-bf90-44ac-a0d5-0da48c3645a1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"94616ade-85b6-035e-defb-f4cae8c2891e\",\n \"due_on\": \"1964-05-06\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50821568-60c7-462d-9431-bd575aaa10b8", "name": "Caller is not a member of the project's team.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"94616ade-85b6-035e-defb-f4cae8c2891e\",\n \"due_on\": \"1964-05-06\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f431dbd5-0760-40d9-82e6-6e7ab7ac3b0a", "name": "No such project or obligation, or not the caller's to see.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"94616ade-85b6-035e-defb-f4cae8c2891e\",\n \"due_on\": \"1964-05-06\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7be25c24-bbdc-4909-9506-68ef281b9f82", "name": "The If-Match version is stale; reload and retry.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"94616ade-85b6-035e-defb-f4cae8c2891e\",\n \"due_on\": \"1964-05-06\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "654f51ac-244e-4453-8a95-966843ddcd85", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "702d97de-7776-0dc0-e306-8aae36934097", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"94616ade-85b6-035e-defb-f4cae8c2891e\",\n \"due_on\": \"1964-05-06\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "44d32561-f1e9-455d-886e-9b211036675f", "name": "remediation", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6a4a44f5-7b8a-46c7-b2e1-88934d9a6982", "name": "Preview the npm dependency-bump edit for a project (dry-run, no PR)", "request": { "name": "Preview the npm dependency-bump edit for a project (dry-run, no PR)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e2078262-2c3d-48cd-af48-a2c542cf876d", "name": "Computed dry-run (may be a no-op / no-manifest).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"changed\": true,\n \"changes\": [\n {\n \"after\": \"^4.17.21\",\n \"before\": \"^4.17.20\",\n \"changed\": true,\n \"package\": \"lodash\",\n \"section\": \"dependencies\"\n }\n ],\n \"ecosystem\": \"npm\",\n \"edited_manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.21\\\"\\n }\\n}\\n\",\n \"manifest_found\": true,\n \"manifest_source\": \"preserved_source\",\n \"notes\": [],\n \"project_id\": \"5b8f1c2e-0c2a-4a1e-9c3d-9c2b1a0f7e11\",\n \"recommendations\": [\n {\n \"current_version\": \"4.17.20\",\n \"package\": \"lodash\",\n \"recommended_version\": \"4.17.21\"\n }\n ],\n \"scan_id\": \"7a1d2c3b-4e5f-6a7b-8c9d-0e1f2a3b4c5d\",\n \"warnings\": [\n {\n \"code\": \"lockfile_regeneration_required\",\n \"detail\": \"run `npm install` to regenerate package-lock.json\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f476ddc-ea2b-4aaa-981a-ce59a65cb996", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ef96423-61b5-4fc7-8818-21f4236167c0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c2c446c-1206-4b1a-968c-059b04667a22", "name": "Project not found / not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8331076a-0df3-48bd-b6b9-3af2e34afc57", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da929e6d-dec2-4b48-9900-7d0a38886bf1", "name": "Open an automated npm remediation PR on the project's opted-in repo", "request": { "name": "Open an automated npm remediation PR on the project's opted-in repo", "description": { "content": "Open (or return the existing) automated npm remediation PR.\n\nteam_admin RBAC + opt-in enforcement live in the service. Returns 201 for a\nfreshly opened PR, 200 for an idempotent hit on an existing open PR, and 204\nwhen there is nothing to remediate.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7a94d7a4-87ec-4c44-b278-185c2d6ae70e", "name": "An existing open PR was returned (idempotent hit).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"da9894c2-088b-e343-2f27-b626449412e9\",\n \"project_id\": \"774e2a0d-e1bd-a8bb-d83c-62a84ecc2ff5\",\n \"ecosystem\": \"string\",\n \"repository_full_name\": \"string\",\n \"head_branch\": \"string\",\n \"base_branch\": \"string\",\n \"status\": \"open\",\n \"created_at\": \"1968-01-01T20:04:20.690Z\",\n \"updated_at\": \"2022-09-13T08:44:00.049Z\",\n \"package_changes\": [\n {\n \"from\": \"4.17.20\",\n \"package\": \"lodash\",\n \"to\": \"4.17.21\"\n },\n {\n \"from\": \"4.17.20\",\n \"package\": \"lodash\",\n \"to\": \"4.17.21\"\n }\n ],\n \"pr_number\": 6007,\n \"pr_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8d3b7a8-f2f7-42cd-be6a-a2f4c548bbca", "name": "A new remediation PR was opened.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e983e530-8547-48d5-93fc-f8a8d891272f", "name": "Nothing to remediate (no manifest change).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6bb57df-99de-4399-93cd-005032202bb9", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "df09d86b-45e9-4dcd-a981-9e5789197f25", "name": "Caller is not a team_admin of the project's team", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c18de51-1e0a-493d-9c92-f716e99d5a2a", "name": "Project not found / not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3522356b-2f45-47a3-a6fe-5c013cfd9c27", "name": "Project is not opted in to automated remediation PRs", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "100af8d9-0a4c-4759-9e32-d0db8321e801", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8f2ee09-ae32-4562-8df1-f493db096eab", "name": "A GitHub write failed", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"manifest\": \"{\\n \\\"name\\\": \\\"demo\\\",\\n \\\"dependencies\\\": {\\n \\\"lodash\\\": \\\"^4.17.20\\\"\\n }\\n}\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f317342-f53a-478f-8980-f8017f455b50", "name": "List the project's automated remediation PR records", "request": { "name": "List the project's automated remediation PR records", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "remediation", "pull-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a1ff0ab8-8c4d-48d5-a773-d7980bc7f9eb", "name": "The project's remediation-PR records (newest first).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "pull-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 4572,\n \"items\": [\n {\n \"id\": \"ca3bf86b-7d38-d06d-3ff5-eefc6bde7ad2\",\n \"project_id\": \"82c90e8f-85d1-316d-01d6-f73175919760\",\n \"ecosystem\": \"string\",\n \"repository_full_name\": \"string\",\n \"head_branch\": \"string\",\n \"base_branch\": \"string\",\n \"status\": \"superseded\",\n \"created_at\": \"1965-08-10T17:29:22.976Z\",\n \"updated_at\": \"2020-06-08T07:49:26.324Z\",\n \"package_changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pr_number\": 4619,\n \"pr_url\": \"string\"\n },\n {\n \"id\": \"facb6f95-5d27-3cb2-adad-fd1def9d054d\",\n \"project_id\": \"717cdc13-530c-b644-6ec7-24d670203892\",\n \"ecosystem\": \"string\",\n \"repository_full_name\": \"string\",\n \"head_branch\": \"string\",\n \"base_branch\": \"string\",\n \"status\": \"failed\",\n \"created_at\": \"1986-10-15T18:22:26.195Z\",\n \"updated_at\": \"1995-10-31T16:29:20.684Z\",\n \"package_changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pr_number\": 2362,\n \"pr_url\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "474c7c6c-93db-49e5-85aa-b9c0f587fbe3", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "pull-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b87dca60-7591-4b5d-b634-9eac7334f74e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "pull-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ae10f0-04f9-4cac-946e-3325f33226b3", "name": "Project not found / not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "pull-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a0d7c5e-b435-43c7-884b-47dfbfb161f4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "pull-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c1740f4c-8afa-47f9-a69d-ef8d49ec8a7f", "name": "reports", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "399fb2f9-92ed-4997-bd3d-074d2cf3b92e", "name": "List download / export history for the project's Reports center", "request": { "name": "List download / export history for the project's Reports center", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "sbom", "description": "Optional filter — one or more report_type values to include. Repeat the parameter (``?type=notice&type=sbom``) for multi-select. Omit for all four types." }, { "disabled": false, "key": "type", "value": "vex_export", "description": "Optional filter — one or more report_type values to include. Repeat the parameter (``?type=notice&type=sbom``) for multi-select. Omit for all four types." }, { "disabled": false, "key": "page", "value": "1", "description": "1-based page number." }, { "disabled": false, "key": "page_size", "value": "50", "description": "Rows per page (1..200, default 50)." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0beb2427-0763-49d3-802c-09077bb88c48", "name": "Paginated report-download history (newest first).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "notice" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"37b73325-f572-9b64-3d2d-fce1d4bbaea6\",\n \"project_id\": \"c45b840d-f492-93d8-9f15-520f06d122c7\",\n \"team_id\": \"c0b5387f-2b90-4363-0969-1b7dbc8a7e58\",\n \"report_type\": \"vuln_pdf\",\n \"format\": \"string\",\n \"created_at\": \"1970-02-24T22:03:02.531Z\",\n \"scan_id\": \"6751a813-893e-ced9-f6a4-dc84c4faf531\",\n \"size_bytes\": 2751,\n \"user\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"d4d9a158-388d-e465-200b-6b887a86a957\",\n \"project_id\": \"d38f820b-fabb-d97e-b0fb-d743b9a1f2a2\",\n \"team_id\": \"aad7d301-e899-2509-f56e-eff21539d605\",\n \"report_type\": \"vex_export\",\n \"format\": \"string\",\n \"created_at\": \"1963-07-30T18:41:36.971Z\",\n \"scan_id\": \"f3ba1da9-4d46-28d9-6805-90b10046857f\",\n \"size_bytes\": 8566,\n \"user\": {\n \"value\": \"\"\n }\n }\n ],\n \"total\": 4454,\n \"page\": 870,\n \"page_size\": 8808\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b190a6e7-bf72-4a80-88b3-84c63b3d95dc", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "notice" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcbd5d7e-7c2b-4605-a73b-0aa412833a4a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "notice" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68cf9f94-d856-411f-82c3-6d2f7076baba", "name": "Project does not exist, or the caller is not a member of its team (existence-hidden — same envelope either way).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "notice" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cf4c792-caf5-46dd-98f8-96e1f6be72df", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "notice" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e93850d-8ebf-4cac-b179-5a6a13f3d300", "name": "Rate limit exceeded for this client.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "notice" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24208d83-85fc-4d5f-9a2b-884edd850912", "name": "Download a vulnerability PDF report for the project's latest scan", "request": { "name": "Download a vulnerability PDF report for the project's latest scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "vulnerability_columns", "value": "string", "description": "Subset of ['cve', 'cvss', 'summary', 'status'] to render. Overrides the organization's report formatting default for this request only." }, { "disabled": false, "key": "vulnerability_columns", "value": "string", "description": "Subset of ['cve', 'cvss', 'summary', 'status'] to render. Overrides the organization's report formatting default for this request only." }, { "disabled": false, "key": "component_columns", "value": "string", "description": "Subset of ['name', 'version', 'license', 'severity', 'vulns'] to render. Overrides the organization's report formatting default for this request only." }, { "disabled": false, "key": "component_columns", "value": "string", "description": "Subset of ['name', 'version', 'license', 'severity', 'vulns'] to render. Overrides the organization's report formatting default for this request only." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7770efd1-ca72-48aa-acde-3ed1a321aedb", "name": "PDF report download", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "vulnerability_columns", "value": "string" }, { "key": "vulnerability_columns", "value": "string" }, { "key": "component_columns", "value": "string" }, { "key": "component_columns", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96867271-b659-4753-8614-cc13aab57f67", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "vulnerability_columns", "value": "string" }, { "key": "vulnerability_columns", "value": "string" }, { "key": "component_columns", "value": "string" }, { "key": "component_columns", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d4e4e2f-3251-4a3f-a464-144acd8c672a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "vulnerability_columns", "value": "string" }, { "key": "vulnerability_columns", "value": "string" }, { "key": "component_columns", "value": "string" }, { "key": "component_columns", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f775d90f-f15b-4c29-a061-9a3676fe878d", "name": "Project not found or not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "vulnerability_columns", "value": "string" }, { "key": "vulnerability_columns", "value": "string" }, { "key": "component_columns", "value": "string" }, { "key": "component_columns", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa50947d-c1cc-405a-be9a-ea0578ccb170", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "vulnerability_columns", "value": "string" }, { "key": "vulnerability_columns", "value": "string" }, { "key": "component_columns", "value": "string" }, { "key": "component_columns", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63694de4-deba-46eb-93a8-f54fca4c075e", "name": "PDF rendering failed (e.g. weasyprint unavailable)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.pdf" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "vulnerability_columns", "value": "string" }, { "key": "vulnerability_columns", "value": "string" }, { "key": "component_columns", "value": "string" }, { "key": "component_columns", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78ea996c-de31-4370-973a-ee6f5d2d8ef2", "name": "Download a vulnerability Excel (.xlsx) report for the project's latest scan", "request": { "name": "Download a vulnerability Excel (.xlsx) report for the project's latest scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b0186474-4ecb-490d-9af3-f8ffeb22f720", "name": "XLSX report download", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99b2c93b-77bc-4b9e-8e0b-fd83b78afd74", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d2a73795-0638-422c-bfb3-26f8758f36d0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46db9bde-3d08-4343-a0be-5acfcd70b733", "name": "Project not found or not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "453a7c95-fd25-493c-8400-60942c0b520b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "359a7637-746f-4beb-8ec2-8d776fb1b68b", "name": "sbom", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4e4abaf3-d4e0-4b8f-a520-240f221cb75a", "name": "Export SBOM for the project's latest succeeded scan", "request": { "name": "Export SBOM for the project's latest succeeded scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "cyclonedx-json", "description": "SBOM output format." }, { "disabled": false, "key": "profile", "value": "policy-filtered", "description": "Optional policy profile (C3). Applies the project's effective license policy: 'policy-annotated' flags each violating component in place (CycloneDX properties / SPDX annotations); 'policy-filtered' drops forbidden components (and their VEX entries), recording the excluded count on the document. Omit for the canonical, cosign-signable default export. Profile exports are NOT signed." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "{{projectId}}", "key": "project_id", "description": "(Required) " } ], "raw": "{{baseUrl}}/v1/projects/:project_id/sbom?format=cyclonedx-json&profile=policy-filtered&scan_id=cb9ec708-aa08-8a32-0af6-345d92d80d99&release=string" }, "header": [ { "key": "Accept", "value": "application/spdx+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fc4af7ff-db85-465a-88e9-f5e2db437023", "name": "SBOM document download", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-filtered" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/spdx+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/spdx+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec17690c-a440-470a-8f46-d742e60bbab4", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-filtered" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ffef39d4-2a43-45ab-a8ad-facd540065be", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-filtered" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbd753fd-99b7-4d8c-9bdf-fbacd7ca2d91", "name": "Project not found or not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-filtered" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8dd2fc3e-8697-4816-bf9e-132a2c3c7bfd", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-filtered" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "993b9458-13c3-4f75-84af-8befd87a4af8", "name": "Ingest an external CycloneDX or SPDX SBOM (queues a Celery task; returns 202)", "request": { "name": "Ingest an external CycloneDX or SPDX SBOM (queues a Celery task; returns 202)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "sbom", "value": "string", "type": "text", "description": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence." }, { "key": "ref", "value": "string", "type": "text", "description": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key." }, { "key": "release", "value": "string", "type": "text", "description": "Optional release/version label for the resulting snapshot." } ] } }, "response": [ { "id": "e233ed51-2daf-421d-9af2-d22f96a766f6", "name": "SBOM accepted; a queued scan row is returned.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"71d389b9-d220-9b3c-4322-dc670d4d5c61\",\n \"project_id\": \"e415d9ad-efb9-28d7-d98d-0678d770b3a2\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 2509,\n \"current_step\": \"string\",\n \"started_at\": \"2012-07-01T21:51:55.001Z\",\n \"completed_at\": \"2009-08-04T21:40:02.964Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"42c7c0bf-afaa-5b12-33ed-523a85612cbe\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2010-04-05T06:49:10.828Z\",\n \"updated_at\": \"1992-08-14T00:47:52.435Z\",\n \"metadata\": {\n \"key_0\": false\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1949-08-14T22:55:36.747Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db45d403-feec-485d-bfff-7d5bbfe7aead", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2edd243-b7ec-400b-9ee7-d3ae2caef6c0", "name": "Caller is not a member of the project's owning team, or a project-scoped API key targets a different project. RFC 7807.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1541f6b4-20ac-43d3-bd20-91de7806d2f2", "name": "Project not found (existence-hidden). RFC 7807.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49ea9aba-e65d-460c-aa67-8c373992e067", "name": "A scan is already queued/running for this project, or the project is archived. RFC 7807.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ad32b49-63ad-4b9c-bcae-4f4fb8e369a8", "name": "SBOM exceeds the ingest size cap. RFC 7807.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6662fd4d-3326-4363-8493-3bc4343c3615", "name": "Upload is not a CycloneDX or SPDX media type. RFC 7807.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Unsupported Media Type", "code": 415, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34189b5e-d6a0-47bd-b35c-f04d513a4604", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a61d676b-e05d-4d16-a53d-c91d2322e4dc", "name": "Rate limited (too many scan creations from this user) or the team's concurrent-scan cap is reached. RFC 7807 + Retry-After; the concurrency-cap variant adds `limit` and, when the deployment has queue-backlog metrics on, an `estimated_wait_seconds` extension field (S7).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) A CycloneDX-JSON (.json / .cdx.json) or SPDX (.spdx / .spdx.json / .tag) SBOM document. Trivy auto-detects the format for CVE matching; SPDX is mapped to CycloneDX for component persistence.", "type": "text/plain" }, "key": "sbom", "value": "string", "type": "text" }, { "description": { "content": "Optional git ref this SBOM was produced from (e.g. refs/heads/main, a tag, or a bare branch name). Normalized into a retention key.", "type": "text/plain" }, "key": "ref", "value": "string", "type": "text" }, { "description": { "content": "Optional release/version label for the resulting snapshot.", "type": "text/plain" }, "key": "release", "value": "string", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "549fc70c-e36b-4eda-b4a1-8ad4cbd06d83", "name": "Download the in-toto / SLSA provenance attestation for the latest SBOM", "request": { "name": "Download the in-toto / SLSA provenance attestation for the latest SBOM", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "00c7bfe9-e8be-45f7-a280-dafe9665bdc0", "name": "in-toto / DSSE SLSA provenance attestation", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4f004bc-a0bd-4183-835c-be6aef3f183e", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e8a8a90-1edd-4558-b3ae-016f9f718c8c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "417f79b0-8d77-4309-ba1a-b266ccdd61ff", "name": "Project not accessible, or no attestation exists", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0de0f60-1ecf-4672-a117-a6660dccc043", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39e681e9-f85e-4a6d-a65d-f6f952aa45d6", "name": "Download the Fulcio certificate for the attestation (keyless signing only)", "request": { "name": "Download the Fulcio certificate for the attestation (keyless signing only)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/x-pem-file" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8765e99f-6671-4338-8454-916f86937684", "name": "Fulcio certificate for the in-toto attestation (keyless verification)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/x-pem-file" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/x-pem-file" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42b5ca7b-5e02-4810-9f17-9367027db3eb", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1a5824ad-cab5-4fe9-a889-9d5dceb16163", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fd3dd55-bde2-407a-be07-aa6cea885ecd", "name": "Project not accessible, or no attestation certificate exists", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af4f96e0-d8f6-4f41-bee5-d005558e885c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56ee8ad3-a7ba-47a7-a9e4-a6c674763fa2", "name": "Download the Fulcio signing certificate (keyless signing only)", "request": { "name": "Download the Fulcio signing certificate (keyless signing only)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/x-pem-file" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "948ff9d9-8799-408e-8585-6c34149d8f4b", "name": "Fulcio signing certificate (keyless verification)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/x-pem-file" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/x-pem-file" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11487c81-bd8a-4ce7-b5db-9629c87dd8c2", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afcfabfd-6435-4ebe-b124-bb4efa248190", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adf7b3f7-bfde-439c-87f8-3e17e42b8f0e", "name": "Project not accessible, or no keyless certificate exists", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "007dbb68-7e1b-440a-9b87-5a1489a18181", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b94ded1b-9450-4912-8869-a2a2da0fd60e", "name": "Download the cosign public key for verifying SBOM signatures", "request": { "name": "Download the cosign public key for verifying SBOM signatures", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/x-pem-file" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ed3fc0c6-fc61-4f18-a306-5a7e003f752a", "name": "cosign PUBLIC key (verify with cosign verify-blob --key)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/x-pem-file" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/x-pem-file" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3fba735-e3bb-44e1-98f7-1bc0bf504e01", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4531e320-ab1b-49f5-a45e-52d5342836f2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96e94b01-21ef-4dd9-91c5-ee82598018a5", "name": "Project not accessible, or no public key is configured", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42dd3fd1-7c2d-4bea-8c35-f75dd814c00c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a425d8f2-bd2a-4b31-8d07-06b4a80a0a64", "name": "Download the detached cosign signature for the latest SBOM", "request": { "name": "Download the detached cosign signature for the latest SBOM", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a1c0e73c-190a-4e80-a732-f1ade8a8d8ff", "name": "Detached cosign signature (verify with cosign verify-blob)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "be525c52-4c60-4469-a623-5b8181e86efd", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "505de229-1158-44c8-85b1-877455f3ec8d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b217a6fd-95a0-4554-88b8-0acb3b1d5b41", "name": "Project not accessible, or the SBOM was not signed", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5d9df2d-e12e-41ee-8093-78431e4a9b15", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e30ad141-7349-4c03-92c8-7002376986c8", "name": "Download a zip bundle (SBOM + signature + cert/public-key + attestation + README)", "request": { "name": "Download a zip bundle (SBOM + signature + cert/public-key + attestation + README)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/zip" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "38974222-e9be-4fb0-8fd7-67ee17c9142d", "name": "Zip bundle for external cosign verification", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/zip" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/zip" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e069c2f-701d-4f69-851d-3c07254b68bf", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c80462d5-a378-4765-a057-12e227d8084c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00069ea0-f9c7-4751-915c-31b0912710d3", "name": "Project not accessible, or the SBOM was not signed", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a37ea40-2aba-40dd-8021-96823b17c12c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d66043e9-b82e-46bd-b3c3-c189aab7606e", "name": "Get the conformance verdict for an ingested SBOM scan", "request": { "name": "Get the conformance verdict for an ingested SBOM scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "50e672d2-d0ee-4557-b1df-318373032b74", "name": "The SBOM conformance verdict (pass/warn/fail + per-check detail).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scan_id\": \"eae5aa13-0aa4-7a1c-fbdd-68935d729031\",\n \"project_id\": \"50314499-5fbd-9251-dc10-be558bc003c3\",\n \"source_format\": \"spdx-json\",\n \"result\": \"warn\",\n \"n_fail\": 4052,\n \"n_warn\": 4041,\n \"component_count\": 3928,\n \"created_at\": \"1971-02-23T16:33:21.094Z\",\n \"ai_assessment\": {\n \"verdict\": \"conditional\",\n \"disclaimer\": \"string\",\n \"disclaimer_ko\": \"string\",\n \"condition_labels\": {\n \"key_0\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n },\n \"key_4\": {\n \"value\": \"\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\n \"value\": \"\"\n },\n \"key_2\": {\n \"value\": \"\"\n },\n \"key_3\": {\n \"value\": \"\"\n }\n }\n },\n \"datasets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"models\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"scenario\": \"outputs-only\"\n },\n \"checks\": [\n {\n \"id\": \"string\",\n \"label\": \"string\",\n \"required\": true,\n \"status\": \"warn\",\n \"detail\": \"string\",\n \"cluster\": \"string\",\n \"evidence\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"guidance\": {\n \"value\": \"\"\n },\n \"missing\": [\n \"string\",\n \"string\"\n ],\n \"regulations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"review\": {\n \"value\": \"\"\n },\n \"role\": \"string\",\n \"source\": \"string\"\n },\n {\n \"id\": \"string\",\n \"label\": \"string\",\n \"required\": true,\n \"status\": \"fail\",\n \"detail\": \"string\",\n \"cluster\": \"string\",\n \"evidence\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"guidance\": {\n \"value\": \"\"\n },\n \"missing\": [\n \"string\",\n \"string\"\n ],\n \"regulations\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"review\": {\n \"value\": \"\"\n },\n \"role\": \"string\",\n \"source\": \"string\"\n }\n ],\n \"hash_coverage_pct\": 6635,\n \"license_coverage_pct\": 5461,\n \"purl_coverage_pct\": 8974,\n \"regulatory_crosswalk\": {\n \"disclaimer\": \"string\",\n \"disclaimer_ko\": \"string\",\n \"frameworks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f346eb2b-373e-461a-a2f6-693d71957b89", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6616ea27-c067-4347-96ce-56072b1424c8", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a0172be-bfa7-4901-9494-2063b7fa8e53", "name": "Project not accessible (existence-hidden), or no conformance verdict exists for this scan (not an ingested SBOM scan, or still queued). RFC 7807.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a309a54-9340-4176-9664-b00b9411f79f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a7387a53-a468-444e-a36b-186743565811", "name": "scans", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "39f5768d-29a9-4586-a476-6f6c9ed91da7", "name": "List scans for a project (most recent first)", "request": { "name": "List scans for a project (most recent first)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "size", "value": "20" }, { "disabled": false, "key": "ref", "value": "string", "description": "Optional branch filter. Accepts a bare branch (``main``) or a fully-qualified ref (``refs/heads/main``, ``refs/pull/12/merge``), normalized the same way scan triggers normalize it. Unlike the releases list this covers every status, so it answers \"what has this branch done lately\" including failures." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e04f63b5-31d8-4d5d-85b9-cd71df423498", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"dab0a0ae-7433-8c10-320b-f05c44880b32\",\n \"project_id\": \"5171c4f4-5bbd-9eb4-5a2a-a239d92af257\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 1271,\n \"current_step\": \"string\",\n \"started_at\": \"2011-07-19T15:13:27.501Z\",\n \"completed_at\": \"1985-09-01T21:02:43.051Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"b5ad02ad-6c89-9d1c-5dbf-32bb859f52c7\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2024-07-02T09:09:07.510Z\",\n \"updated_at\": \"2010-10-28T09:27:46.658Z\",\n \"metadata\": {\n \"key_0\": 2343,\n \"key_1\": 7961.346329044687,\n \"key_2\": 9845,\n \"key_3\": \"string\"\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1951-12-26T12:19:59.569Z\"\n },\n {\n \"id\": \"8bbf767e-938b-b2a2-6365-de87ac32054f\",\n \"project_id\": \"aae7115f-17f9-48e9-2c02-3def9ccd1288\",\n \"kind\": \"sbom\",\n \"status\": \"cancelled\",\n \"progress_percent\": 8444,\n \"current_step\": \"string\",\n \"started_at\": \"2020-08-17T06:16:01.383Z\",\n \"completed_at\": \"1972-04-03T10:45:39.464Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"03abb760-ec6d-08e9-8a3a-a5f429c34529\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2011-07-23T09:37:50.583Z\",\n \"updated_at\": \"2002-09-02T23:06:18.144Z\",\n \"metadata\": {\n \"key_0\": \"string\"\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1980-05-05T13:17:11.842Z\"\n }\n ],\n \"total\": 5509,\n \"page\": 5829,\n \"size\": 6332\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4348f0f-39e2-45a0-8866-1627e5b5b4b4", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02fba046-b613-43af-9be9-33a87e4c8146", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28e2217d-f4d4-409e-888e-dd8565cf3705", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e08bb0a-8c5f-4540-959d-0a724c108a2a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "ref", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a99b6d12-d045-415c-bc5d-ec9391a99d1c", "name": "List scans across every project accessible to the caller", "request": { "name": "List scans across every project accessible to the caller", "description": {}, "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "running", "description": "Filter by scan status." }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f3575e3f-18af-430b-8ffc-41cfbf4be8cc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "running" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"dab0a0ae-7433-8c10-320b-f05c44880b32\",\n \"project_id\": \"5171c4f4-5bbd-9eb4-5a2a-a239d92af257\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 1271,\n \"current_step\": \"string\",\n \"started_at\": \"2011-07-19T15:13:27.501Z\",\n \"completed_at\": \"1985-09-01T21:02:43.051Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"b5ad02ad-6c89-9d1c-5dbf-32bb859f52c7\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2024-07-02T09:09:07.510Z\",\n \"updated_at\": \"2010-10-28T09:27:46.658Z\",\n \"metadata\": {\n \"key_0\": 2343,\n \"key_1\": 7961.346329044687,\n \"key_2\": 9845,\n \"key_3\": \"string\"\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1951-12-26T12:19:59.569Z\"\n },\n {\n \"id\": \"8bbf767e-938b-b2a2-6365-de87ac32054f\",\n \"project_id\": \"aae7115f-17f9-48e9-2c02-3def9ccd1288\",\n \"kind\": \"sbom\",\n \"status\": \"cancelled\",\n \"progress_percent\": 8444,\n \"current_step\": \"string\",\n \"started_at\": \"2020-08-17T06:16:01.383Z\",\n \"completed_at\": \"1972-04-03T10:45:39.464Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"03abb760-ec6d-08e9-8a3a-a5f429c34529\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2011-07-23T09:37:50.583Z\",\n \"updated_at\": \"2002-09-02T23:06:18.144Z\",\n \"metadata\": {\n \"key_0\": \"string\"\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1980-05-05T13:17:11.842Z\"\n }\n ],\n \"total\": 5509,\n \"page\": 5829,\n \"size\": 6332\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f4616e7-6415-422a-af34-35fc0d0cdc07", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "running" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69b84be4-fcf2-4412-ac5c-06378e023f4c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "running" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "541335a2-46e5-445b-bbd5-6c1c938e7688", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "running" }, { "key": "page", "value": "1" }, { "key": "size", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e673ec01-f6cc-4806-86b6-b0d9143b9819", "name": "Delete a terminal scan and its findings (own-team scans only)", "request": { "name": "Delete a terminal scan and its findings (own-team scans only)", "description": { "content": "Hard-delete a terminal scan and (via cascade) its findings / components.\n\nDT-style retention reclaims most stale scans automatically; this is the\nmanual escape hatch. Auth: any team member (``developer``+). The owning-team\ncheck lives in the service (``delete_scan``), which existence-hides other\nteams' scans as 404. Active scans (queued/running) return 409 — cancel\nfirst. A release-labelled scan returns 409 unless ``force=true``.", "type": "text/plain" }, "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "force", "value": "false", "description": "Delete even when the scan carries an explicit metadata.release label. Release-labelled snapshots are immutable by default." } ], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "70ef3624-dff4-44e1-9ea1-c828793c8a76", "name": "Scan deleted (cascade removed its findings).", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c04382e5-4cbb-491f-b8e7-0f330897c02c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb0acca-3403-4e3a-afb2-cc4ef6aba332", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d55a4b4-edf7-45d5-afca-7fbcd370b990", "name": "Scan not found, or not visible to the caller.", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49575360-4cbc-494d-990d-034f4f86e476", "name": "Scan is active (cancel it first) or carries a release label (pass ``force=true`` to delete).", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e1d2a78f-5bed-4162-9728-3233c864b78f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a3f87ff-66c3-47c8-9d52-02629fb0a40c", "name": "Read one scan (IDOR-safe via project team membership)", "request": { "name": "Read one scan (IDOR-safe via project team membership)", "description": {}, "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "759d6192-b342-42be-8f22-1631fcaeba6e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"71d389b9-d220-9b3c-4322-dc670d4d5c61\",\n \"project_id\": \"e415d9ad-efb9-28d7-d98d-0678d770b3a2\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 2509,\n \"current_step\": \"string\",\n \"started_at\": \"2012-07-01T21:51:55.001Z\",\n \"completed_at\": \"2009-08-04T21:40:02.964Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"42c7c0bf-afaa-5b12-33ed-523a85612cbe\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2010-04-05T06:49:10.828Z\",\n \"updated_at\": \"1992-08-14T00:47:52.435Z\",\n \"metadata\": {\n \"key_0\": false\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1949-08-14T22:55:36.747Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6044dfb1-25aa-4eaa-85db-63c0a6665556", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a08d055-9fd1-48a7-9862-57d2f4d3f7a1", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dfec15d-27eb-4a75-9b37-5f20d39bf0ba", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb186f07-024f-449c-b736-641f76a969ec", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ffe65ea1-f158-4d68-8067-83c727ac6140", "name": "Cancel a queued / running scan owned by the caller's team", "request": { "name": "Cancel a queued / running scan owned by the caller's team", "description": { "content": "Cancel one of the caller's own team's scans.\n\nPR-A1 (scan stability). Auth: any authenticated team member\n(``developer`` or higher). The owning-team check lives in the service\n(``cancel_scan_for_actor``) which existence-hides other teams' scans as\n404 — so a developer cannot probe scan ids belonging to other teams.\n\nAdmin force-cancel (``POST /v1/admin/scans/{id}/cancel``) remains separate\nand cross-team; the two share the same revoke + status-mutation core.", "type": "text/plain" }, "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ad410ec7-7019-42da-ad23-96f4f0906680", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c7f2e43-fb31-449e-89ba-b0ebeb36f9c9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d88a30e1-58af-4642-ae57-cb1f5c858b83", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0448bad4-9b62-400d-a090-f77d7c6c1552", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72b36b74-688c-41cd-8f8c-91c0ab48ccaa", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "baa8dbaf-818e-4719-977c-1eff1a5e7987", "name": "Download the persisted tool log for one scan", "request": { "name": "Download the persisted tool log for one scan", "description": { "content": "Stream the per-scan ``scan.log`` written by ``tasks._progress.publish_log``.\n\nAuthorization: same gate as ``GET /v1/scans/{scan_id}`` — reuses\n``services.scan_service.get_scan`` so team-membership / super-admin rules\nstay in lock-step with the metadata endpoint. A non-member sees the same\n404 as a non-existent scan id (existence-hide) so a developer cannot probe\nscan ids belonging to other teams via this endpoint.\n\nLifecycle: the file is written incrementally by the worker as the scan\nruns. While the scan is still running the response returns whatever has\nbeen flushed so far (the publisher uses a line-buffered handle, so each\ncompleted line is on disk by the time it is on the WebSocket). After the\nscan terminates the file stays on disk until ``workspace_cleaner`` reaps\nthe parent workspace directory (current default: per\n``WORKSPACE_ORPHAN_MAX_AGE_SECONDS``).", "type": "text/plain" }, "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "89af1433-b688-487e-b018-9784fb09f5b4", "name": "Plain-text scan log, streamed.", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "709c36ff-87a5-4d7d-b0ff-c000afa62c25", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecd28136-4ef2-40d0-bb3b-56c162751497", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18024e88-d350-4847-acc4-48f9e890d5ac", "name": "No scan log is available for this scan id. The body is deliberately the same for every miss path (scan not found, caller has no access, log file not yet on disk, or path traversal defense triggered) so the response envelope cannot be used to enumerate scan ids across teams. Operators can distinguish branches via the ``scan_log_not_found`` structlog event's ``reason`` field.", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8e12c9d-4798-4f70-b134-1574f4767189", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3114981a-509d-4dd2-bb15-71c7438e5f17", "name": "Where a scan's results came from (IDOR-safe via project team membership)", "request": { "name": "Where a scan's results came from (IDOR-safe via project team membership)", "description": { "content": "Serve the scan's recorded inputs.\n\nExistence-hide comes from ``get_scan`` — the same resolver the scan read\nuses — so an id in another team is indistinguishable here from one that\nnever existed. Nothing about this route may answer a question the scan read\nwould refuse.\n\nA scan with neither half recorded is a 200 with two nulls, not a 404: the\nscan exists and the honest answer is that nothing was recorded, which a\n404 would misreport as \"no such scan\".", "type": "text/plain" }, "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "05bdc1de-366d-4b97-b10b-918261274aa9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scan_id\": \"eae20b3f-9d96-7083-5ad5-915d5b1c51f1\",\n \"kind\": \"container\",\n \"document\": {\n \"format\": \"string\",\n \"component_count\": 6767,\n \"authors\": [\n \"string\",\n \"string\"\n ],\n \"byte_size\": 7002,\n \"created\": \"string\",\n \"original_filename\": \"string\",\n \"serial_number\": \"string\",\n \"spec_version\": \"string\",\n \"subject\": \"string\",\n \"subject_version\": \"string\",\n \"supplier\": \"string\",\n \"tools\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"manifests\": {\n \"files\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"count\": 9559,\n \"truncated\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea1a8cec-ae83-4bc1-be7c-16d7394fcaf6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b96c1d41-4612-4270-b4f0-9b99fd47ab89", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2444e2ae-b8fa-482b-8499-90c0289b525c", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65265217-ac22-480a-87b5-3b64302c7bcf", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "779ff3ce-0d64-f251-cd8e-0a91f439498c", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb6f998c-854c-47a7-bac8-b682c8948e22", "name": "Start a scan on many projects (auth required, role >= developer)", "request": { "name": "Start a scan on many projects (auth required, role >= developer)", "description": { "content": "Start the first scan on a set of freshly registered projects.\n\nThe team's concurrent-scan cap is re-counted for each row against the\nteam's live active-scan total, so a batch starts scans up to the cap and\nreports the rest as `rate_limited` with an estimated wait. It is not a way\naround the cap: the cap protects the shared worker pool, and queueing past\nit would move the load rather than shed it. Send the remainder again once\nthe earlier scans finish.\n\nA project that already has a queued or running scan counts as success, for\nthe same reason an existing project does in the project batch: that is the\nstate the caller asked for.\n\nStatus is 201 when every row started and 207 when any did not.", "type": "text/plain" }, "url": { "path": [ "v1", "scans:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"8f93a50b-06a0-b692-cbab-90ef0c9a80b2\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "098de674-c01a-433b-9539-32ebb89b95c8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"8f93a50b-06a0-b692-cbab-90ef0c9a80b2\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"all_succeeded\": true,\n \"total\": 3838,\n \"created\": 6570,\n \"already_existed\": 1602,\n \"failed\": 2384,\n \"rows\": [\n {\n \"index\": 8898,\n \"status\": \"forbidden\",\n \"detail\": \"string\",\n \"project_id\": \"0fcf484f-ec22-009e-06ca-efee16924aa1\",\n \"retry_after_seconds\": 6221,\n \"scan_id\": \"f15042f0-3046-c190-433e-a2ef91f3ffc0\"\n },\n {\n \"index\": 7436,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"f74262f5-5724-7e81-02f6-16cd31e26604\",\n \"retry_after_seconds\": 6958,\n \"scan_id\": \"66f537ef-f8ea-e9d2-f210-cfcc5d46e256\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 9871,\n \"key_1\": 3184,\n \"key_2\": 3651\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "521be209-2906-4bef-86ea-7c04f38ec770", "name": "Some rows did not start. The body is the same shape; read `all_succeeded` and `failed_by_status`.", "originalRequest": { "url": { "path": [ "v1", "scans:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"8f93a50b-06a0-b692-cbab-90ef0c9a80b2\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"all_succeeded\": true,\n \"total\": 3838,\n \"created\": 6570,\n \"already_existed\": 1602,\n \"failed\": 2384,\n \"rows\": [\n {\n \"index\": 8898,\n \"status\": \"forbidden\",\n \"detail\": \"string\",\n \"project_id\": \"0fcf484f-ec22-009e-06ca-efee16924aa1\",\n \"retry_after_seconds\": 6221,\n \"scan_id\": \"f15042f0-3046-c190-433e-a2ef91f3ffc0\"\n },\n {\n \"index\": 7436,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"f74262f5-5724-7e81-02f6-16cd31e26604\",\n \"retry_after_seconds\": 6958,\n \"scan_id\": \"66f537ef-f8ea-e9d2-f210-cfcc5d46e256\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 9871,\n \"key_1\": 3184,\n \"key_2\": 3651\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "522f1b35-eaf5-4fb1-9054-ca9e47be6bba", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"8f93a50b-06a0-b692-cbab-90ef0c9a80b2\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbe0c83c-dd7a-445b-a210-ba1d8bedcb22", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"8f93a50b-06a0-b692-cbab-90ef0c9a80b2\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8e1fed0-7fcc-4890-90f2-f04b0e6bab97", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans:batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"8f93a50b-06a0-b692-cbab-90ef0c9a80b2\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9a02853c-a3b3-4b7b-a5c2-9df2079a6638", "name": "source-tree", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a9edc34f-c524-4ee0-a7a7-b74677d7ab8b", "name": "Read one file from a scan's preserved source + per-line license matches", "request": { "name": "Read one file from a scan's preserved source + per-line license matches", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "path", "value": "string", "description": "(Required) File to read, relative to the source root." }, { "disabled": false, "key": "raw", "value": "false", "description": "When true, stream the FULL member as application/octet-stream (no per-file viewer cap) for download instead of the capped JSON preview. Same path-traversal / symlink defences apply." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "167588cd-5e5b-47db-834f-daa956f006ea", "name": "Capped file JSON (default), or — with ``raw=true`` — the FULL member streamed as application/octet-stream.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "string" }, { "key": "raw", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"byte_size\": 1071,\n \"content\": \"MIT License\\n\\nCopyright (c) ...\",\n \"encoding\": \"utf-8\",\n \"license_matches\": [\n {\n \"end_line\": 21,\n \"score\": 99.5,\n \"spdx_id\": \"MIT\",\n \"start_line\": 1\n }\n ],\n \"path\": \"LICENSE\",\n \"scan_id\": \"5b6c0f2e-3a1d-4e8a-9b2c-7d4e1f0a9c33\",\n \"truncated\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09ad4f98-11f9-4074-823d-3d8fb9e0329a", "name": "Malformed path selector", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "string" }, { "key": "raw", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5932b3c-192c-4ef4-9242-8a837785b2a9", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "string" }, { "key": "raw", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4fe0f85a-53e9-4d78-87cf-f46d5b44b25f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "string" }, { "key": "raw", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58df23eb-0d02-4fa5-a20b-1d2b95427521", "name": "Project / scan / file not available", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "string" }, { "key": "raw", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8519f375-f203-4886-b1ff-7fd5ba6a13e5", "name": "Requested member is a directory / non-regular file", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "string" }, { "key": "raw", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3698ae62-5e46-4907-88af-86edb4351b7e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-file" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "string" }, { "key": "raw", "value": "false" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "295cf40d-c22e-4de8-855d-34da1e609d6c", "name": "List immediate children of a directory in a scan's preserved source", "request": { "name": "List immediate children of a directory in a scan's preserved source", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "source-tree" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "path", "value": "", "description": "Directory whose immediate children to list. Empty = root." }, { "disabled": false, "key": "page", "value": "1", "description": "1-based page index." }, { "disabled": false, "key": "size", "value": "100", "description": "Page size (max 500)." }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e077365f-05b5-426f-981d-3bf7bea75e05", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-tree" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "" }, { "key": "page", "value": "1" }, { "key": "size", "value": "100" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"entries\": [\n {\n \"byte_size\": 1280,\n \"is_dir\": false,\n \"license_spdx_ids\": [\n \"MIT\"\n ],\n \"name\": \"main.py\",\n \"path\": \"src/main.py\"\n }\n ],\n \"page\": 1,\n \"path\": \"src\",\n \"scan_id\": \"5b6c0f2e-3a1d-4e8a-9b2c-7d4e1f0a9c33\",\n \"size\": 50,\n \"total\": 1\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "828b104a-c8a0-4564-b271-7fecd4d5710c", "name": "Malformed path selector", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-tree" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "" }, { "key": "page", "value": "1" }, { "key": "size", "value": "100" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e83b7f2-db1a-41cb-8e19-78c46e90fe9c", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-tree" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "" }, { "key": "page", "value": "1" }, { "key": "size", "value": "100" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "337e7148-b35b-403a-89f6-7137c0ece064", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-tree" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "" }, { "key": "page", "value": "1" }, { "key": "size", "value": "100" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cf670e0-1916-4c96-a22b-3792ee1ca9f5", "name": "Project / scan / preserved source not available", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-tree" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "" }, { "key": "page", "value": "1" }, { "key": "size", "value": "100" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4b1a1de-7af1-4fc3-ac70-6fa1a284b97c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-tree" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "path", "value": "" }, { "key": "page", "value": "1" }, { "key": "size", "value": "100" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e57527ed-ed5c-4854-8db2-29d1b262e136", "name": "vex", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f5b80445-7ed8-4968-84f9-fded16ebd9ed", "name": "Export a VEX document from the project's current finding triage", "request": { "name": "Export a VEX document from the project's current finding triage", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "format", "value": "openvex", "description": "VEX output format." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4240c14e-4e5a-4b91-a64a-b8e7d1ef0674", "name": "VEX document download", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "openvex" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b7ccf54-a8ed-4cb6-9a63-d043be257b68", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "openvex" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23aaf90e-1781-43b2-8ea4-adfd935e1771", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "openvex" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d1de0c2-879b-4e52-8507-82175c484f07", "name": "Project not found or not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "openvex" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f060bbf-49bd-404c-b513-451f64cbe20f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "openvex" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b25fcfb-9e18-4808-961f-b73a0318472a", "name": "Import a VEX document, auto-transitioning matching findings (team_admin)", "request": { "name": "Import a VEX document, auto-transitioning matching findings (team_admin)", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "upload", "value": "string", "type": "text", "description": "(Required) An OpenVEX or CycloneDX VEX JSON document (format auto-detected)." } ] } }, "response": [ { "id": "14dc9696-857a-466c-b6e0-d148e56c2062", "name": "Import summary (matched/applied/skipped/errors)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) An OpenVEX or CycloneDX VEX JSON document (format auto-detected).", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"format\": \"openvex\",\n \"matched\": 2327,\n \"applied\": 4240,\n \"skipped\": 2559,\n \"errors\": [\n {\n \"reason\": \"malformed_statement\",\n \"detail\": \"string\",\n \"product\": \"string\",\n \"vulnerability\": \"string\"\n },\n {\n \"reason\": \"unmapped_status\",\n \"detail\": \"string\",\n \"product\": \"string\",\n \"vulnerability\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "085a563c-d8af-432c-9575-80222bf89882", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) An OpenVEX or CycloneDX VEX JSON document (format auto-detected).", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a44b7d0e-acfc-47ea-a378-7a40b6b552b8", "name": "Requires team_admin within the project's team", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) An OpenVEX or CycloneDX VEX JSON document (format auto-detected).", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00029378-a688-4f1a-ac0a-b2ae054e79b7", "name": "Project not found or not accessible", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) An OpenVEX or CycloneDX VEX JSON document (format auto-detected).", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fa165572-b7ec-4aa3-b76e-ffe0fb7479dd", "name": "VEX document too large", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) An OpenVEX or CycloneDX VEX JSON document (format auto-detected).", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99d30385-ad1c-4dba-bb74-f32e8997afb1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) An OpenVEX or CycloneDX VEX JSON document (format auto-detected).", "type": "text/plain" }, "key": "upload", "value": "string", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "49e8383c-b069-4e5f-8f44-3c5a468b4fc6", "name": "vulnerabilities", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f5b4aeac-2d83-4e5b-bd0d-a6fbf821b617", "name": "Paginated CVE findings for the project's latest scan", "request": { "name": "Paginated CVE findings for the project's latest scan", "description": {}, "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "offset", "value": "0" }, { "disabled": false, "key": "search", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string", "description": "W2 #33 — License risk-axis filter. Repeatable; accepted values: ``forbidden``, ``conditional``, ``allowed``, ``unknown`` (the cv had no license finding in this scan). Unknown values are dropped, so a query that filters ONLY by unknown values returns an empty page (not a 422). Omit to include all categories." }, { "disabled": false, "key": "license_category", "value": "string", "description": "W2 #33 — License risk-axis filter. Repeatable; accepted values: ``forbidden``, ``conditional``, ``allowed``, ``unknown`` (the cv had no license finding in this scan). Unknown values are dropped, so a query that filters ONLY by unknown values returns an empty page (not a 422). Omit to include all categories." }, { "disabled": false, "key": "min_epss", "value": "0.49295742347547855", "description": "Keep only findings whose CVE has an EPSS exploit-probability >= this threshold, in [0, 1]. CVEs with no published EPSS score are excluded. Omit to disable EPSS filtering." }, { "disabled": false, "key": "reachable", "value": "unknown", "description": "Tri-state reachability filter (v2.3). ``true`` → only findings whose vulnerable symbol is reachable on the call graph; ``false`` → only findings an analyser proved NOT reachable; ``unknown`` → only not-analysed findings (reachable IS NULL). Omit to disable the reachability filter." }, { "disabled": false, "key": "sla", "value": "overdue", "description": "X1 SLA filter (single value). ``overdue`` → past the per-severity SLA due date; ``imminent`` → due within 7 days; ``ok`` → inside the window. Findings with no SLA (info / unknown severity) never match any token. Omit to disable SLA filtering." }, { "disabled": false, "key": "assignee", "value": "inactive", "description": "Ownership filter. `me` returns the caller's own findings, `unassigned` the ones nobody has taken, and `inactive` the ones assigned to somebody whose account is closed, which look owned and cannot move. Values name a state rather than a person: the parameter already says whose. Deliberately not a user id, which would add a way to ask which findings a named person owns without any screen needing it." }, { "disabled": false, "key": "sort", "value": "severity", "description": "Sort key. ``reachable`` ranks reachable findings first (then not-analysed, then proven-unreachable), tie-broken by severity desc. ``component`` sorts by affected package name. ``priority`` is the triage ranking: CISA-KEV-listed CVEs first, then severity desc, then EPSS desc (nulls last). ``sla_due`` orders by the SLA due date (asc = most urgent first); findings with no SLA sort last in both directions." }, { "disabled": false, "key": "order", "value": "desc" }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "32b21f5a-2089-414e-a30f-8bd6d97c8c20", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"03d13fd7-f2e2-a3ea-89d3-3d26947f027a\",\n \"cve_id\": \"string\",\n \"severity\": \"info\",\n \"status\": \"false_positive\",\n \"affected_component_count\": 7164,\n \"discovered_at\": \"1994-04-30T09:30:22.552Z\",\n \"first_detected_at\": \"1997-04-16T20:45:55.863Z\",\n \"updated_at\": \"1972-03-31T16:01:42.196Z\",\n \"affected_component_license\": \"string\",\n \"affected_component_license_category\": \"unknown\",\n \"affected_component_name\": \"string\",\n \"affected_component_version\": \"string\",\n \"analysis_source\": \"vex_import\",\n \"assignee_is_active\": true,\n \"assignee_user_id\": \"0cc59117-b3d0-0903-80c8-180ce4764e65\",\n \"component_license_category\": \"conditional\",\n \"cvss_score\": 1524.072166135866,\n \"due_on\": \"2010-02-24\",\n \"due_source\": \"sla\",\n \"effective_due_date\": \"1947-12-08T15:37:56.005Z\",\n \"epss_percentile\": 0.5317346663612612,\n \"epss_score\": 0.3128968623645376,\n \"kev\": false,\n \"kev_due_date\": \"2016-09-22\",\n \"reachability_analyzed_at\": \"2008-02-01T18:41:15.316Z\",\n \"reachability_source\": \"string\",\n \"reachable\": false,\n \"sla_due_date\": \"2008-06-26T14:23:04.723Z\",\n \"sla_status\": \"ok\",\n \"summary\": \"string\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n },\n {\n \"id\": \"26aa1b61-7e38-1712-e00f-8ff4ef1fdd8b\",\n \"cve_id\": \"string\",\n \"severity\": \"critical\",\n \"status\": \"suppressed\",\n \"affected_component_count\": 4232,\n \"discovered_at\": \"1980-09-13T09:56:31.664Z\",\n \"first_detected_at\": \"2006-12-31T15:47:17.932Z\",\n \"updated_at\": \"1993-12-28T14:56:33.648Z\",\n \"affected_component_license\": \"string\",\n \"affected_component_license_category\": \"unknown\",\n \"affected_component_name\": \"string\",\n \"affected_component_version\": \"string\",\n \"analysis_source\": \"manual\",\n \"assignee_is_active\": false,\n \"assignee_user_id\": \"5d70bc8c-4998-9813-a77f-ee6779be58f4\",\n \"component_license_category\": \"conditional\",\n \"cvss_score\": 7208.373320342994,\n \"due_on\": \"2002-07-01\",\n \"due_source\": \"manual\",\n \"effective_due_date\": \"2006-11-26T00:04:21.845Z\",\n \"epss_percentile\": 0.8840455275120598,\n \"epss_score\": 0.24236174624986706,\n \"kev\": false,\n \"kev_due_date\": \"1961-09-18\",\n \"reachability_analyzed_at\": \"1998-09-01T16:55:25.935Z\",\n \"reachability_source\": \"string\",\n \"reachable\": false,\n \"sla_due_date\": \"2009-01-01T18:10:46.357Z\",\n \"sla_status\": \"imminent\",\n \"summary\": \"string\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n }\n ],\n \"total\": 9959,\n \"limit\": 5703,\n \"offset\": 7536,\n \"severity_distribution\": {\n \"key_0\": 477\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48341033-bc23-45d2-ae3c-361cc3b617f7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e59495d4-6b6d-45ae-b024-af011aeef21e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c17cf7ac-f21c-43d8-93ec-1e82f8afc678", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14965efb-3f65-48bb-aa12-3e496864777e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eda6aef5-52b3-40ba-9053-8e36a86727d4", "name": "The filtered CVE findings as CSV", "request": { "name": "The filtered CVE findings as CSV", "description": { "content": "The same rows the list endpoint would return, without the paging.\n\nEvery filter the list accepts is accepted here and applied by the same\ncode: the export pages the list service rather than rebuilding its query,\nso a filter that narrows the screen narrows the file identically, and the\ncross-team check the list performs is the one this performs.\n\n``limit`` and ``offset`` are deliberately absent. Exporting \"page 3 of\nwhat I am looking at\" is not a thing anyone wants, and accepting them\nwould invite a caller to walk the table with a script.\n\n``sort``/``order`` are still accepted and still validated (an invalid\nvalue still 422s), but no longer decide the exported rows' order (#463):\nthe export walks a fixed key (the finding id) instead of the screen's 8\nsort modes, so a filtered export that reaches real depth does not pay\nfor ``OFFSET``'s cost growing with it. Kept on the signature rather than\ndropped so an existing caller's `?sort=...&order=...` keeps 200ing\ninstead of 422ing on an unknown parameter.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "min_epss", "value": "0.49295742347547855" }, { "disabled": false, "key": "reachable", "value": "unknown" }, { "disabled": false, "key": "sla", "value": "overdue" }, { "disabled": false, "key": "assignee", "value": "inactive" }, { "disabled": false, "key": "sort", "value": "severity" }, { "disabled": false, "key": "order", "value": "desc" }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a5b173b0-ad62-4201-a726-d3f3cdc18dc0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7cf87d0f-db33-4ef2-873f-5953fcb778aa", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8edfa83e-1879-4423-af2d-8bf68f2c315a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dbc3559-809c-4e67-b61b-134aea35aee6", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10b1a46c-d788-47c2-b794-115c6322f324", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "min_epss", "value": "0.49295742347547855" }, { "key": "reachable", "value": "unknown" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "inactive" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4349513c-0868-4869-9c5e-734d25478e83", "name": "Open findings grouped by the component upgrade that fixes them", "request": { "name": "Open findings grouped by the component upgrade that fixes them", "description": { "content": "The \"Group by upgrade\" view: the resolved scan's OPEN findings grouped by\nthe minimum safe upgrade that clears them, most-actionable first.\n\nSame auth / snapshot semantics as the list endpoint — non-member → 403,\nmissing project → 404, unresolvable ``?scan_id=`` → 404, no succeeded scan →\n200 with an empty ``clusters`` and ``total_findings == 0``.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "50" }, { "disabled": false, "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99", "description": "Optional release-snapshot anchor. Read this surface as of ONE specific succeeded scan instead of the project's current state. Must belong to this project and be succeeded, else 404. Takes precedence over ``release``." }, { "disabled": false, "key": "release", "value": "string", "description": "Optional version anchor — read this surface as of the release carrying this label (e.g. '4.0'). Equivalent to looking the label up on ``/releases?release=`` and pinning the ``scan_id`` it returns, but as one permanent URL. Matched exactly, whitespace trimmed. Unknown label → 404, and so does a label in a project you cannot read. Ignored when ``scan_id`` is also given." } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8ec8b845-2e8f-4d6e-90e3-ba9731161a04", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total_findings\": 8787,\n \"clusters\": [\n {\n \"component_version_id\": \"7d1bffae-4d08-4489-c703-36355e4ef4f1\",\n \"component_name\": \"lodash\",\n \"current_version\": \"4.17.19\",\n \"reason\": \"no_open_findings\",\n \"direct\": true,\n \"finding_count\": 9351,\n \"findings\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"component_purl\": \"string\",\n \"max_epss\": 0.8372006298776911,\n \"max_severity\": \"info\",\n \"recommended_version\": \"string\"\n },\n {\n \"component_version_id\": \"d362b024-b6e8-f52d-3b54-1a4ba8c3501a\",\n \"component_name\": \"lodash\",\n \"current_version\": \"4.17.19\",\n \"reason\": \"no_open_findings\",\n \"direct\": false,\n \"finding_count\": 8842,\n \"findings\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"component_purl\": \"string\",\n \"max_epss\": 0.3805092727737911,\n \"max_severity\": \"medium\",\n \"recommended_version\": \"string\"\n }\n ],\n \"scan_id\": \"d6861bbb-f1eb-4e8a-143e-8af73b3f03da\",\n \"total_clusters\": 0,\n \"truncated\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "212d9d70-3074-4250-8999-a7d7233de209", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7159ea7-b77d-46ad-922b-5da69b58b1a5", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab5b547d-848d-4183-8140-a77f13549fcf", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "022dcd5f-38a7-423e-849f-5d3aa6fa4031", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "cb9ec708-aa08-8a32-0af6-345d92d80d99" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e197a68c-c73b-4f4d-b6ef-aa90b13defcd", "name": "Transition many findings in one project to the same VEX status", "request": { "name": "Transition many findings in one project to the same VEX status", "description": { "content": "W2 #33b — apply one VEX transition across many findings in one round-trip.\n\nPer-row failures (404 / 403 / 422) are surfaced in the response envelope\nso the UI can render \"succeeded N · failed M\" with per-row details.\nOnly envelope-level shape violations (empty list, > cap, unknown enum)\nreturn RFC 7807 — those would still abort a per-row partial commit, so\nthey belong on the envelope rather than masquerading as per-row outcomes.", "type": "text/plain" }, "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"5bb7a8f3-213e-e198-7398-6beaf70b1f3c\"\n ],\n \"target_status\": \"not_affected\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb6cbb70-6ae5-47c3-8ad6-08885aee1571", "name": "Bulk envelope completed. ``results[*].status_code`` reports per-row outcomes (200/403/404/422). ``succeeded`` + ``failed`` == ``total``.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"5bb7a8f3-213e-e198-7398-6beaf70b1f3c\"\n ],\n \"target_status\": \"not_affected\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"target_status\": \"suppressed\",\n \"total\": 5364,\n \"succeeded\": 1219,\n \"failed\": 9507,\n \"results\": [\n {\n \"finding_id\": \"bedbc34b-9842-e71e-3c82-ac905f030c0b\",\n \"success\": true,\n \"status_code\": 442,\n \"allowed_to\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"detail\": \"string\",\n \"error\": \"string\"\n },\n {\n \"finding_id\": \"d0b6789a-3336-d562-1420-f7a788f26758\",\n \"success\": false,\n \"status_code\": 314,\n \"allowed_to\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"detail\": \"string\",\n \"error\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6526ba4-564f-40da-9313-960c1d2d35ea", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"5bb7a8f3-213e-e198-7398-6beaf70b1f3c\"\n ],\n \"target_status\": \"not_affected\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbb09e0f-8a70-4757-b164-1b719e4e39aa", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"5bb7a8f3-213e-e198-7398-6beaf70b1f3c\"\n ],\n \"target_status\": \"not_affected\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6818e61-cc90-4542-ba85-5abbe6bf58c4", "name": "Project does not exist, OR the caller is not a member of the project's team. Returned in lieu of 403 to avoid leaking team membership (mirrors the single-row PATCH existence-hide policy).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"5bb7a8f3-213e-e198-7398-6beaf70b1f3c\"\n ],\n \"target_status\": \"not_affected\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "711842e8-2c76-4c48-851c-395bb8062811", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"5bb7a8f3-213e-e198-7398-6beaf70b1f3c\"\n ],\n \"target_status\": \"not_affected\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "becea4d6-d162-48a5-9ace-19fc4881d042", "name": "Vulnerability finding drawer payload (404 if invisible to caller)", "request": { "name": "Vulnerability finding drawer payload (404 if invisible to caller)", "description": {}, "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b081a14c-970b-43f4-a7d2-2eb8f225396b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1e9009c7-0998-b68f-d303-ecb768d5ba1e\",\n \"project_id\": \"d433e01d-c5c9-b8b0-19fe-8a9292a488ee\",\n \"scan_id\": \"21fa1644-4827-246e-e9f2-4d25665a4176\",\n \"cve_id\": \"string\",\n \"severity\": \"info\",\n \"status\": \"fixed\",\n \"first_detected_at\": \"2004-06-05T06:45:29.941Z\",\n \"created_at\": \"1973-05-27T00:05:05.060Z\",\n \"updated_at\": \"1966-07-25T13:56:11.366Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"e45c806d-d2f4-65a4-e042-7a61b4976053\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n },\n {\n \"component_version_id\": \"3f1e2c83-c228-88c7-130f-441f0eac6eaf\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n }\n ],\n \"analysis_justification\": \"string\",\n \"analysis_source\": \"manual\",\n \"analysis_state\": \"string\",\n \"analyst_user_id\": \"c4e92efe-f64e-30cc-76a2-aba20ca0cdc8\",\n \"analyzed_at\": \"1956-09-24T08:37:06.018Z\",\n \"assignee_is_active\": false,\n \"assignee_user_id\": \"aac7a80a-2c6b-5606-9a03-af97fa0dd9a9\",\n \"cvss_score\": 7572.564529578636,\n \"cvss_vector\": \"string\",\n \"details\": \"string\",\n \"due_on\": \"1977-06-21\",\n \"due_source\": \"sla\",\n \"effective_due_date\": \"1979-01-13T23:00:54.383Z\",\n \"epss_percentile\": 0.6360384398225383,\n \"epss_score\": 0.8618092197341285,\n \"kev\": false,\n \"kev_due_date\": \"1987-02-05\",\n \"manual_due_ignored\": false,\n \"matching_provenance\": {\n \"name\": \"string\",\n \"feed_url\": \"string\",\n \"id\": \"string\"\n },\n \"published_at\": \"2025-11-23T23:40:34.341Z\",\n \"reachability_analyzed_at\": \"2007-01-27T12:32:17.901Z\",\n \"reachability_source\": \"string\",\n \"reachable\": true,\n \"sla_due_date\": \"1950-05-26T00:00:12.137Z\",\n \"sla_status\": \"ok\",\n \"status_history\": [\n {\n \"action\": \"string\",\n \"new_status\": \"analyzing\",\n \"created_at\": \"1983-05-20T09:46:59.884Z\",\n \"actor_user_id\": \"0050fe99-8419-aa3a-1bc7-bbe654e28d16\",\n \"previous_status\": \"false_positive\",\n \"request_id\": \"string\"\n },\n {\n \"action\": \"string\",\n \"new_status\": \"suppressed\",\n \"created_at\": \"2024-12-02T19:53:43.570Z\",\n \"actor_user_id\": \"88f0034f-cdc6-4e58-65b1-1a5a4332cdcc\",\n \"previous_status\": \"analyzing\",\n \"request_id\": \"string\"\n }\n ],\n \"summary\": \"string\",\n \"ticket_check_error\": \"string\",\n \"ticket_checked_at\": \"1967-04-09T13:15:17.459Z\",\n \"ticket_key\": \"string\",\n \"ticket_resolved\": false,\n \"ticket_status\": \"string\",\n \"ticket_url\": \"string\",\n \"upgrade_recommendation\": {\n \"reason\": \"unparseable_version\",\n \"direct\": true,\n \"finding_count\": 0,\n \"max_epss\": 0.03811280620990343,\n \"max_severity\": \"high\",\n \"recommended_version\": \"string\"\n },\n \"vex_origin\": {\n \"author\": \"string\",\n \"format\": \"cyclonedx\",\n \"id\": \"string\",\n \"imported_at\": \"string\",\n \"timestamp\": \"string\",\n \"vex_status\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c90faa1-c699-4478-a2b1-ff84aae15ee8", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e0309d8-aab0-4d1c-ac5c-bbb58b9830ec", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd76675-a878-4b0a-8f70-edbe79ff0d5e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1234c79f-35c2-4474-927f-d1f8f76554ed", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "115f1cae-2fec-4ccd-99b6-06ed620fb98a", "name": "Set a finding's owner, deadline and ticket (audit-logged)", "request": { "name": "Set a finding's owner, deadline and ticket (audit-logged)", "description": {}, "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"4ce203ed-c5b0-5051-74f2-e9007635dd2b\",\n \"due_on\": \"2019-12-22\",\n \"if_match\": \"1990-10-31T15:36:14.975Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "061b34dc-d3a7-490e-af4d-8411edb497c9", "name": "Assignment updated. The body is the post-commit detail payload, which carries `effective_due_date`, `due_source` and `manual_due_ignored` so the caller can tell the person immediately when a date they just set does not govern.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"4ce203ed-c5b0-5051-74f2-e9007635dd2b\",\n \"due_on\": \"2019-12-22\",\n \"if_match\": \"1990-10-31T15:36:14.975Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1e9009c7-0998-b68f-d303-ecb768d5ba1e\",\n \"project_id\": \"d433e01d-c5c9-b8b0-19fe-8a9292a488ee\",\n \"scan_id\": \"21fa1644-4827-246e-e9f2-4d25665a4176\",\n \"cve_id\": \"string\",\n \"severity\": \"info\",\n \"status\": \"fixed\",\n \"first_detected_at\": \"2004-06-05T06:45:29.941Z\",\n \"created_at\": \"1973-05-27T00:05:05.060Z\",\n \"updated_at\": \"1966-07-25T13:56:11.366Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"e45c806d-d2f4-65a4-e042-7a61b4976053\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n },\n {\n \"component_version_id\": \"3f1e2c83-c228-88c7-130f-441f0eac6eaf\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n }\n ],\n \"analysis_justification\": \"string\",\n \"analysis_source\": \"manual\",\n \"analysis_state\": \"string\",\n \"analyst_user_id\": \"c4e92efe-f64e-30cc-76a2-aba20ca0cdc8\",\n \"analyzed_at\": \"1956-09-24T08:37:06.018Z\",\n \"assignee_is_active\": false,\n \"assignee_user_id\": \"aac7a80a-2c6b-5606-9a03-af97fa0dd9a9\",\n \"cvss_score\": 7572.564529578636,\n \"cvss_vector\": \"string\",\n \"details\": \"string\",\n \"due_on\": \"1977-06-21\",\n \"due_source\": \"sla\",\n \"effective_due_date\": \"1979-01-13T23:00:54.383Z\",\n \"epss_percentile\": 0.6360384398225383,\n \"epss_score\": 0.8618092197341285,\n \"kev\": false,\n \"kev_due_date\": \"1987-02-05\",\n \"manual_due_ignored\": false,\n \"matching_provenance\": {\n \"name\": \"string\",\n \"feed_url\": \"string\",\n \"id\": \"string\"\n },\n \"published_at\": \"2025-11-23T23:40:34.341Z\",\n \"reachability_analyzed_at\": \"2007-01-27T12:32:17.901Z\",\n \"reachability_source\": \"string\",\n \"reachable\": true,\n \"sla_due_date\": \"1950-05-26T00:00:12.137Z\",\n \"sla_status\": \"ok\",\n \"status_history\": [\n {\n \"action\": \"string\",\n \"new_status\": \"analyzing\",\n \"created_at\": \"1983-05-20T09:46:59.884Z\",\n \"actor_user_id\": \"0050fe99-8419-aa3a-1bc7-bbe654e28d16\",\n \"previous_status\": \"false_positive\",\n \"request_id\": \"string\"\n },\n {\n \"action\": \"string\",\n \"new_status\": \"suppressed\",\n \"created_at\": \"2024-12-02T19:53:43.570Z\",\n \"actor_user_id\": \"88f0034f-cdc6-4e58-65b1-1a5a4332cdcc\",\n \"previous_status\": \"analyzing\",\n \"request_id\": \"string\"\n }\n ],\n \"summary\": \"string\",\n \"ticket_check_error\": \"string\",\n \"ticket_checked_at\": \"1967-04-09T13:15:17.459Z\",\n \"ticket_key\": \"string\",\n \"ticket_resolved\": false,\n \"ticket_status\": \"string\",\n \"ticket_url\": \"string\",\n \"upgrade_recommendation\": {\n \"reason\": \"unparseable_version\",\n \"direct\": true,\n \"finding_count\": 0,\n \"max_epss\": 0.03811280620990343,\n \"max_severity\": \"high\",\n \"recommended_version\": \"string\"\n },\n \"vex_origin\": {\n \"author\": \"string\",\n \"format\": \"cyclonedx\",\n \"id\": \"string\",\n \"imported_at\": \"string\",\n \"timestamp\": \"string\",\n \"vex_status\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdae8037-beff-45d6-aaae-8b3932056dfe", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"4ce203ed-c5b0-5051-74f2-e9007635dd2b\",\n \"due_on\": \"2019-12-22\",\n \"if_match\": \"1990-10-31T15:36:14.975Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79bcb242-fa36-4a26-bbc2-72f0aa84a4e9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"4ce203ed-c5b0-5051-74f2-e9007635dd2b\",\n \"due_on\": \"2019-12-22\",\n \"if_match\": \"1990-10-31T15:36:14.975Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aac3737c-388a-4d42-b19e-e0a4a7c0500d", "name": "Finding does not exist, or exists in a team the caller cannot access. Returned in lieu of 403 to avoid leaking existence.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"4ce203ed-c5b0-5051-74f2-e9007635dd2b\",\n \"due_on\": \"2019-12-22\",\n \"if_match\": \"1990-10-31T15:36:14.975Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc673487-2dd0-4d62-a4e2-d298d6330bfd", "name": "if_match snapshot did not match the current updated_at.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"4ce203ed-c5b0-5051-74f2-e9007635dd2b\",\n \"due_on\": \"2019-12-22\",\n \"if_match\": \"1990-10-31T15:36:14.975Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5603c4f8-5da0-400d-b2e4-41e575a8971a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"4ce203ed-c5b0-5051-74f2-e9007635dd2b\",\n \"due_on\": \"2019-12-22\",\n \"if_match\": \"1990-10-31T15:36:14.975Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b910b5f-919c-42d3-aab1-dddddfcf9dff", "name": "Transition a vulnerability finding's VEX status (audit-logged)", "request": { "name": "Transition a vulnerability finding's VEX status (audit-logged)", "description": {}, "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"exploitable\",\n \"if_match\": \"1957-12-21T04:26:20.259Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2185cc3d-84c3-4579-ab96-4815da6db3e8", "name": "Status transitioned, OR the finding was already at the requested status (idempotent no-op — M-26). Body is the post-commit detail payload.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"exploitable\",\n \"if_match\": \"1957-12-21T04:26:20.259Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"1e9009c7-0998-b68f-d303-ecb768d5ba1e\",\n \"project_id\": \"d433e01d-c5c9-b8b0-19fe-8a9292a488ee\",\n \"scan_id\": \"21fa1644-4827-246e-e9f2-4d25665a4176\",\n \"cve_id\": \"string\",\n \"severity\": \"info\",\n \"status\": \"fixed\",\n \"first_detected_at\": \"2004-06-05T06:45:29.941Z\",\n \"created_at\": \"1973-05-27T00:05:05.060Z\",\n \"updated_at\": \"1966-07-25T13:56:11.366Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"e45c806d-d2f4-65a4-e042-7a61b4976053\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n },\n {\n \"component_version_id\": \"3f1e2c83-c228-88c7-130f-441f0eac6eaf\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n }\n ],\n \"analysis_justification\": \"string\",\n \"analysis_source\": \"manual\",\n \"analysis_state\": \"string\",\n \"analyst_user_id\": \"c4e92efe-f64e-30cc-76a2-aba20ca0cdc8\",\n \"analyzed_at\": \"1956-09-24T08:37:06.018Z\",\n \"assignee_is_active\": false,\n \"assignee_user_id\": \"aac7a80a-2c6b-5606-9a03-af97fa0dd9a9\",\n \"cvss_score\": 7572.564529578636,\n \"cvss_vector\": \"string\",\n \"details\": \"string\",\n \"due_on\": \"1977-06-21\",\n \"due_source\": \"sla\",\n \"effective_due_date\": \"1979-01-13T23:00:54.383Z\",\n \"epss_percentile\": 0.6360384398225383,\n \"epss_score\": 0.8618092197341285,\n \"kev\": false,\n \"kev_due_date\": \"1987-02-05\",\n \"manual_due_ignored\": false,\n \"matching_provenance\": {\n \"name\": \"string\",\n \"feed_url\": \"string\",\n \"id\": \"string\"\n },\n \"published_at\": \"2025-11-23T23:40:34.341Z\",\n \"reachability_analyzed_at\": \"2007-01-27T12:32:17.901Z\",\n \"reachability_source\": \"string\",\n \"reachable\": true,\n \"sla_due_date\": \"1950-05-26T00:00:12.137Z\",\n \"sla_status\": \"ok\",\n \"status_history\": [\n {\n \"action\": \"string\",\n \"new_status\": \"analyzing\",\n \"created_at\": \"1983-05-20T09:46:59.884Z\",\n \"actor_user_id\": \"0050fe99-8419-aa3a-1bc7-bbe654e28d16\",\n \"previous_status\": \"false_positive\",\n \"request_id\": \"string\"\n },\n {\n \"action\": \"string\",\n \"new_status\": \"suppressed\",\n \"created_at\": \"2024-12-02T19:53:43.570Z\",\n \"actor_user_id\": \"88f0034f-cdc6-4e58-65b1-1a5a4332cdcc\",\n \"previous_status\": \"analyzing\",\n \"request_id\": \"string\"\n }\n ],\n \"summary\": \"string\",\n \"ticket_check_error\": \"string\",\n \"ticket_checked_at\": \"1967-04-09T13:15:17.459Z\",\n \"ticket_key\": \"string\",\n \"ticket_resolved\": false,\n \"ticket_status\": \"string\",\n \"ticket_url\": \"string\",\n \"upgrade_recommendation\": {\n \"reason\": \"unparseable_version\",\n \"direct\": true,\n \"finding_count\": 0,\n \"max_epss\": 0.03811280620990343,\n \"max_severity\": \"high\",\n \"recommended_version\": \"string\"\n },\n \"vex_origin\": {\n \"author\": \"string\",\n \"format\": \"cyclonedx\",\n \"id\": \"string\",\n \"imported_at\": \"string\",\n \"timestamp\": \"string\",\n \"vex_status\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35addfda-12bf-4efc-92ae-62fa1ee35722", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"exploitable\",\n \"if_match\": \"1957-12-21T04:26:20.259Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ee7bc98-f30e-4c7d-bbd6-2196682f203f", "name": "Caller's role is insufficient (e.g. developer attempting `→ suppressed`).", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"exploitable\",\n \"if_match\": \"1957-12-21T04:26:20.259Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e2a092f-5baf-4d12-a164-c02d2c2adad3", "name": "Finding does not exist, or exists in a team the caller cannot access. Returned in lieu of 403 to avoid leaking existence.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"exploitable\",\n \"if_match\": \"1957-12-21T04:26:20.259Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9406b5a5-6fe5-4984-a1ad-1238df515079", "name": "if_match snapshot did not match the current updated_at.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"exploitable\",\n \"if_match\": \"1957-12-21T04:26:20.259Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39696a0e-c061-419a-a889-9ce459375912", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"exploitable\",\n \"if_match\": \"1957-12-21T04:26:20.259Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46a7f4d5-b530-4756-bd57-7da944d5fae0", "name": "Read the finding's external ticket back and record its state", "request": { "name": "Read the finding's external ticket back and record its state", "description": {}, "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "962e757e-0b6c-415f-9a69-ba4f70795303", "name": "The attempt completed; check `ticket_check_error` for whether it actually reached an answer. A failed OUTBOUND call to the tracker (no credential configured, the URL failed the SSRF guard, the tracker rejected the token, the issue does not exist) is reported here, not as a non-200 status.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"finding_id\": \"c161e3e7-a8c8-2547-554c-74223637d7b9\",\n \"ticket_status\": \"string\",\n \"ticket_resolved\": true,\n \"ticket_checked_at\": \"2006-06-11T12:15:12.098Z\",\n \"ticket_check_error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30acb492-7a69-4e6c-9b52-e03e696ea74b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5db83438-f508-4cea-a5b2-66462ed1f7cd", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d285a9eb-9dcb-4f42-a846-3ed9309405cf", "name": "Finding does not exist, or exists in a team the caller cannot access. Returned in lieu of 403 to avoid leaking existence.", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40580a1f-17d4-4387-8775-4bf0458e99be", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "7578e19c-3712-4036-bf4c-f6475aba3b28", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dfacc2f1-039f-4b8b-9534-3fa2e14ae363", "name": "report-format-templates", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1ac26838-9086-44ed-9eae-5f6fd44aa4d9", "name": "Remove the organization's report formatting defaults", "request": { "name": "Remove the organization's report formatting defaults", "description": {}, "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3e21aca2-6f3c-4cc1-8e5f-3c53e7e372e7", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a1606b13-2deb-47c1-a111-28b6c52b0069", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b971600a-4934-4259-a5e4-57f0162f9d47", "name": "Only a super admin may write report formatting templates.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62fc789d-32b1-429d-992b-21a5213166f0", "name": "The organization has written no report formatting row.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18895758-11b9-44bc-94db-11af93de1c93", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fa22c53-c641-4d4e-9817-aff0ebd8f467", "name": "Read the organization's report formatting defaults", "request": { "name": "Read the organization's report formatting defaults", "description": {}, "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "343a630c-9293-4570-834b-e1d381f92b02", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"caf7483b-a287-083e-d313-8ab52babacd3\",\n \"organization_id\": \"cf025fc9-2fd0-8574-2c92-77e2b34b1eab\",\n \"created_at\": \"2007-02-08T22:26:40.855Z\",\n \"updated_at\": \"1983-07-14T04:52:45.111Z\",\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fc11b19-abfa-4a02-9f06-067872911062", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d0d23fd-c5da-4871-84fa-4c400283ba54", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd8ae650-26c5-4195-803f-9dc9fa36ffbc", "name": "The organization has written no report formatting row.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0b2b843-fd82-4f88-9bf7-8ecd363940fb", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7a4081b-846e-4d78-a807-fc64418a2d70", "name": "Create or replace the organization's report formatting defaults", "request": { "name": "Create or replace the organization's report formatting defaults", "description": {}, "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23c24b15-493e-429e-b1e7-d7705bf40086", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"caf7483b-a287-083e-d313-8ab52babacd3\",\n \"organization_id\": \"cf025fc9-2fd0-8574-2c92-77e2b34b1eab\",\n \"created_at\": \"2007-02-08T22:26:40.855Z\",\n \"updated_at\": \"1983-07-14T04:52:45.111Z\",\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e50e7fb5-6439-4572-b83b-a4805240e234", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5b56b25-4472-45b0-86e0-d3cce69023bc", "name": "Only a super admin may write report formatting templates.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87cf5b74-f8d2-45e4-a2a0-ef6b27ac6268", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3d68fafe-e7cb-4098-b2f5-4a5ab82ff117", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"component_columns\": [\n \"string\",\n \"string\"\n ],\n \"header_text\": \"string\",\n \"org_label\": \"string\",\n \"vulnerability_columns\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c4992d30-7efe-4d00-b206-0f8940b0f902", "name": "saved-searches", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "070d23f6-3310-4e49-9c16-9c8114e1ab6e", "name": "List the caller's saved searches", "request": { "name": "List the caller's saved searches", "description": {}, "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "52103192-7082-4379-b678-f6dd0e11b7ae", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"4ba8b7b2-c557-b8b9-0d14-82013566e63e\",\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": 8901.67333879723,\n \"key_1\": 498.4104360531627\n },\n \"created_at\": \"1947-10-15T17:29:57.394Z\"\n },\n {\n \"id\": \"8aaba6cb-21dd-b734-43cf-8fe0766ca64d\",\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": false,\n \"key_1\": 8093.0763917663735,\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"created_at\": \"1996-05-23T02:40:32.785Z\"\n }\n ],\n \"limit\": 20,\n \"total\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bc3db7d-4a73-4eae-8d57-eabc9d77c1d9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60922650-352f-415e-a294-ab51a7e4ef60", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b1921d5-84cc-4f36-96ee-0572fb30f2cb", "name": "Save a search", "request": { "name": "Save a search", "description": {}, "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "be45a62a-c4c3-498e-b501-1488acfc3abe", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e0e093e6-0e49-7bf2-120c-35fcf850e8a5\",\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"created_at\": \"1957-01-21T16:18:32.690Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2661ef1-ca46-4d5d-b207-b3c73ec9c808", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86f135a-024f-46f5-8028-17220ab75522", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0d97c01-b425-46da-8b7f-3b034e0540d7", "name": "The caller already has a saved search by that name.", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b766a4e2-f000-4f20-a868-d4d1a133a6e8", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "saved-searches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "478ef69b-23f4-4e57-b159-64195be7c22c", "name": "Delete one of the caller's saved searches", "request": { "name": "Delete one of the caller's saved searches", "description": {}, "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f9d8ff22-80bf-96e5-0c43-34af6b65a33f", "key": "saved_search_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "eed5b6b3-783a-4275-890e-fa35f2f38787", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f9d8ff22-80bf-96e5-0c43-34af6b65a33f", "key": "saved_search_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dfc78de3-69f8-4e4a-8507-9a458c893458", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f9d8ff22-80bf-96e5-0c43-34af6b65a33f", "key": "saved_search_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce0968cd-61fc-496d-ace7-cdd5a4fdef5c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f9d8ff22-80bf-96e5-0c43-34af6b65a33f", "key": "saved_search_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecbca98b-e53f-46ea-aaf2-30e847e6b080", "name": "No such saved search, or it belongs to another user. The two are deliberately indistinguishable.", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f9d8ff22-80bf-96e5-0c43-34af6b65a33f", "key": "saved_search_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "776fe789-c4c3-4d73-85bf-948000601044", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f9d8ff22-80bf-96e5-0c43-34af6b65a33f", "key": "saved_search_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e059f5cc-b834-41dc-92c0-1afc293c7694", "name": "scan-schedules", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "22c7c647-69ac-4916-b38a-3e3ab724192c", "name": "What will actually scan this project on a schedule, if anything", "request": { "name": "What will actually scan this project on a schedule, if anything", "description": {}, "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "80f70455-5d8e-4d9b-bf5f-a8ef8889786d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"f798e9e4-c7f0-3624-0fe6-8b12cd23f1a2\",\n \"is_active\": false,\n \"source\": \"string\",\n \"cadence\": \"string\",\n \"day_of_week\": 2387,\n \"hour\": 4687,\n \"timezone\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39626cb2-ddeb-41a6-9483-39b40f673783", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71ce475f-5548-4902-ab37-3eecf8dfa0f4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "521ca70f-c035-400a-86c8-1e282aa4f8bd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e165e582-c41b-44a8-b19a-8e96cb7c0ca8", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b517f35-8240-4098-9d80-7d5a81b5b767", "name": "Create or replace the organization default", "request": { "name": "Create or replace the organization default", "description": {}, "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d4fe1cef-8f33-46ee-8854-b2a3708cc8b3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"467eaad7-775f-011c-0527-7ab5e08e6728\",\n \"organization_id\": \"6dccdd8b-cff2-62d0-5584-a7458528f9b6\",\n \"is_active\": true,\n \"timezone\": \"string\",\n \"created_at\": \"1958-11-24T01:00:39.877Z\",\n \"updated_at\": \"2001-05-17T11:04:15.852Z\",\n \"cadence\": \"string\",\n \"day_of_week\": 7143,\n \"hour\": 1997,\n \"last_triggered_at\": \"1987-01-20T17:20:38.345Z\",\n \"project_id\": \"baa7e395-9b84-f3ae-f82a-a65310cc83a3\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54789ce7-91bf-49c9-9216-c805e5b8b64b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31dbc90f-7b70-493e-82e2-901e84a73cea", "name": "Only a super admin may set the organization default.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21262ef0-282b-4ed7-ae49-9fc77f8895b0", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d517b405-84fb-4660-a32c-8d3b789ee7a1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "404389ed-cbc3-d14b-9d8d-612cc81df5b8", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4289c22-550d-4825-b732-d8da4d79c15a", "name": "Drop a project's schedule so it follows its organization default again", "request": { "name": "Drop a project's schedule so it follows its organization default again", "description": {}, "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ef5a2894-e3c7-46ed-9375-bd7e71065afd", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4a84a064-9c79-406f-8c84-30fd9d0acae6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "880d78f1-930e-489f-828e-ca31ca696a35", "name": "Caller does not administer this project's team.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a64aad25-1202-441f-81bc-9ea7895dcb71", "name": "Project not found, or it had no schedule of its own.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d97eaf24-0780-49c1-a239-2c28f59e5fd6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ba3f13f-e069-40bf-8e26-aa2603fa6280", "name": "Read a project's own schedule row", "request": { "name": "Read a project's own schedule row", "description": {}, "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7d7ce6c9-9921-454d-aca5-39d8c201e47a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"467eaad7-775f-011c-0527-7ab5e08e6728\",\n \"organization_id\": \"6dccdd8b-cff2-62d0-5584-a7458528f9b6\",\n \"is_active\": true,\n \"timezone\": \"string\",\n \"created_at\": \"1958-11-24T01:00:39.877Z\",\n \"updated_at\": \"2001-05-17T11:04:15.852Z\",\n \"cadence\": \"string\",\n \"day_of_week\": 7143,\n \"hour\": 1997,\n \"last_triggered_at\": \"1987-01-20T17:20:38.345Z\",\n \"project_id\": \"baa7e395-9b84-f3ae-f82a-a65310cc83a3\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "052eb048-f595-4738-9150-5fb8d0f6df25", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0262d8a-294c-4ab0-ada6-053a122bed71", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e69b4d0-45fb-441e-8a73-4a7916574685", "name": "Project not found, or it has written no schedule.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8dc9b3bb-1ad8-429d-b7cd-7d46af480005", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ce39949-2bc7-4f5e-a4c1-4ec871138bf5", "name": "Create or replace a project's own scan schedule", "request": { "name": "Create or replace a project's own scan schedule", "description": {}, "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c39f9c3e-fb22-4163-be26-1e16dc2f7602", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"467eaad7-775f-011c-0527-7ab5e08e6728\",\n \"organization_id\": \"6dccdd8b-cff2-62d0-5584-a7458528f9b6\",\n \"is_active\": true,\n \"timezone\": \"string\",\n \"created_at\": \"1958-11-24T01:00:39.877Z\",\n \"updated_at\": \"2001-05-17T11:04:15.852Z\",\n \"cadence\": \"string\",\n \"day_of_week\": 7143,\n \"hour\": 1997,\n \"last_triggered_at\": \"1987-01-20T17:20:38.345Z\",\n \"project_id\": \"baa7e395-9b84-f3ae-f82a-a65310cc83a3\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "527c4b9e-19d9-4f80-a342-342d5f137784", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74442121-3429-4a6b-a2cc-4ec1373ab8b3", "name": "Caller does not administer this project's team.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0a9d130-8fba-4bb3-895c-75e20d88cbbd", "name": "Project not found.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3987da6d-7396-4762-a70f-a7b07f552bb4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "2b2055ac-0f4c-e591-dba6-d7b06bf020a0", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 5,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c20b6012-23c7-429a-90b7-f5e1047cb1ee", "name": "search", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1222259b-6c9a-4d84-b928-336624e9291f", "name": "Cross-project global search (components + vulnerabilities)", "request": { "name": "Cross-project global search (components + vulnerabilities)", "description": {}, "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "string", "description": "(Required) Search term. Trimmed; a term shorter than 3 characters yields empty results. Matched case-insensitively as a substring against component name/purl and CVE id. LIKE metacharacters (`%`, `_`) are escaped and matched literally." }, { "disabled": false, "key": "kinds", "value": "string", "description": "Comma-separated categories to search: `components`, `vulnerabilities`. Unknown tokens are ignored; omit to search both." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0bfbb26e-ca06-4064-9496-6dd7d3418f40", "name": "Search results, each category capped at 20 rows. A query shorter than 3 chars (after trim) returns empty lists with a 200 — not a 422 — so the debounced search palette can fire harmlessly on every keystroke.", "originalRequest": { "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "kinds", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"components\": [\n {\n \"component_name\": \"lodash\",\n \"project_id\": \"6f9619ff-8b86-d011-b42d-00cf4fc964ff\",\n \"project_name\": \"Payments API\",\n \"project_slug\": \"payments-api\",\n \"purl\": \"pkg:npm/lodash\",\n \"version\": \"4.17.19\"\n }\n ],\n \"query\": \"lodash\",\n \"vulnerabilities\": [\n {\n \"cve_id\": \"CVE-2021-23337\",\n \"project_id\": \"6f9619ff-8b86-d011-b42d-00cf4fc964ff\",\n \"project_name\": \"Payments API\",\n \"project_slug\": \"payments-api\",\n \"severity\": \"high\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e54ef61b-0bed-4d72-bae0-033a29d266b3", "name": "No / invalid bearer token.", "originalRequest": { "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "kinds", "value": "string" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b58d6cd9-39a5-4ca1-852b-167436e2b4c5", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "kinds", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff4239a-4441-4866-9a14-229ef18b3db4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "kinds", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a51222c9-79d5-4221-9fb0-692447c4bc48", "name": "Paged, faceted search results for one kind", "request": { "name": "Paged, faceted search results for one kind", "description": {}, "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "kind", "value": "components", "description": "(Required) Which result set to page through." }, { "disabled": false, "key": "q", "value": "string", "description": "(Required) " }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "size", "value": "25" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "severity", "value": "string" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "status", "value": "string" }, { "disabled": false, "key": "package_type", "value": "string" }, { "disabled": false, "key": "package_type", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" }, { "disabled": false, "key": "license_category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cd40860f-b44a-4b03-81d4-1cd77e870cb1", "name": "One page of results. A query shorter than 3 characters returns an empty page with a 200, not a 422, so the page can fire as the user types.", "originalRequest": { "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kind", "value": "components" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "25" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"kind\": \"string\",\n \"query\": \"string\",\n \"counts_capped\": false,\n \"facets\": {\n \"key_0\": [\n {\n \"value\": \"string\",\n \"count\": 3432\n },\n {\n \"value\": \"string\",\n \"count\": 908\n }\n ],\n \"key_1\": [\n {\n \"value\": \"string\",\n \"count\": 6194\n },\n {\n \"value\": \"string\",\n \"count\": 2950\n }\n ],\n \"key_2\": [\n {\n \"value\": \"string\",\n \"count\": 5244\n },\n {\n \"value\": \"string\",\n \"count\": 3921\n }\n ]\n },\n \"items_components\": [\n {\n \"project_id\": \"0492ca29-044d-3392-a789-d6b5185c8303\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_id\": \"d826e6e3-ea01-1d12-0b10-54799468af6c\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\"\n },\n {\n \"project_id\": \"b0035fd7-1431-7712-aa91-baa1636c96e9\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_id\": \"675bf9dd-2273-2b78-335a-7ba7dc975c2e\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\"\n }\n ],\n \"items_licenses\": [\n {\n \"project_id\": \"c5314fa9-9498-2722-5e7d-e7784d0b8d27\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"license_id\": \"02fe5f0f-e41b-11c5-4663-44e16e5b3466\",\n \"license_name\": \"string\",\n \"category\": \"string\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"spdx_id\": \"string\"\n },\n {\n \"project_id\": \"697e29bc-9704-f269-cc43-f3a2534729df\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"license_id\": \"639efc94-a504-0bac-8f44-02b13448ac42\",\n \"license_name\": \"string\",\n \"category\": \"string\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"spdx_id\": \"string\"\n }\n ],\n \"items_projects\": [\n {\n \"project_id\": \"1ab6ec24-d614-f21d-339f-dfae6415acfe\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"archived\": false,\n \"git_url\": \"string\"\n },\n {\n \"project_id\": \"f5ea1623-7794-6cf4-1f28-655f6874e187\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"archived\": false,\n \"git_url\": \"string\"\n }\n ],\n \"items_vulnerabilities\": [\n {\n \"project_id\": \"a8acaee6-5373-1adc-5e12-4743680a3298\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"finding_id\": \"ddc76b38-1d2e-43ac-e2f1-028033064b61\",\n \"cve_id\": \"string\",\n \"severity\": \"string\",\n \"status\": \"string\",\n \"component_name\": \"string\",\n \"version\": \"string\"\n },\n {\n \"project_id\": \"e418e1ff-fe7b-13dd-a16d-cd619d6841f0\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"finding_id\": \"a18fa6f6-e9d7-4798-197b-13bdb6e7b3be\",\n \"cve_id\": \"string\",\n \"severity\": \"string\",\n \"status\": \"string\",\n \"component_name\": \"string\",\n \"version\": \"string\"\n }\n ],\n \"page\": 1,\n \"size\": 25,\n \"total\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49691d48-9938-4758-8a5c-0cf9a57d61f5", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kind", "value": "components" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "25" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ae487d3-e6b0-45b0-b2bd-e80eecce98f2", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kind", "value": "components" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "25" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eebf77fa-5a30-4d10-bdf0-8ac939221931", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kind", "value": "components" }, { "key": "q", "value": "string" }, { "key": "page", "value": "1" }, { "key": "size", "value": "25" }, { "key": "severity", "value": "string" }, { "key": "severity", "value": "string" }, { "key": "status", "value": "string" }, { "key": "status", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "package_type", "value": "string" }, { "key": "license_category", "value": "string" }, { "key": "license_category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b5cd291a-ecc7-4d12-91e2-ae99f96f22c8", "name": "service-accounts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4d195416-8c1e-4844-8a0e-036897c5f57e", "name": "A team's automation identities", "request": { "name": "A team's automation identities", "description": {}, "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "team_id", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "de16a9a0-f28d-4104-91c8-bea8a9ac7e7a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"b883f013-87ca-f95c-b0fd-02ccf029d5f8\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": true,\n \"created_at\": \"1976-05-19T18:54:45.295Z\",\n \"managed_by_user_id\": \"b9994a4c-8d0c-547a-0543-2c80dd2ef277\"\n },\n {\n \"id\": \"cbc4698b-ab3c-0c9f-45ee-0af9f54d60a1\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"1968-03-04T06:47:48.520Z\",\n \"managed_by_user_id\": \"8d14f7c9-10fb-86f6-7e09-9471161abf6e\"\n }\n ],\n \"total\": 9082\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ead2f83-1f43-4179-8082-0c8d8db3b1e9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "782a55ae-903d-4f4e-ba54-e14a08f2c682", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "238506e1-71f9-4bb7-8c84-54cb39a3a5c9", "name": "Team not found, or the caller does not administer it. Returned in lieu of 403 so membership does not leak.", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3bef2739-76a5-4b39-b6d9-cf84a9da0e24", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "7b0b2608-1369-b455-3bf0-67efd10a16f2" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1059c3d-f4b2-4002-91af-8d1d71acabdd", "name": "Create an automation identity for a team", "request": { "name": "Create an automation identity for a team", "description": {}, "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"team_id\": \"68c56960-7a4c-29ff-8bd6-96c5fddfa7b9\",\n \"slug\": \"string\",\n \"display_name\": \"string\",\n \"role\": \"developer\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7bd2f5e6-2cd4-4627-bd0c-33ab8acd1341", "name": "Created. The caller becomes the steward.", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"68c56960-7a4c-29ff-8bd6-96c5fddfa7b9\",\n \"slug\": \"string\",\n \"display_name\": \"string\",\n \"role\": \"developer\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"3f8fb11a-648c-02ea-72d8-a07e81529d24\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"2021-03-02T13:27:01.290Z\",\n \"managed_by_user_id\": \"0560b37a-aa54-7d78-ca39-7bd32fc546b1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49d34945-2431-4143-95b7-20422230b4b7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"68c56960-7a4c-29ff-8bd6-96c5fddfa7b9\",\n \"slug\": \"string\",\n \"display_name\": \"string\",\n \"role\": \"developer\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "124abb28-fff2-41f3-8881-23e97c277439", "name": "Caller does not administer this team.", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"68c56960-7a4c-29ff-8bd6-96c5fddfa7b9\",\n \"slug\": \"string\",\n \"display_name\": \"string\",\n \"role\": \"developer\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff55ffca-bf1d-44d6-b4e9-c338d44dc524", "name": "A service account with this name already exists.", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"68c56960-7a4c-29ff-8bd6-96c5fddfa7b9\",\n \"slug\": \"string\",\n \"display_name\": \"string\",\n \"role\": \"developer\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "719036fa-2c6d-41fe-a59e-6a50319c61a8", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"team_id\": \"68c56960-7a4c-29ff-8bd6-96c5fddfa7b9\",\n \"slug\": \"string\",\n \"display_name\": \"string\",\n \"role\": \"developer\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f646063-9f3b-4468-93b0-c4873c9df769", "name": "Stop every key this account holds", "request": { "name": "Stop every key this account holds", "description": { "content": "Deactivate rather than delete.\n\nThe row is the actor on every audit entry its keys produced, and deleting\nit would either orphan those or cascade them away. Deactivating stops the\ncredentials, which is what the caller is asking for.", "type": "text/plain" }, "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6500c720-8a87-45c3-aac9-91b8a0b60f41", "name": "Deactivated, and with it every key it issued. Idempotent. The row stays so the audit trail keeps its actor.", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"3f8fb11a-648c-02ea-72d8-a07e81529d24\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"2021-03-02T13:27:01.290Z\",\n \"managed_by_user_id\": \"0560b37a-aa54-7d78-ca39-7bd32fc546b1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eb515a7-09d8-43ff-a1d1-3ee791899ea7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e31c054-625a-40c1-b9df-97e43f2e4f14", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ce2f835-37bc-470a-8f1f-c1b791861a21", "name": "No such account, or not the caller's to manage.", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "648fcfe2-045d-4ed5-b87b-a7bdfebaeff3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03c0bd87-4c4f-4b1d-bd0b-a10062ad7180", "name": "Hand an account to somebody who will answer for it", "request": { "name": "Hand an account to somebody who will answer for it", "description": {}, "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"c9a9a7dd-6859-2a73-5eac-a91d186827ce\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b5214d02-ab75-4fda-b97b-783ae1d5c8ab", "name": "Steward assigned. The account's keys are untouched.", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"c9a9a7dd-6859-2a73-5eac-a91d186827ce\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"3f8fb11a-648c-02ea-72d8-a07e81529d24\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"2021-03-02T13:27:01.290Z\",\n \"managed_by_user_id\": \"0560b37a-aa54-7d78-ca39-7bd32fc546b1\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5080558d-4566-4284-8c12-aa67250a4f03", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"c9a9a7dd-6859-2a73-5eac-a91d186827ce\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f21289ca-2b49-4fcd-8eb6-ea5d2dea8fdc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"c9a9a7dd-6859-2a73-5eac-a91d186827ce\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "304e9993-11e3-4a0c-8d11-c5ef9dbbfec5", "name": "No such account, or not the caller's to manage.", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"c9a9a7dd-6859-2a73-5eac-a91d186827ce\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d6ef2802-73cd-47b8-b1f6-b7e016bdef3d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6b78c80f-e7ab-cbe1-cb9a-90bed3f2963e", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"c9a9a7dd-6859-2a73-5eac-a91d186827ce\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "713dcde7-c4e2-423b-a129-b3ceee81e12a", "name": "transition-approvals", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "66a2b254-afc2-4082-8b9f-5d65b494be67", "name": "Requests waiting on a decision, for the caller's teams", "request": { "name": "Requests waiting on a decision, for the caller's teams", "description": { "content": "Scoped to the caller's own teams, so the queue never shows another team's work.", "type": "text/plain" }, "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d937d2b3-d488-4d73-b148-7d29dae1a6f7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"8136aa12-dfba-ccbc-60b2-9e0c0160f851\",\n \"finding_id\": \"126b2cc3-045f-e8d9-e9b1-070fda540865\",\n \"team_id\": \"5b321afc-8524-341f-878d-27ff836fcafc\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"ed4edbc3-7aed-63fa-d4b0-9c000843623b\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"ee294069-200c-a2d5-5b89-5f23c3cf450c\",\n \"decision_note\": \"string\",\n \"decided_at\": \"2002-01-03T12:04:14.788Z\",\n \"created_at\": \"1956-10-13T22:06:59.615Z\"\n },\n {\n \"id\": \"65652b74-a1c3-41b5-9084-dfd3a18e2248\",\n \"finding_id\": \"c37184fb-468a-d03d-612f-a5eaedd6a617\",\n \"team_id\": \"158a9311-707a-f14e-72a6-dcf7992b79cd\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"54ac2473-3eb5-9330-0c17-1061ab564e7f\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"6818e590-361b-9b7e-1e8c-7e8b6a7234a7\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1967-11-23T04:31:48.520Z\",\n \"created_at\": \"1989-05-10T08:55:36.099Z\"\n }\n ],\n \"total\": 5927\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dcf0365-6e65-4b05-935f-ab243de9f75b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d2fc55-2880-46cf-92b1-de06e82942c4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "073af4b0-96df-458d-bc3f-7585444a5c3d", "name": "Ask for a status change that needs a second person", "request": { "name": "Ask for a status change that needs a second person", "description": {}, "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"finding_id\": \"60714f16-4dce-4647-ef53-dfa6e152d758\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "14cb3192-3796-41d5-8af0-8fff639b428a", "name": "Request recorded. The finding has not moved.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_id\": \"60714f16-4dce-4647-ef53-dfa6e152d758\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"be6a9e88-d747-5695-a06c-7f42998c223c\",\n \"finding_id\": \"ab38737b-e198-2a0b-c4ff-d9883c5192d4\",\n \"team_id\": \"6a4a81ba-a19b-e355-37ce-eb9e6804378e\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"2fefe901-954f-01d7-2d3b-1b1204fb7191\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"999d696d-3c10-0063-8d28-f5b9ae81b6f9\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1969-06-16T22:33:43.901Z\",\n \"created_at\": \"1956-06-25T21:06:56.082Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae2cf9d5-d35b-4e4b-bdfc-132790fdebbc", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_id\": \"60714f16-4dce-4647-ef53-dfa6e152d758\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7aefe489-ebe2-4921-91fb-d7cb8eeb11c8", "name": "Caller may not make this transition even with agreement.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_id\": \"60714f16-4dce-4647-ef53-dfa6e152d758\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80eaffc5-4540-4309-9f4e-19d7bf2d0a46", "name": "Finding does not exist, or the caller is not a member of its team. Returned in lieu of 403 so membership does not leak.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_id\": \"60714f16-4dce-4647-ef53-dfa6e152d758\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91f6afc0-c687-4da6-b11f-32e38326fed5", "name": "The policy does not ask for approval on this status (make the change directly), or a request for this finding is already open.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_id\": \"60714f16-4dce-4647-ef53-dfa6e152d758\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3395c308-3101-4a0d-a1ea-209f1a1ff737", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "transition-approvals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_id\": \"60714f16-4dce-4647-ef53-dfa6e152d758\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a83941a-f054-428c-8997-1635dba28a7d", "name": "Agree to or refuse a request somebody else opened", "request": { "name": "Agree to or refuse a request somebody else opened", "description": {}, "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"approve\": true,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d3fd9689-39d7-4ee5-9312-cf1f08663e49", "name": "Decision recorded. On approval the finding has been transitioned, audited like any other status change.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": true,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"be6a9e88-d747-5695-a06c-7f42998c223c\",\n \"finding_id\": \"ab38737b-e198-2a0b-c4ff-d9883c5192d4\",\n \"team_id\": \"6a4a81ba-a19b-e355-37ce-eb9e6804378e\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"2fefe901-954f-01d7-2d3b-1b1204fb7191\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"999d696d-3c10-0063-8d28-f5b9ae81b6f9\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1969-06-16T22:33:43.901Z\",\n \"created_at\": \"1956-06-25T21:06:56.082Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4639d4da-1b53-413d-b608-c72eb6a58659", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": true,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "306d0552-4998-473c-993c-47afe23f24b1", "name": "Caller opened this request, or does not administer the team. The requester may not decide their own request.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": true,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c60e987a-1a7d-4192-aaf3-a89b7dd4af3b", "name": "No such request, or it is not the caller's to see.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": true,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2a2db3d-da8c-4997-9b4d-e21b7c237e66", "name": "The request has already been decided.", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": true,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f706eeff-78c3-429e-bc95-ee85f58ebe94", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "6a86cd36-17b7-d114-7919-1cfffcb68145", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": true,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fb6d0251-09fa-48c4-95fe-b56b01a1c437", "name": "user-anonymisation", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "77c1db56-76a3-4d2c-9c54-1294b85df021", "name": "Ask for a user's data to be anonymised", "request": { "name": "Ask for a user's data to be anonymised", "description": {}, "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"ef30bc2e-02cc-ef7d-b7c9-92841440d7c7\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4fff20db-571b-49ec-bcf6-1d3a07525981", "name": "Request recorded. Nothing has been erased and nothing will be until a second super admin approves and an operator runs the command.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"ef30bc2e-02cc-ef7d-b7c9-92841440d7c7\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8d943e8e-bcee-5213-302d-fb04dcff694a\",\n \"subject_user_id\": \"4e646d70-69d7-5006-b9a7-bdb90de16a05\",\n \"requested_by_user_id\": \"32d2943d-9c77-0d21-6a14-adaa19485660\",\n \"approved_by_user_id\": \"3835d7ec-011f-03a6-1f2c-8cf50abac80b\",\n \"state\": \"string\",\n \"reason\": \"string\",\n \"created_at\": \"1994-11-13T00:30:50.062Z\",\n \"expires_at\": \"1961-08-22T03:19:04.087Z\",\n \"approved_at\": \"1955-02-19T00:48:42.242Z\",\n \"executed_at\": \"2017-03-27T18:10:50.900Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0298689a-8397-4db0-b8c2-2691a954ee0e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"ef30bc2e-02cc-ef7d-b7c9-92841440d7c7\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a8b6cfd-06ea-4a0a-b89e-5dc57f99a26f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"ef30bc2e-02cc-ef7d-b7c9-92841440d7c7\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6d7c3e4-c2fd-4c69-a689-d8d662a0d9d7", "name": "No such user.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"ef30bc2e-02cc-ef7d-b7c9-92841440d7c7\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab171bcc-876e-47f2-9952-89068ba18abb", "name": "A request for this subject is already open, or the caller named themselves as the subject.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"ef30bc2e-02cc-ef7d-b7c9-92841440d7c7\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69e5285e-2cfa-4dcb-a807-49c388dd8f87", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"ef30bc2e-02cc-ef7d-b7c9-92841440d7c7\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29a6e097-7d06-47e1-a0d4-f60c686997c0", "name": "Approved requests no operator has run yet", "request": { "name": "Approved requests no operator has run yet", "description": {}, "url": { "path": [ "v1", "user-anonymisation", "awaiting-execution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c0194aa1-043f-45a6-a609-223d8b0fb451", "name": "The backlog, oldest first. A non-empty list is not an error and not a fault in the software: it is work the deployment owes people, and only an operator running the command discharges it.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", "awaiting-execution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"request_id\": \"6dd1e998-5fac-ba84-24e1-2b8dc59c4d42\",\n \"subject_user_id\": \"25cbdee5-252f-ef75-d77b-14017117a732\",\n \"requested_by_user_id\": \"0d7becb1-c111-7ef0-29e7-da51b191702a\",\n \"approved_by_user_id\": \"a2600f15-40d6-dc85-06f4-d67d75edfaae\",\n \"approved_at\": \"1965-06-01T04:20:42.566Z\",\n \"waiting_days\": 9272\n },\n {\n \"request_id\": \"a2603fae-9375-f6c2-6bea-7ea20cf6e7d4\",\n \"subject_user_id\": \"d1fb031d-2143-ba00-f184-265ecf7e6d0a\",\n \"requested_by_user_id\": \"4f8b5d3b-b710-37e5-4ada-8415762d4016\",\n \"approved_by_user_id\": \"40a27b16-a139-1b06-8ef9-19cd483a33c4\",\n \"approved_at\": \"1982-08-16T12:09:16.220Z\",\n \"waiting_days\": 2068\n }\n ],\n \"count\": 9920\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b74b1990-aa38-482a-a5b6-063f9d68c174", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", "awaiting-execution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e2793ee-1fbd-4fe4-af78-08d85f9fa2e4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", "awaiting-execution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "277d906b-adc3-44c8-ae45-c0cbe7e36832", "name": "Withdraw a request that has not run", "request": { "name": "Withdraw a request that has not run", "description": {}, "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "155f1ff1-a506-4eb3-b00f-1c3b8cb96d70", "name": "Cancelled. Approved-but-unexecuted requests may also be cancelled.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8d943e8e-bcee-5213-302d-fb04dcff694a\",\n \"subject_user_id\": \"4e646d70-69d7-5006-b9a7-bdb90de16a05\",\n \"requested_by_user_id\": \"32d2943d-9c77-0d21-6a14-adaa19485660\",\n \"approved_by_user_id\": \"3835d7ec-011f-03a6-1f2c-8cf50abac80b\",\n \"state\": \"string\",\n \"reason\": \"string\",\n \"created_at\": \"1994-11-13T00:30:50.062Z\",\n \"expires_at\": \"1961-08-22T03:19:04.087Z\",\n \"approved_at\": \"1955-02-19T00:48:42.242Z\",\n \"executed_at\": \"2017-03-27T18:10:50.900Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8251401e-018e-4615-aad2-950ac96a2cdf", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6317f928-c116-4659-9896-bcbf46624570", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22fae308-205f-4da1-a3fe-a3192f155581", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0635f36e-bf78-45fa-8d7b-58610aef1c63", "name": "No such request, or it has already been executed.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82f4ba3f-4146-4faf-8d49-35077571658c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44e575fe-cfee-4d29-928e-7cffa0472728", "name": "Agree to a request somebody else opened", "request": { "name": "Agree to a request somebody else opened", "description": {}, "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ebd09240-0aa7-4565-b849-752926735250", "name": "Approved. The erasure has NOT run: it is now waiting for an operator, and appears under /awaiting-execution until it does.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8d943e8e-bcee-5213-302d-fb04dcff694a\",\n \"subject_user_id\": \"4e646d70-69d7-5006-b9a7-bdb90de16a05\",\n \"requested_by_user_id\": \"32d2943d-9c77-0d21-6a14-adaa19485660\",\n \"approved_by_user_id\": \"3835d7ec-011f-03a6-1f2c-8cf50abac80b\",\n \"state\": \"string\",\n \"reason\": \"string\",\n \"created_at\": \"1994-11-13T00:30:50.062Z\",\n \"expires_at\": \"1961-08-22T03:19:04.087Z\",\n \"approved_at\": \"1955-02-19T00:48:42.242Z\",\n \"executed_at\": \"2017-03-27T18:10:50.900Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "529db4e4-fd22-48f5-8146-6e74a4c5b6ef", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86761610-58ac-46a3-9878-a66c73addacb", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf8e8d1e-ca3f-4dc6-9c2f-802e814215d9", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38ad37e6-f36b-4859-819a-980410621ddd", "name": "No such request, or it is not pending, or it has expired, or the caller opened it. The approver must be a third party to both the requester and the subject.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2fe73ee5-588d-4abb-8463-5100289e3bcc", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "bee74e7a-a937-047a-9d14-492040a5679b", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a4bbd86f-c509-49a7-84d5-05cb44775866", "name": "users-me", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5f9d0d94-b0ed-4832-b827-1d4360d2400b", "name": "Download a copy of your own personal data", "request": { "name": "Download a copy of your own personal data", "description": { "content": "Keyed off the JWT, never off a parameter.\n\nThere is no ``user_id`` anywhere in this route. An export endpoint that\naccepted one would be an endpoint for reading other people's personal\ndata, guarded only by whatever check somebody remembered to write.\n\nRefused on the public read-only demo. Its accounts are shared, so \"your\nown activity\" there is every visitor's sign-ins, with their IP addresses\nand user agents.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "me", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "728c26ab-743f-4d7a-82c8-bfd19c5728f2", "name": "The personal data held about the caller. Work product (projects, scans, findings, policies) is not included: it belongs to the organisation, not to the individual. The activity section reports its own total and says when it has been capped.", "originalRequest": { "url": { "path": [ "v1", "users", "me", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57f7aad9-30a9-4278-88ff-432dd396cfba", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d074aa44-6ca8-41fe-88e7-8e71dc753dea", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "570e248a-2e4c-495b-b692-6cce920362ea", "name": "Start enrolling a second factor", "request": { "name": "Start enrolling a second factor", "description": { "content": "Store a secret and hand back what the setup screen needs to show it.\n\nBehind a step-up. Enrolling on somebody else's account is a takeover: the\nattacker's authenticator becomes the factor, and the owner is locked out\nby the control they never set up.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "me", "mfa", "enrol" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b25f4663-713b-4484-a98c-6942978e352b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"secret\": \"string\",\n \"provisioning_uri\": \"string\",\n \"mfa_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d753e68-9983-45ec-bcf5-efe507bb6420", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea87a450-644d-49af-b9d3-7056daebe563", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "796431c2-7fb7-4af6-82fc-554546907417", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6225a093-4ea7-4c0f-9f5b-8d7819cb27a4", "name": "Finish enrolling by proving the authenticator works", "request": { "name": "Finish enrolling by proving the authenticator works", "description": { "content": "Turn the factor on and return the recovery codes, shown once.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "me", "mfa", "enrol", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "09625fe9-9f1b-4672-8f59-31c5bd95a5c2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"codes\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94751fce-95d4-4d40-80f3-1f128efe5d58", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c45c248b-89c7-4f35-aeed-9f9a5c74fc7f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94329bde-b3cc-4a89-ad79-4997e33079a6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "enrol", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mfa_token\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8cc9f71-1c9a-4cd6-882d-6c9d822b4f09", "name": "Replace the unused recovery codes with a fresh set", "request": { "name": "Replace the unused recovery codes with a fresh set", "description": { "content": "Issue a new set, invalidating every unused code from the old one.\n\nBehind a step-up, because what it hands back is ten sign-ins that bypass\nthe factor, survive a password change, and are not touched by revoking\nsessions. Gating that on a session alone means a stolen token is worth ten\nof them, and a stolen session is the case the factor exists to survive.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "me", "mfa", "recovery-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "694b4298-d6ff-464d-b991-7df810c210cb", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "recovery-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"codes\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c975d4ff-a856-435a-9a0b-9febeb46cae2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "recovery-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00ab825f-f872-4ded-a866-e0770739c011", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "recovery-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b413350-ccf7-4d30-b14c-7beab16d9b56", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "users", "me", "mfa", "recovery-codes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"password\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "913679fc-073d-4ba0-abe8-1488d83ef677", "name": "Return the caller's notification preferences (creates defaults)", "request": { "name": "Return the caller's notification preferences (creates defaults)", "description": {}, "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "54f78c71-f8ae-4871-a8c9-4b5f92ed2242", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email_enabled\": true,\n \"slack_enabled\": true,\n \"teams_enabled\": false,\n \"in_app_enabled\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45f753fa-50d2-4a25-afd3-0a4c275eafa6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79abf390-d8f3-45ce-883f-da20bacf054f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7eb9279-af17-4a3d-9005-a1c957ffb13f", "name": "Replace the caller's notification preferences (full-row PUT)", "request": { "name": "Replace the caller's notification preferences (full-row PUT)", "description": { "content": "Full-row update — every channel field must be supplied.\n\nThe body's only meaningful inputs are the four channel toggles. Any\nadditional fields a caller may send (``user_id``, ``id``, ...) are\nignored: Pydantic strips unknown fields by default and the service is\nkeyed off ``actor.id``, never the body.\n\nChore O / M3 — In-app notifications cannot be disabled. The frontend\ndocuments the in-app switch as \"rendered but disabled\"; this server-\nside guard closes the API drift where a direct PUT could opt out.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"email_enabled\": true,\n \"slack_enabled\": false,\n \"teams_enabled\": false,\n \"in_app_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d232d4e-eed5-4d1e-84be-73052786f5e3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email_enabled\": true,\n \"slack_enabled\": false,\n \"teams_enabled\": false,\n \"in_app_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email_enabled\": true,\n \"slack_enabled\": true,\n \"teams_enabled\": false,\n \"in_app_enabled\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dd4558e-20a2-4853-b791-7c651c08f75f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email_enabled\": true,\n \"slack_enabled\": false,\n \"teams_enabled\": false,\n \"in_app_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95dc6cc9-0ae2-467e-81a4-9b647707ec05", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email_enabled\": true,\n \"slack_enabled\": false,\n \"teams_enabled\": false,\n \"in_app_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18828d06-3972-43df-b99e-350f458cc160", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "users", "me", "notification-prefs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email_enabled\": true,\n \"slack_enabled\": false,\n \"teams_enabled\": false,\n \"in_app_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c642fbb1-60a2-4470-a2a2-cd8283c81e05", "name": "List the caller's connected OAuth identities (sorted oldest-first)", "request": { "name": "List the caller's connected OAuth identities (sorted oldest-first)", "description": {}, "url": { "path": [ "v1", "users", "me", "oauth-identities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7dd95819-678e-4754-95a3-be9c021e04bf", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"646d8ad2-322e-1f26-0900-ba4e3ba5191d\",\n \"provider\": \"oidc\",\n \"provider_user_id\": \"string\",\n \"created_at\": \"1975-04-07T06:29:13.734Z\",\n \"provider_email\": \"string\"\n },\n {\n \"id\": \"2dfe03f2-bd75-ba6b-531f-a305bd94ad46\",\n \"provider\": \"oidc\",\n \"provider_user_id\": \"string\",\n \"created_at\": \"1981-04-30T22:45:55.940Z\",\n \"provider_email\": \"string\"\n }\n ],\n \"has_password\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca781e29-e5e8-486a-92bd-9f9a415f872e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0096fc0c-f0f4-415e-a9f5-5ae675ba82d6", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d7114c7-0f14-47cf-9048-0aaebf350832", "name": "Unlink one of the caller's OAuth identities", "request": { "name": "Unlink one of the caller's OAuth identities", "description": { "content": "Remove an OAuth identity link from the authenticated user.\n\nReturns 204 on success. Domain failures map to RFC 7807:\n\n - 404 ``urn:trustedoss:problem:oauth_identity_not_found`` —\n identity does not exist OR belongs to another user\n (existence-hide; the two cases share a shape).\n - 409 ``urn:trustedoss:problem:oauth_unlink_blocks_login`` —\n unlinking would leave the user with no way to authenticate.", "type": "text/plain" }, "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4caf847f-d96b-18ad-5547-502538a0a3cf", "key": "identity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2324638a-1e20-472e-8c17-fb34fce8298e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4caf847f-d96b-18ad-5547-502538a0a3cf", "key": "identity_id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9ec915ab-d7a3-4398-a53a-86a0bbfb9189", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4caf847f-d96b-18ad-5547-502538a0a3cf", "key": "identity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a1dbb96-f51c-452b-9bbc-bb05d1ca9055", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4caf847f-d96b-18ad-5547-502538a0a3cf", "key": "identity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b337fc85-3ea7-4bc0-b284-ec2a85e44b38", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4caf847f-d96b-18ad-5547-502538a0a3cf", "key": "identity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a34c888-8a4f-4d13-921d-e2b0f6a94709", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4caf847f-d96b-18ad-5547-502538a0a3cf", "key": "identity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "292497fd-83de-45f7-9134-8522f58c2497", "name": "webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c32f9af0-7bc1-43f8-a4d1-2296b41ab430", "name": "Receive a GitHub webhook delivery", "request": { "name": "Receive a GitHub webhook delivery", "description": {}, "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "949fa7c9-7203-4941-b29a-a0fa0541c5b6", "name": "Delivery accepted. Body shape: ``{\"status\": \"enqueued\"|\"duplicate\"|\"ignored\"|\"skipped_active_scan\"|\"skipped_team_at_capacity\"|\"skipped_disk_full\", \"delivery_id\": str, \"scan_id\": uuid?}``. The ``skipped_*`` values all mean the delivery was accepted and scannable but no scan started: the ref already had one, the team is at its concurrency cap, or the workspace volume is full. They are distinct from ``duplicate``, which means this delivery had already been seen.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfe85262-70d5-4849-babe-eb6ed2d780c7", "name": "Required webhook headers are missing or malformed JSON body.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64524147-7992-416e-93b7-6923ae4d6a22", "name": "HMAC verification failed.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9797440-12d2-4c2b-9432-9fa0bf8cde8a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b94e2a2-11ab-44e8-acec-293b8c5b86f8", "name": "The payload carried no recognisable repository URL. A URL that simply matches no project answers 401, identical to a bad signature, so the status code cannot be used to enumerate which repositories this portal watches.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a5449f8-52f4-49ef-b458-557246d91e65", "name": "Body over ``WEBHOOK_MAX_BODY_BYTES`` (default 2 MiB). Refused before it is buffered and before any signature work.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1a8ffa1f-d52d-43f5-bf12-8112587b7b75", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e5899c-d03e-414c-aafb-4bc213d7d348", "name": "Source IP over ``WEBHOOK_RATE_LIMIT`` (default 120/minute). The delivery is not recorded; redeliver it from the Git host.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "github" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Hub-Signature-256", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-GitHub-Delivery", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "248aac76-c196-4a4e-a7c3-9f253ff1f01a", "name": "Receive a GitLab webhook delivery", "request": { "name": "Receive a GitLab webhook delivery", "description": {}, "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "069f6667-288a-451d-9625-c6cd0c6fc187", "name": "Delivery accepted. Body shape: ``{\"status\": \"enqueued\"|\"duplicate\"|\"ignored\"|\"skipped_active_scan\"|\"skipped_team_at_capacity\"|\"skipped_disk_full\", \"delivery_id\": str, \"scan_id\": uuid?}``", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4821020-8a41-4be1-b32c-d7b101639ab8", "name": "Required webhook headers are missing or malformed JSON body.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "790943cb-b015-4ec5-b612-d68bad6b08de", "name": "X-Gitlab-Token mismatch.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a67a4c30-5fa2-4bd8-8c09-d5f28364d271", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99c7e710-df6e-43d3-9b59-24ac596637c0", "name": "The payload carried no recognisable repository URL. A URL that simply matches no project answers 401, identical to a bad token, so the status code cannot be used to enumerate which repositories this portal watches.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cf520b2-401d-4986-964a-ee29bc43ac7e", "name": "Body over ``WEBHOOK_MAX_BODY_BYTES`` (default 2 MiB). Refused before it is buffered and before any token comparison.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2ddb517-a0cb-486f-85c0-3c54258c84b1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 2450,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcec4a8d-52b9-4df6-ab58-70205a511786", "name": "Source IP over ``WEBHOOK_RATE_LIMIT`` (default 120/minute). The delivery is not recorded; redeliver it from the Git host.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "gitlab" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "key": "X-Gitlab-Token", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Event", "value": "string", "description": "" }, { "disabled": false, "key": "X-Gitlab-Webhook-UUID", "value": "string", "description": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://trustedoss.example.com", "type": "string", "description": "Your TRUSCA deployment's base URL, no trailing slash." }, { "key": "bearerToken", "value": "", "type": "string", "description": "A JWT access token (run 'Login' to fill this in) or a tos_... API key." }, { "key": "projectId", "value": "", "type": "string" }, { "key": "scanId", "value": "", "type": "string" } ], "info": { "_postman_id": "073c51ec-67e2-444c-b89d-a43434222d65", "name": "TRUSCA API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "TRUSCA REST API. Run 'Login', then 'Create a project', then 'Trigger a scan', then 'Export SBOM' in order: each carries its result into the next via collection variables (bearerToken / projectId / scanId). Every other request in this collection needs the same bearerToken (set it directly, or run Login first) and its own path/query values." } }