{ "item": [ { "id": "79b45d18-23ab-4816-9e54-362b755060c9", "name": "auth", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8b696abc-5f37-4a90-8c60-0cf7af005704", "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\": \"j5lcSE1F@M.xf\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "705309d5-87b6-415e-81a2-5a471c5425bf", "name": "Successful Response", "originalRequest": { "url": { "path": [ "auth", "forgot-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"j5lcSE1F@M.xf\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f7151a4-1834-46f6-bc27-f01f1e28ae38", "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\": \"j5lcSE1F@M.xf\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a35cd0e5-8557-4a2b-b2fe-7b04f6223860", "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\": \"j5lcSE1F@M.xf\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "201dd870-41f5-4e31-87df-5ea1c87ff232", "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\": \"j5lcSE1F@M.xf\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8c3de41-d558-48f4-b06e-dfba9e04a1d1", "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": "bba657af-2b80-4863-8da9-e21ec1cc0cb6", "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\": \"2g2aJ@RrTVCmfLzllSATdXwoLUcLaWsFUFme.ku\",\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\": 4332,\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "116cad63-6938-4afe-9e71-1b40a7eba2fe", "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\": \"2g2aJ@RrTVCmfLzllSATdXwoLUcLaWsFUFme.ku\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1bb7f15-1988-49e0-87d3-d1689a9f6142", "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\": \"2g2aJ@RrTVCmfLzllSATdXwoLUcLaWsFUFme.ku\",\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\": 6862,\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": "5643cacc-462f-4b21-90c4-4ead409bdbc0", "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": "9b558dd9-3a74-4c8a-88c6-733b4d783623", "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": "380e4e54-5dcc-4bd1-abc8-bab2476b3bca", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89643dae-9c2f-465d-a265-b4009793d3a6", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75ab5819-56c2-48c2-848c-6df286b832d1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9201abe-a565-44b9-9074-9e2ee4a303b7", "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": "cfe4101b-4afc-4119-b70f-c34bce3c661f", "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\": \"737236e6-ca15-edca-c721-52d731841505\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"2001-12-26T17:12:21.387Z\",\n \"full_name\": \"string\",\n \"memberships\": [\n {\n \"team_id\": \"7670e4a3-ff6c-d43c-f903-efb695e21ccf\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"f2825ccf-f50b-c460-7e87-efd0c6341c72\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "449cb68a-24b4-4171-aa39-c3029905ffc1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c69b292-7c9b-4269-bf95-96c5761221cb", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a979ec72-6c90-45ba-92b4-10b5866bab99", "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": "818b0fef-251d-4744-b348-2623cc2b8023", "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\": 4332,\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4be1dd8b-8754-4001-a5a9-2b29ec5459f2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b9cadf7-3284-424d-b1dd-d4a21ed37f56", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cf88c43-3121-4479-aec1-2520c5eefe68", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bae87ac-e377-4576-96fd-2ec250ea8e23", "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": "6a2b3088-94f1-4087-8289-d9b5f7d39133", "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\": true\n },\n {\n \"provider\": \"oidc\",\n \"configured\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e40a1d2d-0a9f-4a1c-bcda-fd801f154b1f", "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": "dca9545a-69cc-4be5-8aa6-778b194c2420", "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": "0a9cde7e-cf24-4a23-9a96-54595b0e5648", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c873db-dd90-4ef8-87c8-d994a1f591ee", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f45babd8-1b76-4ca8-a9a4-0dfa933437bc", "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": "998ad302-f619-49ce-a45e-5907fca10c5f", "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": "81a9f234-5d43-45e6-a228-6728169cfa81", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e0f010e-8efc-470d-83e3-15be8003e96c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90c73921-0a53-4d43-af30-9ec901b5981d", "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": "9be1137e-270d-4ded-9868-8e400bf1f1fc", "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\": 4332,\n \"token_type\": \"bearer\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5149004-0eac-42bf-8ac1-05953ef1686c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb5ae2dc-49b6-4926-870f-015d6ca5883d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e41e4aff-5ced-4943-851f-9f243a2fdd8a", "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\": \"6vcYtmhA@oTtzcGgkUxSB.acf\",\n \"password\": \"stringstring\",\n \"full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "69dac671-f16f-40c1-93ab-f0d5611339d0", "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\": \"6vcYtmhA@oTtzcGgkUxSB.acf\",\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\": \"82bbff3f-d869-344c-c8c1-f5440c9fc4b4\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": true,\n \"created_at\": \"2016-06-28T14:09:29.510Z\",\n \"full_name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5006b862-a5ff-4039-8ee2-6655dc688b83", "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\": \"6vcYtmhA@oTtzcGgkUxSB.acf\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7416df2-53bf-489e-ab71-55805e1a78f8", "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": "c8358bad-e131-40b6-9194-d2651766a27a", "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": "12e828cd-f7f1-4fe7-8cc5-f70f9330597c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0202f8ef-d7e6-4c46-a428-60f6b465fd6a", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e72f2f-25f1-446c-98d3-52a79c8cc766", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2f5e0d81-7803-4d10-892a-1b274a96bdd5", "name": "public", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "03ea7d0e-71c5-44e7-aec2-b8e9c620dfce", "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": "31f520df-728c-481f-94f9-cdeed70b9018", "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\": \"string\",\n \"key_1\": 7068.095537957109,\n \"key_2\": 9786.426881066329,\n \"key_3\": 5712.868528727065\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4343655c-47c3-467b-b04a-be52333f555e", "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": "d108979f-7d2d-4f26-b40a-6a31251d3135", "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": "ae83f743-006e-439e-b482-8a3cff22ce88", "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": "44b83416-311e-483b-890c-f711453bd305", "name": "metrics", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "13d36786-ad7a-4b76-9b39-4f50eafe6ae9", "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": "941dd3a2-0d14-454d-8f69-13cb1513668c", "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": "cacc6075-af8f-4e8c-9454-583fd012896c", "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": "2ca4329f-802c-4b59-8c6c-8739da34eb31", "name": "about", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a641cb6b-f592-40ef-9ff7-6eb4a95f5339", "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": "a8ae57c0-1035-484c-a9d7-cca1675a02ce", "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": "8391bb50-c89e-4d7c-8791-4122bacfcef6", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5456c99e-db8a-4952-bc7d-e66be448de03", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25277c7a-1b9a-4f1c-965a-c3436fcf876a", "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": "9b0fda6a-d835-4563-93e0-f7f5cd966c1e", "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": "fe307bc3-3dcd-4462-b3ac-1f01b4cbb704", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47d10295-c194-41a4-82f5-932a9806bc52", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55037ac7-fcfb-4693-98d2-a964706f19f4", "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": "05116b6f-8f87-42f5-a2c3-fe1cbe6f0208", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7892ec83-e509-4761-8a7f-b45ff664b65d", "name": "admin", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "946beb2a-55cc-4f05-aefe-f0edb34408fa", "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": "0deea4ed-e212-4fe6-8916-1a6164d9d865", "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\": 885,\n \"hmac_sha256_count\": 634,\n \"active_total\": 9063\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ad30b41-8eea-45e1-bb44-6141ea5d3ae5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18d094a8-9875-436a-be91-1d550e086c27", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cb74294-b324-41fe-a8ba-6807371f2145", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49303f84-2f82-482b-92fb-3b936de8d03e", "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": "6b77d1ef-005e-46a6-8f82-d0dbd60fa386", "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\": 885,\n \"hmac_sha256_count\": 634,\n \"active_total\": 9063\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e772ce4-c515-4871-9d84-0b79322f6bd1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38e73e1c-7592-41d7-b06e-e543e300dbd0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd6c6a64-0746-4197-9cdc-f8b8b67061d3", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ed05a4e-fe90-4c66-b6a4-856306dd15fa", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "target_table", "value": "password_reset_tokens" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "disabled": false, "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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": "8f0f9587-0d8a-4a14-b0e7-70bf030f4f9a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": \"6a8e54b2-fe9d-d05b-db28-26947b50c8b7\",\n \"created_at\": \"2007-02-04T04:07:29.476Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"f74498b7-aac5-1fb5-353b-e06b1cd69198\",\n \"diff\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 7140.975305284492,\n \"key_3\": \"string\"\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"af70b9ee-a63b-d5fc-3a2b-fbe237ea0d10\"\n },\n {\n \"id\": \"a1ecaf59-cde6-5f02-a085-c601a0de54c4\",\n \"created_at\": \"1946-11-09T21:14:33.402Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"e0884044-de3d-5ca4-81d3-976d23c33d4e\",\n \"diff\": {\n \"key_0\": 43,\n \"key_1\": 2625,\n \"key_2\": true,\n \"key_3\": 2894.285172710398\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"f3dab21d-b0b1-92b0-e4de-ee78b14dd588\"\n }\n ],\n \"total\": 6393,\n \"page\": 1803,\n \"page_size\": 4312,\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d57d4144-372f-4013-85bc-8ada45e176b8", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e668399-32cd-425a-bbf5-83c8691681fc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc7bcc67-db27-4787-ad1f-8b3b6fb355ea", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3600aee-80b0-4e08-af06-8d22f593d6c6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf4d2a81-cef6-43b1-b918-9ae8aa4f63f8", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "target_table", "value": "password_reset_tokens" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "disabled": false, "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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": "8e73e739-77ae-41a0-8420-66c5237ef70c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": \"b847fb31-8acf-4feb-c6b0-3d89e8dc91c6\",\n \"created_at\": \"1976-06-05T07:44:51.526Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"cef620d3-6344-4bec-ffb4-5376b6b3242f\",\n \"diff\": {\n \"key_0\": 1323.3267415005746\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"6b84b0e4-dfd1-7316-9664-af526ca4f056\"\n },\n {\n \"id\": \"261fa160-46d7-5d45-b4f0-2eda7feeb9e4\",\n \"created_at\": \"2014-09-02T13:06:20.021Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"675a64b9-af9d-ed75-9f86-87e197cc4f0b\",\n \"diff\": {\n \"key_0\": 2072.7882323951176\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"49a222d7-c583-80fb-9363-db2b8c06b27c\"\n }\n ],\n \"total\": 7773,\n \"page\": 6078,\n \"page_size\": 7812,\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "053048f3-fc7f-46ce-9681-6ab7c98ba7f3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2ea9f10-0069-4be1-97f9-f16dceb5b23b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bb54daf-b68a-45f5-a866-1fa763444d0c", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b0f5ebd-18b1-4f98-a501-55112dab60a3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1b2b452-0973-4df4-a1e8-b3cd40e756dd", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "target_table", "value": "password_reset_tokens" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "disabled": false, "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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": "8486a8c4-a7e2-4d4b-9c44-182b3a368d5c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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": "0bcfd6e0-6429-4182-87eb-e6aff697f7be", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "710a44eb-ca24-432d-b788-96ad1b4e88b4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a1ca7ae-99e8-4282-88cf-e00b13e88763", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "371123c4-f153-448a-a9c6-d8f7b467dba4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f33807d-bb8e-443e-839e-471bdac3784a", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "target_table", "value": "password_reset_tokens" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "disabled": false, "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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": "1dd04bc6-f744-48d3-9de5-5317c70afffa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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": "8c541969-f052-46a2-be04-264a9af19ee0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bfefb83-d800-4a15-a5cb-c7f0e7b65f2f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a4c9742-896c-476b-882b-e17f9ba50036", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd6039c2-b3ab-4b56-b779-052d0ee95e79", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "audit", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c512c6e7-d588-4e74-85e3-1e5a9888443b", "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": "3635cc64-bbf1-4bf5-a0ee-f4f735071d34", "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\": \"auto\",\n \"created_at\": \"1971-09-08T16:54:30.204Z\",\n \"size_bytes\": 8241,\n \"complete\": true,\n \"db_revision\": \"string\"\n },\n {\n \"name\": \"string\",\n \"kind\": \"auto\",\n \"created_at\": \"1988-11-26T08:52:47.061Z\",\n \"size_bytes\": 3949,\n \"complete\": true,\n \"db_revision\": \"string\"\n }\n ],\n \"total\": 5050\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "931248a0-4759-48fc-86ea-3157d3c5bcfb", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55708a94-175f-4e91-b9f8-b7b3f1de6691", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c4d62d-70ec-4339-a32d-f4a1a1627fd4", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b4b6a22-3d75-49ec-9f90-02e88dd90d83", "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": "e40ecefb-5927-472a-96f8-02a5e18fb50b", "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\": \"auto\",\n \"created_at\": \"1956-04-20T17:12:36.745Z\",\n \"size_bytes\": 4565,\n \"complete\": true,\n \"db_revision\": \"string\"\n },\n {\n \"name\": \"string\",\n \"kind\": \"auto\",\n \"created_at\": \"2022-02-15T14:29:16.709Z\",\n \"size_bytes\": 8637,\n \"complete\": true,\n \"db_revision\": \"string\"\n }\n ],\n \"total\": 7281\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6384b04-bfcc-49f3-a390-ae74e187607d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bd558a0-ec99-4fce-8440-e53e0ad79bc0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614cb9a7-57f3-4fbc-8852-7320bc91db0a", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "187a6ba9-8053-429e-87bb-93d849bb800e", "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": "bd4599ac-b9c9-4078-9b6f-e0e622c057ff", "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": "830f2f72-cf8a-499f-8f7c-042607572eae", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb253c63-7cad-4eb3-b6a8-db4d0d3a1d60", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a3f0bc-2543-4e47-9434-78c5bce249c4", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5aa2721d-6d4d-493d-a4e5-53041a2476aa", "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": "f8b2189e-c216-4c18-a225-0a623a815d52", "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": "7cc481d0-3b18-4fd3-af78-b4804bc66135", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbdf7015-0abe-4ae7-8c1f-abffa7489e5d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab2916ed-e2c4-466e-a9fa-79650eb309f3", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b428cc35-2ebd-47d3-b579-7c0bae2eec78", "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": "2945", "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": "2c9f47b1-22aa-4f6e-af4e-f2454980daf6", "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": "2945", "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": "16cc4c08-d684-453f-9848-4d0d7a6909a3", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25a5fbd6-eba3-4cef-9fe2-02a58724eccc", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dce87f98-d213-4c36-a5de-92e23c8fd5c4", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45afc33-e332-41e8-9804-815f8b07daf4", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "161ddb43-1b3d-410e-bad8-a37f26e65355", "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": "2945", "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": "3e6637b0-6719-4f09-beff-83379dee5c47", "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": "2945", "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": "e275151e-192a-4690-b70e-4c7a585a9c3b", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f998ab15-521f-484a-a072-3096b5958563", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f129c192-00a1-4a55-b0b4-6d10386989c6", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58f4fc07-2dc9-4b7b-999b-d477cdcfec5c", "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": "2945", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "437e742f-42b1-41f0-bfc8-530785a38630", "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": "bed61316-74d9-48cb-be23-a481bf35dab8", "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": "e6a99cd4-2035-4346-9d6b-14e63bf6cdac", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c766680-9ca8-434b-8456-ee3b00294e58", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d3756a4-cffc-44eb-bb84-ac7f066ba482", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04426511-d4c5-48f4-8324-7a01b9ff095c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d3a3e73-4841-484b-a953-169ea6540661", "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": "7548dabc-b3a3-4cc8-856a-9975d3fe266e", "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": "d1b5ed65-3cb6-46c5-b93a-2f7c6480c946", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "108f7e5d-d60d-4952-afa0-1be0c744c652", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6d75c27-4645-443e-9c20-2f015e843fa2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55bcd71c-2365-40ae-a922-7a943dbbf105", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3aae3bb-e9bd-48d6-ab3a-17e977efd59f", "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": "82f82e02-72da-453d-a93c-7d04ce02fd64", "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": "2ae2d575-034b-47ef-9bca-8cbfbb9160af", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05f196e-bdc9-4b01-a40f-27ba4b5d8dd2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81c4f7d1-c770-486a-91c6-658185cd51f2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62ef00b5-64ed-4fc6-808e-8aa7399ddaf0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88b60391-b854-4f10-b8ac-e9dc9d6ba7bf", "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": "341f136a-a5cc-4cdd-b2d5-d15b176da425", "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": "9a189b90-aaac-40cc-9a3e-a1d6ad488dec", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68483e2d-3a6f-47d0-a32d-862907979256", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a64f6a53-4911-4827-a369-ae3ef2c85743", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed3f56b8-0b83-4a6e-855a-a74f820de9e6", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eca152f1-345d-4cbb-98eb-deab25f80121", "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": "0b825ddd-d691-44f2-8123-c5c099709547", "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\": \"postgres\",\n \"used_bytes\": 6992,\n \"status\": \"degraded\",\n \"error\": \"string\",\n \"free_bytes\": 7275,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 2148,\n \"used_pct\": 12.05398296251088\n },\n {\n \"name\": \"trivy_db\",\n \"used_bytes\": 6327,\n \"status\": \"ok\",\n \"error\": \"string\",\n \"free_bytes\": 7870,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 6759,\n \"used_pct\": 55.756697072368766\n }\n ],\n \"collected_at\": \"1959-11-18T13:27:35.328Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9858509d-432b-4147-93cf-04ab6cb1f85d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "736e3922-b304-4b07-a78a-85381fbe1431", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bc41b8b-fecf-48e9-a0ee-8b5e4b52c9e1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adccdbb2-6df3-4a3c-8b01-1cf4b591ad7d", "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": "83b3348a-3e56-4068-b96a-329eed8294f3", "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\": \"trivy_db\",\n \"used_bytes\": 9388,\n \"status\": \"ok\",\n \"error\": \"string\",\n \"free_bytes\": 9149,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 8499,\n \"used_pct\": 31.703781911854236\n },\n {\n \"name\": \"workspace\",\n \"used_bytes\": 1047,\n \"status\": \"ok\",\n \"error\": \"string\",\n \"free_bytes\": 8230,\n \"path\": \"string\",\n \"threshold_critical\": 90,\n \"threshold_warning\": 80,\n \"total_bytes\": 9928,\n \"used_pct\": 12.384030641059907\n }\n ],\n \"collected_at\": \"1963-05-11T10:53:43.116Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b6a2e42-a5b6-4bff-bde5-21fd9c7279f2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ca150fd-81d2-4f63-b6ab-465b2b91dd56", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7f92fb6-92c5-40a8-813e-4d57adfdb034", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5b1acd2-af32-4465-b26a-96f291c28b92", "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": "01872633-9f8a-49e1-89f7-d85ca9219338", "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\": true,\n \"refresh_enabled\": false,\n \"cleared\": 8711,\n \"duration_ms\": 9659,\n \"eol_flagged_total\": 783,\n \"feed_host\": \"string\",\n \"last_attempt_at\": \"1948-09-23T15:53:04.506Z\",\n \"last_result\": \"skipped\",\n \"last_synced_at\": \"1955-04-04T23:33:32.062Z\",\n \"next_refresh_at\": \"1991-03-14T07:43:57.912Z\",\n \"product_count\": 0,\n \"rule_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"1955-04-28\",\n \"snapshot_origin\": \"feed\",\n \"stamped\": 1378\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da85a91f-37c4-4ac9-a100-da02f60d9d10", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9732cbf-73a3-4a8c-871f-71a7a9f96dbc", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e7f609e-b4a8-4722-90bb-095749e29c92", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "735128fa-2a61-41d9-9945-4b2e4ccfdbe5", "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": "5d2aad85-fbcd-4252-931e-42c20f9c3e7d", "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\": true,\n \"refresh_enabled\": false,\n \"cleared\": 8711,\n \"duration_ms\": 9659,\n \"eol_flagged_total\": 783,\n \"feed_host\": \"string\",\n \"last_attempt_at\": \"1948-09-23T15:53:04.506Z\",\n \"last_result\": \"skipped\",\n \"last_synced_at\": \"1955-04-04T23:33:32.062Z\",\n \"next_refresh_at\": \"1991-03-14T07:43:57.912Z\",\n \"product_count\": 0,\n \"rule_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"1955-04-28\",\n \"snapshot_origin\": \"feed\",\n \"stamped\": 1378\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a938cb8b-c1f7-4921-b837-a456a522cc77", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c80813b-9029-41f5-94a4-cc618caaca93", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6f6104f-3f6f-4a91-b9a7-d5c304fd2fba", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a80f2682-95c7-43e7-a03e-2c951e2996b7", "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": "7824f211-c3de-49d7-9461-eab829dd7caa", "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\": \"celery\",\n \"status\": \"degraded\",\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\": 4887.032236976065\n },\n {\n \"name\": \"celery\",\n \"status\": \"ok\",\n \"detail\": \"string\",\n \"detail_code\": \"string\",\n \"detail_params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"value\": 5916.380773126954\n }\n ],\n \"updated_at\": \"1952-06-05T01:16:14.788Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b117034-903a-4699-8874-0733b80c14ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ee9d0a-337b-46ad-a969-44f38b15f5c1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b74225cc-5d9d-4725-b840-0d6acf2c7664", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77870bc6-2ea9-4507-adec-cfeaa42436ab", "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": "7b4f9cf5-2579-4ab1-9f4a-deccf5d0bc34", "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\": \"active_scans\",\n \"status\": \"degraded\",\n \"detail\": \"string\",\n \"detail_code\": \"string\",\n \"detail_params\": {\n \"key_0\": {\n \"value\": \"\"\n }\n },\n \"value\": 6022.874808620726\n },\n {\n \"name\": \"postgres\",\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 },\n \"value\": 5293.83111621071\n }\n ],\n \"updated_at\": \"2015-07-15T21:20:03.376Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f3619d7-d359-43a9-84d9-fb74a9f4b8b7", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e21d8abf-eaaf-441d-bf0e-1bbc30aaab46", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1f57d96-69de-45a9-a6e7-86e5bfccec6e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2eea0a4-9980-48fb-8f42-8ff53ad85c76", "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": "3152f2a5-316c-4827-83d9-a66ddd754400", "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\": false,\n \"delisted\": 9319,\n \"duration_ms\": 1822,\n \"feed_count\": 1866,\n \"feed_host\": \"string\",\n \"kev_flagged_total\": 1807,\n \"last_attempt_at\": \"1993-07-26T16:38:14.011Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1958-10-06T00:30:56.223Z\",\n \"listed\": 5789,\n \"next_refresh_at\": \"2012-10-13T17:05:46.538Z\",\n \"skipped_reason\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7ed4f0a-11d4-4502-9029-fa554cae1431", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0e846ff-5f07-476b-8827-344017fc4360", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feab3be8-2b8b-45d6-a185-7bf5dfd4986d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91486b7d-2f06-4af3-a8c1-a0775f6b126d", "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": "174d2840-9f0f-424e-a4f3-d5256796155a", "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\": false,\n \"delisted\": 9319,\n \"duration_ms\": 1822,\n \"feed_count\": 1866,\n \"feed_host\": \"string\",\n \"kev_flagged_total\": 1807,\n \"last_attempt_at\": \"1993-07-26T16:38:14.011Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1958-10-06T00:30:56.223Z\",\n \"listed\": 5789,\n \"next_refresh_at\": \"2012-10-13T17:05:46.538Z\",\n \"skipped_reason\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d71f45e-9301-4912-a3dc-d29dd6daf4ba", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e73e75b-b5c8-4409-b57f-701daec8f157", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fb05ebf-a0f5-405d-b98a-02052c5ea835", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "878df358-3a7c-4b01-8838-0eb2c92c4506", "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": "d0298892-917c-4056-9a6c-e11c0eb8fe28", "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\": 9473,\n \"last_attempt_at\": \"2003-06-05T06:30:08.145Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1948-10-30T08:58:08.480Z\",\n \"newly_flagged\": 9150,\n \"next_refresh_at\": \"1966-05-24T15:37:28.342Z\",\n \"purl_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"1977-12-10\",\n \"snapshot_stale\": false,\n \"stamped\": 1596\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f90cb092-0ece-4059-a9dd-aff2b8381593", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a49ca765-cdbd-48dd-acee-9fc2e9425923", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98fc2f49-c35f-4265-859d-a9f3dee742ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c206352b-3660-4e29-b1b8-5158b9bd1763", "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": "09b41e9d-b287-43a1-92a2-0c6b41b1b6a8", "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\": false,\n \"ecosystems\": [\n \"string\",\n \"string\"\n ],\n \"flagged_total\": 9707,\n \"last_attempt_at\": \"1985-09-20T05:49:41.563Z\",\n \"last_result\": \"synced\",\n \"last_synced_at\": \"1987-03-06T06:03:33.108Z\",\n \"newly_flagged\": 5463,\n \"next_refresh_at\": \"1996-07-08T05:05:41.038Z\",\n \"purl_count\": 0,\n \"skipped_reason\": \"string\",\n \"snapshot_date\": \"1952-09-21\",\n \"snapshot_stale\": false,\n \"stamped\": 7341\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "439ab371-7db0-4c64-b7d6-24dce12398f4", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6427f599-18e5-4f66-a97b-ee7f3663742e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d90cf470-9195-407d-957f-bf8910e45dd6", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e68eebf5-179d-4d73-b20f-2ab06eacdb66", "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": "599c7897-bc81-4a17-a9dd-8a942fc5be7b", "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\": \"ac63574c-f1ab-0787-cf8d-72b736027d91\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": true,\n \"created_at\": \"2023-05-25T06:53:38.759Z\",\n \"team_count\": 0\n },\n {\n \"id\": \"9c0ca432-2582-3c0a-5b83-be65ac557361\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": false,\n \"created_at\": \"1969-10-24T02:26:26.465Z\",\n \"team_count\": 0\n }\n ],\n \"total\": 8361,\n \"page\": 6201,\n \"page_size\": 6165\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f21350ef-c190-4ea1-8dbd-bdd917055acf", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1f05504-78eb-4bbc-9c45-3e5d8bda59d8", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8179f411-f3ca-441c-b704-7abe6d18c5f3", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0673db2d-47e5-4c08-8739-b13b5eefbe26", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39df2904-cd01-48b2-80e1-02b5625bfa0a", "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": "4121cb39-a09b-430d-b54f-cee38daf73e2", "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\": \"73d98e9b-5a20-be5a-8f51-fa52f1d96e2c\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": false,\n \"created_at\": \"1993-01-20T21:51:14.083Z\",\n \"team_count\": 0\n },\n {\n \"id\": \"ffc88bf1-a6e4-e5d3-8f8f-da5535013934\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"is_personal\": true,\n \"created_at\": \"1965-03-09T05:10:39.258Z\",\n \"team_count\": 0\n }\n ],\n \"total\": 9389,\n \"page\": 6387,\n \"page_size\": 104\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb5eebd5-8930-442c-b7a4-4de1fea595eb", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4183d036-2a6c-4f4f-8c48-39bf99c0fc1b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b6b2ed8-97b3-45d7-9084-700aa4a18a8c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39145c76-5f20-46b5-9024-b3c3932dd2fd", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39e986f7-3000-4ffe-9066-e8508658bf97", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e2c41eda-6cb4-4883-b584-d161c1c08317", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"1be096e4-4e74-b58e-8244-b021719d33e4\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": false\n },\n {\n \"id\": \"6e3f256a-8f19-6318-e814-d4b4abf3274d\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f05d1153-b187-43bc-9d24-c3e852d039af", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cc1b0a4-1e2e-48d9-8810-b8e465c476dc", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d8b5efb-dfe7-426b-a8e9-e3682c880493", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "256f048b-1f53-48b6-a8de-e2e0b9ec4039", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dc96e4e-b53a-4b35-8e22-686251806637", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db5c7c84-6d33-4f0f-9153-0150f25833aa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"647dc26e-0c84-4491-312c-d00bf4a037a6\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": false\n },\n {\n \"id\": \"7bccf46f-5d41-aafa-b99f-a9f29e78eb4a\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d6803be-c298-40c8-9760-2fd31379aa65", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "161a1fe1-35fe-4847-9227-57175e69cf9d", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d193bc9f-eb9f-41f4-9309-5a1e689940db", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4ad9c04-3899-4798-b318-24eca400dabe", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ac5c429-147f-429c-91bb-ac817abdcae0", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "b7904645-1d7b-49e2-a2dc-0dc14ba62a95", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"aad445a1-a1f7-1931-eddf-9190515dc917\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c43bed-1983-4cc8-9af3-32b3abef8e54", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d3b4aa7-326f-4475-8e8e-cc86fe1c54a7", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e178eef-8421-4495-a938-593b82d92565", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "121ff0e9-a444-4985-8f20-a8f25d27a16f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5621e70b-1d46-4949-9db8-9ff2b44d9ae2", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "194dca1b-4c3b-4223-8a5e-115de15a0f22", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"aad445a1-a1f7-1931-eddf-9190515dc917\",\n \"registry_host\": \"string\",\n \"username\": \"string\",\n \"allowed\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de5d3a11-4536-4d10-9993-d79fdf85dcb2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42082189-100b-45b1-914a-461675e10212", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bc3dcca-72f3-4e0d-840d-b856c811e3f6", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d6af5c1-b8fb-45b0-a034-c401354bfcce", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a786c344-a2f5-40ef-baaf-8780233a87b8", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d93a18af-d99a-476a-b0eb-4905d4fd5dca", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "33b9f14d-a683-4c62-bb36-3cc4b18723f8", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd7e496e-7127-4b9c-910b-240b4579c16c", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "674d6d9f-d89e-4afc-b613-4755bb7caa16", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c98cd70-939a-4785-b930-cab8e708cbe2", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d011fcd3-a7c2-4f03-9691-4b4b5b1fae2c", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1e23fa42-acb3-469b-a72b-f562a55d4365", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "c4486c08-a069-4dcf-aa97-7ec519fc99b4", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c97abe0-aa9e-4709-a24b-4f4d0ed58de6", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb33a012-5599-4221-9de3-e52341806680", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4307339-a838-4983-a42f-c0fca6a83db4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "registry-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f9851ef-1dd8-4127-831d-cf7dd610f274", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7452d1ec-ba24-4d1b-978a-95a6183f794e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"1c7aed26-ebc1-e93a-cd0b-bab9d698a734\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n },\n {\n \"id\": \"f0160ff7-9b6c-0b45-cb5a-10485df83c99\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d5eb378-677b-4f80-8e34-180b44af772b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d30ee003-0606-4c33-888a-59bb240ba4d3", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031eb429-35cf-49a0-8679-ed0ca8230e0e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26fd2b49-8ea3-4956-ab86-d033ededa0c3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c5a3066-0b13-45ec-b16b-af64ae56afe0", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2724e9a2-ab8e-4b34-b21f-05db1be5252d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"07f8e75a-2189-8b17-7209-307c5bce357d\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n },\n {\n \"id\": \"7997d30e-b025-75cd-6831-db083fdb35ef\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1992744e-3e91-46ca-8e32-92e4db504c8b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59048ac2-56d3-4c5b-a99f-46225aeacab4", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b58bae7-f08f-47bf-a1be-43ad87e08446", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faa83165-2dad-49c8-adf1-53a3ee746b0c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d85e636a-cd07-412d-985d-74deeb596606", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "ceb0db34-de96-48a5-abbf-2677652f2f24", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"1ff0bd5c-8d57-8ce3-2cb5-5decbe6577bf\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f72d03b4-97c7-47ec-806e-92a617b34f3f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f719d8b-f387-494e-97f2-d109495e1176", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d69156f4-01c0-4e53-8280-9adb2f6720fa", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b52b2a5-64fe-41b9-8cde-8aeb11db3b25", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa6ad249-ff1d-43f2-89ee-b4a25b1e7998", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "ec25ff82-f6f3-4e1f-804c-9d1583b60923", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"1ff0bd5c-8d57-8ce3-2cb5-5decbe6577bf\",\n \"host\": \"string\",\n \"auth_scheme\": \"string\",\n \"username\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d1c7ac5-3010-443c-924d-900337794e83", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "624f5d7d-ac76-4120-8290-4541d6eb8a2e", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aed7e74-418f-4a5e-981d-09ad19ea78d3", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7014a3fd-c6c5-42ab-8ca0-38324fa55f29", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "daec2e57-71ea-4a54-a5ef-012b66284a8a", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "91f226ae-6f02-481f-9cd6-35f3687dd259", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "a3574499-4b2e-4a99-b7f8-d2a2f1db8e2e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dd4d94d-49f7-4f47-b306-7a656f7280c6", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94c88e7b-b49e-4c5c-a308-66cd1a20a468", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56ad4e5b-95cb-43fe-a9df-89cac447106c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5d7b7cf-26a9-4e67-a940-22f5a1f49ab7", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1aab481a-520c-4b18-986f-ba7ece5af465", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "1eae71e1-08d3-4e25-8fc5-5b5aa5fb6626", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c131c15f-afe9-44fc-af45-8118052f7b0e", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee15aea-4603-4629-a43c-57dc9beb0505", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4b10140-f6e0-4866-98af-efa92758d240", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "organizations", ":organization_id", "ticket-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d404375f-cf2f-4fbb-be34-9d7ec662bf5b", "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": "cancelled" }, { "disabled": false, "key": "kind", "value": "container" }, { "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": "b2f660ed-9187-471f-897a-a030376a5c47", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": \"c5733c28-e260-6125-74ad-44de5f01be80\",\n \"project_id\": \"eef7768b-3fb2-50eb-dc6f-148ce6c49f79\",\n \"project_name\": \"string\",\n \"team_id\": \"98068eb6-3c6e-a290-7a3f-97b58a9fd7e7\",\n \"team_name\": \"string\",\n \"status\": \"cancelled\",\n \"kind\": \"string\",\n \"created_at\": \"2010-04-17T23:55:40.284Z\",\n \"duration_seconds\": 7914.055696478732,\n \"error_message\": \"string\",\n \"finished_at\": \"2017-08-15T05:27:45.556Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"978385f2-946f-d6b4-1fda-80603a4b3cbf\",\n \"started_at\": \"2015-04-14T05:20:01.589Z\"\n },\n {\n \"id\": \"16231110-a8cd-cda3-1109-affaee65849e\",\n \"project_id\": \"3c81ed3a-54f6-a6fe-3b4b-1d6eaf0b55c5\",\n \"project_name\": \"string\",\n \"team_id\": \"fe0488af-9743-c517-5c81-772ea22aa410\",\n \"team_name\": \"string\",\n \"status\": \"succeeded\",\n \"kind\": \"string\",\n \"created_at\": \"1997-11-04T10:19:49.091Z\",\n \"duration_seconds\": 1671.7255817264643,\n \"error_message\": \"string\",\n \"finished_at\": \"1991-11-29T10:45:15.014Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"8af89331-8946-adff-3c3d-596d2906e92a\",\n \"started_at\": \"2015-06-26T06:05:38.368Z\"\n }\n ],\n \"total\": 1622,\n \"page\": 152,\n \"page_size\": 2477\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66009a2f-06f6-4337-ac01-3fddcab0b6ca", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a7d1517-d3e4-4aff-92c2-6f658ed1ed35", "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": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20885295-3053-40bb-accb-1a984d918dd5", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "186bf383-bc00-493a-9ad5-2207825a0623", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6d5e925-bfa1-4d8e-824b-e7243dd5945a", "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": "cancelled" }, { "disabled": false, "key": "kind", "value": "container" }, { "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": "41e592ed-2503-4b2f-8af3-c1d54e3e1f5e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": \"e30cacc6-05a8-7bcb-08f4-17ed5cbda170\",\n \"project_id\": \"f73e9ec1-4bcd-98fd-857e-a52665bf0159\",\n \"project_name\": \"string\",\n \"team_id\": \"b6f8e3a8-e424-35a4-1950-d7d43b95a67c\",\n \"team_name\": \"string\",\n \"status\": \"cancelled\",\n \"kind\": \"string\",\n \"created_at\": \"1974-12-27T20:05:21.432Z\",\n \"duration_seconds\": 3768.780245831398,\n \"error_message\": \"string\",\n \"finished_at\": \"1963-09-01T14:17:37.887Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"bac3bba4-0318-d2cb-2ccb-95ad678958dc\",\n \"started_at\": \"2003-05-09T11:56:35.859Z\"\n },\n {\n \"id\": \"e5b098d4-1b8d-9949-7eac-1c2af2406567\",\n \"project_id\": \"14f94ff9-1c08-4c36-8fe2-ddee14e27ece\",\n \"project_name\": \"string\",\n \"team_id\": \"6f061b33-e3de-c069-4189-613a2aff8b04\",\n \"team_name\": \"string\",\n \"status\": \"running\",\n \"kind\": \"string\",\n \"created_at\": \"1976-09-25T09:51:27.038Z\",\n \"duration_seconds\": 9701.731693277326,\n \"error_message\": \"string\",\n \"finished_at\": \"2005-07-04T12:11:34.281Z\",\n \"progress_percent\": 0,\n \"requested_by_user_id\": \"833ba1a8-6083-76bf-1a23-0fa63a437c75\",\n \"started_at\": \"1961-05-13T16:22:21.201Z\"\n }\n ],\n \"total\": 8080,\n \"page\": 9404,\n \"page_size\": 2806\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdf7c289-d69e-4bd0-ac24-885d641cc203", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10137130-ca36-466c-a230-8095fd0a5f22", "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": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89300596-6ede-4967-9bee-fc14b0778cff", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26c5dcc1-d0e6-4c30-84d0-e5735e3d8ad9", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "status", "value": "cancelled" }, { "key": "kind", "value": "container" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b8fb31f-899c-4843-be3b-1c59f23150f5", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4af3ea79-ad7f-4e6d-9254-5f16a646f43a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "87536cbf-99fa-4da9-9f8f-b1d22ca03afe", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82795839-16b3-4b5d-b3e2-fee295c59ff8", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0b2a4c6-825d-4bfb-b0bd-e6ba5d37b302", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d97e7ea2-74bd-45d5-8fee-e70ddd03cbd0", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "272a3d71-b540-4bc0-ab03-045b0c45c67f", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7be57ed0-c116-4e34-be31-aac3fe0557ef", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "bae6d1d9-e33e-48aa-8d17-c4ccb8564620", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113c4923-36ae-4217-8373-fc50dbf304a6", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35d2af8d-9300-45fd-b20d-91657a958b64", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6ee2a5a-98d0-49a2-8622-b6679cdba1c3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "22ba27b2-6bb8-490e-9b23-ffb17a7b99ec", "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": "4d89b4ab-70a6-485d-a3b4-379f147da6a5", "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\": \"f597dc24-7088-dc05-6387-332a6db9586c\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"877b6814-3947-f731-f49c-41c5c5489586\",\n \"created_at\": \"1993-10-07T02:58:07.312Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"1ffc6930-2341-eeca-5402-d92108028414\",\n \"project_count\": 0\n },\n {\n \"id\": \"bc643b31-851b-7f26-e7fe-25fa7b95e8fa\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"c53d6c51-4147-8a01-0314-1d532b71a0c5\",\n \"created_at\": \"2023-04-27T03:59:13.928Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"60040270-d374-0061-db6c-610d1b985402\",\n \"project_count\": 0\n }\n ],\n \"total\": 1228,\n \"page\": 3229,\n \"page_size\": 897\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee2cc76d-0c32-40a0-9ac2-7f77c5cdc373", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71cd68b8-a350-4f13-a858-6d769344c75d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2294c91c-24a0-487a-a11d-24744db7d6e5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c85ddc5-cb8f-4e79-9bd2-5921b31a61e0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e0bb2cf-9c26-48f0-934c-6187385439ef", "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": "af17fa6c-9f30-47f1-80ce-835d737a3668", "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\": \"b6c02e69-925b-f3ba-a927-6fc3cbdc47f9\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"9c61563a-df9d-634a-e558-c791c4af4b4c\",\n \"created_at\": \"1965-03-09T12:17:36.702Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"31a31666-26b6-627d-607e-21316164470a\",\n \"project_count\": 0\n },\n {\n \"id\": \"417403ee-44bb-6f68-fd37-5ea03bf2456f\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"8b020e1f-dec3-7d56-77fd-fa90d503408f\",\n \"created_at\": \"1972-08-04T21:00:31.089Z\",\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"3daf0013-395d-d972-ade5-951797c29a8b\",\n \"project_count\": 0\n }\n ],\n \"total\": 5274,\n \"page\": 4393,\n \"page_size\": 5516\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a740640-e290-41e2-b8e1-38965d288690", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df7fb4f1-dce1-4a1d-afa8-24a53f41e3f3", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f6273b6-b1e4-4403-8f75-3db39b843289", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1ada3d4-5c87-4c47-8e24-28d6c3641d1f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79e74342-44b6-4df0-9559-91bae62b2137", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7737beb0-68b2-4934-9218-d1cc6d18fd56", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7a3d6938-72e9-b3b6-c4ae-5376c4651b7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"f6834c06-003a-f49e-fe67-e0af0e7cb99f\",\n \"created_at\": \"2010-02-16T08:47:47.490Z\",\n \"updated_at\": \"1989-12-29T20:11:00.501Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"0233d02f-16f0-7e8b-fba5-25405a3aa775\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"44656cc3-e62b-4c90-d370-44e59f72d747\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"d91b65c4-8c66-9048-c5f2-d543912bb751\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84812cc0-7c0e-48ee-a770-072d46a30ed7", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98773efd-f333-4a31-868c-cfd53461c186", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2463c0d4-6289-403d-b581-7ff302736ea9", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d478c1b-3106-49b3-9d0a-7107c153d279", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78108c5b-0e67-4f7e-9efc-5df50b6b36f4", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f438f313-ffaa-4378-abd1-25998067ba0f", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e95231fa-3ee2-7bcf-6ee4-7f82cb2e0c69\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"910d5968-e6d7-6fc6-e038-5df9201e7e81\",\n \"created_at\": \"1970-10-04T00:31:07.922Z\",\n \"updated_at\": \"1971-08-28T08:53:45.885Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"f05499f6-e47b-6d54-416c-a6e56f09ecdb\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"013de58b-1f20-d53a-e2d1-e7196c3ec4bf\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"e89b3a24-5efc-2c7a-7830-eb070b310c86\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c08ffb3-e6e4-49f1-bad6-d6fbd43859fc", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83a7b9f8-fe31-4cc2-a7b0-e0546fca9eed", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "991133e3-83b8-40f4-94ef-7d7f334d796d", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71fa53d0-4684-4da5-b235-e91837252bf8", "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\": \"b0e1061d-1c60-a0c1-86ad-5a38a38f0c7f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b8f38a7-d258-42ee-b2c1-bc2f40f14f79", "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": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c01a518e-e29a-4d10-bdfc-18211edcfbf9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7a3d6938-72e9-b3b6-c4ae-5376c4651b7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"f6834c06-003a-f49e-fe67-e0af0e7cb99f\",\n \"created_at\": \"2010-02-16T08:47:47.490Z\",\n \"updated_at\": \"1989-12-29T20:11:00.501Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"0233d02f-16f0-7e8b-fba5-25405a3aa775\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"44656cc3-e62b-4c90-d370-44e59f72d747\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"d91b65c4-8c66-9048-c5f2-d543912bb751\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07cb78af-5885-4802-b978-9f4963841e77", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6802733f-15ff-46e7-923f-51d4bf9d7dc3", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa4922ca-1b02-436a-b6dc-c5ae0043d06c", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbd97699-541c-4cae-994d-f387f518fdef", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d383bd8e-7a04-48da-aeba-2b4042a588a0", "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": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e36f308e-f505-4cf0-b666-fe04cdbe8710", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e95231fa-3ee2-7bcf-6ee4-7f82cb2e0c69\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"910d5968-e6d7-6fc6-e038-5df9201e7e81\",\n \"created_at\": \"1970-10-04T00:31:07.922Z\",\n \"updated_at\": \"1971-08-28T08:53:45.885Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"f05499f6-e47b-6d54-416c-a6e56f09ecdb\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"013de58b-1f20-d53a-e2d1-e7196c3ec4bf\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"e89b3a24-5efc-2c7a-7830-eb070b310c86\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a0fef65-7097-4236-a25d-9dbee8c089f2", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16996c37-ecc2-4cd8-81a4-4f9ada7242af", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47296ef5-9119-4c19-9688-b5fc8f152fbd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0408d8c0-103d-4203-a3f6-3c47c9e1a059", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":group_id", "reparent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"new_parent_id\": \"482552a5-55c0-ea55-96de-a8eb72fbeb7d\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c599de8-b8ba-4387-9269-1715330621bb", "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": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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": "503893d1-2ac7-44cd-8400-506f5555f2ea", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": \"7a3d6938-72e9-b3b6-c4ae-5376c4651b7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"f6834c06-003a-f49e-fe67-e0af0e7cb99f\",\n \"created_at\": \"2010-02-16T08:47:47.490Z\",\n \"updated_at\": \"1989-12-29T20:11:00.501Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"0233d02f-16f0-7e8b-fba5-25405a3aa775\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"44656cc3-e62b-4c90-d370-44e59f72d747\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"d91b65c4-8c66-9048-c5f2-d543912bb751\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ec503d0-c9b0-4a84-a0d7-0d55fc37fc2d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77a64b53-fd2c-453c-8bc8-2f55be1c2d4e", "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": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc5506a8-5030-4558-9aea-c760ebfe1f23", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34185348-47f8-4487-826b-1ab808ec7631", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "408e4db6-c63c-48d4-ac0c-ad939fd88ba5", "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": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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": "df84e2a0-d0ca-4b3b-b71c-e48bd1b457b2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": \"e95231fa-3ee2-7bcf-6ee4-7f82cb2e0c69\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"910d5968-e6d7-6fc6-e038-5df9201e7e81\",\n \"created_at\": \"1970-10-04T00:31:07.922Z\",\n \"updated_at\": \"1971-08-28T08:53:45.885Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"f05499f6-e47b-6d54-416c-a6e56f09ecdb\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"013de58b-1f20-d53a-e2d1-e7196c3ec4bf\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"e89b3a24-5efc-2c7a-7830-eb070b310c86\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8325f568-08bb-4f87-9c0b-d18164ac67f1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1307e6e1-2815-4e16-9949-d992efbc33f8", "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": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "555e6c2b-8329-4579-9f00-7d6a66dba13b", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56bc5fdf-352f-44be-9c35-cc3c9066b578", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":parent_group_id", "subgroups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "060c1aaa-3b90-20cb-1507-7be2aeafef3b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ddf2cfa-e7ad-4c67-8cce-4d5f72551453", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f335586d-423f-4046-8eec-e353ff39beec", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "4306aacf-bf67-4d25-a188-068b11403d67", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12745cce-080a-4dc0-a71c-751841118ffd", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7d0df30-dce0-4f58-b03e-d5dbfa051532", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a63455-decf-49cc-91b3-18fafe862d9c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3d2eae6-8b1e-479d-a4f9-7f13881ac0e0", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9b635555-c7c6-40ae-ae64-d322ce818473", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "974e153f-b29b-4008-99d9-a183b48eee8f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaa21278-fd0f-4bf8-b6be-fec8ff0c9cfe", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a5d9c78-8c03-4f29-ba75-512dcab9e347", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "580aab60-9590-4839-9ac7-b17c03527876", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "435907bd-7e29-4201-a156-17235833b225", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c118a581-16be-4430-8c29-082dff365d03", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"7a3d6938-72e9-b3b6-c4ae-5376c4651b7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"f6834c06-003a-f49e-fe67-e0af0e7cb99f\",\n \"created_at\": \"2010-02-16T08:47:47.490Z\",\n \"updated_at\": \"1989-12-29T20:11:00.501Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"0233d02f-16f0-7e8b-fba5-25405a3aa775\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"44656cc3-e62b-4c90-d370-44e59f72d747\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"d91b65c4-8c66-9048-c5f2-d543912bb751\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29279a4d-727b-4fbc-a282-95f50a81317f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1007c106-4d05-476d-966c-2dfebc60c8c3", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c44cd8f7-197f-483a-82b0-18d5c7e81779", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5c5eaf5-c792-4e2b-bd35-25f39c3cc1aa", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc927d3e-690e-457c-91b4-98334953b436", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0eb0df38-7114-4963-bb28-9b7d4d8a305b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"e95231fa-3ee2-7bcf-6ee4-7f82cb2e0c69\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"910d5968-e6d7-6fc6-e038-5df9201e7e81\",\n \"created_at\": \"1970-10-04T00:31:07.922Z\",\n \"updated_at\": \"1971-08-28T08:53:45.885Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"f05499f6-e47b-6d54-416c-a6e56f09ecdb\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"013de58b-1f20-d53a-e2d1-e7196c3ec4bf\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"e89b3a24-5efc-2c7a-7830-eb070b310c86\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ff3b672-d4ad-4b53-9072-680631cfea25", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b84dcd96-c226-4c68-a385-6e47ae3b633e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3244511a-e095-4a97-a70d-10b17cb74c4a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55146a66-806b-49a4-8774-7f2ceb438825", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07db15da-5f16-49cd-ae8a-f9b4ebe71a94", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "1eb4edea-25c6-4c49-92ed-aa427ef51ef4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"7a3d6938-72e9-b3b6-c4ae-5376c4651b7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"f6834c06-003a-f49e-fe67-e0af0e7cb99f\",\n \"created_at\": \"2010-02-16T08:47:47.490Z\",\n \"updated_at\": \"1989-12-29T20:11:00.501Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"0233d02f-16f0-7e8b-fba5-25405a3aa775\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"44656cc3-e62b-4c90-d370-44e59f72d747\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"d91b65c4-8c66-9048-c5f2-d543912bb751\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac549eee-a1df-414e-a38b-1c4a2a23696b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ce80b06-5c7e-4bf5-877e-cdf2ce10a884", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b22f34e-4d16-4cde-906d-ee1d1e7033fc", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b7c1a4-2215-486c-89b3-784257f48fcd", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71b83261-3863-4151-ad47-f049ff8f0f04", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "f20550ee-d29f-4fe9-aef8-9fa2dec349e7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"e95231fa-3ee2-7bcf-6ee4-7f82cb2e0c69\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"910d5968-e6d7-6fc6-e038-5df9201e7e81\",\n \"created_at\": \"1970-10-04T00:31:07.922Z\",\n \"updated_at\": \"1971-08-28T08:53:45.885Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"f05499f6-e47b-6d54-416c-a6e56f09ecdb\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"013de58b-1f20-d53a-e2d1-e7196c3ec4bf\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"e89b3a24-5efc-2c7a-7830-eb070b310c86\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc59f1eb-cb18-466e-bfbc-4a0b7086aebb", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6d537e6-2605-4833-9bea-a133b44faa3c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7227d171-9a27-463c-ab3b-cec6fa8ad8a0", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6169598-5010-4a8c-adcb-d317dbe65c2f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e6e7163-d85e-42e1-a743-eb0d011c3826", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e3b766e-1458-42de-b5e1-986e9fc072c3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7a3d6938-72e9-b3b6-c4ae-5376c4651b7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"f6834c06-003a-f49e-fe67-e0af0e7cb99f\",\n \"created_at\": \"2010-02-16T08:47:47.490Z\",\n \"updated_at\": \"1989-12-29T20:11:00.501Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"0233d02f-16f0-7e8b-fba5-25405a3aa775\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"44656cc3-e62b-4c90-d370-44e59f72d747\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"d91b65c4-8c66-9048-c5f2-d543912bb751\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32b16859-8acb-4f89-a418-034a4b049b00", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c42bfb06-8151-4206-920f-ad78bfb349f9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bbd0e72-f82e-40c8-8ff0-a959819cd053", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "479e48b7-f928-4d11-be61-238f5125d07f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79e0b14d-fbb6-4469-a224-973a02b14c93", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "95441a60-09da-4d01-9ad8-ccca595abdb7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\n \"role\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e95231fa-3ee2-7bcf-6ee4-7f82cb2e0c69\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"910d5968-e6d7-6fc6-e038-5df9201e7e81\",\n \"created_at\": \"1970-10-04T00:31:07.922Z\",\n \"updated_at\": \"1971-08-28T08:53:45.885Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"f05499f6-e47b-6d54-416c-a6e56f09ecdb\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"013de58b-1f20-d53a-e2d1-e7196c3ec4bf\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"e89b3a24-5efc-2c7a-7830-eb070b310c86\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d37ef7f7-973a-49c2-b38f-9346dbfd2a9e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b3b0ec9-d639-4c02-80c9-dc744bcf26a4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed562c2a-611c-4c3d-9b27-9694629b3368", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f4dd1e1-b909-4a47-891e-d96cdd91742e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"d6c9410b-f348-dbe3-a521-932b9270b88b\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05c439a9-e63d-48bb-bbd5-b60a3a9c97e3", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3e071cf0-32dc-429b-b0c3-77b9ef4f5bde", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"7a3d6938-72e9-b3b6-c4ae-5376c4651b7a\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"f6834c06-003a-f49e-fe67-e0af0e7cb99f\",\n \"created_at\": \"2010-02-16T08:47:47.490Z\",\n \"updated_at\": \"1989-12-29T20:11:00.501Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"0233d02f-16f0-7e8b-fba5-25405a3aa775\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"44656cc3-e62b-4c90-d370-44e59f72d747\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"d91b65c4-8c66-9048-c5f2-d543912bb751\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84cc7eba-5685-4639-a986-722cfe5aab1d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d551555-0104-4b31-9bca-5e960a7f4f64", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28191a3c-75e6-495b-9e4f-e683cebf3288", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fd0fa66-5558-4600-8f7a-7ee49870d7e6", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df200590-6509-4a2c-bf5e-6135777f185d", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aba178a7-dea6-4418-b761-bdddfc16093c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"e95231fa-3ee2-7bcf-6ee4-7f82cb2e0c69\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"organization_id\": \"910d5968-e6d7-6fc6-e038-5df9201e7e81\",\n \"created_at\": \"1970-10-04T00:31:07.922Z\",\n \"updated_at\": \"1971-08-28T08:53:45.885Z\",\n \"description\": \"string\",\n \"members\": [\n {\n \"user_id\": \"f05499f6-e47b-6d54-416c-a6e56f09ecdb\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"013de58b-1f20-d53a-e2d1-e7196c3ec4bf\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"parent_group_id\": \"e89b3a24-5efc-2c7a-7830-eb070b310c86\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4319a353-3b4e-4889-94a3-23891e214dd3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce58f7c5-ef7a-4a91-a399-b9e94cf2b212", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fc208e6-cf79-446b-a2ea-5caf2b5f16e4", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a409ce9-1951-4edd-a211-b4f646247a92", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89845f36-e940-4643-ba52-0e907230998f", "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": "f050f528-2c05-4196-8bc3-f2903341f407", "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\": 3662,\n \"freshness\": \"fresh\",\n \"cache_dir\": \"string\",\n \"repository\": \"string\",\n \"db_size_bytes\": 4221,\n \"db_version\": \"string\",\n \"last_update\": \"2013-12-20T23:46:33.527Z\",\n \"next_refresh_at\": \"1992-03-19T13:21:32.363Z\",\n \"vuln_count\": 720\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "717830e6-2d3c-4288-897d-077a373d7d0e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d71c392-2a40-4e01-86b6-305f5646bd5b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0189a4c-0017-4ee4-ae6c-70d10136d9fa", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed2ec4ad-1f2b-4e96-beab-097d0b5e784a", "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": "10e5509d-3cab-41d1-ba4d-195d5702bac9", "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\": 3662,\n \"freshness\": \"fresh\",\n \"cache_dir\": \"string\",\n \"repository\": \"string\",\n \"db_size_bytes\": 4221,\n \"db_version\": \"string\",\n \"last_update\": \"2013-12-20T23:46:33.527Z\",\n \"next_refresh_at\": \"1992-03-19T13:21:32.363Z\",\n \"vuln_count\": 720\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90c77332-d73e-4e81-a4ea-b67cb5a60321", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61482ed5-31f0-4837-ad35-eaf7c3a6e888", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2747b67-5928-438e-be17-f6513e2952ac", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79c2cf10-7ee5-49dd-87eb-e30aaf85e3d2", "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": "193bb627-c7e2-4e79-bcc6-dcfd521bbb0a", "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\": \"4cb31316-9e37-98b8-0564-509a28ff74ad\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1974-12-25T13:05:48.305Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2004-07-21T17:00:50.865Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n },\n {\n \"id\": \"1c52a19a-705d-1503-736f-0c38b3650309\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"2007-01-02T01:11:49.530Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1954-04-03T03:25:06.633Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n }\n ],\n \"total\": 8618,\n \"page\": 4565,\n \"page_size\": 7543\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d428b009-d445-4acd-b901-545322c61080", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "425d246e-29e5-45fd-b33d-260c8297b873", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eafff1e-b1c8-415a-9d87-7a296999529b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72c08ed8-db64-4bba-8608-9cc7f87ecf50", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ef228a4-2b8b-4b0b-9726-fa97523d7033", "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": "a5a21cac-58e1-4603-87dd-a7cb0e5aec62", "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\": \"6e5c0fe7-e8f4-d64a-0df0-eef8c73d6b30\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": false,\n \"created_at\": \"1973-05-23T08:32:33.591Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2010-12-12T14:58:56.747Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n },\n {\n \"id\": \"a3ee4f6a-3d62-971e-765e-d7648c2e8019\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"2025-05-24T06:50:06.710Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2015-12-25T06:40:54.451Z\",\n \"role\": \"developer\",\n \"team_count\": 0\n }\n ],\n \"total\": 3873,\n \"page\": 8969,\n \"page_size\": 9320\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d759b0c-3b71-417b-9b7b-4afb8351bab1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05fe5f62-f8a4-46d3-9e48-dcd3e249ae5c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39d9a4b7-a452-4eec-a5a0-b2cbef4ed829", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d603526-5ecd-4aa5-b0a2-40acbdd7f47b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "823e5a2e-ff47-4589-b9c4-356287ed98b0", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8f9aedaa-9815-44ad-87c8-bcee57a0092e", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"54cb5fa2-6cd6-ca16-d431-b88630f2d29e\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"2026-06-22T05:31:22.919Z\",\n \"updated_at\": \"2023-07-11T11:32:14.425Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2000-03-20T07:39:03.937Z\",\n \"memberships\": [\n {\n \"team_id\": \"4a566b02-69fc-25ad-cdf7-1ab0ff338512\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"38a3e02a-db62-f538-ceed-ce8907125e55\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9002910a-7b8e-4e04-80c2-290fac4a267e", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dbd6e4d-7ec6-4645-bfda-528b83954dc5", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "725f0fd0-d6f8-4fb3-9909-da76baf1e1c6", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07dd9b31-1b60-4011-9e67-f6a8a1764cb4", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e02e2697-bada-43d9-bd0e-346dfc39d185", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65e76b3a-de21-4cc0-a3de-b39e90a94a64", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9a3572da-08aa-4ec8-9ab6-cc882ea9e195", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"163ac352-e3fe-b04a-66b9-37ee7ddb61fb\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1984-08-18T12:05:34.606Z\",\n \"updated_at\": \"1962-03-15T04:34:19.409Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1953-03-10T23:43:58.254Z\",\n \"memberships\": [\n {\n \"team_id\": \"8a2ec25a-1a73-632f-20bf-fd52257517ee\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"edc5b2e7-95db-b84d-9bf3-b505351fa9b3\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14abae80-e2c4-48e4-90c3-1d21f5e36181", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3878ca3a-0913-427a-a614-23b51c4fee8e", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a766b1a-7832-4af8-b95f-43ca5ae72a46", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8817e48e-23d2-407a-8174-b47ce43857e2", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16e34503-1255-4265-8d3a-689be2bc0960", "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\": \"fGaN5T@UAlUPXJ.tol\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"developer\",\n \"team_id\": \"076e3a82-34df-e24e-5ba6-c4937666fcb5\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82c67a46-8085-44ee-8e0f-c7bbcc67b03b", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "772be11d-fdc8-4769-9353-5656c964d5da", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 70,\n \"succeeded\": 4261,\n \"failed\": 6957,\n \"results\": [\n {\n \"index\": 980,\n \"identifier\": \"string\",\n \"status\": \"skipped\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"77b8efcb-6ddf-d131-9aa1-268a207bf814\"\n },\n {\n \"index\": 4596,\n \"identifier\": \"string\",\n \"status\": \"deactivated\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"4c84bad5-18a0-3664-b4ac-c1ede105a9d7\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feacbf1c-448f-49f3-a0ea-188a5a5cafb5", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e28b65-966c-4c5a-bdc8-1c4e771b1b69", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8747c02c-75b9-4a80-9e65-6e78a50fdaec", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0330f082-2bd0-4a5c-9e85-9b6b3be9ff9b", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ea075a7-256d-461d-b2cb-b926552346be", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d053883-2bb6-4d22-8c65-e213de940eae", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 1051,\n \"succeeded\": 607,\n \"failed\": 9197,\n \"results\": [\n {\n \"index\": 7102,\n \"identifier\": \"string\",\n \"status\": \"failed\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"70bb9a50-7d2a-3b0c-eee9-ffb9989979cc\"\n },\n {\n \"index\": 6947,\n \"identifier\": \"string\",\n \"status\": \"failed\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"753719b7-2319-fc37-018f-7442ec92dad1\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d324b3ca-db03-4c9b-a63f-ee3d094bf8cf", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf25445-c945-4af5-9811-849c2aede8a3", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ab00d47-b071-45ce-abd6-5457f9d3fbdd", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81bf6b09-d6be-4596-93ea-438eb43f6147", "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\": \"ohiqv9sfA48q@YgslEguHmUDVb.yc\",\n \"full_name\": \"string\",\n \"password\": \"stringstring\",\n \"role\": \"group_admin\",\n \"team_id\": \"247ff71a-3c40-4479-7f4c-8fb227a4a5ee\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0ae4dfb-ae81-4f9f-bedb-51886e6f469e", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de33372e-0a2b-40d3-87f9-d435f751ae31", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 70,\n \"succeeded\": 4261,\n \"failed\": 6957,\n \"results\": [\n {\n \"index\": 980,\n \"identifier\": \"string\",\n \"status\": \"skipped\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"77b8efcb-6ddf-d131-9aa1-268a207bf814\"\n },\n {\n \"index\": 4596,\n \"identifier\": \"string\",\n \"status\": \"deactivated\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"4c84bad5-18a0-3664-b4ac-c1ede105a9d7\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f65f993-2554-4644-800a-0a4dd0356569", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6e09a01-182d-45a7-b4dd-02ec286e2e78", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e4d0ddb-f99a-450c-bad9-7653a85e357c", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24431ea-d2e1-4a1f-8873-391b1bf291ac", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e2648ef-8499-4135-b298-9af0d185968f", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6ea64c23-681b-4167-a148-4272e7bbc2be", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 1051,\n \"succeeded\": 607,\n \"failed\": 9197,\n \"results\": [\n {\n \"index\": 7102,\n \"identifier\": \"string\",\n \"status\": \"failed\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"70bb9a50-7d2a-3b0c-eee9-ffb9989979cc\"\n },\n {\n \"index\": 6947,\n \"identifier\": \"string\",\n \"status\": \"failed\",\n \"detail\": \"string\",\n \"reason\": \"string\",\n \"user_id\": \"753719b7-2319-fc37-018f-7442ec92dad1\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe1d0d43-837e-456f-ac3c-5022a58f488e", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd235fa4-92c2-40c7-a855-9fa84b0b074a", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27fdf379-4a60-4ece-8b8a-dbe62add578e", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2efa602a-f2e5-4a0d-9fe7-d5b0fd59d6b9", "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 \"25df5e68-3654-6b8e-0326-cc6d0d4ceb8e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d4ff941-af68-4400-8713-12ef92b4a377", "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": "68d1f0f0-a0d5-486b-891f-d0d56266cf62", "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": "4645780d-6add-4dc3-bb5f-849fcf1c51c2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae275d6e-3adc-4f15-b0b5-18bc979a8a82", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bba3ffc0-7af3-4bdd-bd6e-79356d787b42", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ad2862f-8629-4f67-8632-53358dc23743", "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": "068473c9-f230-4e43-832a-87a9da157946", "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": "15b694ef-f7fc-4efa-b621-ad32e28b2d2b", "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": "21b277f2-6561-4b4e-ba03-584ce69de84c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01603ec3-5ee7-410a-8866-c8cd4eaee3e5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5705bc6-93cf-421e-a785-43018ac43040", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cfc4bff-ca63-4e1d-9736-16c70e908117", "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": "6f2c4450-0fcd-43dc-9010-ed8ebd079863", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b95cc47c-e190-4be1-977b-8c0a5a901faa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"54cb5fa2-6cd6-ca16-d431-b88630f2d29e\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"2026-06-22T05:31:22.919Z\",\n \"updated_at\": \"2023-07-11T11:32:14.425Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2000-03-20T07:39:03.937Z\",\n \"memberships\": [\n {\n \"team_id\": \"4a566b02-69fc-25ad-cdf7-1ab0ff338512\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"38a3e02a-db62-f538-ceed-ce8907125e55\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb2e5266-b913-4de8-93d4-0144c1d9a9a0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44bc43e4-6660-4cdb-98b6-35ef0e6e1a76", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dea75ac4-3aec-40b8-b258-25ed955bb4b3", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fa9de3c-40a5-47bc-9121-a3c33cd8bd2c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64f61775-6f33-4df6-bd93-765ed319ba56", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dce6232c-1c52-4a32-82f4-de79b5bdfe38", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"163ac352-e3fe-b04a-66b9-37ee7ddb61fb\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1984-08-18T12:05:34.606Z\",\n \"updated_at\": \"1962-03-15T04:34:19.409Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1953-03-10T23:43:58.254Z\",\n \"memberships\": [\n {\n \"team_id\": \"8a2ec25a-1a73-632f-20bf-fd52257517ee\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"edc5b2e7-95db-b84d-9bf3-b505351fa9b3\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07e0de39-428f-4e60-ac38-11de28dbdeea", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2af86f02-b695-415d-b166-7a9a5a0bd49c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9085b15e-359b-4f81-9308-e4c21b0a91b6", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99406940-072f-48a0-a0ef-1d722cde1fc0", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05e70784-c726-40d7-a60a-5b69c9fb13ce", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "360afd99-6dfc-4d82-8ebb-cbd5363c4865", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"54cb5fa2-6cd6-ca16-d431-b88630f2d29e\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"2026-06-22T05:31:22.919Z\",\n \"updated_at\": \"2023-07-11T11:32:14.425Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2000-03-20T07:39:03.937Z\",\n \"memberships\": [\n {\n \"team_id\": \"4a566b02-69fc-25ad-cdf7-1ab0ff338512\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"38a3e02a-db62-f538-ceed-ce8907125e55\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "768fe763-ce23-43bc-aa29-de0010073590", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8e9e961-7e68-4949-82d8-6dbd214fd43b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa40e8d7-da1c-4757-8a23-82ba099179db", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b67e1e62-ac05-4594-8d0f-0c999892f89c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "766f0b0f-0b81-4e11-a825-ac63ec3d7db7", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7a9be711-fa78-4abb-a767-cb20785136d4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"163ac352-e3fe-b04a-66b9-37ee7ddb61fb\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1984-08-18T12:05:34.606Z\",\n \"updated_at\": \"1962-03-15T04:34:19.409Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1953-03-10T23:43:58.254Z\",\n \"memberships\": [\n {\n \"team_id\": \"8a2ec25a-1a73-632f-20bf-fd52257517ee\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"edc5b2e7-95db-b84d-9bf3-b505351fa9b3\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e15a444-0725-4cbb-ad93-caaf6f68dc33", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d789dd86-b0a8-44b9-81a7-f4c6b317e1a7", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb0c797c-9d6b-4d55-a1e1-31e0cd762d18", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6676a9af-83d0-4fea-a87c-cf74190e6b0c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "activate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ae2d806-62cd-4014-889d-483c42261a8a", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5b0f025d-a94e-4016-81dc-d93e4ea7c54e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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": "166dfd53-3ff7-41cd-b6b1-d4ddbfa04418", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18921322-ba97-4af2-8f4f-a16a0382c004", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0035778b-bb09-4e4c-9f91-8527f7358fb6", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5113303-2de8-4329-8e28-802d1a754084", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a295d560-709a-41cc-8882-4dc79adf95ea", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "241cdf33-89c5-4dfd-9305-f9a3e527ca7e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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": "075a23a6-77e8-4ab5-bdb8-6f4f19cb9958", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e50147d-2c8f-4afc-9cc7-2855acbce6c7", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86ae64b6-70f4-443b-b223-ab99e24dd1fe", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f9f1d5-5477-4245-8c6b-9ccd6465f925", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "clear-mfa" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5ca287e-75b4-41a8-b49d-07774488a6f6", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d178ceb0-b8f6-4e47-9f38-25647da112d1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"54cb5fa2-6cd6-ca16-d431-b88630f2d29e\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"2026-06-22T05:31:22.919Z\",\n \"updated_at\": \"2023-07-11T11:32:14.425Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2000-03-20T07:39:03.937Z\",\n \"memberships\": [\n {\n \"team_id\": \"4a566b02-69fc-25ad-cdf7-1ab0ff338512\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"38a3e02a-db62-f538-ceed-ce8907125e55\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2bbeeb3-e638-4383-9f7f-c05de030bbf1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b0147f-3b5f-4172-944d-f5b3c07d5c98", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b1f412c-7b48-409f-8323-108a1e50b1fc", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "028b7e61-657f-4090-ad6e-f964fe4b863e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a2cfc1c-6811-44ec-b9eb-66d8b81e06e6", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "84414725-8730-439f-ae9d-76f2702c032d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"163ac352-e3fe-b04a-66b9-37ee7ddb61fb\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1984-08-18T12:05:34.606Z\",\n \"updated_at\": \"1962-03-15T04:34:19.409Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1953-03-10T23:43:58.254Z\",\n \"memberships\": [\n {\n \"team_id\": \"8a2ec25a-1a73-632f-20bf-fd52257517ee\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"edc5b2e7-95db-b84d-9bf3-b505351fa9b3\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95218994-ce4f-4a05-9f8a-58c0f57d0990", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf79685b-2171-4b5f-be33-89db9c4eda33", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2ba60b4-14ba-4f54-b8a7-814fd8b81d14", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dac41f4-048c-47ea-b6f8-c5623447f294", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "deactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ffc6f48-df3b-4d95-be89-bd710726c600", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0286d405-4318-4bfb-b374-6561fd19b6a1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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": "ae8b06eb-da71-4670-91ef-590bdf0cccb6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fd872e3-0f76-4f13-85c8-ee2f8bf54af0", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd03d9a-5124-4da4-a00f-d532b17af309", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd37bf9e-a624-4f58-b534-cc49946380f4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5a7cbe1-5e49-46f6-8bc5-d91a54c16efc", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "645318fb-057f-4ba9-a363-f19f8efdf777", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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": "b4a76d7d-3027-410c-8c5e-a7be96b62694", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "748d124d-b507-44b1-a2c5-7632da044772", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88379f26-3e62-4e14-9ed4-9cb973fcfbcf", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9b4c44a-0677-444d-b314-2b2112c60f7e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "password-reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bf9061b-f39b-47c2-b1c9-cdea8f994df4", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "69944241-5b25-4c36-bffa-4129e63558d1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"54cb5fa2-6cd6-ca16-d431-b88630f2d29e\",\n \"email\": \"string\",\n \"is_active\": false,\n \"is_superuser\": true,\n \"created_at\": \"2026-06-22T05:31:22.919Z\",\n \"updated_at\": \"2023-07-11T11:32:14.425Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"2000-03-20T07:39:03.937Z\",\n \"memberships\": [\n {\n \"team_id\": \"4a566b02-69fc-25ad-cdf7-1ab0ff338512\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"38a3e02a-db62-f538-ceed-ce8907125e55\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d58c9378-7093-48c4-a006-f3b1170176e1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a955d903-1c0b-4216-bcf1-b4907ee08a70", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236a3a17-65d1-4da4-8427-778565ef79c3", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c73e4b0b-b191-4ae6-9d6a-c757a4e3559d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "746fab73-e6b1-451a-bc00-ff7bb0a6d13b", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b3bd7104-936b-438a-abb4-f99f51ec9fdc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"163ac352-e3fe-b04a-66b9-37ee7ddb61fb\",\n \"email\": \"string\",\n \"is_active\": true,\n \"is_superuser\": false,\n \"created_at\": \"1984-08-18T12:05:34.606Z\",\n \"updated_at\": \"1962-03-15T04:34:19.409Z\",\n \"full_name\": \"string\",\n \"last_login_at\": \"1953-03-10T23:43:58.254Z\",\n \"memberships\": [\n {\n \"team_id\": \"8a2ec25a-1a73-632f-20bf-fd52257517ee\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n },\n {\n \"team_id\": \"edc5b2e7-95db-b84d-9bf3-b505351fa9b3\",\n \"team_name\": \"string\",\n \"role\": \"string\"\n }\n ],\n \"mfa_enabled\": false,\n \"scan_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d34b21c2-00c1-4427-b631-13b8eaac4aed", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "322740eb-708e-4cec-b5b1-0bcb6fdd0de9", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4c71761-6281-411d-889e-5d44765b1124", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36fb63d9-6fd2-4981-9955-19fe58859881", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "role" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"string\",\n \"team_id\": \"2c8d9004-4fbd-9062-4aea-5f3053e9c236\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ccf81f96-a34c-4d56-b792-80234d9e29a0", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1539cf3d-3562-474c-ba9b-5fc30cf03ed2", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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": "e8701614-6bef-47f7-832a-65890815300e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c8c578d-75fa-4339-a65d-8c28bee9ce52", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4304808b-092d-4d7e-a820-9bb684372839", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d994371-41b4-403c-9e4a-376c7aaa43f3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9414133-40cc-496d-9a20-62adff1c1e06", "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": "46649135-6747-6547-4bff-64f25570d1d9", "key": "user_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8668cdf6-23af-42f0-b53b-58a7680ac698", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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": "0230bcea-444f-4d31-ac9f-fe7498df4646", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0999897-bbb3-4f6f-9640-a2f3cefdc5a8", "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": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32b6a44a-ef4a-45cd-8892-26ad0fb86ae8", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "881122b9-206e-4b22-a9a1-2b827d2ba144", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "admin", "users", ":user_id", "unlock-sign-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46649135-6747-6547-4bff-64f25570d1d9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6066b8c2-5ce9-4bd2-9f6b-46df6dc3e3b0", "name": "api-keys", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1bb99057-a3e3-47a0-98d9-d00c5b17fce1", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "3d9c6982-8d73-43c5-9e5d-3b2edae20fc8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": \"22909c0d-e4c8-ca5a-027c-1df41de24b8c\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"team\",\n \"team_id\": \"c0803f4a-7f56-3f94-dfb5-d6033443e42d\",\n \"project_id\": \"52690cdf-4d7a-842e-4cb1-959b144fa5e8\",\n \"created_by_user_id\": \"9259fb72-ca8a-9c01-d40a-beeb943fb019\",\n \"created_at\": \"2020-05-02T16:26:57.677Z\",\n \"revoked_at\": \"1957-09-21T20:50:16.368Z\",\n \"created_by_email\": \"string\",\n \"expires_at\": \"1975-05-18T02:19:59.932Z\",\n \"last_used_at\": \"1989-03-19T03:59:04.856Z\",\n \"permission_breadth\": \"read_write\"\n },\n {\n \"id\": \"9499843b-fa7f-8474-1b92-a0184e8240a7\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"project\",\n \"team_id\": \"4ed83a54-e845-1e88-ff7a-0f9810e38d53\",\n \"project_id\": \"859da1c1-78e5-cc50-5f53-5dfe22a2339e\",\n \"created_by_user_id\": \"04adbceb-5c7a-9abb-dc35-cfd70ed37d46\",\n \"created_at\": \"1956-08-07T01:03:44.216Z\",\n \"revoked_at\": \"1949-12-24T09:17:47.238Z\",\n \"created_by_email\": \"string\",\n \"expires_at\": \"1951-08-17T21:49:31.571Z\",\n \"last_used_at\": \"2004-10-29T21:48:57.210Z\",\n \"permission_breadth\": \"read_write\"\n }\n ],\n \"total\": 5879,\n \"page\": 3457,\n \"page_size\": 4892\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c24286a-2ab1-4951-960d-65500ebd7234", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d84245cd-e899-43cf-8803-cfc07a2deef0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24d2e082-824c-4269-ae0e-ce6931bd0743", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scope", "value": "project" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d241fc2d-1430-4e54-baec-28badace7334", "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\": \"org\",\n \"expires_in_days\": 1461,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"f9f185d9-5692-e8d4-4247-25d82b5300f7\",\n \"service_account_id\": \"0b0a438b-bc2b-8560-3cb8-80c40d79c321\",\n \"team_id\": \"34a6c468-907b-f9cd-087b-f15a10867f53\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "37816153-8851-4751-a019-e1863c1cc56b", "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\": \"org\",\n \"expires_in_days\": 1461,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"f9f185d9-5692-e8d4-4247-25d82b5300f7\",\n \"service_account_id\": \"0b0a438b-bc2b-8560-3cb8-80c40d79c321\",\n \"team_id\": \"34a6c468-907b-f9cd-087b-f15a10867f53\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a9a02bf5-fe60-8aa5-b013-27bcda155777\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"org\",\n \"permission_breadth\": \"read_write\",\n \"team_id\": \"e5a815a4-4aad-a40d-f7b2-54bff108c86e\",\n \"project_id\": \"0625ef3b-f2f9-8d71-290b-950854fe7ec1\",\n \"created_by_user_id\": \"9a2558d0-ea12-dc46-2eb7-31ae92fd9fa9\",\n \"created_at\": \"2003-07-12T21:28:47.227Z\",\n \"raw_key\": \"string\",\n \"expires_at\": \"1969-05-12T09:31:44.844Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "156d68c1-6fdf-47a3-ae16-ed0e06c56f42", "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\": \"org\",\n \"expires_in_days\": 1461,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"f9f185d9-5692-e8d4-4247-25d82b5300f7\",\n \"service_account_id\": \"0b0a438b-bc2b-8560-3cb8-80c40d79c321\",\n \"team_id\": \"34a6c468-907b-f9cd-087b-f15a10867f53\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32ae74ae-b904-45e4-9ef3-eb6d42d870bc", "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\": \"org\",\n \"expires_in_days\": 1461,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"f9f185d9-5692-e8d4-4247-25d82b5300f7\",\n \"service_account_id\": \"0b0a438b-bc2b-8560-3cb8-80c40d79c321\",\n \"team_id\": \"34a6c468-907b-f9cd-087b-f15a10867f53\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d14ad86-c287-41a6-a2dd-835a7c9b6b8c", "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\": \"org\",\n \"expires_in_days\": 1461,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"f9f185d9-5692-e8d4-4247-25d82b5300f7\",\n \"service_account_id\": \"0b0a438b-bc2b-8560-3cb8-80c40d79c321\",\n \"team_id\": \"34a6c468-907b-f9cd-087b-f15a10867f53\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c98ea518-23ff-48d2-9c04-adb9f2d89bac", "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\": \"org\",\n \"expires_in_days\": 1461,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"f9f185d9-5692-e8d4-4247-25d82b5300f7\",\n \"service_account_id\": \"0b0a438b-bc2b-8560-3cb8-80c40d79c321\",\n \"team_id\": \"34a6c468-907b-f9cd-087b-f15a10867f53\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f43f02f3-bf37-440e-9b95-baa37054db14", "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\": \"org\",\n \"expires_in_days\": 1461,\n \"permission_breadth\": \"read_only\",\n \"project_id\": \"f9f185d9-5692-e8d4-4247-25d82b5300f7\",\n \"service_account_id\": \"0b0a438b-bc2b-8560-3cb8-80c40d79c321\",\n \"team_id\": \"34a6c468-907b-f9cd-087b-f15a10867f53\"\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": "d05a7f03-ee8f-464f-9f39-18148b6d388e", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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": "8440df5b-bf21-4ac5-83a3-0b3e62e23ebe", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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": "04e2e055-1de0-4c81-a933-3cd7135eb744", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8a2ba28-f68e-41b1-a14d-2433dbb94694", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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": "d22157b2-6a4e-48f3-9274-e7b89bfc270a", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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": "c89f6752-301a-498e-aa18-9c55a49fb4d3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f8861fd-dbfd-498e-8025-7018be3ceea4", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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": "60dff4ad-5fc8-4be2-b891-605dd6192acc", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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\": \"18e57485-0b6c-0575-d079-82ce337ccdcf\",\n \"key_prefix\": \"string\",\n \"name\": \"string\",\n \"scope\": \"org\",\n \"team_id\": \"ef92daca-0620-dfab-7b66-44d5e10736c8\",\n \"project_id\": \"c34e7253-a540-fd00-0ede-a870fa2bc369\",\n \"created_by_user_id\": \"5bd78117-4ddf-d84a-a58a-dae7dd3d4366\",\n \"created_at\": \"2014-11-14T08:15:32.022Z\",\n \"revoked_at\": \"1963-08-26T02:27:16.161Z\",\n \"created_by_email\": \"string\",\n \"expires_at\": \"1988-12-11T09:33:53.173Z\",\n \"last_used_at\": \"1970-08-06T22:40:50.572Z\",\n \"permission_breadth\": \"read_write\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d0fb37b-1907-48be-83e2-b5a0289adde7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2302dd49-bb46-48f7-b025-2fe2e46a564e", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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": "52008a63-62ac-4d83-a6f1-1230eaa97678", "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": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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": "00026205-cc3e-43b1-8613-464876fc65bf", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "api-keys", ":api_key_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d260cbac-a02b-43d6-6eb1-d0f03453bdcc", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "115d8793-af96-43e7-bcce-a89cf0e38391", "name": "approvals", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "bd85f484-c82d-4971-8018-0d7944e7ff88", "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": "under_review", "description": "Single status or a comma-separated list of statuses (e.g. ``pending,under_review``)." }, { "disabled": false, "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "from_dt", "value": "2001-02-23T06:05:25.013Z" }, { "disabled": false, "key": "to_dt", "value": "2001-02-23T06:05:25.013Z" }, { "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": "1654d9b1-2e1f-4034-9587-242773be7554", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "under_review" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "requested_by_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "from_dt", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to_dt", "value": "2001-02-23T06:05:25.013Z" }, { "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\": \"e4a3e98c-f1c3-97b2-fb74-b2ad6a2bebe2\",\n \"component_id\": \"d831e77c-ee55-669a-d517-27631631465b\",\n \"project_id\": \"63591821-7986-1125-ab0d-cc19ca2775ee\",\n \"team_id\": \"e8371710-0301-9a6e-8374-a454b5f3d192\",\n \"requested_by_user_id\": \"4714b499-dd30-82d1-e5c2-0ce9d56020af\",\n \"requested_at\": \"1986-12-05T08:41:56.852Z\",\n \"status\": \"pending\",\n \"decided_by_user_id\": \"46e24edd-a651-fb83-cdc8-9e7c026b1c6f\",\n \"decided_at\": \"1950-11-11T06:44:49.675Z\",\n \"decision_note\": \"string\",\n \"version\": 2067,\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\": \"8e4a7613-aa76-ceff-48da-f0c59e8d99cc\",\n \"component_id\": \"99579d9d-604d-0e15-f003-c47b9867f4c8\",\n \"project_id\": \"0221297b-95ac-4597-411b-b2389d5597cd\",\n \"team_id\": \"1267d961-11a1-4bfa-98cc-092b79390371\",\n \"requested_by_user_id\": \"88cd982d-de3a-53d5-0dda-19674cca0020\",\n \"requested_at\": \"1982-08-27T04:37:04.351Z\",\n \"status\": \"pending\",\n \"decided_by_user_id\": \"50f61b9a-a3f1-c437-1f03-47c6e616c026\",\n \"decided_at\": \"1971-04-14T04:00:05.160Z\",\n \"decision_note\": \"string\",\n \"version\": 3975,\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\": 5363,\n \"page\": 8357,\n \"page_size\": 1612\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f9ce492-dd3d-4a27-86d2-f96df3b5aa2d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "under_review" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "requested_by_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "from_dt", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to_dt", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74223fa1-3281-49f1-9a04-db1dd3a13b66", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "under_review" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "requested_by_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "from_dt", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to_dt", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39c97a15-d687-4af0-82c4-af4eeebbee01", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "under_review" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "requested_by_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "from_dt", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to_dt", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49aa992a-7a1a-415c-a49f-1f084fa5fe55", "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\": \"65bfb186-c0d8-adf3-c83e-ef884e9eacd5\",\n \"project_id\": \"f3b5c3da-46dd-7f51-488c-7ff881197f18\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2715a8c4-0e46-4bf0-b96e-9a84227aaaa1", "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\": \"65bfb186-c0d8-adf3-c83e-ef884e9eacd5\",\n \"project_id\": \"f3b5c3da-46dd-7f51-488c-7ff881197f18\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a739f562-0d88-0013-6a79-2c0a2d8b6ea6\",\n \"component_id\": \"88f52e83-48a8-0e52-ca30-0d8734eb1677\",\n \"project_id\": \"69878868-e91e-535c-9ab4-c6313a37bb16\",\n \"team_id\": \"787b854e-bab9-e26b-ce93-892e4ebf8e27\",\n \"requested_by_user_id\": \"72783350-25b6-fab0-a62d-3e02f8dedb58\",\n \"requested_at\": \"1955-11-13T22:54:04.039Z\",\n \"status\": \"rejected\",\n \"decided_by_user_id\": \"1900857a-681f-0010-74c9-0b4991485af8\",\n \"decided_at\": \"1968-12-21T05:53:32.002Z\",\n \"decision_note\": \"string\",\n \"version\": 1633,\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": "862e222f-cb7a-4683-8246-c90d20730063", "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\": \"65bfb186-c0d8-adf3-c83e-ef884e9eacd5\",\n \"project_id\": \"f3b5c3da-46dd-7f51-488c-7ff881197f18\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "348cc942-9000-464f-94fe-c88727b1fea5", "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\": \"65bfb186-c0d8-adf3-c83e-ef884e9eacd5\",\n \"project_id\": \"f3b5c3da-46dd-7f51-488c-7ff881197f18\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68d521d6-abd5-487e-9168-0a1a897ce804", "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\": \"65bfb186-c0d8-adf3-c83e-ef884e9eacd5\",\n \"project_id\": \"f3b5c3da-46dd-7f51-488c-7ff881197f18\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3730408-f669-4b18-aef0-add048e69f41", "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\": \"65bfb186-c0d8-adf3-c83e-ef884e9eacd5\",\n \"project_id\": \"f3b5c3da-46dd-7f51-488c-7ff881197f18\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62205850-04e8-4872-9bd5-4f8fc15afa34", "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\": \"65bfb186-c0d8-adf3-c83e-ef884e9eacd5\",\n \"project_id\": \"f3b5c3da-46dd-7f51-488c-7ff881197f18\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21eea64b-5912-4649-8376-6efa7f4bbf7f", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3fc6d3fa-95b0-4179-9a5f-0f7d8df6f1b6", "name": "Approval deleted.", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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": "55dc576e-3c50-4630-97b1-f911fe0e4d8b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "169d5ac7-e54c-44a8-a167-f359e4cbb59e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629ad52d-e9d5-423a-8e6a-86b4fd3db048", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "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": "b3a15432-d2c8-4d08-9329-33434c959c2d", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "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": "e420cfe5-d719-4128-bab1-3f2c4183a886", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c0035ed-8f7f-4cab-9ef2-c445071720cc", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "88d63955-dc3e-4af9-b09c-877be8590ac8", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": \"a739f562-0d88-0013-6a79-2c0a2d8b6ea6\",\n \"component_id\": \"88f52e83-48a8-0e52-ca30-0d8734eb1677\",\n \"project_id\": \"69878868-e91e-535c-9ab4-c6313a37bb16\",\n \"team_id\": \"787b854e-bab9-e26b-ce93-892e4ebf8e27\",\n \"requested_by_user_id\": \"72783350-25b6-fab0-a62d-3e02f8dedb58\",\n \"requested_at\": \"1955-11-13T22:54:04.039Z\",\n \"status\": \"rejected\",\n \"decided_by_user_id\": \"1900857a-681f-0010-74c9-0b4991485af8\",\n \"decided_at\": \"1968-12-21T05:53:32.002Z\",\n \"decision_note\": \"string\",\n \"version\": 1633,\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": "f464cc53-5f7c-4ed3-a780-ef99a4449017", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35fff180-cd73-4076-93c2-1305171f5f39", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15683da3-8ae5-4da7-9b88-20b2866fc131", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "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": "996342be-be04-48b5-aadb-4b266fb59a0b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3666184b-b086-4352-bf59-c50da032f4e8", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": \"approved\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ffcc751a-1d7f-4186-b57e-344274305356", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": \"approved\",\n \"decision_note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a739f562-0d88-0013-6a79-2c0a2d8b6ea6\",\n \"component_id\": \"88f52e83-48a8-0e52-ca30-0d8734eb1677\",\n \"project_id\": \"69878868-e91e-535c-9ab4-c6313a37bb16\",\n \"team_id\": \"787b854e-bab9-e26b-ce93-892e4ebf8e27\",\n \"requested_by_user_id\": \"72783350-25b6-fab0-a62d-3e02f8dedb58\",\n \"requested_at\": \"1955-11-13T22:54:04.039Z\",\n \"status\": \"rejected\",\n \"decided_by_user_id\": \"1900857a-681f-0010-74c9-0b4991485af8\",\n \"decided_at\": \"1968-12-21T05:53:32.002Z\",\n \"decision_note\": \"string\",\n \"version\": 1633,\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": "c420c291-4b02-43cf-b9ca-50ab90792584", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"approved\",\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": "4ea0e001-3e86-45e5-9c83-15705e643d94", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": \"approved\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b56c866b-6ee8-4f59-979c-8123cbb30114", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"approved\",\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": "157c3188-687a-4b19-b6af-9d03b263a038", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"approved\",\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": "45876bb5-babf-44eb-aac0-b8b389155704", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"approved\",\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": "66ed61bc-94d9-42d3-bde3-7113ea563c9c", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "key": "if-match", "value": "string", "description": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"approved\",\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": "a68d17af-68fb-404d-8170-0417e639b6e9", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "approvals", ":approval_id", "transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": \"approved\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4be8f4c9-0ea2-426d-87ea-f65efaa6a9cf", "name": "audit", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "beed5bec-633b-4b0b-8e98-2219989bc9b6", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "target_table", "value": "password_reset_tokens" }, { "disabled": false, "key": "action", "value": "string" }, { "disabled": false, "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "disabled": false, "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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": "16158370-ffd1-4d86-bc72-382d5f6487c1", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": \"6a8e54b2-fe9d-d05b-db28-26947b50c8b7\",\n \"created_at\": \"2007-02-04T04:07:29.476Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"f74498b7-aac5-1fb5-353b-e06b1cd69198\",\n \"diff\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 7140.975305284492,\n \"key_3\": \"string\"\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"af70b9ee-a63b-d5fc-3a2b-fbe237ea0d10\"\n },\n {\n \"id\": \"a1ecaf59-cde6-5f02-a085-c601a0de54c4\",\n \"created_at\": \"1946-11-09T21:14:33.402Z\",\n \"target_table\": \"string\",\n \"action\": \"string\",\n \"actor_email\": \"string\",\n \"actor_user_id\": \"e0884044-de3d-5ca4-81d3-976d23c33d4e\",\n \"diff\": {\n \"key_0\": 43,\n \"key_1\": 2625,\n \"key_2\": true,\n \"key_3\": 2894.285172710398\n },\n \"request_id\": \"string\",\n \"target_id\": \"string\",\n \"team_id\": \"f3dab21d-b0b1-92b0-e4de-ee78b14dd588\"\n }\n ],\n \"total\": 6393,\n \"page\": 1803,\n \"page_size\": 4312,\n \"has_more\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6602708-de6b-4b67-b280-b6ec45576381", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a7f6b19-abf2-4321-811b-de1082b0acee", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8343abe8-8097-4d8c-80e0-31cce0bc7e7d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "audit" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "actor_user_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "target_table", "value": "password_reset_tokens" }, { "key": "action", "value": "string" }, { "key": "from", "value": "2001-02-23T06:05:25.013Z" }, { "key": "to", "value": "2001-02-23T06:05:25.013Z" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a736c77f-88bc-4ee4-8e6c-de2becf67ce8", "name": "client-errors", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c25941ba-26e3-49a2-be03-f4d03cc60c8c", "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": "1aca875d-8b34-401f-983e-c47cb25cbb22", "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": "0a64b1c0-9d53-426b-9c67-acdb9cdfa6fd", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61e36bf0-cb4b-4c75-9cff-4971070ec2e4", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bbbbfd0-c634-4724-b683-8b7cc4cff28d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "508f50a2-e0d0-4666-b249-9d640224cee4", "name": "components", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "14aa382d-f559-48af-8191-aff8f10cf7b4", "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": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "edefd31e-65a0-4311-b2d4-86fa58b9883a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": \"a9a7f875-5848-fb52-cd18-7c33bf557c8e\",\n \"component_id\": \"dc2568de-eaa6-0e25-6a3f-4717d6cb63b7\",\n \"project_id\": \"c2d93239-4c44-7c3c-2941-052f006adfd1\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"license_category\": \"forbidden\",\n \"severity_max\": \"medium\",\n \"created_at\": \"2023-09-22T03:31:16.472Z\",\n \"updated_at\": \"2000-09-18T15:38:30.767Z\",\n \"currency_latest\": \"string\",\n \"currency_latest_release_date\": \"1994-07-06\",\n \"currency_state\": \"current\",\n \"dependency_scope\": \"required\",\n \"depth\": 4370,\n \"direct\": false,\n \"eol_cycle\": \"string\",\n \"eol_date\": \"1956-12-30\",\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\": \"ab7ca6f3-d3ee-d39b-b8d1-a9be0bdf363d\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"license\": \"string\",\n \"link\": \"string\"\n },\n {\n \"id\": \"2accffa2-9316-5683-c2c1-a88663010553\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"license\": \"string\",\n \"link\": \"string\"\n }\n ],\n \"purl\": \"string\",\n \"raw_data\": {\n \"key_0\": \"string\"\n },\n \"vulnerabilities\": [\n {\n \"cve_id\": \"string\",\n \"severity\": \"string\",\n \"title\": \"string\",\n \"cvss\": 8890.922923593727,\n \"description\": \"string\",\n \"epss_percentile\": 0.42757239511783074,\n \"epss_score\": 0.8420964051523623,\n \"fixed_version\": \"string\"\n },\n {\n \"cve_id\": \"string\",\n \"severity\": \"string\",\n \"title\": \"string\",\n \"cvss\": 1203.531769249433,\n \"description\": \"string\",\n \"epss_percentile\": 0.6141972516550953,\n \"epss_score\": 0.32371915366640636,\n \"fixed_version\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "208fe280-0cbf-408f-8e30-4b5610781b53", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e7dda2f-ab9f-458a-8dc6-c340f3ea5b3f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eca66bd4-9e37-4400-b868-c6d63fdfff59", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffd80e6d-a6c1-4456-98aa-c9b66d620b4d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "components", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "10ebdc25-fb40-4ec6-a700-e1dfd27357fb", "name": "dashboard", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f8eb10c1-ff43-4da7-b1be-3dd8734db1da", "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": "f37d2126-f5ac-45e5-b393-a56e031ab93b", "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\": 1077,\n \"kev_sla\": {\n \"overdue\": 7309,\n \"due_soon\": 1356\n },\n \"gate_blocked\": [\n {\n \"project_id\": \"f87fada0-a85d-1a1c-d920-bd8cebcc7cc8\",\n \"project_name\": \"string\",\n \"scan_id\": \"d4dfd52b-679e-2879-91e2-35b2bd0eac70\",\n \"critical_cve_count\": 3397,\n \"forbidden_license_count\": 815,\n \"epss_gate_count\": 0,\n \"malicious_component_count\": 0\n },\n {\n \"project_id\": \"7479fab3-2f35-c566-53b6-c203eb1ecc94\",\n \"project_name\": \"string\",\n \"scan_id\": \"08c96372-c580-568e-c593-2aa9389f6b55\",\n \"critical_cve_count\": 663,\n \"forbidden_license_count\": 8608,\n \"epss_gate_count\": 0,\n \"malicious_component_count\": 0\n }\n ],\n \"stale_projects\": [\n {\n \"project_id\": \"c48fec62-fd3a-6db7-db33-ebc32db8e4f3\",\n \"project_name\": \"string\",\n \"last_succeeded_at\": \"1965-04-17T15:54:49.155Z\"\n },\n {\n \"project_id\": \"a59a75be-da9a-ca07-e03f-283fafe191a3\",\n \"project_name\": \"string\",\n \"last_succeeded_at\": \"2010-11-01T16:35:14.906Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e8bf79a-95b1-4eb3-991b-8d9b8a6fa631", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6300d4c8-dd49-425d-a017-cec67d64726f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2aea22a-162c-44b5-96d4-2b47bfc5ef86", "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": "72fb587c-c549-474a-8c19-64bd6b5541bd", "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\": 3235,\n \"shown_team_count\": 7950,\n \"project_count\": 1779,\n \"shown_project_count\": 6977,\n \"truncated\": false,\n \"teams\": [\n {\n \"team_id\": \"e6be178b-045d-51db-10f6-37b79177d35e\",\n \"team_name\": \"string\",\n \"project_count\": 9072,\n \"projects\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"team_id\": \"1dbc7038-2b4d-5169-f106-0ca7c1f08afa\",\n \"team_name\": \"string\",\n \"project_count\": 4972,\n \"projects\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f225184f-eb52-4f43-a06c-241d6d9d50e9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bbd03d2-aaa0-4fde-bfc0-b2a7cc79b5c1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2d818ae-0fe7-4dce-803f-f59e11ec8f19", "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": "b11dbf9f-6e68-46e0-917f-d5f92600a1fe", "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": "59e2e727-085f-4dfd-a058-bf18fd0d300f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b89a35b-c1ef-41fa-b985-7cef2c41417b", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4b6d6bc-ff80-4b8e-8b35-7a549d8e9cc4", "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": "e2f10934-d239-48e8-89d8-71ef9aec5d2a", "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\": 3538,\n \"start_date\": \"1961-09-15\",\n \"end_date\": \"1994-09-16\",\n \"totals\": {\n \"new_findings\": 5618,\n \"resolved_findings\": 250\n },\n \"project_count\": 830,\n \"points\": [\n {\n \"date\": \"1971-11-24\",\n \"new_findings\": 3552,\n \"resolved_findings\": 2168,\n \"critical_open\": 5728,\n \"kev_open\": 9730,\n \"scan_count\": 9056\n },\n {\n \"date\": \"2005-07-10\",\n \"new_findings\": 3109,\n \"resolved_findings\": 8635,\n \"critical_open\": 4481,\n \"kev_open\": 7461,\n \"scan_count\": 3262\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ba5250e-3ab5-46e9-99d2-658001c32bd9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8719beb9-59fc-418b-b4cb-32f5fe09e2b8", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d69d43f1-cd04-4f4b-95e2-833b5047de7e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "eab0b691-ae84-4384-83cf-005e9ccb307a", "name": "external-packages", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a5fe5692-45fa-44b2-a3b5-ae7d2616b8bc", "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": "str", "key": "advisory_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1fa127e1-3694-4252-a878-1431532946c5", "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": "str", "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": "2e9c733f-ed29-4d62-a42c-39c4e76c40bf", "name": "No / invalid bearer token.", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "str", "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": "bbb35586-0b06-4ba6-85c9-1d9fef401c65", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "str", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b602e22-13f6-4c27-a767-3be5b53193d4", "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": "str", "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": "ec2b90ac-1bcc-4c9e-9169-77198f80dd29", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "str", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9c95c59-3dc6-4d4f-a96c-dd6f2e539b9f", "name": "deps.dev did not answer cleanly.", "originalRequest": { "url": { "path": [ "v1", "external-advisories", ":advisory_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "str", "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": "7af27bf1-f16f-4754-81db-5523b8a51b9e", "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": "00bf72a4-5487-457a-b8e3-0cb9804c26ca", "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": "3998923f-b5b3-4461-9d4d-9d13d81c5a5b", "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": "9d0ef345-5951-4481-a037-09ce420e6c59", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de0b6797-93d0-4c2a-aa81-201ddd254dd6", "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": "fbed43e8-e640-4891-a230-0c04faea88a5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dec4fd74-8439-490e-a810-b1a4412c98de", "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": "41d29cc7-fcd0-45b9-9780-99313feaf538", "name": "gate-policies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "552611e2-3314-41d2-ba30-02ce2ef143f8", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0757709e-33c5-4be7-b11b-63949b6aacf4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"757bdbe1-df1a-cd1a-1d77-46687b775b7d\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_data_available\": true,\n \"epss_last_synced_at\": \"2011-05-02T17:34:32.744Z\",\n \"epss_refresh_enabled\": false,\n \"epss_scored_cves\": 0,\n \"epss_threshold\": 6378.393859677345,\n \"malicious_blocks\": false,\n \"reachable_critical_only\": true,\n \"sources\": {\n \"key_0\": {\n \"scope\": \"organization\",\n \"group_ids\": [\n \"11771112-afdc-6393-7146-3f7cee289167\",\n \"5aa330b6-29db-335e-94da-2f26efbc3a2f\"\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\": \"organization\",\n \"key_1\": \"deployment\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "303707db-f70d-445d-9886-397d92758694", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2deaba90-01a9-4deb-ae8c-ba135c4fbb00", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b637fdf-02bb-404b-b891-d2ef3681df82", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c06637e-99ec-4cc2-8e62-1e50433477db", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2277e90-d547-4767-b78d-6234a7dca70c", "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": "f6af6155-422d-4d32-9142-a7d2a5b66dd5", "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\": true,\n \"refresh_enabled\": false,\n \"scored_cves\": 9758,\n \"last_synced_at\": \"1977-04-11T21:27:19.823Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f867f7e7-5d4b-4787-bc5e-f3b18b50efc1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74b7b588-fee3-4a1e-9bb6-361aab87b44e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06524d8e-f72e-4a64-b285-d9cd42741799", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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 \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.22737615178748283,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c3b9677e-e8c7-4555-a149-1ef5d16e13ac", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a978569b-d409-dbdd-31c1-56b3100ad70b\",\n \"organization_id\": \"5f3a133e-5062-32f1-44f8-dbce4098272f\",\n \"created_at\": \"1954-11-18T17:46:27.182Z\",\n \"updated_at\": \"1970-06-14T17:27:13.013Z\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 1638.7851934989928,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": true,\n \"team_id\": \"afc0c2db-2995-4011-ffd1-c93efefa5fec\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc666cdf-883f-46c4-8c84-398fbbd97cab", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "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.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": 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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b24f3b8-72ed-4c9d-b46e-7d3c751523cc", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a91b434-78e4-40ca-a902-b99f376d73d9", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f560945-9953-4339-9bf0-0ba6d7f9511d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "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.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": 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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd90d47b-8d4e-484e-b5eb-edfae76a6ae7", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1379c8d4-151a-41d9-b3ec-b049631b8e12", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "e2f60374-3a9e-46af-bf1c-3f14ea2d2750", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71155732-09a3-4ace-86e8-ee8337f9eba7", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "2c167a60-b4cf-4990-b41f-94cbf86e3169", "name": "Team not found, or it had no policy of its own.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "c5b360f9-fa4c-4d5a-81d8-96731a44a959", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b9d6eb6-6e6d-4f39-8895-0cb488b3528c", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2a71daf3-cebf-4f59-90fa-83a79c28050c", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"a978569b-d409-dbdd-31c1-56b3100ad70b\",\n \"organization_id\": \"5f3a133e-5062-32f1-44f8-dbce4098272f\",\n \"created_at\": \"1954-11-18T17:46:27.182Z\",\n \"updated_at\": \"1970-06-14T17:27:13.013Z\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 1638.7851934989928,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": true,\n \"team_id\": \"afc0c2db-2995-4011-ffd1-c93efefa5fec\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0b51406-b779-491a-80f9-061475950d6e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b598795-927f-4dca-9139-abaf0fc5d4c4", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6c69173-efdd-4179-b707-ce81b5efde2c", "name": "Team not found, or it has written no policy.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "b0f0ed12-80ff-4a39-9e69-bb2e776b9a30", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c65e2937-9b2a-4bd7-8936-baccdc21c31e", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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 \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.22737615178748283,\n \"malicious_blocks\": true,\n \"name\": \"string\",\n \"reachable_critical_only\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e5bd1fcd-2fac-4e1f-999c-1715d48e8a0e", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a978569b-d409-dbdd-31c1-56b3100ad70b\",\n \"organization_id\": \"5f3a133e-5062-32f1-44f8-dbce4098272f\",\n \"created_at\": \"1954-11-18T17:46:27.182Z\",\n \"updated_at\": \"1970-06-14T17:27:13.013Z\",\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 1638.7851934989928,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": true,\n \"team_id\": \"afc0c2db-2995-4011-ffd1-c93efefa5fec\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a56efe6-75a5-4466-8306-2e611144bf4d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "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.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": 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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3496654f-2545-4a0b-8705-df8c5c6ec48b", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07a35fd7-c753-406e-80b5-c21ad5f073c4", "name": "Team not found.", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"approval_required_statuses\": [\n \"string\",\n \"string\"\n ],\n \"epss_threshold\": 0.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7aaf8a0-73dc-4083-a6c6-65cec8540f9f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "gate-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "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.5105881867042599,\n \"malicious_blocks\": false,\n \"name\": \"string\",\n \"reachable_critical_only\": 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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0ebb8892-bfa3-4fdf-bf1b-6f43b95832c5", "name": "github-app", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "eb912765-a318-4b37-b743-e2624df16fa3", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "e3d6807b-cc8d-47d2-a612-2a48b31ef295", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": \"8723f020-5ebb-d915-b461-e09c8faa5438\",\n \"team_id\": \"9c469337-65dc-114c-a959-fe749618a21d\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": true,\n \"has_webhook_secret\": true,\n \"created_by_user_id\": \"15858942-ac10-6f68-b78c-e9d2181af096\",\n \"created_at\": \"2013-11-22T22:01:29.270Z\",\n \"updated_at\": \"1970-03-05T00:53:02.061Z\",\n \"revoked_at\": \"1988-03-16T07:41:58.879Z\"\n },\n {\n \"id\": \"cd5055b8-583d-276d-ff2a-18a301617e4b\",\n \"team_id\": \"59ec40ef-8235-20f7-c2e7-ac100c1ee758\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": false,\n \"has_webhook_secret\": false,\n \"created_by_user_id\": \"50395b43-2c17-9334-a51e-a823dd1bf833\",\n \"created_at\": \"2017-05-31T21:10:38.282Z\",\n \"updated_at\": \"1960-03-08T07:13:38.260Z\",\n \"revoked_at\": \"2005-08-31T00:08:14.641Z\"\n }\n ],\n \"total\": 1318,\n \"page\": 7340,\n \"page_size\": 9657\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "926b8f8d-7381-492e-bc31-9d2e7b015859", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09a14609-a362-4f6a-89bf-65c6257e63b8", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fe13e46-56fe-4df6-91d3-41b1bdbaa626", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16f41ee3-608e-42f8-8bf9-25bed4780f0d", "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": "beb22c2e-fcf7-2d22-539b-9e3b4efcfd36", "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": "0fc0e8b9-80bb-4815-b7d2-90fbdec280ce", "name": "Credential registered. Private key is never returned.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "beb22c2e-fcf7-2d22-539b-9e3b4efcfd36" } ], "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\": \"cdb5ddf4-cc5d-8ffd-6c73-5c60504e9b13\",\n \"team_id\": \"b5f755bf-662c-9be9-5c32-ef33e674c1ce\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": true,\n \"has_webhook_secret\": true,\n \"created_by_user_id\": \"743af6c0-361c-9d69-3849-c76c554fe58f\",\n \"created_at\": \"1983-11-08T02:50:33.013Z\",\n \"updated_at\": \"2014-04-09T16:57:08.838Z\",\n \"revoked_at\": \"1949-07-03T07:32:43.733Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "740cd63c-ccab-4112-bdfd-8b25977bbe28", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "beb22c2e-fcf7-2d22-539b-9e3b4efcfd36" } ], "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6039c90-54e9-4fdf-9117-a613c7a89a54", "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": "beb22c2e-fcf7-2d22-539b-9e3b4efcfd36" } ], "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": "95d49927-e87d-4be7-a062-264ce2658ab1", "name": "A credential for this (team, app_id) already exists.", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "beb22c2e-fcf7-2d22-539b-9e3b4efcfd36" } ], "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": "c7f354b5-1f42-4ee9-bda8-4c3c2b71ea38", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "beb22c2e-fcf7-2d22-539b-9e3b4efcfd36" } ], "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb8fe911-a460-4b5e-bf67-521763f4e937", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c6f2478f-b435-4f02-b49e-a5b5f5a16cef", "name": "Revoked (or already revoked — idempotent).", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "dd7ab978-6840-48c4-b632-29347ba4cdec", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebe8e524-ac91-4b58-b081-79f4bb4c56cb", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "4ab34c56-d5a9-4371-9206-56be8f9c08bb", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "d840e4fc-5357-4843-9e18-1132882423f0", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28e743d4-a2ee-497c-85f2-a6e22e6f10fd", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d5fbef6f-1f6e-4e42-851a-b8b97a2b953e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": \"cdb5ddf4-cc5d-8ffd-6c73-5c60504e9b13\",\n \"team_id\": \"b5f755bf-662c-9be9-5c32-ef33e674c1ce\",\n \"app_id\": \"string\",\n \"app_slug\": \"string\",\n \"has_private_key\": true,\n \"has_webhook_secret\": true,\n \"created_by_user_id\": \"743af6c0-361c-9d69-3849-c76c554fe58f\",\n \"created_at\": \"1983-11-08T02:50:33.013Z\",\n \"updated_at\": \"2014-04-09T16:57:08.838Z\",\n \"revoked_at\": \"1949-07-03T07:32:43.733Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea99fd1-0823-4c0e-a233-9ab0f5c804c0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f12adf-a4da-48f9-a293-1f2ca8e11f6e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eccf0f4e-16b7-42bf-9228-3af09ab82819", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "b4b65899-787a-40a0-b3c4-2461041253d5", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26ab615f-fae3-4a6c-a08b-d2cc430033cd", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "49cb0ec8-460f-4a9a-bf99-2f3b170ea51f", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": \"d1b5cb7d-7205-f1dc-44b7-7d7751b6af01\",\n \"credential_id\": \"ad2011b5-96d2-ec32-8f7b-c308919efdec\",\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"repository_full_name\": \"string\",\n \"project_id\": \"987438bd-6c79-17b0-34b6-71cca787fe8c\",\n \"created_by_user_id\": \"c0b786ca-b978-f031-e66d-bc1e2f61cc2e\",\n \"created_at\": \"1954-12-01T21:08:41.360Z\",\n \"updated_at\": \"1978-01-15T20:14:18.740Z\"\n },\n {\n \"id\": \"e6dab4f1-7e9f-750c-e131-0ca5b8c8e943\",\n \"credential_id\": \"fa070c61-36cc-3c50-802e-656ea80ea50b\",\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"repository_full_name\": \"string\",\n \"project_id\": \"c2d6e49e-116c-3b0f-c025-014443b29405\",\n \"created_by_user_id\": \"b4faa0cd-b847-a678-2dcc-94c437f7d578\",\n \"created_at\": \"1967-02-19T20:32:07.780Z\",\n \"updated_at\": \"1964-01-26T07:04:32.638Z\"\n }\n ],\n \"total\": 7157,\n \"page\": 8714,\n \"page_size\": 103\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88d9d783-df4e-4a9b-a5be-1b02ada7f2b7", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b131f865-89bc-4cb8-a97a-a54bc45dc679", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1baa596-6c4f-4d44-a10d-dba4eff7fa66", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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": "4d9028df-d24f-4aed-a9b2-a44c7cd633fd", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a0d1931-286a-47d4-b0e2-ad2c3271a513", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": \"8917dd54-b2af-d00c-9a25-6afb0a41ebca\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2315d809-dab9-47cb-a668-92d0d4466065", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": \"8917dd54-b2af-d00c-9a25-6afb0a41ebca\",\n \"repository_full_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"ca8866a2-3e1b-bbf9-7136-ba371f53cd29\",\n \"credential_id\": \"0f83b863-d4c9-9662-d250-7a172adc1a03\",\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"repository_full_name\": \"string\",\n \"project_id\": \"0537b6cf-08fb-37f0-54c9-03f70dee7e33\",\n \"created_by_user_id\": \"ce0387a4-9065-0480-f420-e6f666ec314c\",\n \"created_at\": \"2020-12-09T13:33:34.720Z\",\n \"updated_at\": \"1962-10-11T20:26:27.296Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a1d6e1-06a1-4741-b989-0391c2929cd4", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": \"8917dd54-b2af-d00c-9a25-6afb0a41ebca\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aecb38c-d78a-43fc-b292-6ed747b475bb", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"8917dd54-b2af-d00c-9a25-6afb0a41ebca\",\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": "10756b09-f99d-4218-bdc4-f15936a3ae21", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"installation_id\": \"string\",\n \"account_login\": \"string\",\n \"project_id\": \"8917dd54-b2af-d00c-9a25-6afb0a41ebca\",\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": "dee95332-cbb4-40a7-b11b-a908be36c1bc", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "github-app-credentials", ":credential_id", "installations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "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\": \"8917dd54-b2af-d00c-9a25-6afb0a41ebca\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8806fa9b-ca39-4e80-b535-470a016d6ef1", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "6c34380c-fcba-4da3-f4f6-48f26952e9be", "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": "d157b702-17a2-4c70-bfb6-b2dc0d86f1ec", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "6c34380c-fcba-4da3-f4f6-48f26952e9be", "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": "5a8b9981-5d44-4df0-8128-67ae8d171af3", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "6c34380c-fcba-4da3-f4f6-48f26952e9be", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99559699-bb14-4220-8ae4-73a0f655eb91", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "6c34380c-fcba-4da3-f4f6-48f26952e9be", "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": "15a56c4a-4a25-4f3d-8dc6-0244e41622ed", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "6c34380c-fcba-4da3-f4f6-48f26952e9be", "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": "c3f94a9e-f7ad-485c-91cd-9bff27532e5f", "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": "f5e076f9-f753-04a9-6732-75ffb6cb4c63", "key": "credential_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "6c34380c-fcba-4da3-f4f6-48f26952e9be", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1c541fba-db65-41ff-ae66-40ce3a9f678b", "name": "groups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "17c16c5b-c515-4a40-b0ba-fc3d4a4f1f1c", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "48d1e1e7-754d-4703-a7c3-7c00a46ede5e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": \"3ce94409-5d9a-e059-8522-3059afc85d6e\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"updated_at\": \"1989-08-14T20:22:48.715Z\",\n \"child_group_count\": 0,\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"2ca7d184-b0b8-080b-a7c6-bdda6da3efdd\",\n \"project_count\": 0\n },\n {\n \"id\": \"39b0dcbf-3649-0556-e57e-12e05c1b895e\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"updated_at\": \"1964-09-01T02:09:14.067Z\",\n \"child_group_count\": 0,\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"9a077db5-936e-7ca2-64e0-6b82bc18fefa\",\n \"project_count\": 0\n }\n ],\n \"total\": 9820,\n \"page\": 1150,\n \"page_size\": 7605\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0d0e26e-63cf-4003-9fd2-b26c110c53a9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abf6ea09-37df-47ed-9886-86722c71ad19", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d67ac48-ed90-435b-8fbb-828169dfe9bf", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "parent_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b73a2ae3-8111-4ef8-999c-0407bda7920f", "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": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "63004133-22d0-4a49-9240-cf266da78af4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": \"1afbf379-530c-154e-f6d7-aafdd5cc5038\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"stats\": {\n \"subtree_scan_count\": 2326,\n \"subtree_approvals_processed_count\": 2572,\n \"subtree_new_member_count\": 7467,\n \"window_days\": 30\n },\n \"created_at\": \"1979-02-21T11:18:17.407Z\",\n \"updated_at\": \"1947-01-30T15:35:18.540Z\",\n \"ancestors\": [\n {\n \"id\": \"fe7448f7-1700-ba5e-1280-9fade0f84414\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"09801c6c-4241-7bfe-fae8-ca50e99f91c6\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"child_group_count\": 0,\n \"description\": \"string\",\n \"member_count\": 0,\n \"parent_group_id\": \"7f439190-7dc5-5abb-c4ba-d328c7a9e88b\",\n \"project_count\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72d6582d-fcbf-4772-8da0-29f5bddd9336", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fca9791-a7d9-4fba-9212-721b0f6ad539", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82dcc6a7-e2ec-4159-ad4f-22fc624f3f22", "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": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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": "2ffbc3b5-2bc4-436d-8fdf-d6ce2bcdea08", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92d4563c-8253-4d11-90d7-85730e09865a", "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": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "key": "group_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1765ba75-411f-4f8c-95a2-acada47acefd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": \"5f719002-9a2e-300a-f95d-938973e842e1\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"505ab1fb-e629-b9bd-c1bc-0d816a62109e\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ],\n \"inherited\": [\n {\n \"user_id\": \"4ae2ce30-bb04-e054-e456-a934206eb6ab\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"source_group_id\": \"ca0e14a2-4b37-1f5d-1f6e-f6337048ae13\",\n \"source_group_name\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n },\n {\n \"user_id\": \"1c9aadb8-10e1-e458-5bbc-be487c86e22b\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"source_group_id\": \"953bb0b6-33c6-ed4e-893f-d8e9914ece77\",\n \"source_group_name\": \"string\",\n \"full_name\": \"string\",\n \"is_service_account\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86242e72-9eca-4a25-9897-88396caf072e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3431773-254e-461b-8013-8fe44749e3d0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f497dd97-85c6-406c-86c2-95fac532f729", "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": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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": "a0cc4f3a-cf06-4a1e-b0db-96772a967044", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "groups", ":group_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "a2949ff6-32b2-74e0-eb8c-a0a189a479d1", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b6986d0f-728c-4966-8012-07c4e3d4c736", "name": "intake-requests", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "473a46f0-c572-465b-b847-fad805484f22", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "1ca7f457-3871-42ca-b216-3628dcccf21e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": \"010dc29c-173c-7bd8-cb9a-cf1dfb048c10\",\n \"project_id\": \"3f3ee421-df53-52a5-582b-fee3e683adb2\",\n \"team_id\": \"43e761a6-e227-c066-8a52-7be6ba6f424f\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"5448f9de-8ebe-f192-30b6-5552c597202a\",\n \"decided_by_user_id\": \"4fa4ffca-984d-c349-7263-8deee7e57dd6\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1958-04-07T02:04:47.114Z\",\n \"version\": 2902,\n \"created_at\": \"2001-10-28T21:04:37.162Z\",\n \"updated_at\": \"1948-02-11T04:32:28.204Z\"\n },\n {\n \"id\": \"566d7e6f-fb78-5f83-82ce-959f556e5fb0\",\n \"project_id\": \"e024b319-0440-3fa9-f2af-b74529f792ee\",\n \"team_id\": \"e8698a9c-fabe-05e0-9dd6-aebca777fad5\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"edf6c512-67fb-9a4b-e2e7-bad85ea67951\",\n \"decided_by_user_id\": \"f14ae25f-6bfe-9157-1dc7-ffafda52e5e7\",\n \"decision_note\": \"string\",\n \"decided_at\": \"2009-02-23T17:50:03.533Z\",\n \"version\": 5013,\n \"created_at\": \"1964-10-24T10:35:48.095Z\",\n \"updated_at\": \"1972-06-06T03:55:31.407Z\"\n }\n ],\n \"total\": 5204\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e70250a2-40de-4fad-a8d4-284540ea387b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48e6e3fb-f32c-4f86-95e5-71a0941b6547", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b390f5ef-800c-4d45-b135-3b9162afe34a", "name": "This deployment does not use an intake queue.", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "228ca2a0-434f-4b05-bb94-1592324ff5f7", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "intake-requests" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "project_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84718e2f-729a-4211-843c-f1df212428ca", "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\": \"05cf6cc2-73cb-eb71-1942-a3194e358fb8\",\n \"purl\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cd3a138c-a50b-4617-aff2-5952a263e3ba", "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\": \"05cf6cc2-73cb-eb71-1942-a3194e358fb8\",\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\": \"134c484c-f584-9040-495c-ce4d0c7d5faa\",\n \"project_id\": \"73f8de93-94a4-852b-1e47-c57f0b343ae9\",\n \"team_id\": \"a3be9f36-c6f8-f753-681d-de54a9f0e8dd\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"3e9dca24-e915-66a0-b339-1017c358c250\",\n \"decided_by_user_id\": \"f8469821-52a2-358c-9953-017ce3469b57\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1965-03-01T17:33:28.840Z\",\n \"version\": 4832,\n \"created_at\": \"1978-04-22T08:18:52.008Z\",\n \"updated_at\": \"2012-12-03T14:32:10.700Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2ad100c-82d5-4153-ad61-a5fff068a014", "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\": \"05cf6cc2-73cb-eb71-1942-a3194e358fb8\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76cc0962-8f71-4f9a-94e9-2fb72d720786", "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\": \"05cf6cc2-73cb-eb71-1942-a3194e358fb8\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aad9bc07-b209-4e37-8201-a2ff2fa8bfee", "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\": \"05cf6cc2-73cb-eb71-1942-a3194e358fb8\",\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": "da527cae-ea92-4a19-a68e-6d5435e82ade", "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\": \"05cf6cc2-73cb-eb71-1942-a3194e358fb8\",\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": "637248e8-98b0-441d-89eb-ddc51289bbba", "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\": \"05cf6cc2-73cb-eb71-1942-a3194e358fb8\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f360f4e-825b-4ce6-a899-f60bd88fecac", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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": "14a9fb92-0bfd-4208-b625-732fd425b431", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": \"134c484c-f584-9040-495c-ce4d0c7d5faa\",\n \"project_id\": \"73f8de93-94a4-852b-1e47-c57f0b343ae9\",\n \"team_id\": \"a3be9f36-c6f8-f753-681d-de54a9f0e8dd\",\n \"purl\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\",\n \"requested_by_user_id\": \"3e9dca24-e915-66a0-b339-1017c358c250\",\n \"decided_by_user_id\": \"f8469821-52a2-358c-9953-017ce3469b57\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1965-03-01T17:33:28.840Z\",\n \"version\": 4832,\n \"created_at\": \"1978-04-22T08:18:52.008Z\",\n \"updated_at\": \"2012-12-03T14:32:10.700Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8d0ea09-bd28-405a-9ed3-8b787bed3859", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95304719-8267-4fb5-a459-241a3954ddf8", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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": "5b1f6dbd-cc6e-4756-b73a-522341de8cea", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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": "dad32216-edd7-4f0f-8459-c79fe525fb61", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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": "baccbb64-e601-40c8-9c39-0809f431506f", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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": "aaeecf03-4ee1-4012-ace2-efccfe912d8c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "intake-requests", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5f324c85-32b2-4a31-ab73-7ef407404926", "name": "inventory", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "501f70b1-38d9-4edb-b1b2-5274f9d4a8d3", "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": "d4eceb5a-f7cb-4471-9a2b-4a11c46e0539", "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\": \"e6d0553f-027d-21c1-2a01-eebf9ad1515f\",\n \"name\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\",\n \"project_count\": 3292,\n \"version_count\": 9258,\n \"severity_max\": \"medium\",\n \"vulnerability_count\": 5311,\n \"license_category_max\": \"unknown\",\n \"eol\": false,\n \"outdated\": false,\n \"versions\": [\n \"string\",\n \"string\"\n ]\n },\n {\n \"component_id\": \"49933837-845f-917e-aee8-bd5d63dc36bc\",\n \"name\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\",\n \"project_count\": 6778,\n \"version_count\": 9659,\n \"severity_max\": \"info\",\n \"vulnerability_count\": 9457,\n \"license_category_max\": \"allowed\",\n \"eol\": true,\n \"outdated\": true,\n \"versions\": [\n \"string\",\n \"string\"\n ]\n }\n ],\n \"total\": 7801,\n \"limit\": 2060,\n \"offset\": 9378\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f693b32-141d-43ba-acf7-9fff1c8da4fa", "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": "52ed3917-7061-47f4-a448-03d80059d0b7", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "febaee76-0e8a-44b6-b9eb-625d7e198011", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45ab3526-37b1-4aea-9b70-c0e3c5bd47ae", "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": "b60877ab-b0b3-44dd-aff3-11acd92a757a", "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": "b2193081-9303-4b92-a062-20b6c7d0f9e3", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13a77821-2bac-437b-95ee-ecd56e8ab434", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1131e9d9-6430-4ab4-9497-72cd0eab35f9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e3e5063-5a0f-4dc6-b607-47502c28a6ee", "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": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "80572053-83e6-4d4d-bfe0-a7db47bfed50", "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": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": \"df18c537-203d-bf41-cab8-9dd24349d5c7\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"version\": \"string\",\n \"direct\": false,\n \"scan_id\": \"299f0e16-16f2-4737-6459-23e3128c5181\",\n \"scanned_at\": \"2012-05-12T08:09:11.388Z\"\n },\n {\n \"project_id\": \"b6ca062d-39b7-60a1-3bf1-557104666fcc\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"version\": \"string\",\n \"direct\": false,\n \"scan_id\": \"93dc6c5b-54c0-4711-76b8-e5b739ebd2d2\",\n \"scanned_at\": \"2017-07-07T02:27:50.335Z\"\n }\n ],\n \"total\": 5567,\n \"limit\": 5229,\n \"offset\": 2312\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c75569-e1f9-4a0d-bff1-eaa5278278bc", "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": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f3655ea-d36a-4b83-873a-cd09882db0f2", "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": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55f3394c-afad-4b4c-b3a9-de2fac3120e2", "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": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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": "cb3224ee-2f6b-4dab-a0ae-7c87cbe7878b", "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": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76eb5c90-16b1-4635-9172-deb83c33f87e", "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": "e880d67d-e805-491a-8ec7-76d8e0f7307f", "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\": \"medium\",\n \"items\": [\n {\n \"project_id\": \"2b14958c-4439-900c-e202-f4909ad1a700\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_name\": \"string\",\n \"purl\": \"string\",\n \"version\": \"string\",\n \"finding_id\": \"69bb0d4c-c1f9-ca58-c427-9ea726f2f593\",\n \"status\": \"string\",\n \"severity\": \"medium\"\n },\n {\n \"project_id\": \"7ab9ff63-2ad3-1005-68c2-ee9a46799127\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_name\": \"string\",\n \"purl\": \"string\",\n \"version\": \"string\",\n \"finding_id\": \"10e0731e-ee53-4716-b67c-dd25e0da70b2\",\n \"status\": \"string\",\n \"severity\": \"high\"\n }\n ],\n \"total\": 8368,\n \"limit\": 5970,\n \"offset\": 4705\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa9c5cca-e656-4233-b665-f340f31782e2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb7022a2-bcde-44c0-b2b1-2c526061ea49", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6f5fefb-7a80-4e76-95da-0bb2849fc1e1", "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": "69a91ede-e8e1-490a-97fc-f96289d1e9ec", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a2708a2b-bc21-4984-9cac-664cd3a78312", "name": "license-policies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "039849e5-386c-4dfe-840c-173f1a7e3e96", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "disabled": false, "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "bbde6c2f-0cdc-444b-83d3-c9e3871e490d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": \"4ffbf0a9-dcce-8fa0-fb73-d79f69b3bb4e\",\n \"organization_id\": \"e3b484e2-d3de-00bf-516c-bf2eb4a34618\",\n \"team_id\": \"53143bdd-fdc5-5875-2a4d-f51fa56badc5\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": true\n },\n {\n \"key_0\": false\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\": \"b53f9e8b-2f6e-e82b-95d7-44999b82f9a2\",\n \"created_at\": \"2009-04-01T19:44:03.068Z\",\n \"updated_at\": \"1956-04-26T01:53:54.094Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 1341\n }\n ]\n },\n {\n \"id\": \"54e74ac5-0034-ab71-0ff4-efe4d2bd6bb9\",\n \"organization_id\": \"3a9b729a-e1c2-cfb6-aae4-e04a97b77791\",\n \"team_id\": \"95934804-e74c-dc60-0d1d-2f80336384bd\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 4092,\n \"key_1\": \"string\",\n \"key_2\": 5129.341499050246,\n \"key_3\": 3859\n },\n {\n \"key_0\": \"string\",\n \"key_1\": 6894.127894729391\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\": \"57221768-08c1-e2ca-9361-63d00c401331\",\n \"created_at\": \"1948-08-20T09:57:09.029Z\",\n \"updated_at\": \"2026-08-11T02:48:32.659Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": 8254,\n \"key_1\": true,\n \"key_2\": 4271.157105011647\n },\n {\n \"key_0\": 1173.3166631526349,\n \"key_1\": 4621,\n \"key_2\": \"string\"\n }\n ]\n }\n ],\n \"total\": 3830,\n \"page\": 3710,\n \"page_size\": 930\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d814539e-30c1-4555-975d-94508e88d311", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "014f3be8-43d7-4409-93aa-168ef7cafc77", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56d85dce-bdfc-42f1-9f02-92ace50dd45e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "organization_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "589da43b-86ab-4396-a012-62b405fbb33e", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "52b631f8-06bd-4c32-9edb-5e9aa8165489", "name": "The org-default policy.", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"95f3508f-4f3d-ebd1-01cc-d66c6a155354\",\n \"organization_id\": \"63e309da-0f83-cab7-977c-55a33f40f6df\",\n \"team_id\": \"fc333f75-b0d7-388a-4f10-035e205c9995\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 4550.501051624618\n },\n {\n \"key_0\": 4298.41073888684,\n \"key_1\": \"string\"\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\": \"e033249a-1373-15d3-b8d1-ce3baf216d49\",\n \"created_at\": \"1984-06-24T10:12:50.195Z\",\n \"updated_at\": \"1955-08-31T09:11:13.873Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 8404\n },\n {\n \"key_0\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3839f77c-7210-4155-b277-309a5779e992", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e525728-708c-4ff8-a099-3abf5972839d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea5ac8e3-020e-48d2-bb7e-12835159dbdd", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "30dee483-67bf-47e7-b174-0eee2680a7d1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f2be252-a194-4aee-874a-ef6f92d95018", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"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\": \"1974-02-25T16:36:02.640Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1948-12-13T02:12:33.825Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-08T04:54:11.466Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2014-04-07T14:41:20.163Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "82ed643a-8929-4134-9d1b-99cacc1f460c", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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\": \"95f3508f-4f3d-ebd1-01cc-d66c6a155354\",\n \"organization_id\": \"63e309da-0f83-cab7-977c-55a33f40f6df\",\n \"team_id\": \"fc333f75-b0d7-388a-4f10-035e205c9995\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 4550.501051624618\n },\n {\n \"key_0\": 4298.41073888684,\n \"key_1\": \"string\"\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\": \"e033249a-1373-15d3-b8d1-ce3baf216d49\",\n \"created_at\": \"1984-06-24T10:12:50.195Z\",\n \"updated_at\": \"1955-08-31T09:11:13.873Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 8404\n },\n {\n \"key_0\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4c7b5b4-5c24-4b6f-a08d-4facd6fa5f25", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50f9ab1b-9cc9-461f-9809-d2238763cd98", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd6246fe-d607-4008-b779-154e2c4a33df", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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": "678bd4fb-37c0-4daa-add4-899cf07d8c22", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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": "965459f6-4deb-4f7b-879a-8067c4ec90e1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a70097a-4a23-4e45-b2ba-8a5a429c8733", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "13ef30fc-4f63-43c5-abe1-d7c20b646a9e", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "c27adc7d-ccfb-4c11-ab90-3fb07a8446f6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f99a747-c8ef-4935-971f-61e9b3d590a9", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "5b255823-258a-4b7c-8ddf-cdb733aeb818", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "b07df597-886d-4721-b79c-b23e00ea385e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1972d372-3cba-4a06-a4c9-426e246c7581", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9e5c88fa-c3ff-4acf-b79b-ef56131c1575", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"95f3508f-4f3d-ebd1-01cc-d66c6a155354\",\n \"organization_id\": \"63e309da-0f83-cab7-977c-55a33f40f6df\",\n \"team_id\": \"fc333f75-b0d7-388a-4f10-035e205c9995\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 4550.501051624618\n },\n {\n \"key_0\": 4298.41073888684,\n \"key_1\": \"string\"\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\": \"e033249a-1373-15d3-b8d1-ce3baf216d49\",\n \"created_at\": \"1984-06-24T10:12:50.195Z\",\n \"updated_at\": \"1955-08-31T09:11:13.873Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 8404\n },\n {\n \"key_0\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee5cc9de-9057-49f1-a40b-0d8ad38389f6", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff46c627-f58b-4f7d-845d-1ab160c10298", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "ebdd5643-f0f3-4eb0-aab1-0f5883d9959c", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "a2c0ea90-ea52-457e-a448-cc64347e3c9b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40237d54-e3b2-4563-a35e-3627c4ae11f5", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"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\": \"1974-02-25T16:36:02.640Z\"\n },\n {\n \"spdx_id\": \"string\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1948-12-13T02:12:33.825Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1970-06-08T04:54:11.466Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2014-04-07T14:41:20.163Z\"\n }\n ],\n \"name\": \"string\",\n \"unknown_license_category\": \"conditional\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ba2b040d-6c32-4c75-adeb-8c7fec28b527", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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\": \"95f3508f-4f3d-ebd1-01cc-d66c6a155354\",\n \"organization_id\": \"63e309da-0f83-cab7-977c-55a33f40f6df\",\n \"team_id\": \"fc333f75-b0d7-388a-4f10-035e205c9995\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 4550.501051624618\n },\n {\n \"key_0\": 4298.41073888684,\n \"key_1\": \"string\"\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\": \"e033249a-1373-15d3-b8d1-ce3baf216d49\",\n \"created_at\": \"1984-06-24T10:12:50.195Z\",\n \"updated_at\": \"1955-08-31T09:11:13.873Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 8404\n },\n {\n \"key_0\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cf18996-75ba-4f79-8869-0a1e5a524ce0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3736cd75-8823-49e7-8039-a03ee22370ab", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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": "d64e946d-aacc-4ade-ad70-e67ae1d27238", "name": "Team not found (existence-hidden).", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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": "434e909d-162b-4ff0-aed2-8a4a0fd9ab44", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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": "3b7f523c-15a8-4dc0-bb8c-a1569497f12d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"forbidden\"\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\": \"2005-01-10T08:00:48.037Z\"\n },\n {\n \"spdx_id\": \"strin\",\n \"reason\": \"string\",\n \"component_purl\": \"string\",\n \"expires_at\": \"1966-03-16T06:02:54.924Z\"\n }\n ],\n \"malicious_exceptions\": [\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"1980-02-06T06:00:22.032Z\"\n },\n {\n \"component_purl\": \"string\",\n \"reason\": \"string\",\n \"expires_at\": \"2002-01-15T19:05:28.612Z\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d46eb084-5eef-4815-95f7-ac9e150181d8", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bd31da85-8243-4b4f-84f6-9b67b9222d43", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"95f3508f-4f3d-ebd1-01cc-d66c6a155354\",\n \"organization_id\": \"63e309da-0f83-cab7-977c-55a33f40f6df\",\n \"team_id\": \"fc333f75-b0d7-388a-4f10-035e205c9995\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 4550.501051624618\n },\n {\n \"key_0\": 4298.41073888684,\n \"key_1\": \"string\"\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\": \"e033249a-1373-15d3-b8d1-ce3baf216d49\",\n \"created_at\": \"1984-06-24T10:12:50.195Z\",\n \"updated_at\": \"1955-08-31T09:11:13.873Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 8404\n },\n {\n \"key_0\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "079bdf83-afd4-4ea2-a1de-e007ab2db0ca", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "359b1193-cce5-40cb-9d52-e06141f4a0e4", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "4e0be483-d496-404e-9e14-b9b358a03307", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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": "b06c2c0f-d539-4bc7-a9ff-d8ab6b311ffe", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42d5fe32-f2cb-4fea-84bd-3a11754759a8", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"2006-05-29T05:58:34.551Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d25abde-c086-4ee2-b1cb-7c93cbd35421", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"2006-05-29T05:58:34.551Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"95f3508f-4f3d-ebd1-01cc-d66c6a155354\",\n \"organization_id\": \"63e309da-0f83-cab7-977c-55a33f40f6df\",\n \"team_id\": \"fc333f75-b0d7-388a-4f10-035e205c9995\",\n \"name\": \"string\",\n \"category_overrides\": {\n \"key_0\": \"string\"\n },\n \"license_exceptions\": [\n {\n \"key_0\": 4550.501051624618\n },\n {\n \"key_0\": 4298.41073888684,\n \"key_1\": \"string\"\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\": \"e033249a-1373-15d3-b8d1-ce3baf216d49\",\n \"created_at\": \"1984-06-24T10:12:50.195Z\",\n \"updated_at\": \"1955-08-31T09:11:13.873Z\",\n \"malicious_exceptions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": 8404\n },\n {\n \"key_0\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07fa205d-ac88-44e9-9686-6737d12ab67f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"2006-05-29T05:58:34.551Z\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e82f275-7810-4fa3-adb4-b5d03701b4de", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"2006-05-29T05:58:34.551Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a9fb540-b81b-4eef-b3a7-d4396bb49ba3", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"2006-05-29T05:58:34.551Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9223aef7-eacf-43c2-9105-44e11f94ba57", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license-policies", "teams", ":team_id", "exceptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"2006-05-29T05:58:34.551Z\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "442cdacc-8549-4cc1-9bfe-939f31df34bb", "name": "licenses", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "05ac2fbc-3db3-4bc2-bf16-8e274e0a6949", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "51cb7a5c-cd0c-4e4a-a6ed-2f749222ce3a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": \"84a62b31-ad6b-85b4-701d-a375ecda9ac6\",\n \"license_id\": \"7a43099f-1f70-6541-dc18-3a48331283b5\",\n \"name\": \"string\",\n \"category\": \"unknown\",\n \"finding_kind\": \"declared\",\n \"created_at\": \"1996-05-31T06:43:43.788Z\",\n \"updated_at\": \"2002-02-24T00:16:12.827Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"3929e86d-044f-a3b7-944b-3c95364506ea\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"kind\": \"declared\",\n \"source_path\": \"string\"\n },\n {\n \"component_version_id\": \"4f45af83-16d0-3049-8944-1ae21c880bfd\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"kind\": \"detected\",\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\": false\n },\n \"osori\": {\n \"name\": \"string\",\n \"notification_required\": false,\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\": \"non_commercial\",\n \"spdx_id\": \"string\",\n \"summary\": \"string\",\n \"summary_ko\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df58165e-7f36-4e72-b72e-84e1d27372c4", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7294973d-3360-4d24-a3e6-af0cd91b0018", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "510daf78-ca33-4c2c-a625-e70ef15cd71e", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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": "03c48b58-eb75-4ede-a2ac-3fde68879753", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "license_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ffbee2d0-cfdf-4d74-9a9c-b0c45e9ebe36", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "84ba49f8-5dac-4d06-8f3d-054f7d0262e9", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"32ae99eb-9bef-507a-4eef-05c35c1bd4b9\",\n \"license_id\": \"09e009ab-e5dc-8e07-9e4b-aa91fbbe5572\",\n \"name\": \"string\",\n \"category\": \"allowed\",\n \"kind\": \"declared\",\n \"affected_count\": 5507,\n \"sample_finding_id\": \"d0be7004-f7fc-0e04-0233-8109741e745d\",\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\": \"49ad07fc-99b6-c359-1517-f0645894a660\",\n \"license_id\": \"4bb306c2-6ae9-3c85-e177-69a8d9f78f0f\",\n \"name\": \"string\",\n \"category\": \"allowed\",\n \"kind\": \"detected\",\n \"affected_count\": 5132,\n \"sample_finding_id\": \"e528dada-5399-da34-1c42-492beaa6e92b\",\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\": 5572,\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": "9edf7f45-beee-4aed-ae8c-dd161b74950d", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62282456-38c6-4691-a3cd-5c90b7e068e0", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d93000f-f731-4ad3-98cd-7c656bf5acae", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c5422fa-f900-41f5-bdd9-a6f1af6b6809", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "014187be-f1d4-41fa-ad45-72e66612798d", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "00057ee8-c39a-4987-b83a-0e378289b057", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "937bf826-ff3b-42ee-bd77-0d1e403a2f9f", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d9cfe90-3a43-42af-90da-1127a9f1e7e3", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24d9cd38-3708-41a7-8422-fe008bc44fd5", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0f13461-035f-4613-bedf-faec196a986e", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0ebe98f1-29fe-4d69-a10f-4ff03b00af94", "name": "notice-templates", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c131038d-abac-4f15-a7de-efce8fd22917", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c6976499-d9d4-4674-bb2c-b3c9709e01aa", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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": "7f488cf0-464f-4929-b40e-0038d8c6ec7b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b1a7fd0-39e4-4343-9f68-f93a7e0e6c8c", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "key": "format", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed09d7c2-fd5d-4592-9e0d-e1c7ffbd8b25", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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": "971b07a2-1f04-4742-bec6-566aae89a45f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54572ca1-92db-4dcd-ac88-5bc5c1e791d9", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "key": "format", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "435395a9-856d-4323-a590-c8bd174e13cf", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": \"6f0a00a8-c081-b546-02d7-5ac364e4c874\",\n \"organization_id\": \"7347050a-5068-66e6-d33e-04e395e31a5f\",\n \"format\": \"string\",\n \"created_at\": \"1976-11-14T23:39:29.832Z\",\n \"updated_at\": \"2000-08-05T16:20:04.997Z\",\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3e116b8-441e-4d57-991e-60e2eb190ed9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4470fbb8-cfc5-48f2-82b0-bc4d8349981d", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c70c30-5649-4b0a-b63c-bbbdcb96d624", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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": "04618043-cdc3-49cd-8ce2-0e1798139aee", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "650a443a-534a-4294-8a33-35fa045fe0bd", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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": "22a7e30b-2b94-40b5-b438-7daf2a2bfe7a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": \"6f0a00a8-c081-b546-02d7-5ac364e4c874\",\n \"organization_id\": \"7347050a-5068-66e6-d33e-04e395e31a5f\",\n \"format\": \"string\",\n \"created_at\": \"1976-11-14T23:39:29.832Z\",\n \"updated_at\": \"2000-08-05T16:20:04.997Z\",\n \"footer\": \"string\",\n \"preface\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06390edf-8cea-4b3b-9bd6-efa88de3bb8e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bb6761f-afb1-4d7b-af91-e58dd9e3f287", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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": "e252c1ec-4e69-4e31-b3e9-d79b0d1665c7", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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": "836bc115-dbd0-4a1f-a3a2-2c59cd9195c3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notice-templates", "org", ":organization_id", ":format" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "html", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a08ee240-eb7b-4edb-93a6-324c6f6fda6a", "name": "notifications", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a84f2791-ce94-4263-93f6-c5c1ce2bf5b5", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b10401fe-383a-4dfb-958f-5893041feaad", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"a32758d9-5849-2ca0-21a1-21b338085a8c\",\n \"organization_id\": \"a2b103e6-c038-8223-8012-8e4c984eba00\",\n \"team_id\": \"8956f3a6-910d-622c-89d3-2c41bb5ed765\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"7011e6ee-7556-8fff-cb8c-f791ddd0e901\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"1954-11-15T22:47:29.360Z\",\n \"updated_at\": \"1948-09-11T20:01:47.938Z\"\n },\n {\n \"id\": \"f506637c-cad6-b14c-43ce-80d55e1b7803\",\n \"organization_id\": \"2371400c-2960-93b4-e4ee-494b5131d1c0\",\n \"team_id\": \"d909ac83-0601-d47c-ebe6-98a86f155ad3\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"3cc0b3ba-1eca-b807-6713-8aa671e32c02\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"1978-05-05T02:29:20.451Z\",\n \"updated_at\": \"1999-07-26T10:36:20.346Z\"\n }\n ],\n \"total\": 6171\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5e88302-e0a1-492d-ae67-846e993f095e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3915486-5fef-45e7-9a2f-aada128c9b0a", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b86c5a6-81be-44c3-ac2f-b75a3dd1ba37", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f533e5f2-af19-487a-a539-f5328d133a78", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fee4e0c-7439-49da-83a1-cafe1c351b37", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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 \"RjTYT7ZpY0E@ZosmcrCmaoEjjhlusYecnIUhkVWj.vadb\",\n \"ANj2sFN@bjEaguEYESF.yfr\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"cff68bec-8c42-d182-06c1-7a9024245638\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "142399a8-987a-492c-ad80-227e6fdd4f69", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cad7f44a-31e4-1134-9f1e-7a2ba2f24488\",\n \"organization_id\": \"14ddc1d0-cb98-9bbc-9ba1-9927efeb4128\",\n \"team_id\": \"9cb4cadd-1041-890e-5f23-334ddbe8b961\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"17be27fb-01c4-499a-9dd6-abdb65797e99\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": false,\n \"created_at\": \"1966-03-16T04:59:13.494Z\",\n \"updated_at\": \"2016-03-19T07:36:22.052Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b10b4874-f051-476f-9c47-6e5e0e8aa43e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27af1044-ece1-4945-84ee-0b6772b15a52", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d5ec4f4-bc8a-47c5-8e97-0641bef19cb0", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e0f3df1-51f6-420c-a3e5-69a611d04bd1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86c3a727-d2ec-41ae-9714-78d69cd23b4f", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "999e5ce5-d6f4-4361-9681-4d9bb26e8811", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": \"a32758d9-5849-2ca0-21a1-21b338085a8c\",\n \"organization_id\": \"a2b103e6-c038-8223-8012-8e4c984eba00\",\n \"team_id\": \"8956f3a6-910d-622c-89d3-2c41bb5ed765\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"7011e6ee-7556-8fff-cb8c-f791ddd0e901\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"1954-11-15T22:47:29.360Z\",\n \"updated_at\": \"1948-09-11T20:01:47.938Z\"\n },\n {\n \"id\": \"f506637c-cad6-b14c-43ce-80d55e1b7803\",\n \"organization_id\": \"2371400c-2960-93b4-e4ee-494b5131d1c0\",\n \"team_id\": \"d909ac83-0601-d47c-ebe6-98a86f155ad3\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"3cc0b3ba-1eca-b807-6713-8aa671e32c02\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": true,\n \"created_at\": \"1978-05-05T02:29:20.451Z\",\n \"updated_at\": \"1999-07-26T10:36:20.346Z\"\n }\n ],\n \"total\": 6171\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fae9a17-4cdd-4f1e-b38f-a4ad8ac9a9ec", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e85e5f5d-4544-47df-94de-d408a1109c55", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea46b20-6aed-4d00-803b-7218edc7145f", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "620826aa-a3e4-48ca-afb6-bffab0478cba", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e26bddc5-09a2-4fd4-9093-9917749bb76b", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "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 \"RjTYT7ZpY0E@ZosmcrCmaoEjjhlusYecnIUhkVWj.vadb\",\n \"ANj2sFN@bjEaguEYESF.yfr\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"cff68bec-8c42-d182-06c1-7a9024245638\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7ac5a221-46fd-4db4-a3b5-488ea93ea445", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cad7f44a-31e4-1134-9f1e-7a2ba2f24488\",\n \"organization_id\": \"14ddc1d0-cb98-9bbc-9ba1-9927efeb4128\",\n \"team_id\": \"9cb4cadd-1041-890e-5f23-334ddbe8b961\",\n \"name\": \"string\",\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"17be27fb-01c4-499a-9dd6-abdb65797e99\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"string\",\n \"string\"\n ],\n \"is_active\": false,\n \"created_at\": \"1966-03-16T04:59:13.494Z\",\n \"updated_at\": \"2016-03-19T07:36:22.052Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d6276d8-e985-4ce8-887d-3ac68d73a452", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdc88ed9-09df-405d-bc1c-25fcc3c87b6c", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0cfbd6-bfb1-4fe1-b579-593ce34712fc", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c71ad84b-b462-4dcf-9ae5-07b69b78ae93", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "key": "team_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"channels\": [\n \"string\",\n \"string\"\n ],\n \"email_recipients\": [\n \"0V95@fHprQoPQQMaDyuquFUAlhhgKbyttdfPla.um\",\n \"6wm2Fa@GTVNUeBlBtNARZbaeNNFSvwCrKfi.vyq\"\n ],\n \"is_active\": true,\n \"kinds\": [\n \"string\",\n \"string\"\n ],\n \"min_severity\": \"string\",\n \"project_id\": \"272d297d-34f8-6cea-581b-1cde1043a19f\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b04f250-cc0b-4f31-b8f8-8e95a3a8366e", "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": "c757b524-8277-6ade-394f-1190c4cf3de9", "key": "rule_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "56082508-fb77-43d1-94fd-ab6466c5881d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "c757b524-8277-6ade-394f-1190c4cf3de9", "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": "579be126-15ee-4277-8520-b1e083857e3a", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "c757b524-8277-6ade-394f-1190c4cf3de9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdb6a9f7-7ba8-4845-99d2-4b301d387c3b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "c757b524-8277-6ade-394f-1190c4cf3de9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ecfae67-c66a-4150-847f-8de22afa306d", "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": "c757b524-8277-6ade-394f-1190c4cf3de9", "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": "acab7460-dd20-4dfd-81b2-e1661b8f45b4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notification-rules", ":rule_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "c757b524-8277-6ade-394f-1190c4cf3de9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe97e738-9f83-4b4b-9e85-13e02b592098", "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": "7cd049ab-ca95-4b22-8276-4de1e794b161", "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\": \"c1031bf1-e5e4-3943-547e-b9a0a773b6f7\",\n \"kind\": \"cve_detected\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"link\": \"string\",\n \"target_table\": \"string\",\n \"target_id\": \"4d589bd4-3b59-29f7-747e-3a8b15f9099d\",\n \"read_at\": \"2013-10-25T08:17:22.704Z\",\n \"created_at\": \"1978-07-19T12:40:11.524Z\"\n },\n {\n \"id\": \"d76c9b83-cad4-a2a0-cc9f-0f924ad55375\",\n \"kind\": \"scan_completed\",\n \"title\": \"string\",\n \"body\": \"string\",\n \"link\": \"string\",\n \"target_table\": \"string\",\n \"target_id\": \"81e4f110-208b-7661-099c-fcb1126af3f9\",\n \"read_at\": \"1968-04-25T01:30:23.647Z\",\n \"created_at\": \"1964-09-22T07:08:05.852Z\"\n }\n ],\n \"total\": 929,\n \"unread_count\": 1608,\n \"page\": 3848,\n \"page_size\": 4367\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cec64ac3-f4cb-4d9d-b824-89d55aa95257", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "264c811d-b740-445e-a0cc-37d98148ea5a", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "391fdabf-6583-4b5b-94d9-56d627363e72", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "957aedb1-c2ec-4f18-915c-a11a2df34a1d", "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": "d7ffaaa0-a7cd-4912-969a-17fa2e8775b0", "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": "79533459-ecdd-44e6-8f12-2f4be983ae97", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "998f79ca-f51c-4c6e-8fb3-18554a975583", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "546274c0-25cc-48b1-92c8-e07c243a72de", "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": "ff6fab19-7b25-4b86-b854-62843e27c15e", "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\": 7364\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89955209-d160-4c43-998c-8f6a00c7023a", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "048f007a-4dc8-4e11-8444-41f34760e2b2", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b54f4740-b9e2-40c4-bd87-cee4a7e10622", "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": "ea16aeea-0d1f-473d-4a0d-3f9198c8f569", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4e541c10-6d9d-4bd3-b65d-bc11cefd0a30", "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": "ea16aeea-0d1f-473d-4a0d-3f9198c8f569", "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": "7353f8df-9c87-44fa-b33c-ba746bbc9e2c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ea16aeea-0d1f-473d-4a0d-3f9198c8f569", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9f95f7f-bacc-4aec-9ce0-b7d8f21dc07d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ea16aeea-0d1f-473d-4a0d-3f9198c8f569", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95a1fbff-8fc3-4fa8-92a5-f73d35e77b13", "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": "ea16aeea-0d1f-473d-4a0d-3f9198c8f569", "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": "e7f2f829-e059-4764-a22c-bb0c2697021a", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "notifications", ":notification_id", "read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ea16aeea-0d1f-473d-4a0d-3f9198c8f569", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "49fa8cd7-17da-426a-9aa7-fb0b18631dc4", "name": "organization-verdicts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5b1028a5-a76b-45a9-8fed-3d8206c3f5b6", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "key": "component_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "05588091-ff8d-4ff9-9820-3ca35269d667", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": \"3e1f111c-c483-7a79-ec1d-e913c2799af1\",\n \"component_id\": \"7c29b30b-2529-6918-eea2-f8a63d783d51\",\n \"scope\": \"string\",\n \"justification\": \"string\",\n \"status\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdb2259f-bced-4aff-ab7f-767c68d8b58f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "383a001f-5d07-4ab7-9d81-7b03f64c631f", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10f4ddae-da62-4f56-96e3-843f79f9e50b", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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": "c4d5acd4-aedb-45d0-a809-ab161d11dc79", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "effective", ":project_id", ":component_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "559a18bf-5ff1-1e63-6f1f-ac231550844c", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ee3cf57-a060-4913-a1dd-d91589472deb", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "51dd946a-ff17-4395-85a7-9b51ea1743b8", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"f9f90e2b-ee33-1ff0-2900-16c021d93ed7\",\n \"organization_id\": \"15548926-a093-6c87-ea50-d73fdf3ead17\",\n \"component_id\": \"a49bba6d-ed36-ae84-672e-02bcfeae2b93\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"1956-06-19T19:29:23.878Z\",\n \"version\": 7714,\n \"created_at\": \"1986-08-09T10:37:29.799Z\",\n \"updated_at\": \"2023-09-18T05:55:00.033Z\"\n },\n {\n \"id\": \"0dbdfe23-0f27-533d-9c61-9c8d131a2086\",\n \"organization_id\": \"18575b3d-0c6b-a75d-c61d-45acdd1b531f\",\n \"component_id\": \"49f0e78f-4c2d-7ae5-7668-96d08a01f6d5\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"1974-10-02T16:52:59.002Z\",\n \"version\": 2165,\n \"created_at\": \"1946-10-04T22:01:29.200Z\",\n \"updated_at\": \"2021-06-23T13:33:46.331Z\"\n }\n ],\n \"total\": 4446,\n \"page\": 1,\n \"page_size\": 50\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d46e7975-79c3-4a5f-b333-3bb20c1a9eeb", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ecc31f3-b302-4e0b-9e11-759dbd348b2b", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b206049f-440f-4012-8aa3-5c79895f760e", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c290b78e-eb55-4412-b641-2728513b681a", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "208348e4-eb22-44e6-ae31-9b132b92b05d", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"6bb89842-75e8-5b7e-7158-f5a56ccaf6c7\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "178ebd58-4bf6-40dc-9038-155cb9a0775a", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"6bb89842-75e8-5b7e-7158-f5a56ccaf6c7\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"2ba56d37-c1c0-b3c6-cffa-1ef99b89e3b8\",\n \"organization_id\": \"6091f98f-cf2b-62d5-255d-3f59c2706434\",\n \"component_id\": \"0a7572be-80c3-10fa-bbca-772f1c035556\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"1953-01-29T16:13:03.512Z\",\n \"version\": 9803,\n \"created_at\": \"1972-08-25T02:06:41.495Z\",\n \"updated_at\": \"1950-06-13T04:13:22.897Z\",\n \"decided_by_user_id\": \"4a77e753-7867-18d7-f4c7-87b4591e8bd2\",\n \"decision_note\": \"string\",\n \"requested_by_user_id\": \"235c5a8e-7ef4-3a1a-0a1e-9dcdf5d51af3\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec5a03e3-6394-4cb1-9bd8-a683e11f9124", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"6bb89842-75e8-5b7e-7158-f5a56ccaf6c7\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92fdbd3d-3f94-46b4-9d8d-72e4b1862e86", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"6bb89842-75e8-5b7e-7158-f5a56ccaf6c7\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "733d9e42-c12a-495b-a22d-163c7a42c3a5", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"6bb89842-75e8-5b7e-7158-f5a56ccaf6c7\",\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": "2bccb638-afa7-421d-aa13-2f9e3fc42d79", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"6bb89842-75e8-5b7e-7158-f5a56ccaf6c7\",\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": "9f5a17c5-fe36-4237-ba01-c72d0cdf3354", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"component_id\": \"6bb89842-75e8-5b7e-7158-f5a56ccaf6c7\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e948bc5b-c35f-4ba8-9503-d6721d88340e", "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": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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": "e15fa955-b74f-4460-b97a-19cebf9d1d8b", "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": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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\": \"2ba56d37-c1c0-b3c6-cffa-1ef99b89e3b8\",\n \"organization_id\": \"6091f98f-cf2b-62d5-255d-3f59c2706434\",\n \"component_id\": \"0a7572be-80c3-10fa-bbca-772f1c035556\",\n \"status\": \"string\",\n \"justification\": \"string\",\n \"decided_at\": \"1953-01-29T16:13:03.512Z\",\n \"version\": 9803,\n \"created_at\": \"1972-08-25T02:06:41.495Z\",\n \"updated_at\": \"1950-06-13T04:13:22.897Z\",\n \"decided_by_user_id\": \"4a77e753-7867-18d7-f4c7-87b4591e8bd2\",\n \"decision_note\": \"string\",\n \"requested_by_user_id\": \"235c5a8e-7ef4-3a1a-0a1e-9dcdf5d51af3\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e56c111-3864-4346-a5de-087b9dcb905b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df4eb34b-24f5-484b-a9f4-e89d490c143b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c0e057-fec2-4afe-a8fe-376b94afa75b", "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": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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": "5f0fa83f-4408-4bef-8176-8251c997ab28", "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": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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": "30cadd6f-5a41-43b7-a788-8b5493779e2c", "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": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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": "2e206132-748d-41ba-b6b6-0b2e14d29478", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "organization-verdicts", ":verdict_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9114d1ca-05b4-47af-be03-3f9530c0b1db", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7f6c119a-df35-4ce6-af80-8c87b410de74", "name": "projects", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c9b39c0d-7446-4d26-8c50-c135a6d616d4", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "af31651f-ab95-4532-a254-10961487d75e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": \"04aedb2b-11ba-30de-9062-2a895a1df2ce\",\n \"team_id\": \"e9d7ab50-8dd2-54a9-37cc-04524a5b37aa\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"organization\",\n \"archived_at\": \"1951-07-23T16:22:09.358Z\",\n \"created_by_user_id\": \"c5770d45-a8c3-c8df-1cba-c2cb8d71b750\",\n \"latest_scan_id\": \"b72a4c85-36e2-c657-3ff2-454952ab1df1\",\n \"created_at\": \"1952-09-24T01:08:27.983Z\",\n \"updated_at\": \"1959-01-19T10:56:03.358Z\",\n \"ai_usage_context\": \"internal\",\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\": \"1948-01-21T13:08:45.771Z\",\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 \"id\": \"57b0159f-6bea-e6bd-76e8-0d3229778a58\",\n \"team_id\": \"97bcef94-be89-dd15-f8f8-b8fd162338aa\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"organization\",\n \"archived_at\": \"1947-05-16T07:31:13.622Z\",\n \"created_by_user_id\": \"12cdd250-2423-1cc0-cea0-648dd8be5cef\",\n \"latest_scan_id\": \"f9e4ad29-2dea-264e-3697-927943a7974c\",\n \"created_at\": \"2017-11-05T00:57:47.441Z\",\n \"updated_at\": \"1962-02-03T10:22:08.221Z\",\n \"ai_usage_context\": \"outputs-only\",\n \"business_unit\": \"string\",\n \"created_by_user_name\": \"string\",\n \"declared_license\": \"string\",\n \"distribution_model\": \"saas\",\n \"group_path\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"2003-06-20T11:01:36.931Z\",\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 \"total\": 6042,\n \"page\": 6658,\n \"size\": 4001\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ded993c1-886b-4337-a91e-f8f44b40c267", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e514438b-e309-4d9e-bc92-ecc9719bf02e", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f01b167-39d9-4cdc-9004-221777706e96", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85563485-e50b-456a-b21c-d3db90186c01", "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": "8b5f4312-f5a8-4c00-8977-0d3c8dde1041", "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\": \"f0f81a19-4a02-d6a6-e672-61bfc6443e77\",\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\": \"saas\",\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\": \"cfb285a1-bd73-ee98-b090-f30f3037b276\",\n \"team_id\": \"4f1a8c1a-25ad-562e-d61f-9ef1b3dd8a5f\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"team\",\n \"archived_at\": \"1971-07-17T02:17:35.420Z\",\n \"created_by_user_id\": \"ffe10286-19f9-9869-9067-76f6b83532bf\",\n \"latest_scan_id\": \"2e5302ca-a467-7e49-fd3a-9450cd238955\",\n \"created_at\": \"1969-10-17T13:36:08.353Z\",\n \"updated_at\": \"1959-08-16T17:50:10.168Z\",\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 \"id\": \"8d5af587-b6fc-6f64-a9f5-50b5e40db03b\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"056e429c-4b60-ba73-86d4-26b689a981b3\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"1998-07-01T17:41:08.225Z\",\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": "2306c377-378f-409c-8803-2e7ff50e38cf", "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\": \"f0f81a19-4a02-d6a6-e672-61bfc6443e77\",\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\": \"saas\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e78fa197-917d-4f82-87ac-98215a2f9c42", "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\": \"f0f81a19-4a02-d6a6-e672-61bfc6443e77\",\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\": \"saas\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a994430-9d4f-4656-8bcf-3b5158abfc15", "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\": \"f0f81a19-4a02-d6a6-e672-61bfc6443e77\",\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\": \"saas\",\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\": 6862,\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": "860fd56a-385c-4121-a9ea-e974b4675538", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "03a2296e-fcee-45c5-9768-20e5e31f0dfa", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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": "4456b9e7-156b-45a9-8482-9588b04756e4", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba2fdafc-ef0d-4605-a0e3-577103ec7a19", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "207408b6-cce5-4833-ba07-a89096f05639", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", "export.csv" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9666fb6b-9a73-4948-9fcb-ad66b4b3d7a9", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bd3d79d9-6907-4a43-8757-704f92b9b918", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "2b4ebc51-5d08-4990-b20c-fcfff83532e9", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a341e2e0-74c0-4a3e-94aa-3591b1ad2ad0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50872b89-43c3-471f-8f4f-b478e87aa200", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20c7bb4c-d039-4acf-bb2b-91d6385699df", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf11a7f9-9e0b-42d4-9d2d-15e08b83604d", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c9d1e3ec-fd41-4dd3-a732-0300f19b9413", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"cfb285a1-bd73-ee98-b090-f30f3037b276\",\n \"team_id\": \"4f1a8c1a-25ad-562e-d61f-9ef1b3dd8a5f\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"team\",\n \"archived_at\": \"1971-07-17T02:17:35.420Z\",\n \"created_by_user_id\": \"ffe10286-19f9-9869-9067-76f6b83532bf\",\n \"latest_scan_id\": \"2e5302ca-a467-7e49-fd3a-9450cd238955\",\n \"created_at\": \"1969-10-17T13:36:08.353Z\",\n \"updated_at\": \"1959-08-16T17:50:10.168Z\",\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 \"id\": \"8d5af587-b6fc-6f64-a9f5-50b5e40db03b\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"056e429c-4b60-ba73-86d4-26b689a981b3\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"1998-07-01T17:41:08.225Z\",\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": "ef9b2308-a305-4f9a-9b26-d35478f4f8c3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704695a9-5cf5-4bdd-9e16-369b780533b7", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d957f58-3bde-4b7c-bcec-e960f46d2d31", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ed7c9cc-3d17-4741-bc8b-72c02e626d9d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1bc9763-f59f-47aa-ad69-0e9e81fdecd4", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"product\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\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": "14950f54-0ff0-4c5f-a283-246d05bdd48b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"product\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\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\": \"cfb285a1-bd73-ee98-b090-f30f3037b276\",\n \"team_id\": \"4f1a8c1a-25ad-562e-d61f-9ef1b3dd8a5f\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"description\": \"string\",\n \"git_url\": \"string\",\n \"default_branch\": \"string\",\n \"visibility\": \"team\",\n \"archived_at\": \"1971-07-17T02:17:35.420Z\",\n \"created_by_user_id\": \"ffe10286-19f9-9869-9067-76f6b83532bf\",\n \"latest_scan_id\": \"2e5302ca-a467-7e49-fd3a-9450cd238955\",\n \"created_at\": \"1969-10-17T13:36:08.353Z\",\n \"updated_at\": \"1959-08-16T17:50:10.168Z\",\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 \"id\": \"8d5af587-b6fc-6f64-a9f5-50b5e40db03b\",\n \"name\": \"string\",\n \"slug\": \"string\"\n },\n {\n \"id\": \"056e429c-4b60-ba73-86d4-26b689a981b3\",\n \"name\": \"string\",\n \"slug\": \"string\"\n }\n ],\n \"has_git_credential\": false,\n \"last_scan_at\": \"1998-07-01T17:41:08.225Z\",\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": "4327ac59-19eb-4e10-99dc-720bac736208", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"product\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "135738e9-c5e1-4ade-aac9-97c450517623", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"product\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6693ced5-a57c-4be4-9a9a-01e8647e6cde", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"product\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c0fe0a8-73d0-4825-959f-4aafa06bf1a3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ai_usage_context\": \"product\",\n \"business_unit\": \"string\",\n \"clear_git_credential\": false,\n \"declared_license\": \"string\",\n \"default_branch\": \"string\",\n \"description\": \"string\",\n \"distribution_model\": \"embedded\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5705af91-100a-4ff1-94ac-2a37fb5b5701", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "82c8ba47-b2c5-44ba-9692-31fef597cbe4", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"da8d462a-ce9a-35eb-bdbd-c8ca08e3e442\",\n \"full_name\": \"string\"\n },\n {\n \"user_id\": \"69c065c0-fa2e-8048-9691-ceda58edee7a\",\n \"full_name\": \"string\"\n }\n ],\n \"total\": 7579\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a3f065d-5e8c-40aa-ba70-cd129d6f282c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c151386-009d-40f4-b286-a6b2a3d050c3", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "e39847a4-4019-46c5-b7c2-3c26280a2b29", "name": "No such project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "d2092c1a-a758-46d7-80f8-a2fc864b96f7", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "assignable-members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08c11cf3-4046-41e7-bba7-2cd3de94599e", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e91d508e-d643-4068-b922-bfb18412a3a8", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"ba922fe9-b446-cb72-cc0e-ded6cd8157bf\",\n \"component_id\": \"70dee3a7-9c4c-ad7a-06f9-60a86ddbf7e2\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"license_category\": \"allowed\",\n \"severity_max\": \"info\",\n \"vulnerability_count\": 2941,\n \"currency_latest\": \"string\",\n \"currency_state\": \"outdated\",\n \"dependency_scope\": \"required\",\n \"depth\": 678,\n \"direct\": false,\n \"eol_date\": \"2009-12-06\",\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 \"id\": \"377f4698-7bca-9e03-4cd9-cb904607e2c5\",\n \"component_id\": \"c533fae8-5bfe-611a-bae4-ee0ddc23b567\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"license_category\": \"unknown\",\n \"severity_max\": \"medium\",\n \"vulnerability_count\": 982,\n \"currency_latest\": \"string\",\n \"currency_state\": \"unknown\",\n \"dependency_scope\": \"required\",\n \"depth\": 4374,\n \"direct\": false,\n \"eol_date\": \"1970-11-03\",\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\": 128,\n \"limit\": 716,\n \"offset\": 1714\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c21e887a-4042-4628-9d66-23047b11cbf1", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51352568-2d20-460e-ad33-495eb5715953", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecf72758-ffd1-4550-b33a-4bac629e744a", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "642ec36e-89fb-4985-8625-505a4cc7da61", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dbe23975-9ace-4190-91f5-33150b7c2f74", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4569a6c7-ddf9-4c6b-84d5-f0f34480d099", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "4eb409e2-6526-4090-a5f5-247983a9577b", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b9a806-6b0a-43c2-8276-d94f47f06522", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c552c0a-ce0f-43de-b002-8b97353ef3b3", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bab64b9-4c56-42c6-b5c6-1e94d70b3120", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09087cb5-8de5-406b-88b0-e41044a309f3", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ca850dab-8081-4ce7-b0d9-d89f8ba6ee27", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"651bea87-785c-6307-f48d-07dd0e497d58\",\n \"node_count\": 9566,\n \"edge_count\": 5118,\n \"node_cap\": 2776,\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\": true,\n \"depth\": 4363,\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\": 6073,\n \"max_severity\": \"none\",\n \"namespace\": \"string\",\n \"vulnerability_count\": 0\n }\n ],\n \"truncated\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c929fe5f-9c69-42e8-b187-f549e0dc8c2b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56addce6-5042-4ef3-a408-1820d1334b80", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b72d9f56-20c7-4ff1-bc67-fb33e0e799d9", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "fa2046a0-aa9f-405a-b07f-c07f16f6b49e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "dependency-graph" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95be7829-8a23-4743-bb0e-a21d3e6a077d", "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": "2abfbb52-ab1c-f821-5091-17875d89c341", "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": "d67287c3-24ae-4218-b7fd-60c92a1dc61d", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5261ac9d-5cc6-4a1a-af9e-2d0b492dcadc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "2abfbb52-ab1c-f821-5091-17875d89c341" }, { "key": "target", "value": "d67287c3-24ae-4218-b7fd-60c92a1dc61d" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"69dc749c-1159-217c-481d-8ce648873301\",\n \"created_at\": \"1965-08-19T02:05:46.210Z\",\n \"release\": \"string\"\n },\n \"target\": {\n \"scan_id\": \"2679d2ce-a4a6-9864-06d3-d63fc30ad6cb\",\n \"created_at\": \"1962-07-11T16:00:43.935Z\",\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": "8193f8bc-34d0-42df-94a3-0922ac8327e1", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "2abfbb52-ab1c-f821-5091-17875d89c341" }, { "key": "target", "value": "d67287c3-24ae-4218-b7fd-60c92a1dc61d" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9477c571-af0f-45e6-85ff-ab56234745b5", "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": "2abfbb52-ab1c-f821-5091-17875d89c341" }, { "key": "target", "value": "d67287c3-24ae-4218-b7fd-60c92a1dc61d" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "65ee5944-9a39-46d9-b2c6-81237c523162", "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": "2abfbb52-ab1c-f821-5091-17875d89c341" }, { "key": "target", "value": "d67287c3-24ae-4218-b7fd-60c92a1dc61d" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "94004d4a-1446-4ad2-8dda-2d41b7f54159", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "diff" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "base", "value": "2abfbb52-ab1c-f821-5091-17875d89c341" }, { "key": "target", "value": "d67287c3-24ae-4218-b7fd-60c92a1dc61d" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f09a79f-3c1a-4029-a268-879472eeaaa7", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "286d5c9f-27c2-4652-8abf-1f11636bb6b6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"f2b5f524-2771-6930-ce64-ddce755104f9\",\n \"scanned\": false,\n \"risk_score\": 18.88528309624913,\n \"gate\": {\n \"critical_cve_count\": 224,\n \"forbidden_license_count\": 7735,\n \"epss_gate_count\": 3345,\n \"malicious_component_count\": 0,\n \"scan_id\": \"5c76b796-e15b-c11a-89c4-b06c40ca8588\",\n \"status\": \"string\"\n },\n \"kev_sla\": {\n \"overdue\": 1099,\n \"due_soon\": 1938\n },\n \"pending_approvals\": 3828,\n \"trend\": [\n {\n \"scan_id\": \"0b07f077-46be-7c92-8f34-7102f33d9473\",\n \"scanned_at\": \"2026-08-31T02:07:40.138Z\",\n \"critical\": 113\n },\n {\n \"scan_id\": \"1187b640-5aed-f6ed-3c58-196514b955d9\",\n \"scanned_at\": \"1987-10-28T02:00:21.124Z\",\n \"critical\": 6739\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5646b453-3bba-4fc4-af72-9b7ece4467cc", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9c59472-82a2-49c7-a97f-f51a2d507a83", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17677cf9-fde0-432a-bbc9-3eb9a59f6f34", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa4439b4-c1f4-4d21-946b-eab20cf84967", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "governance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16fccca9-3dee-48a6-b3e6-176ecb73d9b0", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c9c7aa35-4ee2-46b2-a028-b9f12837a8ae", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"589b647d-f2c1-61e9-5a23-077d7173d9f8\",\n \"project_name\": \"string\",\n \"total_components\": 5896,\n \"risk_score\": 94.24429598131539,\n \"security_score\": 47.86500340201052,\n \"license_score\": 38.52438443722874,\n \"current_user_role\": \"super_admin\",\n \"component_outcome\": \"string\",\n \"eol_count\": 0,\n \"has_git_credential\": false,\n \"last_scan_at\": \"1984-06-12T15:50:12.697Z\",\n \"last_succeeded_scan_at\": \"1980-03-24T15:13:47.342Z\",\n \"license_distribution\": {\n \"key_0\": 609,\n \"key_1\": 399\n },\n \"malicious_count\": 0,\n \"outdated_count\": 0,\n \"recent_scans\": [\n {\n \"id\": \"640ed49a-5afd-ea5d-165e-f8db374c384b\",\n \"kind\": \"string\",\n \"status\": \"string\",\n \"progress_percent\": 9163,\n \"started_at\": \"2007-03-21T11:06:10.942Z\",\n \"completed_at\": \"1953-03-20T06:22:24.410Z\",\n \"created_at\": \"2023-01-15T11:13:14.650Z\",\n \"ref\": \"string\",\n \"release\": \"string\"\n },\n {\n \"id\": \"a4dd197e-7bfe-d8ea-43f7-314a491a601f\",\n \"kind\": \"string\",\n \"status\": \"string\",\n \"progress_percent\": 5169,\n \"started_at\": \"1966-11-13T13:22:03.081Z\",\n \"completed_at\": \"1988-05-09T15:36:13.238Z\",\n \"created_at\": \"1956-12-08T03:23:36.074Z\",\n \"ref\": \"string\",\n \"release\": \"string\"\n }\n ],\n \"severity_distribution\": {\n \"key_0\": 9029,\n \"key_1\": 4499,\n \"key_2\": 4150,\n \"key_3\": 1983\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63c20478-3b24-412f-a2f4-1079e735e280", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7be3c641-31f4-4bd8-8cef-ea251548f272", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bcacc3d-e8e0-40fa-80e1-9abd65c0a87e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ae766c3-a454-4abb-a9ef-070be75267ac", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "overview" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a13a574-9422-4fec-9a0c-68dcb3da5311", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fb71322f-18c5-4f44-a1b4-faeedbf2e763", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "25c5e02b-f0c6-45af-96d8-8c95b9dc6986", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac6615ab-fd07-413e-b90c-18849077e02d", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "306d36c3-1b56-445f-9e53-d49ca61d1aac", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "9e2faa44-d2cb-4106-a58a-d57280cf3eb1", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1de08bc7-9993-4e4d-b4d6-a8daf0f61f33", "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": "b8598b61-e8c2-46f3-9c83-066af46c4f4b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9985.5562525977\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"cbb0ec47-989d-eaf7-913b-a3c8cbeaef42\",\n \"project_id\": \"5567c191-ba9a-a845-4177-5c6d24afce54\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 2634,\n \"current_step\": \"string\",\n \"started_at\": \"1985-04-17T13:14:50.752Z\",\n \"completed_at\": \"2000-10-02T19:09:10.018Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"8633caf2-6e3f-33e5-ddf8-6650fd3a1724\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"1958-06-05T06:46:27.327Z\",\n \"updated_at\": \"2019-08-21T00:18:29.097Z\",\n \"metadata\": {\n \"key_0\": 9747.715732425615\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"2011-05-28T12:30:49.638Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "073d7903-839b-4b55-805c-261ced47c766", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9985.5562525977\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d291100-7ed8-44cd-a6f6-639d865e201f", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9985.5562525977\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "485a293f-892a-4ac7-a740-aa2ff9fc6402", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9985.5562525977\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f4ff44b-c6d7-4b44-9120-8389dc898498", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9985.5562525977\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b18293-6e4f-47b2-b03e-08cf717ab7f7", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9985.5562525977\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": "5664366c-e8bf-45ba-92ea-e17725ba22f3", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "913c0420-b3c6-49a1-8ecc-1a68e9b5d2b7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "ba8da784-9821-4d7a-9a07-9ae83f01f67b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7e7a30a-9de8-4845-a91c-46b2ed08db55", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7eab5a43-288f-4b7a-ac03-8177f2e5b5ee", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b395b41-50c1-4b67-a84b-9c3eb99fafb1", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "source-archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8dee1f5c-934d-49fe-87f6-d83d8ad3e20e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2e628f33-9d76-4850-9d85-b0aa5be69e44", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"fbcb01e1-0afd-5e58-86ed-fafe912e7fb3\",\n \"configured\": false,\n \"provider\": \"github\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91e79131-152b-4516-9389-de0991c0855c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0d73ef7-f124-43ab-b1f1-125cd96d322f", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "15b15a39-c6a8-4695-bfe3-99734d9bab61", "name": "No such project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "9401b922-5130-4d58-8e8d-c782ad6bebbe", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83eedb46-4ab2-4ea6-b383-52bdad36f6d6", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "09a13c2f-b9e9-48b9-ab96-7a9207aa60bd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"project_id\": \"af4b28aa-8026-773c-a767-3ca25ca74ef2\",\n \"provider\": \"github\",\n \"issued_at\": \"1948-02-01T10:32:04.478Z\",\n \"replaced_existing\": false,\n \"secret\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4259e11-c96f-4671-b3f6-fc9783bd28f3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c96f24d-52a9-4a30-a569-4b7524912b32", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00fe7463-d9de-465b-816f-8d80f6c19333", "name": "No such project.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54abe91b-dde9-4da2-81a2-09598d864e2f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "webhook-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c2e8bc-c140-40e9-ae8a-c178a9ef8c18", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"provider\": \"github\"\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": "0f08ae6d-1642-45a2-a839-b4cf6df6a505", "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\": \"c3ff63fa-c690-d5ea-0e41-f9b1823479ed\",\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 }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fbcc54d3-5eb0-4d52-84f3-b0ff02b4edb9", "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\": \"c3ff63fa-c690-d5ea-0e41-f9b1823479ed\",\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 }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"all_succeeded\": false,\n \"total\": 8516,\n \"created\": 2508,\n \"already_existed\": 3205,\n \"failed\": 4735,\n \"rows\": [\n {\n \"index\": 5626,\n \"status\": \"created\",\n \"detail\": \"string\",\n \"project_id\": \"25cee540-3883-efff-7790-cf0090d0b1b4\",\n \"retry_after_seconds\": 3473,\n \"scan_id\": \"ca62b9c9-15c3-1b42-2cd0-aa5e2a218a5a\"\n },\n {\n \"index\": 4366,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"ab68b34d-7c6c-bc8f-0cd7-104c49c8a164\",\n \"retry_after_seconds\": 3894,\n \"scan_id\": \"51189021-7e62-c215-b702-95509fc535ca\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 7136\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4bd8046-c608-4de4-8f6d-35a3d93ff278", "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\": \"c3ff63fa-c690-d5ea-0e41-f9b1823479ed\",\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 }\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\": false,\n \"total\": 8516,\n \"created\": 2508,\n \"already_existed\": 3205,\n \"failed\": 4735,\n \"rows\": [\n {\n \"index\": 5626,\n \"status\": \"created\",\n \"detail\": \"string\",\n \"project_id\": \"25cee540-3883-efff-7790-cf0090d0b1b4\",\n \"retry_after_seconds\": 3473,\n \"scan_id\": \"ca62b9c9-15c3-1b42-2cd0-aa5e2a218a5a\"\n },\n {\n \"index\": 4366,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"ab68b34d-7c6c-bc8f-0cd7-104c49c8a164\",\n \"retry_after_seconds\": 3894,\n \"scan_id\": \"51189021-7e62-c215-b702-95509fc535ca\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 7136\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e927a28-64a7-4cfe-afaa-a409709a865e", "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\": \"c3ff63fa-c690-d5ea-0e41-f9b1823479ed\",\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 }\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d63a8672-1220-4c53-9b3c-8697845040c7", "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\": \"c3ff63fa-c690-d5ea-0e41-f9b1823479ed\",\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 }\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ebc90a7-2a35-4837-8654-c1e453f16853", "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\": \"c3ff63fa-c690-d5ea-0e41-f9b1823479ed\",\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 }\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3cb1799a-c445-4699-be64-57c4f16a12a5", "name": "compliance", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "10ab17b6-5d66-4021-a453-13af9d09bb0e", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "41845a67-7a52-4a84-9d1f-6243b6b90e5a", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"85429776-bf71-95ab-96c1-0e5bcb128642\",\n \"license_id\": \"7c20d62d-ccbd-fc92-84f9-1bbf484e4fbc\",\n \"license_name\": \"string\",\n \"category\": \"allowed\",\n \"kind\": \"declared\",\n \"affected_component_count\": 1801,\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\": \"ea10d668-37b7-4f9b-94ca-980df5787af7\",\n \"license_id\": \"e97f6f04-7189-07eb-c846-7b4d97c180c2\",\n \"license_name\": \"string\",\n \"category\": \"unknown\",\n \"kind\": \"concluded\",\n \"affected_component_count\": 4437,\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\": 9770,\n \"limit\": 207,\n \"offset\": 6710,\n \"generated_at\": \"1972-08-28T12:28:30.490Z\",\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": "7d6db14f-4641-486a-a73f-2199a8677f80", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "117e144a-f794-4839-8e45-a79a2e7801d2", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "047a4671-7496-47e2-bac6-70f4384eae73", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3faada1-bc9c-4741-a7b3-0d620881a1cc", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8c2acc10-c72c-4cbb-b1c2-19fc60c76ae4", "name": "policy-gate", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "152d5e74-fd0d-40de-ad5e-4c020539b515", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "40c6cac3-1ec1-4ffe-8596-d837411b54ff", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"fail\",\n \"critical_cve_count\": 3951,\n \"forbidden_license_count\": 6782,\n \"project_id\": \"f966623f-ade1-0de5-9feb-3f52c30699c4\",\n \"evaluated_at\": \"2009-07-11T22:22:25.986Z\",\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.6402329935354141,\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\": \"a306fb99-eff5-f2d8-bdbe-50edcb95c801\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0995de02-2c86-448a-92e0-1c250ce57a07", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6a1ad0d-6c74-4d6b-8b01-aa906a63c565", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44158e92-b423-4fae-bdd6-4fa3e17886a4", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4877fc-6061-49c8-addd-467f013929d4", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f416a65b-da1a-4b41-b8e1-f57266eeaecc", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/sarif+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9c815254-984d-4715-ae1d-08121cc4ac8d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "76e0c030-8ebd-4678-8cc3-456b083c312d", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c99f9fd3-1abc-4548-8b3c-f8b0856ad4a3", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd8312ac-668f-4c60-b739-b10589c045a9", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e227d905-059b-4ccb-b5ba-1d3d58102257", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "gate-result", "sarif" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "ref", "value": "string" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c28b434c-9d58-4bbb-8f70-21aa5b9f2fc8", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 8149622,\n \"dry_run\": false,\n \"provider\": \"github\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e7ddb99b-7de0-40c0-8f15-974e65a4a6d0", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 8149622,\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\": \"posted\",\n \"body_preview\": \"string\",\n \"gate\": \"fail\",\n \"comment_id\": 3190,\n \"comment_url\": \"string\",\n \"provider\": \"github\",\n \"provider_assumed\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea70f49-7623-49b6-9430-ce90f84985cf", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 8149622,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d4ad1c6-4785-4012-9c00-7471e8250da6", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 8149622,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "362aac11-2e1c-4821-b2d7-bedd7ec3e29e", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 8149622,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e2dc8f-82df-42e7-a8bb-777794aa5546", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "post-pr-comment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 8149622,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "657ff50d-7b3c-44cc-8a38-248cce24a38c", "name": "obligations", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a17ed4b5-5db5-43f3-9ff4-252dc4ab6593", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b7239e94-c9db-4a8e-ae6c-1beb6fff1ff4", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "7ec21f5b-8abc-47b0-89dd-d12477d98676", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "900560cb-1fab-49a0-8c26-4299d4fbbf42", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "356d30d3-2229-4bde-a03f-481144719219", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "f6f84da6-8219-4bf6-8842-e49f04e8a338", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ae14659-be15-4bc8-92b8-6f5006dc035a", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "87069138-9fd6-4c2d-861c-8c23d8fab01d", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "56e02576-292f-4eea-8b41-dd6e1eb0810d", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"4990c37c-bfb2-0e2f-311a-328d5b34c10e\",\n \"project_id\": \"74e44a07-c74b-e856-4054-126f98315f2a\",\n \"obligation_id\": \"d3421330-7181-e231-95f0-0c8830bfb27f\",\n \"status\": \"string\",\n \"assignee_user_id\": \"bc2c8c1c-ad62-9340-3625-3883fc08f9cd\",\n \"due_on\": \"1970-07-31\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\",\n \"completed_at\": \"1973-08-31T22:01:00.093Z\",\n \"completed_by_user_id\": \"85ad798b-657a-8f27-43a8-929c341ca3d5\",\n \"version\": 3798,\n \"created_at\": \"1995-11-04T22:50:15.531Z\",\n \"updated_at\": \"1962-05-14T07:33:39.721Z\"\n },\n {\n \"id\": \"d3d99e70-3a29-31c2-ad72-773ffc6c6eac\",\n \"project_id\": \"80d71e21-c24e-9b88-7727-bb767c5e0c5d\",\n \"obligation_id\": \"9fa52be3-2707-7a74-efae-7c1f2bd7bfe1\",\n \"status\": \"string\",\n \"assignee_user_id\": \"c8250b58-8bf7-fd79-936c-36e6a78f22fe\",\n \"due_on\": \"2007-06-28\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\",\n \"completed_at\": \"2007-06-22T02:51:09.341Z\",\n \"completed_by_user_id\": \"447a8d66-f053-7ec6-b3a3-7ec7343c3c6a\",\n \"version\": 3296,\n \"created_at\": \"2012-11-23T05:12:27.957Z\",\n \"updated_at\": \"1995-02-07T15:02:58.837Z\"\n }\n ],\n \"total\": 6923\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd5e8a7e-76e2-4673-8b53-34ad93b65305", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f5ce1c-5397-4928-9e82-3cb195c23dbb", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82844e18-db7d-4c98-a049-2a67ec9915ac", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8564efe9-3583-424c-afe8-698ee19f5b33", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligation-fulfilments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9545cf7a-8978-4073-abc3-e04b7e7375e2", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "52e6cf67-18cd-46ad-892a-d556fc70401e", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"b9fc01e9-7b41-3a45-f8b1-cafe00820ca5\",\n \"license_id\": \"d90aff74-95f6-f1fd-d58e-e0ac3e03d92c\",\n \"license_name\": \"string\",\n \"license_category\": \"forbidden\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"affected_count\": 3215,\n \"updated_at\": \"2019-02-22T01:22:22.784Z\",\n \"fulfilment\": {\n \"value\": \"\"\n },\n \"license_spdx_id\": \"string\",\n \"link\": \"string\",\n \"text_ko\": \"string\"\n },\n {\n \"id\": \"085c00a6-6d0d-7152-5b31-06ab0f08eda4\",\n \"license_id\": \"ed16a32d-a903-92dd-5034-87d234d65e25\",\n \"license_name\": \"string\",\n \"license_category\": \"unknown\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"affected_count\": 8283,\n \"updated_at\": \"1951-12-05T09:28:24.827Z\",\n \"fulfilment\": {\n \"value\": \"\"\n },\n \"license_spdx_id\": \"string\",\n \"link\": \"string\",\n \"text_ko\": \"string\"\n }\n ],\n \"distribution\": {\n \"key_0\": 8787,\n \"key_1\": 3904\n },\n \"total\": 8520\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17494e67-9528-40fa-bc7f-c8c0b434b2a1", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7953bcee-392e-41fb-9f03-5f8d1e541139", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5008a345-a808-42d1-958f-b4db3736e3c4", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db6095b1-1872-4c87-b78c-4df6fee595a6", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8004cdb-97da-4d8f-96c4-7d16f3ff1951", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e93f9271-7f96-4275-a133-65e879217445", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": \"cd2af48a-2d8d-c2e2-e6d5-b97b470c4b0b\",\n \"license_id\": \"fb76df28-4d12-f716-16a6-fb674c261efd\",\n \"license_name\": \"string\",\n \"license_category\": \"unknown\",\n \"kind\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-05-26T17:57:29.789Z\",\n \"updated_at\": \"1947-01-07T19:44:35.068Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"ce4b7afc-696f-952f-76ed-b54688da994f\",\n \"component_name\": \"string\",\n \"version\": \"string\"\n },\n {\n \"component_version_id\": \"467fa8bb-2d2c-c617-bd91-6089213a684a\",\n \"component_name\": \"string\",\n \"version\": \"string\"\n }\n ],\n \"affected_components_total\": 0,\n \"affected_components_truncated\": false,\n \"fulfilment\": {\n \"id\": \"be3062e7-fc18-051a-c523-94da0c184edd\",\n \"status\": \"string\",\n \"version\": 7538,\n \"updated_at\": \"1978-11-28T17:00:21.108Z\",\n \"assignee_user_id\": \"84bf4df9-9328-9f2d-4fb7-d5df33eb0d87\",\n \"completed_at\": \"1973-01-15T20:17:16.423Z\",\n \"completed_by_user_id\": \"a03f6ebe-5494-c82f-18ff-3a31aec9d780\",\n \"due_on\": \"2001-09-02\",\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": "01cd7492-6e3b-4a57-a715-5f8c04816202", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1f92dca-96be-4732-9efa-d72816abd8c7", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ff05d99-8995-4d62-be91-fc3473929703", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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": "82acd8e8-24d1-467b-9aa2-4f1694b7d29f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fd83bbe-a032-4280-a3b4-b00f87bc92ef", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "93bbca0c-d3f4-405f-ab2b-9025b6a991e5", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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": "905f4332-b58e-4e70-96b9-4b66f44e5963", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ff0ad31-de9b-4613-ba8f-9b8ed2a88913", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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": "20554fdc-67d5-4528-a351-9413b2d8e664", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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": "ce578660-86da-4e2b-b24e-d1710ef0ebbb", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0222c9e7-8c11-4433-938c-54f4744ea200", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": \"ec2894b3-9b58-12fd-eaf7-4d223040d990\",\n \"due_on\": \"1998-01-22\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3618cdd2-4c82-4bfb-a2ed-1c8bd62500ec", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "key": "obligation_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"ec2894b3-9b58-12fd-eaf7-4d223040d990\",\n \"due_on\": \"1998-01-22\",\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\": \"3665f45d-b09b-1594-850b-ddeafb6bc34e\",\n \"project_id\": \"067c4d1d-b9bf-644d-e5b5-16655ccfed5a\",\n \"obligation_id\": \"47008a4b-c673-e23e-5886-590710257623\",\n \"status\": \"string\",\n \"assignee_user_id\": \"95ac7bb8-c3e0-100c-4e24-830853ead7ab\",\n \"due_on\": \"1982-07-25\",\n \"evidence_note\": \"string\",\n \"evidence_url\": \"string\",\n \"completed_at\": \"1975-12-18T05:23:25.134Z\",\n \"completed_by_user_id\": \"b43e7332-1b18-bbdd-9c58-15b6a04f9ce2\",\n \"version\": 5195,\n \"created_at\": \"2001-07-03T07:29:02.128Z\",\n \"updated_at\": \"1985-12-23T01:51:13.103Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54e31536-b281-4f61-b29e-106d030a4817", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": \"ec2894b3-9b58-12fd-eaf7-4d223040d990\",\n \"due_on\": \"1998-01-22\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84e6e774-45dc-4533-bb81-7c0dfb32ee4d", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "key": "obligation_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"ec2894b3-9b58-12fd-eaf7-4d223040d990\",\n \"due_on\": \"1998-01-22\",\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": "279313ba-ebf2-4934-a94a-9aa9953a2087", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "key": "obligation_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"ec2894b3-9b58-12fd-eaf7-4d223040d990\",\n \"due_on\": \"1998-01-22\",\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": "05e71481-c44a-4859-ac3c-370e5d338efd", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "key": "obligation_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"status\": \"string\",\n \"assignee_user_id\": \"ec2894b3-9b58-12fd-eaf7-4d223040d990\",\n \"due_on\": \"1998-01-22\",\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": "45a72c59-7f2e-4da5-a652-2a868e62b87c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "obligations", ":obligation_id", "fulfilment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "d56863f8-dcda-d2ac-0454-626f69ae480f", "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\": \"ec2894b3-9b58-12fd-eaf7-4d223040d990\",\n \"due_on\": \"1998-01-22\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3c742c7c-eb16-4961-930b-241680a8a84c", "name": "remediation", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "307ff512-f9d4-4bde-baf6-51fedca21b43", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "d2da7090-fad9-42e2-8c73-bf5f88f4bdcf", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "8daaa444-3f8b-426f-978c-a97ac47975ef", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "a0cc7119-9e4f-443a-9a90-6568a4b643c4", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d13956ff-e5b3-4256-935b-099382b98b12", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "817cd1e3-f44e-4e3a-9e6d-1a2751b2e2c9", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "dry-run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2dc52df2-e24f-4022-9eb0-7430fb34cbf5", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "dd141eec-4cbe-407f-9c63-ea327758a209", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"1b561e45-dbe9-1ccf-2ff4-97b7534faa27\",\n \"project_id\": \"801e4070-505e-1f65-5408-e230b5824857\",\n \"ecosystem\": \"string\",\n \"repository_full_name\": \"string\",\n \"head_branch\": \"string\",\n \"base_branch\": \"string\",\n \"status\": \"failed\",\n \"created_at\": \"2008-03-26T23:18:59.957Z\",\n \"updated_at\": \"2023-12-09T09:56:58.477Z\",\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\": 1176,\n \"pr_url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f202d17-f3fb-4da7-a3b8-c36f9fb3c22c", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "6c2193c3-858e-4749-a3e0-d10d24441b58", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "83eea929-9123-4d8d-a778-25fb7640850b", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "03ed0403-7f16-4168-bb0d-8a1e463f4b6a", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "d19adb0c-b348-47f5-859d-d11f7a501432", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "a77b1c9b-5218-4bb0-b795-e949ccbe1253", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "20c46e8c-3240-48ee-b5cc-b3466b98a9cc", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "remediation", "npm", "pull-request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c415dacd-484f-4046-bbbf-7972afc9faa1", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "c17ae715-abcf-444b-943c-9e4861ca622d", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "93252a88-47bf-4f7b-a231-fc6544f1478a", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 4453,\n \"items\": [\n {\n \"id\": \"1e89ae02-fa79-b5e1-0be9-644b5d1ea934\",\n \"project_id\": \"0c597148-578b-c487-21d0-3877baeccb59\",\n \"ecosystem\": \"string\",\n \"repository_full_name\": \"string\",\n \"head_branch\": \"string\",\n \"base_branch\": \"string\",\n \"status\": \"failed\",\n \"created_at\": \"1959-11-08T19:21:57.686Z\",\n \"updated_at\": \"1978-11-14T03:34:49.293Z\",\n \"package_changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pr_number\": 9154,\n \"pr_url\": \"string\"\n },\n {\n \"id\": \"d78a42d7-de85-4a82-4f98-e894c8e43a09\",\n \"project_id\": \"37b4e0c1-efbd-dcb2-7a15-adf5a7095212\",\n \"ecosystem\": \"string\",\n \"repository_full_name\": \"string\",\n \"head_branch\": \"string\",\n \"base_branch\": \"string\",\n \"status\": \"creating\",\n \"created_at\": \"2004-09-14T15:10:43.352Z\",\n \"updated_at\": \"1975-06-01T22:02:57.657Z\",\n \"package_changes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"pr_number\": 3970,\n \"pr_url\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1cb8db3-919f-44d8-8965-fda8d3813896", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "65e2cae9-0c0d-4813-9d07-32c3988a169b", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9f57e5a-ca4d-4eb8-be76-73b79048fa92", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "d926afe9-d5dd-4035-814b-5dc003c9fb27", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a340a7e7-8cc5-46ee-bf4b-1f1935dc0f7b", "name": "reports", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a06d978d-30a2-4296-9871-17cd99e2348b", "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": "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": "type", "value": "vuln_pdf", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c442fc6c-1b93-4443-bc20-a1926be708a0", "name": "Paginated report-download history (newest first).", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "sbom" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"e0651631-7f33-05fa-3928-1397f92517f9\",\n \"project_id\": \"7b716fd2-cc0a-e595-217b-3e4419d35389\",\n \"team_id\": \"3bf5b3fe-dd67-9c14-10c9-b89ff1c57efc\",\n \"report_type\": \"sbom\",\n \"format\": \"string\",\n \"created_at\": \"1959-05-30T19:24:26.048Z\",\n \"scan_id\": \"8da77823-0787-3f26-dea9-df1217206bf9\",\n \"size_bytes\": 6358,\n \"user\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"9749f993-e702-cac5-05fc-215bf6831e1b\",\n \"project_id\": \"f108dafc-ad22-03c1-3301-caebc29e4e56\",\n \"team_id\": \"77dbcae5-c58e-0d5d-d881-ca5238079126\",\n \"report_type\": \"notice\",\n \"format\": \"string\",\n \"created_at\": \"2020-01-08T00:57:16.470Z\",\n \"scan_id\": \"4a625b57-13a8-92b7-f173-28e45b144650\",\n \"size_bytes\": 4050,\n \"user\": {\n \"value\": \"\"\n }\n }\n ],\n \"total\": 3047,\n \"page\": 3081,\n \"page_size\": 5105\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e59ab66d-ca05-4d7a-84a1-d57d3494aa36", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "sbom" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "3ef97a37-06ca-41fd-9179-018e4460f129", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "sbom" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d767e6a6-9c59-4b8b-ad28-8b6d3c832a1b", "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": "sbom" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "3fca1355-bb4c-4920-bc50-487687351c76", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "sbom" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c3e138-919c-4fb2-a318-4d19550df106", "name": "Rate limit exceeded for this client.", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "reports", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "sbom" }, { "key": "type", "value": "vuln_pdf" }, { "key": "page", "value": "1" }, { "key": "page_size", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "a2d674cf-201d-421a-8b1a-68edc6e9455e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c2a7abd6-6a8c-427c-a088-76a6472e36ac", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "5b29c5cc-8995-4ee7-a11e-3f2f6ca6df26", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "25d9eb26-0b6b-40a6-93ab-369530237649", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f638eaed-4137-4db4-96a8-e0214307ca53", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "78539af2-7a06-4818-8e54-1262a20831f5", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c28817-00da-481c-b9f1-2deda327cbf6", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "b92854c2-8278-4eb9-9145-762fd5edae98", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "e0126a6d-f4d4-4484-b022-c29a966f6594", "name": "XLSX report download", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "ff414f98-2ab8-4188-84d3-faacf201ae6e", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "35a7912f-245c-4873-95e5-30e2b8693e42", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2037416-fb7d-4fc9-a194-ee0aeb25abd6", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "6c955b4a-efd0-400c-aad8-1a65c6b0f705", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerability-report.xlsx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1cadb530-f91b-4e07-b3f5-cfc10a676ada", "name": "sbom", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e0184941-68e4-4d16-af60-19280597f355", "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-annotated", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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-annotated&scan_id=2880382c-2926-6714-d818-2622f98e3baa&release=string" }, "header": [ { "key": "Accept", "value": "application/spdx+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1d666deb-7b4a-4657-96f7-8b7cebeadeb4", "name": "SBOM document download", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-annotated" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "2d8788c7-3a5b-4b87-a9c0-825c892630b7", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-annotated" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "5bfe54b1-7be1-4d38-ba62-deed6346a29c", "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-annotated" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "275f9762-ca50-479c-a1fd-605bc1a85e06", "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-annotated" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "c50ebf19-a4cd-4519-9549-6e29435defe3", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "cyclonedx-json" }, { "key": "profile", "value": "policy-annotated" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8580b85-db20-4980-8d17-56344f27e32e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "1173b64e-8d6c-48e9-918c-0397b94989b3", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"cbb0ec47-989d-eaf7-913b-a3c8cbeaef42\",\n \"project_id\": \"5567c191-ba9a-a845-4177-5c6d24afce54\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 2634,\n \"current_step\": \"string\",\n \"started_at\": \"1985-04-17T13:14:50.752Z\",\n \"completed_at\": \"2000-10-02T19:09:10.018Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"8633caf2-6e3f-33e5-ddf8-6650fd3a1724\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"1958-06-05T06:46:27.327Z\",\n \"updated_at\": \"2019-08-21T00:18:29.097Z\",\n \"metadata\": {\n \"key_0\": 9747.715732425615\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"2011-05-28T12:30:49.638Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9128633a-73dd-4cae-aa72-0381c60a02b1", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "b9287531-8299-40aa-95d0-ccf7387b2feb", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "f9e8f75b-f813-4606-b8b5-246a7af40a64", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "96653019-1cd1-4dc4-ab59-4c9e40565cb6", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "9050d15c-946e-4fa7-bb19-252d3bd7253b", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "e340b0a9-c89f-4dd5-bbd1-3924058cef69", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "7bc4ea29-89c6-45ca-893a-f4429e403735", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom-ingest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd9897f0-0013-4f6a-8cd5-dc6c10093b68", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "265b6b9d-3392-44f0-9ed8-8beaa4ec6614", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "83276094-a55a-4be9-b39f-bc108c73f742", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "bf3c225b-ddac-478c-9ac1-fd68985a2ccf", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "d0e85bdf-dc0b-47ea-ad92-92f9657783e8", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e69a2c50-328f-4737-8ada-838d62647e87", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "9faa3d04-f20e-44e1-8205-10a56f65465e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b0f32c5-4d39-4faf-833a-0dec99f4249b", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "ec68a2c6-c7fb-40cd-a648-80c2d2fd61f4", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "8940b552-32f2-497b-883d-13eea362dbaf", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "71b4728e-da5e-4840-923a-a43fe1366c0e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d894b38-d8ba-4592-84b8-56866f612155", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "f5906282-a0fc-42a7-9c73-3cb9e39e8499", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "attestation-certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "871b9925-a302-41eb-ba9d-efd5d152d3de", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "64f6816a-64e5-47c7-a042-3eae6e764d7a", "name": "Fulcio signing certificate (keyless verification)", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "c47bd4eb-c73d-4f90-8b3b-4b6d45e0abd7", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "e1e73fbc-0486-4887-a967-3bd5526e9c78", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80d5c930-1d97-4094-a33d-1e0a5c9a9263", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "34e8b8bd-af1b-4b90-aa5d-cd9ac2e7be03", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e03be92-15a3-4115-a5ed-eddaec9f5311", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "78bcc254-8b79-42fc-bfa4-6ba1f193ad8a", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "0f5b12a9-d338-4a5e-9acd-0de9f838bb84", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "94d1ffb5-637d-4357-895a-8ffd5dbc0715", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31c2af83-11f4-49f6-be80-249c8900394f", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "2ffbcbc6-e82c-484c-9fa4-378050f966d7", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "public-key" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4923830f-da07-49fe-aad6-41c42a1ce53e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4ea31893-0b7d-4007-bbfe-5242be39d9ce", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "8bbabdfc-a1f7-4330-a748-6863fa80e6fa", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "63ce08fc-8177-4687-adf3-ddca2efd4c72", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76f23cd-b625-446f-9e43-2aacbe48011e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "f5f56d7f-1737-433a-852d-8d99ea0dcf69", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd351050-b886-4afe-b1bd-2f6fb48189a9", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/zip" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e52be27d-2752-4a00-afdf-43652d8cd897", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "c90cd573-bce9-4b12-a893-cd03f99dcf0d", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "3be3eeb5-8910-42c4-9fc3-69c279f1846b", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5564a1b-6c4f-43ba-95e3-10122c7f0da0", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "849aa29b-0290-4349-92be-fb88b8f697eb", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "sbom", "signature-bundle" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71c6d2c4-57d1-4b33-9229-e1889fb2ecc5", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5dd0e7da-31b2-402e-9a15-b8a04fd5afd7", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": \"8ba75f18-e718-7943-a5c3-5f5dcca4aced\",\n \"project_id\": \"e998dd5a-0c15-2d3d-2ad5-e85fb3f73a93\",\n \"source_format\": \"spdx-tv\",\n \"result\": \"pass\",\n \"n_fail\": 2386,\n \"n_warn\": 5423,\n \"component_count\": 9965,\n \"created_at\": \"1969-12-17T20:39:03.478Z\",\n \"ai_assessment\": {\n \"verdict\": \"ok\",\n \"disclaimer\": \"string\",\n \"disclaimer_ko\": \"string\",\n \"condition_labels\": {\n \"key_0\": {\n \"key_0\": {\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 \"key_2\": {\n \"key_0\": {\n \"value\": \"\"\n },\n \"key_1\": {\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\": \"product\"\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\": \"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 \"hash_coverage_pct\": 7156,\n \"license_coverage_pct\": 6159,\n \"purl_coverage_pct\": 2271,\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": "e42d2272-79a4-418b-8e2d-51b0dbdd3e1f", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "1b066394-58a6-495a-8484-85a3b4a6344f", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e86343d-02fe-4465-a9d0-7b30df4c612c", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "253b474b-982d-431e-bc76-78f420931bdc", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "scans", ":scan_id", "conformance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fd84581e-f7ed-4c68-9dbc-5d4088ee4e39", "name": "scans", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ed179341-f84f-41d2-8df0-4a1ac45b5b32", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a0a191d1-5378-4ffe-b01e-e1508e62ad59", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"3b4e4663-4cdb-25b1-48d7-be833f6d14da\",\n \"project_id\": \"302a40fa-92d5-456d-7454-12ac5e8fb7b9\",\n \"kind\": \"sbom\",\n \"status\": \"failed\",\n \"progress_percent\": 5072,\n \"current_step\": \"string\",\n \"started_at\": \"1960-06-07T01:25:45.133Z\",\n \"completed_at\": \"1959-08-14T20:55:51.962Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"2493036e-6844-6476-7252-3c85cc348937\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2025-04-12T09:01:11.444Z\",\n \"updated_at\": \"2012-08-06T10:22:27.362Z\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 4385.745782524324,\n \"key_2\": 5788,\n \"key_3\": 3796.7425518398954,\n \"key_4\": 114.53336215794918\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1958-03-18T08:33:47.400Z\"\n },\n {\n \"id\": \"4f9ea346-522c-aaf0-1b51-79f211b8d043\",\n \"project_id\": \"9ec22fd6-812d-59ea-251a-03cb002485b5\",\n \"kind\": \"source\",\n \"status\": \"queued\",\n \"progress_percent\": 7109,\n \"current_step\": \"string\",\n \"started_at\": \"1990-05-27T03:08:33.968Z\",\n \"completed_at\": \"1978-06-19T14:11:16.692Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"b4b36f70-4a3b-3693-93db-228cda94d8ff\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2012-09-13T17:45:00.054Z\",\n \"updated_at\": \"1997-06-08T05:18:27.532Z\",\n \"metadata\": {\n \"key_0\": 8633.165363702023\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1982-03-14T12:07:24.591Z\"\n }\n ],\n \"total\": 9877,\n \"page\": 6081,\n \"size\": 5606\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea53bc70-480f-4f51-951d-3d4d095f227c", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30731aaa-b523-48c7-b768-f82daac02caf", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fff2fa1-2218-4fce-832d-cc5867860005", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "423888e3-1021-469c-a5d3-7559b28f14b0", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b6b412b-0c63-4a1f-ae95-5e9bed6ab94c", "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": "failed", "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": "dfd758f9-45cd-49c6-a91c-ece60aa44313", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "failed" }, { "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\": \"3b4e4663-4cdb-25b1-48d7-be833f6d14da\",\n \"project_id\": \"302a40fa-92d5-456d-7454-12ac5e8fb7b9\",\n \"kind\": \"sbom\",\n \"status\": \"failed\",\n \"progress_percent\": 5072,\n \"current_step\": \"string\",\n \"started_at\": \"1960-06-07T01:25:45.133Z\",\n \"completed_at\": \"1959-08-14T20:55:51.962Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"2493036e-6844-6476-7252-3c85cc348937\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2025-04-12T09:01:11.444Z\",\n \"updated_at\": \"2012-08-06T10:22:27.362Z\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 4385.745782524324,\n \"key_2\": 5788,\n \"key_3\": 3796.7425518398954,\n \"key_4\": 114.53336215794918\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1958-03-18T08:33:47.400Z\"\n },\n {\n \"id\": \"4f9ea346-522c-aaf0-1b51-79f211b8d043\",\n \"project_id\": \"9ec22fd6-812d-59ea-251a-03cb002485b5\",\n \"kind\": \"source\",\n \"status\": \"queued\",\n \"progress_percent\": 7109,\n \"current_step\": \"string\",\n \"started_at\": \"1990-05-27T03:08:33.968Z\",\n \"completed_at\": \"1978-06-19T14:11:16.692Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"b4b36f70-4a3b-3693-93db-228cda94d8ff\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"2012-09-13T17:45:00.054Z\",\n \"updated_at\": \"1997-06-08T05:18:27.532Z\",\n \"metadata\": {\n \"key_0\": 8633.165363702023\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"1982-03-14T12:07:24.591Z\"\n }\n ],\n \"total\": 9877,\n \"page\": 6081,\n \"size\": 5606\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f068b932-f65e-473f-b13d-f4aa67b86cbc", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "failed" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45a4b548-c282-4754-a2ad-cfbc07933aec", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "failed" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77e7b15d-154c-492a-a27f-ceab4360a84e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "failed" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b503c60-0b16-4f99-ba21-9a064008ba7f", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3e5549cf-463a-46f2-a140-cbc850e60084", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "905be86e-ffcc-4252-bfa5-3203ca1d380f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b6dbb13-1d79-4ba3-b5f3-61b521de9921", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de37e635-951b-40e4-9a86-ba6e878e0bb7", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "11069595-305a-4648-b153-cf038d318023", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "0cce725c-5798-4a23-8218-f040b1e3a269", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "force", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15dd18ee-5c9a-48fa-9f2c-74656f39e897", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fc092491-00f7-4f52-9fbc-9d348f23115a", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": \"cbb0ec47-989d-eaf7-913b-a3c8cbeaef42\",\n \"project_id\": \"5567c191-ba9a-a845-4177-5c6d24afce54\",\n \"kind\": \"source\",\n \"status\": \"failed\",\n \"progress_percent\": 2634,\n \"current_step\": \"string\",\n \"started_at\": \"1985-04-17T13:14:50.752Z\",\n \"completed_at\": \"2000-10-02T19:09:10.018Z\",\n \"error_message\": \"string\",\n \"requested_by_user_id\": \"8633caf2-6e3f-33e5-ddf8-6650fd3a1724\",\n \"celery_task_id\": \"string\",\n \"created_at\": \"1958-06-05T06:46:27.327Z\",\n \"updated_at\": \"2019-08-21T00:18:29.097Z\",\n \"metadata\": {\n \"key_0\": 9747.715732425615\n },\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"ref\": \"string\",\n \"release\": \"string\",\n \"superseded_at\": \"2011-05-28T12:30:49.638Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87f16d5d-fd80-4868-a310-1f0624f1c422", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e559c367-2ab1-40a9-8595-7895e00c796d", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbe787a7-dfc0-44f8-80f2-3393ba7a02ef", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73040c23-b670-4f1b-aa6e-cff47104642d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd57e4f4-ccb4-4143-96d6-7137fb6b7487", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "15459047-53cc-4fd8-af02-c46060b35e70", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "a0d502e9-61be-4290-a8c9-d7196b9b8d2e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c38c5252-0df7-4f7f-aad1-7f500339c211", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5af9baf7-1cba-459c-8dc4-d9b79a768f17", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92c3eef1-5a58-4d75-85aa-d56ea629208e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "559c0c36-10ea-4b79-82ec-f8de68e842ac", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "835e0df3-8f1f-4772-8d65-a63adb571be0", "name": "Plain-text scan log, streamed.", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "77c1baf2-da2c-46ec-90be-d69e1a816d74", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80194a38-2b60-48c6-886e-d07b1d2880b5", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf48c309-3eec-456c-93ca-033297d3ec91", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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": "0c2eb382-82b6-4638-a871-5147311a99ea", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34c6f0bb-ec8f-4307-85fe-e3568c5345f0", "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": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "key": "scan_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f3251730-0d5c-4dc3-b1f8-634825a05e14", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": \"993110ba-7187-09eb-be06-cc4089a8cbb0\",\n \"kind\": \"container\",\n \"document\": {\n \"format\": \"string\",\n \"component_count\": 5617,\n \"authors\": [\n \"string\",\n \"string\"\n ],\n \"byte_size\": 3672,\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\": 5713,\n \"truncated\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b4b3c6-1848-4c39-8250-7eade5466c08", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8047fc58-dc83-46aa-915d-226449b867e0", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25262338-efe2-494b-b568-fbbdbb5c77bd", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eaff369-34b9-49d2-8759-3c129835a5ec", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scans", ":scan_id", "provenance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9d7d44b4-9a3d-4924-ae6e-e93d642452c0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67edf725-72cf-4caa-9e3e-2359016827de", "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 \"7ac4393f-5b2f-cc59-4f90-407d3adb2a4e\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6d026f35-4a66-42c5-9112-274a21236aa6", "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 \"7ac4393f-5b2f-cc59-4f90-407d3adb2a4e\"\n ],\n \"ref\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"all_succeeded\": false,\n \"total\": 8516,\n \"created\": 2508,\n \"already_existed\": 3205,\n \"failed\": 4735,\n \"rows\": [\n {\n \"index\": 5626,\n \"status\": \"created\",\n \"detail\": \"string\",\n \"project_id\": \"25cee540-3883-efff-7790-cf0090d0b1b4\",\n \"retry_after_seconds\": 3473,\n \"scan_id\": \"ca62b9c9-15c3-1b42-2cd0-aa5e2a218a5a\"\n },\n {\n \"index\": 4366,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"ab68b34d-7c6c-bc8f-0cd7-104c49c8a164\",\n \"retry_after_seconds\": 3894,\n \"scan_id\": \"51189021-7e62-c215-b702-95509fc535ca\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 7136\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d20a3cfa-6c85-4502-af68-70c60b9a140a", "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 \"7ac4393f-5b2f-cc59-4f90-407d3adb2a4e\"\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\": false,\n \"total\": 8516,\n \"created\": 2508,\n \"already_existed\": 3205,\n \"failed\": 4735,\n \"rows\": [\n {\n \"index\": 5626,\n \"status\": \"created\",\n \"detail\": \"string\",\n \"project_id\": \"25cee540-3883-efff-7790-cf0090d0b1b4\",\n \"retry_after_seconds\": 3473,\n \"scan_id\": \"ca62b9c9-15c3-1b42-2cd0-aa5e2a218a5a\"\n },\n {\n \"index\": 4366,\n \"status\": \"invalid\",\n \"detail\": \"string\",\n \"project_id\": \"ab68b34d-7c6c-bc8f-0cd7-104c49c8a164\",\n \"retry_after_seconds\": 3894,\n \"scan_id\": \"51189021-7e62-c215-b702-95509fc535ca\"\n }\n ],\n \"failed_by_status\": {\n \"key_0\": 7136\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10c9723b-546b-41bc-859c-0d0e8633af97", "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 \"7ac4393f-5b2f-cc59-4f90-407d3adb2a4e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef8d1d04-ca70-49da-b400-570815916339", "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 \"7ac4393f-5b2f-cc59-4f90-407d3adb2a4e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42feee46-5eaa-4842-889c-a508c0c3bdda", "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 \"7ac4393f-5b2f-cc59-4f90-407d3adb2a4e\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "55b41c56-7b03-4216-8c40-dba50914bc69", "name": "source-tree", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6dc108ce-ab20-440b-8abe-c6eedb3affa7", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d3a22c39-2904-4101-af09-4909d33b0b41", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "9d8ee9a8-0fb2-4812-b8fa-8a0d61f47b6f", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "1e7a7cae-707a-4870-beab-e50e250bca36", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "e5f76a46-e303-4ff6-bb6f-853ddf45e022", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cc7cc63-c5b4-4b0c-86ac-d7d1d54fae27", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "0362b90c-80b1-4874-94a8-df248d62cc41", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "b7102de2-feb6-40ec-8f67-ad2bdb0f347a", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7bf74a4-5c58-4d06-bd52-13bafd936e8d", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8037230d-1c60-41ae-9583-338238c48140", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "4994d895-2979-4da5-9a49-90256d685dc4", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "278af36a-55bf-4e41-b7e8-d825e67397a2", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "bd25cb1b-94fd-4686-b8fc-04f63130a7b9", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d498e626-75cb-476e-bed1-268cba203160", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "b638b0f4-7dd5-4d8b-83d7-50cd2f6bef6b", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "758443f7-feaa-4bb7-8fc2-b10b6134c2ce", "name": "vex", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b125394f-b5e8-4f2d-ae6a-735172b737d2", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "00d511ab-9a0a-4677-8adb-26cf5152f1fd", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "75ec295d-0402-4b2d-92c1-d9803d7ee9d0", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "openvex" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "03860e8d-f41b-4d13-8652-7dfe1ce8c08c", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7019b9c-521b-40a1-bcee-1ec034a19cfa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "4268c801-6992-41fb-926e-303e45f7554f", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "format", "value": "openvex" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "631a16eb-4a59-40ee-8c92-2a844f8f789d", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "625bacbd-0e6f-49be-8874-f0a6b6ac900e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 7162,\n \"applied\": 6100,\n \"skipped\": 5003,\n \"errors\": [\n {\n \"reason\": \"ambiguous_match\",\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": "8281b1f4-04a8-464e-96de-41ec7b18be31", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "953abbde-98ff-4132-a1a3-13ac3ffd0d1e", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "7cd2e5f9-c4c7-4851-b56c-07777d336fde", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "f32aab37-5e2f-4df3-b3c8-8a7d2101b079", "name": "VEX document too large", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "3b884fad-0ef6-4989-ab84-a05614edd318", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vex", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "72efb92a-b561-43b0-8206-ee164c27cff8", "name": "vulnerabilities", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a1081479-9df8-4207-a3d6-d9c42483e690", "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.10055670608626577", "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": "true", "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": "unassigned", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ecc3a20a-9657-4f11-ad04-b6654950d27f", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"969b2fbf-2a84-0ff5-a555-cb4e1ab1fddc\",\n \"cve_id\": \"string\",\n \"severity\": \"high\",\n \"status\": \"new\",\n \"affected_component_count\": 2123,\n \"discovered_at\": \"1953-12-27T15:03:30.321Z\",\n \"first_detected_at\": \"1952-07-09T16:49:24.672Z\",\n \"updated_at\": \"2017-04-29T17:18:10.422Z\",\n \"affected_component_license\": \"string\",\n \"affected_component_license_category\": \"allowed\",\n \"affected_component_name\": \"string\",\n \"affected_component_version\": \"string\",\n \"analysis_source\": \"manual\",\n \"assignee_is_active\": true,\n \"assignee_user_id\": \"4435e6dc-cffb-a6f2-d3b0-89cf30071396\",\n \"component_license_category\": \"conditional\",\n \"cvss_score\": 528.5578502908894,\n \"due_on\": \"1983-09-12\",\n \"due_source\": \"sla\",\n \"effective_due_date\": \"1952-08-25T02:31:03.181Z\",\n \"epss_percentile\": 0.5998887834651594,\n \"epss_score\": 0.7423407183294859,\n \"kev\": false,\n \"kev_due_date\": \"2021-02-01\",\n \"reachability_analyzed_at\": \"1961-07-10T22:31:38.151Z\",\n \"reachability_source\": \"string\",\n \"reachable\": false,\n \"sla_due_date\": \"2007-09-24T13:07:40.548Z\",\n \"sla_status\": \"ok\",\n \"summary\": \"string\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n },\n {\n \"id\": \"7dd79ecd-1c22-3b45-585d-cc94f3fa4981\",\n \"cve_id\": \"string\",\n \"severity\": \"critical\",\n \"status\": \"false_positive\",\n \"affected_component_count\": 4132,\n \"discovered_at\": \"1963-12-30T18:34:17.246Z\",\n \"first_detected_at\": \"2025-08-14T09:33:07.486Z\",\n \"updated_at\": \"1951-11-04T16:54:39.039Z\",\n \"affected_component_license\": \"string\",\n \"affected_component_license_category\": \"allowed\",\n \"affected_component_name\": \"string\",\n \"affected_component_version\": \"string\",\n \"analysis_source\": \"manual\",\n \"assignee_is_active\": false,\n \"assignee_user_id\": \"683e6cda-ba2f-28d9-7c06-a2de67b64539\",\n \"component_license_category\": \"conditional\",\n \"cvss_score\": 4487.794579926152,\n \"due_on\": \"1997-10-15\",\n \"due_source\": \"sla\",\n \"effective_due_date\": \"1978-03-12T13:21:29.025Z\",\n \"epss_percentile\": 0.5884555520077177,\n \"epss_score\": 0.405740670281151,\n \"kev\": false,\n \"kev_due_date\": \"2025-02-20\",\n \"reachability_analyzed_at\": \"1951-07-03T05:56:42.469Z\",\n \"reachability_source\": \"string\",\n \"reachable\": false,\n \"sla_due_date\": \"1986-09-21T18:09:47.317Z\",\n \"sla_status\": \"ok\",\n \"summary\": \"string\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n }\n ],\n \"total\": 111,\n \"limit\": 3727,\n \"offset\": 5289,\n \"severity_distribution\": {\n \"key_0\": 191\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "081f9339-8c7c-4606-86b1-b437beec25e6", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c9ed8d2-9588-4bd6-b7a9-5a5f254aba67", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f373290-0922-40af-9ed0-76d46b576663", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92f876e2-10bd-437f-8e86-5052c965860d", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bc592ad-d5b1-4089-81bf-d359f697fa69", "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.10055670608626577" }, { "disabled": false, "key": "reachable", "value": "true" }, { "disabled": false, "key": "sla", "value": "overdue" }, { "disabled": false, "key": "assignee", "value": "unassigned" }, { "disabled": false, "key": "sort", "value": "severity" }, { "disabled": false, "key": "order", "value": "desc" }, { "disabled": false, "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7afbdf7c-08dd-4c5b-98c3-ca7d4aa9a5e4", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "e8793849-4877-4fc6-82d7-f8a86547df8c", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f385dc2-f0c9-4042-888d-0bc18a584a37", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dec727ea-5ea6-4afc-8d41-b49407e547f5", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e82bfc2-0418-4296-9632-8eceb3d0f38e", "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.10055670608626577" }, { "key": "reachable", "value": "true" }, { "key": "sla", "value": "overdue" }, { "key": "assignee", "value": "unassigned" }, { "key": "sort", "value": "severity" }, { "key": "order", "value": "desc" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "976777bf-fcfb-4872-9ff9-632d1351914d", "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": "2880382c-2926-6714-d818-2622f98e3baa", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e1cdd8e-de17-48d2-9398-55c39bdad22b", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9587,\n \"clusters\": [\n {\n \"component_version_id\": \"d5e7d472-4f68-9f62-0fc6-5753c8b571b1\",\n \"component_name\": \"lodash\",\n \"current_version\": \"4.17.19\",\n \"reason\": \"no_fix_version\",\n \"direct\": true,\n \"finding_count\": 1195,\n \"findings\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"component_purl\": \"string\",\n \"max_epss\": 0.1978046125684907,\n \"max_severity\": \"high\",\n \"recommended_version\": \"string\"\n },\n {\n \"component_version_id\": \"ce694d0a-22e5-4385-07e7-560733f3e4b9\",\n \"component_name\": \"lodash\",\n \"current_version\": \"4.17.19\",\n \"reason\": \"no_fix_version\",\n \"direct\": true,\n \"finding_count\": 1928,\n \"findings\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"component_purl\": \"string\",\n \"max_epss\": 0.45896497323200713,\n \"max_severity\": \"low\",\n \"recommended_version\": \"string\"\n }\n ],\n \"scan_id\": \"281121c5-855b-3ca8-9cca-0592630e83e2\",\n \"total_clusters\": 0,\n \"truncated\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a44b4109-a2f4-4174-93f2-d505a31020d0", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea558b38-2a13-4d83-a9a5-6786e60cc5dc", "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": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51e97bdf-3792-4f40-8142-d307c1f264c6", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0341abc-aa03-4d88-8fc1-2124529fd831", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities", "upgrade-clusters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "scan_id", "value": "2880382c-2926-6714-d818-2622f98e3baa" }, { "key": "release", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25dbdb2f-16ef-4367-b50d-d3a8a6a6138f", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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 \"c3738c09-ddac-bde0-ff19-2f15d6cc81f9\"\n ],\n \"target_status\": \"false_positive\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7e3901a9-702c-4e22-8024-31000d449f89", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"c3738c09-ddac-bde0-ff19-2f15d6cc81f9\"\n ],\n \"target_status\": \"false_positive\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"target_status\": \"not_affected\",\n \"total\": 2834,\n \"succeeded\": 1670,\n \"failed\": 6739,\n \"results\": [\n {\n \"finding_id\": \"0bb9d589-7f43-45ee-7b24-77013d87998e\",\n \"success\": true,\n \"status_code\": 485,\n \"allowed_to\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"detail\": \"string\",\n \"error\": \"string\"\n },\n {\n \"finding_id\": \"e0a36be5-2319-eb7e-2527-a592a1346975\",\n \"success\": false,\n \"status_code\": 435,\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": "a2f2fe56-2507-4b92-aa17-325a0ac6a247", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"c3738c09-ddac-bde0-ff19-2f15d6cc81f9\"\n ],\n \"target_status\": \"false_positive\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2f48ca3-0b79-4074-9f91-31b2133dd900", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"c3738c09-ddac-bde0-ff19-2f15d6cc81f9\"\n ],\n \"target_status\": \"false_positive\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b86274-8b79-45f1-a65a-2c83e16476c5", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"c3738c09-ddac-bde0-ff19-2f15d6cc81f9\"\n ],\n \"target_status\": \"false_positive\",\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": "2d71cf71-b35b-467d-8916-00874525b564", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "projects", ":project_id", "vulnerabilities:bulk-transition" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"finding_ids\": [\n \"c3738c09-ddac-bde0-ff19-2f15d6cc81f9\"\n ],\n \"target_status\": \"false_positive\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "490a6438-1893-4aa1-95b1-c599e32b4df6", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5dabc44c-3112-499d-aed7-48162902a1bc", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": \"a0a71e33-0bef-6193-bff1-c32965aa9cd8\",\n \"project_id\": \"0db99305-181c-806b-be4a-feaf4a139732\",\n \"scan_id\": \"5e635a0e-ee4d-9716-5cdd-892774e3e923\",\n \"cve_id\": \"string\",\n \"severity\": \"high\",\n \"status\": \"fixed\",\n \"first_detected_at\": \"2000-11-18T02:43:01.421Z\",\n \"created_at\": \"1986-09-17T19:11:34.781Z\",\n \"updated_at\": \"1985-04-06T02:28:52.337Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"ac3748a6-4b3f-5623-5ec9-893717195862\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n },\n {\n \"component_version_id\": \"f5b3e3ba-c72a-0cc2-665d-180ecde41ad6\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n }\n ],\n \"analysis_justification\": \"string\",\n \"analysis_source\": \"vex_import\",\n \"analysis_state\": \"string\",\n \"analyst_user_id\": \"713cfbcd-c35a-3032-9357-9fe0c75d5c76\",\n \"analyzed_at\": \"1988-09-16T18:31:17.804Z\",\n \"assignee_is_active\": true,\n \"assignee_user_id\": \"a24e58c9-6e41-e3ef-9316-dd8df62f9587\",\n \"cvss_score\": 1529.005496900213,\n \"cvss_vector\": \"string\",\n \"details\": \"string\",\n \"due_on\": \"1999-02-17\",\n \"due_source\": \"manual\",\n \"effective_due_date\": \"1958-09-08T22:12:46.958Z\",\n \"epss_percentile\": 0.04072672914447395,\n \"epss_score\": 0.9697893060880474,\n \"kev\": false,\n \"kev_due_date\": \"2017-05-06\",\n \"manual_due_ignored\": false,\n \"matching_provenance\": {\n \"name\": \"string\",\n \"feed_url\": \"string\",\n \"id\": \"string\"\n },\n \"published_at\": \"1995-08-15T03:29:05.410Z\",\n \"reachability_analyzed_at\": \"1952-12-14T21:17:53.303Z\",\n \"reachability_source\": \"string\",\n \"reachable\": false,\n \"sla_due_date\": \"1960-01-01T03:05:13.799Z\",\n \"sla_status\": \"overdue\",\n \"status_history\": [\n {\n \"action\": \"string\",\n \"new_status\": \"new\",\n \"created_at\": \"2017-05-14T09:01:24.478Z\",\n \"actor_user_id\": \"45f367e7-7031-3eb9-9546-215c916fef8e\",\n \"previous_status\": \"not_affected\",\n \"request_id\": \"string\"\n },\n {\n \"action\": \"string\",\n \"new_status\": \"false_positive\",\n \"created_at\": \"2005-11-01T03:35:11.503Z\",\n \"actor_user_id\": \"d3d4f6ec-ff66-543f-26da-8240cd039bee\",\n \"previous_status\": \"new\",\n \"request_id\": \"string\"\n }\n ],\n \"summary\": \"string\",\n \"ticket_check_error\": \"string\",\n \"ticket_checked_at\": \"2017-06-28T05:16:31.107Z\",\n \"ticket_key\": \"string\",\n \"ticket_resolved\": true,\n \"ticket_status\": \"string\",\n \"ticket_url\": \"string\",\n \"upgrade_recommendation\": {\n \"reason\": \"ok\",\n \"direct\": false,\n \"finding_count\": 0,\n \"max_epss\": 0.5454332005181737,\n \"max_severity\": \"medium\",\n \"recommended_version\": \"string\"\n },\n \"vex_origin\": {\n \"author\": \"string\",\n \"format\": \"openvex\",\n \"id\": \"string\",\n \"imported_at\": \"string\",\n \"timestamp\": \"string\",\n \"vex_status\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41984358-7981-47c0-b6bd-930cfa50afce", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a96021f6-d3c4-4057-a370-b9745721fefc", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cea0e37-af8e-4db0-a4a6-a9a5822f2ef2", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5703680e-dc12-40fc-b87e-3f14f0d9d920", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44534b67-6e29-4965-84f9-78c9ae963e62", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": \"109a96a8-8bea-6e3e-9321-5c21448520df\",\n \"due_on\": \"2024-11-04\",\n \"if_match\": \"1951-11-25T07:13:14.854Z\",\n \"ticket_key\": \"string\",\n \"ticket_url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0c9f5cd3-13ed-4428-ba6b-2d33907e4125", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"109a96a8-8bea-6e3e-9321-5c21448520df\",\n \"due_on\": \"2024-11-04\",\n \"if_match\": \"1951-11-25T07:13:14.854Z\",\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\": \"a0a71e33-0bef-6193-bff1-c32965aa9cd8\",\n \"project_id\": \"0db99305-181c-806b-be4a-feaf4a139732\",\n \"scan_id\": \"5e635a0e-ee4d-9716-5cdd-892774e3e923\",\n \"cve_id\": \"string\",\n \"severity\": \"high\",\n \"status\": \"fixed\",\n \"first_detected_at\": \"2000-11-18T02:43:01.421Z\",\n \"created_at\": \"1986-09-17T19:11:34.781Z\",\n \"updated_at\": \"1985-04-06T02:28:52.337Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"ac3748a6-4b3f-5623-5ec9-893717195862\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n },\n {\n \"component_version_id\": \"f5b3e3ba-c72a-0cc2-665d-180ecde41ad6\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n }\n ],\n \"analysis_justification\": \"string\",\n \"analysis_source\": \"vex_import\",\n \"analysis_state\": \"string\",\n \"analyst_user_id\": \"713cfbcd-c35a-3032-9357-9fe0c75d5c76\",\n \"analyzed_at\": \"1988-09-16T18:31:17.804Z\",\n \"assignee_is_active\": true,\n \"assignee_user_id\": \"a24e58c9-6e41-e3ef-9316-dd8df62f9587\",\n \"cvss_score\": 1529.005496900213,\n \"cvss_vector\": \"string\",\n \"details\": \"string\",\n \"due_on\": \"1999-02-17\",\n \"due_source\": \"manual\",\n \"effective_due_date\": \"1958-09-08T22:12:46.958Z\",\n \"epss_percentile\": 0.04072672914447395,\n \"epss_score\": 0.9697893060880474,\n \"kev\": false,\n \"kev_due_date\": \"2017-05-06\",\n \"manual_due_ignored\": false,\n \"matching_provenance\": {\n \"name\": \"string\",\n \"feed_url\": \"string\",\n \"id\": \"string\"\n },\n \"published_at\": \"1995-08-15T03:29:05.410Z\",\n \"reachability_analyzed_at\": \"1952-12-14T21:17:53.303Z\",\n \"reachability_source\": \"string\",\n \"reachable\": false,\n \"sla_due_date\": \"1960-01-01T03:05:13.799Z\",\n \"sla_status\": \"overdue\",\n \"status_history\": [\n {\n \"action\": \"string\",\n \"new_status\": \"new\",\n \"created_at\": \"2017-05-14T09:01:24.478Z\",\n \"actor_user_id\": \"45f367e7-7031-3eb9-9546-215c916fef8e\",\n \"previous_status\": \"not_affected\",\n \"request_id\": \"string\"\n },\n {\n \"action\": \"string\",\n \"new_status\": \"false_positive\",\n \"created_at\": \"2005-11-01T03:35:11.503Z\",\n \"actor_user_id\": \"d3d4f6ec-ff66-543f-26da-8240cd039bee\",\n \"previous_status\": \"new\",\n \"request_id\": \"string\"\n }\n ],\n \"summary\": \"string\",\n \"ticket_check_error\": \"string\",\n \"ticket_checked_at\": \"2017-06-28T05:16:31.107Z\",\n \"ticket_key\": \"string\",\n \"ticket_resolved\": true,\n \"ticket_status\": \"string\",\n \"ticket_url\": \"string\",\n \"upgrade_recommendation\": {\n \"reason\": \"ok\",\n \"direct\": false,\n \"finding_count\": 0,\n \"max_epss\": 0.5454332005181737,\n \"max_severity\": \"medium\",\n \"recommended_version\": \"string\"\n },\n \"vex_origin\": {\n \"author\": \"string\",\n \"format\": \"openvex\",\n \"id\": \"string\",\n \"imported_at\": \"string\",\n \"timestamp\": \"string\",\n \"vex_status\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05f0bdf9-0529-4930-a0c2-e4ecc9368aaa", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"109a96a8-8bea-6e3e-9321-5c21448520df\",\n \"due_on\": \"2024-11-04\",\n \"if_match\": \"1951-11-25T07:13:14.854Z\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c833da5-8f77-4fb4-af8a-845017cae674", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"109a96a8-8bea-6e3e-9321-5c21448520df\",\n \"due_on\": \"2024-11-04\",\n \"if_match\": \"1951-11-25T07:13:14.854Z\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f60027ac-6809-4af2-b103-6ac490e63088", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"109a96a8-8bea-6e3e-9321-5c21448520df\",\n \"due_on\": \"2024-11-04\",\n \"if_match\": \"1951-11-25T07:13:14.854Z\",\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": "99ee07e5-d9eb-4553-ace0-83e493432f3f", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"109a96a8-8bea-6e3e-9321-5c21448520df\",\n \"due_on\": \"2024-11-04\",\n \"if_match\": \"1951-11-25T07:13:14.854Z\",\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": "5811c92f-bb4c-4b91-a9a3-9862752550e5", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "assignment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"assignee_user_id\": \"109a96a8-8bea-6e3e-9321-5c21448520df\",\n \"due_on\": \"2024-11-04\",\n \"if_match\": \"1951-11-25T07:13:14.854Z\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99ac6d28-3186-477f-9a45-22f0459da5ae", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": \"false_positive\",\n \"if_match\": \"1993-12-10T21:08:01.756Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "74c14cc0-c6c9-4fd2-9222-44a55a46675a", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"false_positive\",\n \"if_match\": \"1993-12-10T21:08:01.756Z\",\n \"justification\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a0a71e33-0bef-6193-bff1-c32965aa9cd8\",\n \"project_id\": \"0db99305-181c-806b-be4a-feaf4a139732\",\n \"scan_id\": \"5e635a0e-ee4d-9716-5cdd-892774e3e923\",\n \"cve_id\": \"string\",\n \"severity\": \"high\",\n \"status\": \"fixed\",\n \"first_detected_at\": \"2000-11-18T02:43:01.421Z\",\n \"created_at\": \"1986-09-17T19:11:34.781Z\",\n \"updated_at\": \"1985-04-06T02:28:52.337Z\",\n \"affected_components\": [\n {\n \"component_version_id\": \"ac3748a6-4b3f-5623-5ec9-893717195862\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n },\n {\n \"component_version_id\": \"f5b3e3ba-c72a-0cc2-665d-180ecde41ad6\",\n \"name\": \"string\",\n \"version\": \"string\",\n \"fixed_version\": \"string\",\n \"purl\": \"string\"\n }\n ],\n \"analysis_justification\": \"string\",\n \"analysis_source\": \"vex_import\",\n \"analysis_state\": \"string\",\n \"analyst_user_id\": \"713cfbcd-c35a-3032-9357-9fe0c75d5c76\",\n \"analyzed_at\": \"1988-09-16T18:31:17.804Z\",\n \"assignee_is_active\": true,\n \"assignee_user_id\": \"a24e58c9-6e41-e3ef-9316-dd8df62f9587\",\n \"cvss_score\": 1529.005496900213,\n \"cvss_vector\": \"string\",\n \"details\": \"string\",\n \"due_on\": \"1999-02-17\",\n \"due_source\": \"manual\",\n \"effective_due_date\": \"1958-09-08T22:12:46.958Z\",\n \"epss_percentile\": 0.04072672914447395,\n \"epss_score\": 0.9697893060880474,\n \"kev\": false,\n \"kev_due_date\": \"2017-05-06\",\n \"manual_due_ignored\": false,\n \"matching_provenance\": {\n \"name\": \"string\",\n \"feed_url\": \"string\",\n \"id\": \"string\"\n },\n \"published_at\": \"1995-08-15T03:29:05.410Z\",\n \"reachability_analyzed_at\": \"1952-12-14T21:17:53.303Z\",\n \"reachability_source\": \"string\",\n \"reachable\": false,\n \"sla_due_date\": \"1960-01-01T03:05:13.799Z\",\n \"sla_status\": \"overdue\",\n \"status_history\": [\n {\n \"action\": \"string\",\n \"new_status\": \"new\",\n \"created_at\": \"2017-05-14T09:01:24.478Z\",\n \"actor_user_id\": \"45f367e7-7031-3eb9-9546-215c916fef8e\",\n \"previous_status\": \"not_affected\",\n \"request_id\": \"string\"\n },\n {\n \"action\": \"string\",\n \"new_status\": \"false_positive\",\n \"created_at\": \"2005-11-01T03:35:11.503Z\",\n \"actor_user_id\": \"d3d4f6ec-ff66-543f-26da-8240cd039bee\",\n \"previous_status\": \"new\",\n \"request_id\": \"string\"\n }\n ],\n \"summary\": \"string\",\n \"ticket_check_error\": \"string\",\n \"ticket_checked_at\": \"2017-06-28T05:16:31.107Z\",\n \"ticket_key\": \"string\",\n \"ticket_resolved\": true,\n \"ticket_status\": \"string\",\n \"ticket_url\": \"string\",\n \"upgrade_recommendation\": {\n \"reason\": \"ok\",\n \"direct\": false,\n \"finding_count\": 0,\n \"max_epss\": 0.5454332005181737,\n \"max_severity\": \"medium\",\n \"recommended_version\": \"string\"\n },\n \"vex_origin\": {\n \"author\": \"string\",\n \"format\": \"openvex\",\n \"id\": \"string\",\n \"imported_at\": \"string\",\n \"timestamp\": \"string\",\n \"vex_status\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6aa63a96-580a-4194-838e-fcbdf4234875", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"false_positive\",\n \"if_match\": \"1993-12-10T21:08:01.756Z\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3437557-4e30-4945-bb88-71490a658e6c", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"false_positive\",\n \"if_match\": \"1993-12-10T21:08:01.756Z\",\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": "13d1c396-5ba6-4d81-a36b-d72e128978c6", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"false_positive\",\n \"if_match\": \"1993-12-10T21:08:01.756Z\",\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": "30a4a114-eef5-4ea3-80de-41b030fe3645", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"false_positive\",\n \"if_match\": \"1993-12-10T21:08:01.756Z\",\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": "6e1032a0-5309-4f2e-a868-99e7374a02a2", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"false_positive\",\n \"if_match\": \"1993-12-10T21:08:01.756Z\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2422d7a-570f-44f9-a43b-2f3d85cb6fc8", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "key": "finding_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c2133463-68c9-4d8e-baee-d2a13c5c280c", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": \"059fdb79-7aed-3f8a-1461-50aaddd21598\",\n \"ticket_status\": \"string\",\n \"ticket_resolved\": false,\n \"ticket_checked_at\": \"2004-12-16T20:42:31.825Z\",\n \"ticket_check_error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b50024cf-d43f-406b-865b-ffb66ea2271b", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb55eb42-3344-4ae1-a84e-159dbec067dc", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeb8f931-e3b5-4f23-9555-162078d3c7f3", "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": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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": "65be3885-0ccb-4aab-9da4-073064c0a0db", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "vulnerability_findings", ":finding_id", "ticket-status", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "92e36609-91cd-f978-8b25-2294e0d8aa37", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "99049419-d145-4b29-9d34-88be6fd6b551", "name": "report-format-templates", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "755a5f15-1de6-4788-acbb-0c045b3d60d0", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b23bf87f-be0d-4191-a214-ccba10b14928", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "2a3c844e-9c9d-4ba5-bd41-650f35bc2cb3", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9aee5c5-4dbf-47ee-863e-70bae37d91df", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "c6caa9fe-3ff7-45d0-bc1e-2718e601798d", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "d64bf482-ac08-495f-96ef-7027533c0f78", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6e12db6-e1a6-4390-bcad-d1f8dd277637", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9229a984-4d9f-41ad-a1b5-fc3aed0acc10", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"fe509237-2c2f-82ba-8e32-ad0d7e220547\",\n \"organization_id\": \"93e41ed5-f817-bd12-7ff5-95988bcfcd22\",\n \"created_at\": \"1973-07-19T16:04:43.038Z\",\n \"updated_at\": \"2016-06-27T10:55:35.547Z\",\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": "e1f49e81-b9df-48bd-afdc-dd8f755b4777", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36ba0367-b26a-4899-aacb-bd1fedf46f81", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d2a8c7d-21df-49af-9103-032d2c255613", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "82afd3c8-5551-4ae2-b67d-f042341ea6e2", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad715e2d-5756-4fb9-afa1-fbd23fe1d553", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "b04ea4e4-6c9b-4085-99bb-4dbe91b45ca5", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": \"fe509237-2c2f-82ba-8e32-ad0d7e220547\",\n \"organization_id\": \"93e41ed5-f817-bd12-7ff5-95988bcfcd22\",\n \"created_at\": \"1973-07-19T16:04:43.038Z\",\n \"updated_at\": \"2016-06-27T10:55:35.547Z\",\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": "339079f2-c44e-4ba4-ac0a-5ebff0e5a1c7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "547e4bcb-ada6-45cf-b981-dc7b99dd2e4d", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "2b247710-73c9-4ca9-8f06-22cae8d70bb6", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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": "8ee46cff-773e-4ef0-8509-421bfd0a0edc", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "report-format-templates", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "21866745-d4ee-4bba-b3f3-640e2069931a", "name": "saved-searches", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "22bf089f-53ad-44d8-903d-d546e78cb342", "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": "abf281be-e3d8-4916-a102-9b5cbd090f75", "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\": \"f99b72ad-4ea2-1fce-9e0d-8c92ad1ec36b\",\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": \"string\",\n \"key_1\": 9258.755332877836\n },\n \"created_at\": \"1948-08-03T03:07:27.281Z\"\n },\n {\n \"id\": \"ed31bbf7-3457-e4dc-40da-a26eb87c9056\",\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": 4034.276071400078,\n \"key_1\": \"string\",\n \"key_2\": 8903,\n \"key_3\": 7409\n },\n \"created_at\": \"1955-11-20T10:57:46.819Z\"\n }\n ],\n \"limit\": 20,\n \"total\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fa1fa6c-320d-4a1f-af46-c41cf7cfbade", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e149c7e-3b4c-4396-a4e8-e46cec05ca02", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "218b866f-4bf7-4659-9308-5b421671c4f2", "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\": 6563.551345578684,\n \"key_1\": 5089.891137876088,\n \"key_2\": 8816.1092023675,\n \"key_3\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4b8680b3-1d08-4542-a33e-284b7f2c2d55", "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\": 6563.551345578684,\n \"key_1\": 5089.891137876088,\n \"key_2\": 8816.1092023675,\n \"key_3\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"24ebb4a9-44a2-70c1-b612-55ef0ffb6650\",\n \"name\": \"string\",\n \"kind\": \"string\",\n \"params\": {\n \"key_0\": 3358,\n \"key_1\": 3934.4190448866943\n },\n \"created_at\": \"1951-09-30T03:33:53.501Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70e216e2-ad2a-4892-85b1-9016b3ddcb18", "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\": 6563.551345578684,\n \"key_1\": 5089.891137876088,\n \"key_2\": 8816.1092023675,\n \"key_3\": \"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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eaf62605-3643-4b51-933d-060896194274", "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\": 6563.551345578684,\n \"key_1\": 5089.891137876088,\n \"key_2\": 8816.1092023675,\n \"key_3\": \"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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdc53a00-bda2-4f34-9b40-ab6e24ade98d", "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\": 6563.551345578684,\n \"key_1\": 5089.891137876088,\n \"key_2\": 8816.1092023675,\n \"key_3\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c369c239-046f-42a0-9083-c47752a7f5f6", "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\": 6563.551345578684,\n \"key_1\": 5089.891137876088,\n \"key_2\": 8816.1092023675,\n \"key_3\": \"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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57dab38e-dc4d-4b53-9163-8e2c14b5e847", "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": "4ced12f5-8bd9-4580-a913-3c04d451f270", "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": "4eabaf08-8d0e-47b1-977f-af58e44baedd", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4ced12f5-8bd9-4580-a913-3c04d451f270", "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": "c65b40a8-c557-4737-b812-479ea179d35c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4ced12f5-8bd9-4580-a913-3c04d451f270", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c912933-08e6-472f-a3ca-976b472c8105", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4ced12f5-8bd9-4580-a913-3c04d451f270", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6d1bc76-872e-440b-b375-c5664d69c13b", "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": "4ced12f5-8bd9-4580-a913-3c04d451f270", "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": "c7dd0c40-821b-49e0-8253-c1d4507acc92", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "saved-searches", ":saved_search_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4ced12f5-8bd9-4580-a913-3c04d451f270", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1a8297b9-3ded-4ecc-a1a2-cff377b76892", "name": "scan-schedules", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0380a83c-71df-45d5-b08f-c9a70eb9b7d7", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "38cc96aa-dd25-4410-b14a-d0248ee0f0da", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"dbf4e8d4-84a1-2584-19aa-82a03a6fa1c9\",\n \"is_active\": false,\n \"source\": \"string\",\n \"cadence\": \"string\",\n \"day_of_week\": 3274,\n \"hour\": 5920,\n \"timezone\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95994e68-6b62-4a57-b6eb-c0118784c64f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a3347c5-3afa-4335-ae06-ebf083f4a160", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4bf0b9d-244d-4120-bb90-0958dd98f804", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3af97b3e-a0b8-47cb-8571-450738e1c59c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "effective", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f11c2404-13f7-47b8-bdc7-86fb86ad79be", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 9,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8337db47-fa6d-4355-8740-53f2ef1e9276", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 9,\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\": \"49e89cb2-37cc-9db5-708b-68f5a101797e\",\n \"organization_id\": \"04538e88-f2b4-71a3-3970-3ad5890dc745\",\n \"is_active\": false,\n \"timezone\": \"string\",\n \"created_at\": \"1972-04-01T15:42:57.478Z\",\n \"updated_at\": \"1985-04-04T14:23:56.203Z\",\n \"cadence\": \"string\",\n \"day_of_week\": 1128,\n \"hour\": 6385,\n \"last_triggered_at\": \"2000-03-06T00:45:12.764Z\",\n \"project_id\": \"4d1f8c61-66ed-92f3-94ae-5ed47bfe03f4\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1339582d-285d-4d4c-a67c-41ab97338530", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 9,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f77547ac-789a-4c48-8424-d442c5c5a788", "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": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 9,\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": "9bf25abc-73ba-4733-a9d6-029051769f2b", "name": "Organization not found.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "key": "organization_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 9,\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": "50092c76-3102-46b5-a991-84488c46f2df", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "org", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "46ab61a1-d526-7cfe-ee7b-d4f2ec0a18d5", "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\": 9,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46e3be01-a767-4557-a9c5-ae75fa406b15", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6c1eff96-e22b-4b01-8bb1-2c478b04d64d", "name": "Row removed.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "09fff28e-2048-4200-9557-1dc32211108e", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6645dc92-e013-4bf0-a20c-f3884f76da77", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "928b5da0-5a44-41e7-9179-133ba24a1359", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "82cecab5-8bd0-465f-a30c-0f68babd5e4e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c033bd9d-7f3a-4278-8cbd-c244010224d9", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7146dcf1-b786-4143-81b0-70495d48faa7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": \"49e89cb2-37cc-9db5-708b-68f5a101797e\",\n \"organization_id\": \"04538e88-f2b4-71a3-3970-3ad5890dc745\",\n \"is_active\": false,\n \"timezone\": \"string\",\n \"created_at\": \"1972-04-01T15:42:57.478Z\",\n \"updated_at\": \"1985-04-04T14:23:56.203Z\",\n \"cadence\": \"string\",\n \"day_of_week\": 1128,\n \"hour\": 6385,\n \"last_triggered_at\": \"2000-03-06T00:45:12.764Z\",\n \"project_id\": \"4d1f8c61-66ed-92f3-94ae-5ed47bfe03f4\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "639e3e5b-3c5d-4b8a-a772-96847b49b02c", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef93aadc-72d3-4a89-b32b-eda43653e666", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfcd8f41-3db7-40f3-8d87-b1c449816e8b", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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": "5d65f182-2403-4960-a82a-830eff35825d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ea9d0d2-c533-4747-8b39-48847f437beb", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9,\n \"is_active\": true,\n \"timezone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "963aea4a-944b-4eac-bcf1-129d0724eba6", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9,\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\": \"49e89cb2-37cc-9db5-708b-68f5a101797e\",\n \"organization_id\": \"04538e88-f2b4-71a3-3970-3ad5890dc745\",\n \"is_active\": false,\n \"timezone\": \"string\",\n \"created_at\": \"1972-04-01T15:42:57.478Z\",\n \"updated_at\": \"1985-04-04T14:23:56.203Z\",\n \"cadence\": \"string\",\n \"day_of_week\": 1128,\n \"hour\": 6385,\n \"last_triggered_at\": \"2000-03-06T00:45:12.764Z\",\n \"project_id\": \"4d1f8c61-66ed-92f3-94ae-5ed47bfe03f4\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34e76a26-d9f9-4458-bbd9-e407eeeb44d7", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75bbdda1-639a-4829-b6d5-cf5ec0653919", "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": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 9,\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": "196666c6-08cd-4de1-b7ee-8fc019e84e64", "name": "Project not found.", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "key": "project_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"cadence\": \"string\",\n \"day_of_week\": 4,\n \"hour\": 9,\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": "047cde52-1cac-46f9-8555-4b5a83fab57b", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "scan-schedules", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "d7fd9559-18da-5857-b27c-7c28911c734d", "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\": 9,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9353b451-56db-424c-8917-ff1ece5ab544", "name": "search", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "79cb1fc6-efa5-43c2-b1f9-889b61722e0d", "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": "afb82b81-a649-41f8-a35e-b11aedbe9465", "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": "ae5c3b4e-8bb8-4b48-b148-829b88a09301", "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": "d4c8458c-1d4b-4fd9-b90d-ec8793024618", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "392e167c-4f01-49ea-90e2-35e051f02f40", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6fbc17b-03fc-4d56-829d-a1c54fac357c", "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": "vulnerabilities", "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": "89149431-980c-4006-9b28-75c224835579", "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": "vulnerabilities" }, { "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\": 5868\n },\n {\n \"value\": \"string\",\n \"count\": 4426\n }\n ],\n \"key_1\": [\n {\n \"value\": \"string\",\n \"count\": 8948\n },\n {\n \"value\": \"string\",\n \"count\": 9630\n }\n ],\n \"key_2\": [\n {\n \"value\": \"string\",\n \"count\": 4309\n },\n {\n \"value\": \"string\",\n \"count\": 4698\n }\n ]\n },\n \"items_components\": [\n {\n \"project_id\": \"321ce784-25db-19ca-047a-dce4af443230\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_id\": \"5eda0e6e-3272-d724-5302-911f8d187461\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\"\n },\n {\n \"project_id\": \"d06283a8-d9f9-e3c9-77b8-d4bb9f7c2394\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"component_id\": \"1abd00c9-ee0d-99b7-5b8c-c1811b9b7447\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"purl\": \"string\",\n \"package_type\": \"string\"\n }\n ],\n \"items_licenses\": [\n {\n \"project_id\": \"650e2519-4790-3180-aa42-11dab3e0052d\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"license_id\": \"3abca01b-2876-e9b0-bf0b-9e91d6137f35\",\n \"license_name\": \"string\",\n \"category\": \"string\",\n \"component_name\": \"string\",\n \"version\": \"string\",\n \"spdx_id\": \"string\"\n },\n {\n \"project_id\": \"d4ccad4d-2dff-1747-cb71-745f0c4124e1\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"license_id\": \"511d6745-b3a2-7feb-44fd-2c9a9a0545e1\",\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\": \"cc7e971f-145e-a470-409e-e557b82c10a0\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"archived\": false,\n \"git_url\": \"string\"\n },\n {\n \"project_id\": \"ed2ef493-e03b-9b25-3012-b7aa096845bb\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"archived\": false,\n \"git_url\": \"string\"\n }\n ],\n \"items_vulnerabilities\": [\n {\n \"project_id\": \"399dd5ef-943a-3572-92f4-9af8d8438904\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"finding_id\": \"39a46091-0ebc-3d6f-a65a-ccb5c9a44166\",\n \"cve_id\": \"string\",\n \"severity\": \"string\",\n \"status\": \"string\",\n \"component_name\": \"string\",\n \"version\": \"string\"\n },\n {\n \"project_id\": \"3ace0cb8-ab23-27de-2451-fbf41097a665\",\n \"project_name\": \"string\",\n \"project_slug\": \"string\",\n \"finding_id\": \"8aff4eeb-2d18-1a4e-8109-78d1a86e6f42\",\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": "27287b4a-96a6-47db-be3d-d77918106509", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kind", "value": "vulnerabilities" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a387fd8-7207-4641-a14f-d1def03c3d9b", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kind", "value": "vulnerabilities" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05933455-349f-4394-abef-f3f82ff56c86", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "search", "results" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "kind", "value": "vulnerabilities" }, { "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "226ff71b-42a0-4f93-9637-160d7c32311a", "name": "service-accounts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8863ce33-bc72-4532-98da-cd34db6f4a98", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04", "description": "(Required) " } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3662f4b9-a707-4d5a-8768-79c70f7002ef", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04" } ], "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\": \"e49d81d3-2050-8028-ccc5-30f5f3bb4e7b\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"2025-09-25T21:44:48.753Z\",\n \"managed_by_user_id\": \"da70004f-a115-84a2-865f-70fe3ea6473e\"\n },\n {\n \"id\": \"6930eaa0-9c9f-ca83-724f-aa6672f58ee6\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"1993-05-15T02:26:28.857Z\",\n \"managed_by_user_id\": \"255a5ac5-1160-a024-16bc-2e973a4103ed\"\n }\n ],\n \"total\": 9841\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea94c157-69c9-4488-b048-9e9c17456217", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04" } ], "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cddaf76-8289-4ec2-80dc-5f9c88fe7922", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04" } ], "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53e11719-7d26-41b5-b584-30ebd529dd63", "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": "1812fd0c-09ad-f219-04cd-a758c2dfed04" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e0994bf3-32a4-4435-ab47-b2b4da50da0c", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "service-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "team_id", "value": "1812fd0c-09ad-f219-04cd-a758c2dfed04" } ], "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48f80623-347e-40c8-9ec4-aa9756219d8c", "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\": \"b9eb10a1-58eb-66a6-502b-6e902bb20a7e\",\n \"slug\": \"string\",\n \"display_name\": \"string\",\n \"role\": \"developer\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bbe4ca50-ade0-4bf4-b211-9eed784a67f5", "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\": \"b9eb10a1-58eb-66a6-502b-6e902bb20a7e\",\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\": \"a969f145-a245-43bf-a8ca-f9160ee079c4\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"1979-07-31T00:19:50.252Z\",\n \"managed_by_user_id\": \"000ecd3a-c611-dcc7-68b3-6f00a4e5a6d5\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09197fef-8d70-4fc7-aebe-b95883a2ab50", "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\": \"b9eb10a1-58eb-66a6-502b-6e902bb20a7e\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f54e3acc-be3d-4516-9419-195f88fbbe69", "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\": \"b9eb10a1-58eb-66a6-502b-6e902bb20a7e\",\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": "cbc96daa-00af-4a0a-9d81-2fd92987d077", "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\": \"b9eb10a1-58eb-66a6-502b-6e902bb20a7e\",\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": "6fc2a253-6d37-4eb7-a4b3-510da55ecbfb", "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\": \"b9eb10a1-58eb-66a6-502b-6e902bb20a7e\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "222420a9-a004-4aaa-af09-a61fd247a523", "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": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "58c27ad3-97d7-4179-9ef5-c579bfaa8f50", "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": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "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\": \"a969f145-a245-43bf-a8ca-f9160ee079c4\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"1979-07-31T00:19:50.252Z\",\n \"managed_by_user_id\": \"000ecd3a-c611-dcc7-68b3-6f00a4e5a6d5\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de872ef6-696e-431b-961f-26866ff17f0f", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae772be1-b7fe-42b8-8916-bbde81090da5", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "201a3282-e78e-4774-932b-002ede52246b", "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": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "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": "725d5199-abc9-44df-b614-5fba78b3efda", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3866b144-abdd-40cd-8a7b-b8213699f559", "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": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "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\": \"58541df5-d984-106b-019e-1536794229f6\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2b65d95-9c60-4e21-954b-fc56c6b0f875", "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": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"58541df5-d984-106b-019e-1536794229f6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a969f145-a245-43bf-a8ca-f9160ee079c4\",\n \"email\": \"string\",\n \"full_name\": \"string\",\n \"is_active\": false,\n \"created_at\": \"1979-07-31T00:19:50.252Z\",\n \"managed_by_user_id\": \"000ecd3a-c611-dcc7-68b3-6f00a4e5a6d5\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25d24bfe-1f34-4aed-9761-aeb7fcbb6787", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"58541df5-d984-106b-019e-1536794229f6\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "316a448a-46fb-472e-8570-a09a0999c8db", "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": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"58541df5-d984-106b-019e-1536794229f6\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d6dab86-ec1b-4bd2-b32a-670ac5eb7d50", "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": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "key": "service_account_id", "description": "(Required) " } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"58541df5-d984-106b-019e-1536794229f6\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0e49cebe-671b-4d59-8ae1-f39466c9e151", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "service-accounts", ":service_account_id", "steward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "5eb66e89-3c42-687f-b6f8-472a8188d1b4", "key": "service_account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"steward_user_id\": \"58541df5-d984-106b-019e-1536794229f6\"\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3a4532bb-1127-4900-867e-3563c8c944c1", "name": "transition-approvals", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "09edef2a-ea22-4150-a87b-589992a8be0c", "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": "c04e79a7-511b-4762-809f-3895b2dd7807", "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\": \"ce4a5c21-d8f1-ede3-e122-e8042630adfb\",\n \"finding_id\": \"2117f26a-4a76-f8ab-4eb8-5b82afaa53d1\",\n \"team_id\": \"236ebacd-1f5e-9f3f-e28e-80ee0d0b7a78\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"b78d3c50-4067-2e0f-2550-4d8ca949ee4d\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"6cd23aef-55f9-54d2-1912-64f81018c6de\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1979-03-11T13:50:41.458Z\",\n \"created_at\": \"1980-05-23T14:15:13.665Z\"\n },\n {\n \"id\": \"5ba0887c-a163-297f-9281-59132a205369\",\n \"finding_id\": \"89c8ec93-448d-66a8-881c-ac3d3d5776cd\",\n \"team_id\": \"4100b11c-c37c-5040-7b4c-a8457844ba94\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"6fcf08d8-8b6e-dcb3-a74a-bee4c808dcbf\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"b398b4f4-2543-1e2e-df3f-7df066937ec8\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1966-07-11T21:13:05.862Z\",\n \"created_at\": \"1996-04-03T08:29:43.708Z\"\n }\n ],\n \"total\": 9069\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12cd7249-33a4-4101-b674-3ba30038f208", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57e5ad46-fa56-43db-aee5-8cdff5adc5e9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52402646-1498-4d35-9ce0-e8255cc9819f", "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\": \"6f494409-5711-765d-3a58-bc4e8669cac4\",\n \"target_status\": \"string\",\n \"justification\": \"stringstring\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ff43a6a8-44f7-4458-8a68-2b085c8e8382", "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\": \"6f494409-5711-765d-3a58-bc4e8669cac4\",\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\": \"0bcbdceb-357f-9506-c24a-9a2f5a2be0c0\",\n \"finding_id\": \"10475dc2-25c1-2ae5-0eff-487b1743cdb3\",\n \"team_id\": \"c0eccfbc-aace-d303-411f-656122f0c631\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"3a1df13c-ccba-3cf1-e6b7-eecbdc0b91e3\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"d1f0f669-5fd2-c2ee-598a-d0a8419ddc10\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1955-11-30T09:08:13.920Z\",\n \"created_at\": \"2007-01-29T07:49:29.398Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "613e45e3-4dc0-4c7f-9b3d-14f87c38698e", "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\": \"6f494409-5711-765d-3a58-bc4e8669cac4\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9876f3af-9046-441e-97ac-9af4f6eaff31", "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\": \"6f494409-5711-765d-3a58-bc4e8669cac4\",\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": "c8ff6105-3d94-4174-b4df-bb1dc2f6e0f3", "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\": \"6f494409-5711-765d-3a58-bc4e8669cac4\",\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": "f7af33e0-6b42-459a-a541-f1d20b4ee061", "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\": \"6f494409-5711-765d-3a58-bc4e8669cac4\",\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": "518de706-fbbd-44ec-b7a9-585751a484a8", "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\": \"6f494409-5711-765d-3a58-bc4e8669cac4\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a40ab0c-59d8-471d-8340-f5a7f2ac9776", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "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\": false,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e67f4d31-1bd6-4a76-ba78-db7cf0903a70", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": false,\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0bcbdceb-357f-9506-c24a-9a2f5a2be0c0\",\n \"finding_id\": \"10475dc2-25c1-2ae5-0eff-487b1743cdb3\",\n \"team_id\": \"c0eccfbc-aace-d303-411f-656122f0c631\",\n \"target_status\": \"string\",\n \"justification\": \"string\",\n \"requested_by_user_id\": \"3a1df13c-ccba-3cf1-e6b7-eecbdc0b91e3\",\n \"state\": \"string\",\n \"decided_by_user_id\": \"d1f0f669-5fd2-c2ee-598a-d0a8419ddc10\",\n \"decision_note\": \"string\",\n \"decided_at\": \"1955-11-30T09:08:13.920Z\",\n \"created_at\": \"2007-01-29T07:49:29.398Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7c44f14-0472-47a1-8c3d-7e76d9cb6f71", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": false,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cca559e1-f06e-43bc-ab40-1a55d455307d", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": false,\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": "f4bd5c6e-95b5-441f-9452-68c618a981ba", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": false,\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": "ff4a7610-789d-425b-9506-b3082251a55a", "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": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": false,\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": "c0137fd9-12f7-4234-8d3f-e072dafbbf07", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "transition-approvals", ":approval_id", "decision" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "09f080e5-4d52-7441-f001-78fefb10761e", "key": "approval_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"approve\": false,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d22c6b94-3aae-4abd-8b1a-006f1d01042f", "name": "user-anonymisation", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4a30bbf4-76d8-4bae-8ff1-53d166bdc3e4", "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\": \"7f2774c0-8ced-23e4-adf9-8bb3d3bbe7a9\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b764de36-0230-41f2-bc34-884c47f13888", "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\": \"7f2774c0-8ced-23e4-adf9-8bb3d3bbe7a9\",\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"ff1cf819-d7a3-d629-0793-92e7a3c37748\",\n \"subject_user_id\": \"7ccec950-e0f3-efff-bd9d-d15ca0a8aa82\",\n \"requested_by_user_id\": \"1c651acb-c648-e0f6-40f4-59c8fc916397\",\n \"approved_by_user_id\": \"57dbd0c0-b885-1deb-cff9-9b7211b88061\",\n \"state\": \"string\",\n \"reason\": \"string\",\n \"created_at\": \"1987-08-13T16:30:11.394Z\",\n \"expires_at\": \"1968-12-10T03:39:30.599Z\",\n \"approved_at\": \"1981-12-28T22:43:07.771Z\",\n \"executed_at\": \"1979-09-29T19:49:02.131Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fb96468-a31a-4129-97b5-def618387971", "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\": \"7f2774c0-8ced-23e4-adf9-8bb3d3bbe7a9\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77aee52a-a1ba-481c-9b52-7ad63d1f1840", "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\": \"7f2774c0-8ced-23e4-adf9-8bb3d3bbe7a9\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ffa5d61-5058-4142-8c71-7be5a02a2dc2", "name": "No such user.", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subject_user_id\": \"7f2774c0-8ced-23e4-adf9-8bb3d3bbe7a9\",\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": "1eed7a4b-d1d5-42e6-816c-b0b2a17b3b55", "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\": \"7f2774c0-8ced-23e4-adf9-8bb3d3bbe7a9\",\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": "f254a0fd-91bd-47f5-975a-2f6ba3f2ccff", "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\": \"7f2774c0-8ced-23e4-adf9-8bb3d3bbe7a9\",\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03f9df7f-ad65-4320-9d79-455f4d059916", "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": "28b0d0dd-5642-4cca-9c2a-b87dff1e3c96", "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\": \"f106e777-8d87-b0b0-b2f8-230b4ef00fd6\",\n \"subject_user_id\": \"579e68a3-e473-ccef-6f53-4cf28db5374f\",\n \"requested_by_user_id\": \"c4e25ef7-45b3-2e46-3097-7c2e2b3c2e08\",\n \"approved_by_user_id\": \"ee229894-9c0b-fc2a-9f53-41b1094402f0\",\n \"approved_at\": \"1961-05-02T05:01:37.499Z\",\n \"waiting_days\": 4309\n },\n {\n \"request_id\": \"00d0ec18-73e7-7f17-36fc-68557c9150db\",\n \"subject_user_id\": \"27635c7f-8ac1-9996-79b2-efcfffb4cea4\",\n \"requested_by_user_id\": \"20b6feb2-f5b0-a974-fc62-1286910a672c\",\n \"approved_by_user_id\": \"20ff82e1-4a3b-999e-163c-680c09e48a43\",\n \"approved_at\": \"1975-12-22T03:14:51.689Z\",\n \"waiting_days\": 2485\n }\n ],\n \"count\": 5637\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b6e8f93-5b8b-4a37-adf0-75c0f9e31adc", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61234284-5c0b-4539-9450-7c150cf06f7e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4114860-f7ff-458e-867e-ec32d325aed3", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "abb0fea5-f4d2-4d6a-91ed-ce06c498fddc", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": \"ff1cf819-d7a3-d629-0793-92e7a3c37748\",\n \"subject_user_id\": \"7ccec950-e0f3-efff-bd9d-d15ca0a8aa82\",\n \"requested_by_user_id\": \"1c651acb-c648-e0f6-40f4-59c8fc916397\",\n \"approved_by_user_id\": \"57dbd0c0-b885-1deb-cff9-9b7211b88061\",\n \"state\": \"string\",\n \"reason\": \"string\",\n \"created_at\": \"1987-08-13T16:30:11.394Z\",\n \"expires_at\": \"1968-12-10T03:39:30.599Z\",\n \"approved_at\": \"1981-12-28T22:43:07.771Z\",\n \"executed_at\": \"1979-09-29T19:49:02.131Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9c7756d-9844-4a04-9c1c-45efb96cadcf", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35e64f48-e854-4e81-9f14-e33913e8dc59", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a706869-2b44-41e8-a5af-99f72e47b1fa", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aa22918-4e2e-4773-9bfc-1a2b1499dc32", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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": "3c0bad45-f3c6-4000-8916-033bd35b4e23", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0e968a9-118c-43d5-b746-4b2f2c0ee7dd", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "key": "request_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aee419e0-3cd3-449b-8ee5-cae706744af8", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": \"ff1cf819-d7a3-d629-0793-92e7a3c37748\",\n \"subject_user_id\": \"7ccec950-e0f3-efff-bd9d-d15ca0a8aa82\",\n \"requested_by_user_id\": \"1c651acb-c648-e0f6-40f4-59c8fc916397\",\n \"approved_by_user_id\": \"57dbd0c0-b885-1deb-cff9-9b7211b88061\",\n \"state\": \"string\",\n \"reason\": \"string\",\n \"created_at\": \"1987-08-13T16:30:11.394Z\",\n \"expires_at\": \"1968-12-10T03:39:30.599Z\",\n \"approved_at\": \"1981-12-28T22:43:07.771Z\",\n \"executed_at\": \"1979-09-29T19:49:02.131Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1360f075-64c9-46d4-b687-2f96023220fe", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2eb22bb-cfd2-4600-90c9-3c63de67db96", "name": "Not permitted for this caller", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd60cc4f-3b89-4fd5-83d1-69a6f06d154f", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2afe708-75f8-4a05-9812-a29d550115dc", "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": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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": "293f788f-ed3b-461b-b183-e352aa67e3f5", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "user-anonymisation", ":request_id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3b270135-a976-ef1a-23a9-9365b0a007ff", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "49d4ce73-8460-4210-a7e2-b06672a86fe1", "name": "users-me", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c3a405cd-03e7-46f6-86c8-a41c52eb6d6b", "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.", "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": "839f2bf6-d2e4-4958-8c52-1c241ba01ccb", "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": "f2d9abe9-5252-439d-a159-adb367162e66", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61ad6595-4101-49ec-947b-040956def90d", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b734f93-84b3-4653-a6bc-6683edb1dfa9", "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": "e4ea2e4f-a451-4661-b3e7-0b891786d413", "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": "f7e435c4-5043-4e02-ae4b-f55c1e0633e0", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7ebde7f-1fac-4783-b41d-a07abb77711a", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a08e74ea-cda5-42fa-9276-532488884953", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10d941b0-0b8d-4ac6-8d52-12e7ef3e69e8", "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": "8ac1771e-0736-4e5c-8a0e-a6797f021f30", "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": "c0481100-50ed-43d1-a287-474f40e4a530", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99402a2e-f611-4dbd-84a0-58e5587772fe", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af109e5c-ef0c-4096-a2cd-0accb6454169", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b50fce9a-51c3-44df-81ff-764bc90a1b9e", "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": "b794a455-857b-4d63-ad5b-c57032341b00", "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": "9a5ab7a3-42eb-4e01-a5d9-38bba0ed0c7e", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71c70a28-8377-456d-a41c-bd394c167778", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e8327cd-3906-4792-9a93-40c63ad1c9f9", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6fae7b0-64f0-409b-a6f5-05e430f8601e", "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": "476871d7-149d-406e-8910-d3964520347e", "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\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "556f150f-9660-4057-b3cc-836ab7fe69e3", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beaedd3c-70ea-4bd5-9ff5-13dc50876a43", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d5ec6e0-81a6-4988-b5ff-cff0fc035fdd", "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\": false,\n \"slack_enabled\": true,\n \"teams_enabled\": true,\n \"in_app_enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c0b93dd5-53a1-417b-9f1b-17185950034d", "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\": false,\n \"slack_enabled\": true,\n \"teams_enabled\": true,\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\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53f2f42a-1af9-45fb-a609-27423dd9777a", "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\": false,\n \"slack_enabled\": true,\n \"teams_enabled\": true,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b92eab59-4c9b-41cb-aef7-4a918d521b39", "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\": false,\n \"slack_enabled\": true,\n \"teams_enabled\": true,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a167c65-a13d-459a-a12a-ed9586fb5d8a", "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\": false,\n \"slack_enabled\": true,\n \"teams_enabled\": true,\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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "236dd8f7-a6d8-4948-8622-e12349e3a458", "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": "6e10cd9b-c77a-4d79-9163-911223a33828", "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\": \"d79e907e-5c47-657f-897c-c0b95eb9c784\",\n \"provider\": \"github\",\n \"provider_user_id\": \"string\",\n \"created_at\": \"2014-04-20T13:20:05.525Z\",\n \"provider_email\": \"string\"\n },\n {\n \"id\": \"1557acb2-f0a5-4988-a88d-da54b5f8f67a\",\n \"provider\": \"google\",\n \"provider_user_id\": \"string\",\n \"created_at\": \"2016-09-13T17:00:09.174Z\",\n \"provider_email\": \"string\"\n }\n ],\n \"has_password\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2cecbc3-cad4-4206-a6d4-dd8f6f9ad795", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f4cde7-3a0d-4e0c-b62f-2ffad41755b7", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c953865-87f3-4ad1-b4a7-803aac820a51", "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": "b61b3c94-b551-e988-8581-892abfb77f52", "key": "identity_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "59cc6366-e075-47a4-8c54-e35d4c0249a8", "name": "Successful Response", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b61b3c94-b551-e988-8581-892abfb77f52", "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": "4426c313-6e26-467b-b40c-f9caf2f726eb", "name": "Not authenticated", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b61b3c94-b551-e988-8581-892abfb77f52", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1bfa88f-cf14-4e31-8a49-be9656d66b47", "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": "b61b3c94-b551-e988-8581-892abfb77f52", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ec55115-604c-4301-b162-a814c1cd5048", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b61b3c94-b551-e988-8581-892abfb77f52", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccae0421-58ab-4ebd-8864-0a629f240943", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "users", "me", "oauth-identities", ":identity_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "b61b3c94-b551-e988-8581-892abfb77f52", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0feb3795-86b3-4ffc-b7ee-3c52be25ec6b", "name": "webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9d19eeb6-0031-4b85-b287-779bdb23dcd1", "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": "521d813f-c1e6-4f88-bbf9-916299db3ac1", "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": "8360ed7e-d5e8-49cc-8001-aeb7acdd122c", "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": "b19f6d83-d7d1-4468-8fe6-93b46824c668", "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": "ac84480a-b36b-4ba1-beb4-9ee7ee244c97", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c25aaa15-7db5-4971-a6f1-9c6404ced8ea", "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": "80489c94-4238-4f8d-a8f7-8269b8a512c7", "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": "4cdc9f49-84b4-41bf-a566-71fd24c43722", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17f7d63a-b8e5-420e-b5ad-749e3dadd1ba", "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": "63631bc7-b5fc-48db-a6a4-ba4a745940a5", "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": "b4c93e10-2ff3-41d6-be16-69404ab0feb5", "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": "ac94f6fa-591d-4e45-a4d3-ac91db15e50d", "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": "5af65d0c-cb04-45f7-8ff9-bff0a68e0763", "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": "840a262e-13c3-4c6c-ada2-469603581e36", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86fa076a-e8af-49aa-baf7-55af4119ab02", "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": "ff8ecd1e-e028-470c-b4b6-503ce308f250", "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": "f44846af-dc1f-4798-b6ea-efa0dc866a32", "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\": 6862,\n \"instance\": \"string\",\n \"detail\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "597ea9ed-f3bb-468f-99d8-ed51d0c4db5f", "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": "7feb4cef-0a45-4f91-bff5-6ed8e145bb0c", "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." } }